net.sf.djdoc.bo
Class Apis

java.lang.Object
  net.sf.djdoc.bo.Apis

public class Apis
extends java.lang.Object

The Apis class is a utility class used for registering and deregistering APIs for the DJDoc web application.

Method Summary

static void	destroy() Cleanup method; shuts down the monitor thread.
static Api	getApi(java.lang.String name) This method retrieves an individual Api from the API cache.
static java.util.Collection<Api>	getApiList() This method returns the list of all Api objects from the API cache, sorted by their names.
static void	setup(java.io.File confDir, int interval) This is an initialization method for the utility class.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setup

public static void setup(java.io.File confDir,
                         int interval)

This is an initialization method for the utility class. It needs to be set up once.

Parameters:

confDir - The File specifying the location from where the API configuration files are read

interval - The interval (in milliseconds) at which the API configuration directory is monitored for changes

destroy

public static void destroy()

Cleanup method; shuts down the monitor thread.

getApi

public static Api getApi(java.lang.String name)

This method retrieves an individual Api from the API cache.

Parameters:

name - The name of the Api to be retrieved

Returns:

The cached Api object of the specified name

getApiList

public static java.util.Collection<Api> getApiList()

This method returns the list of all Api objects from the API cache, sorted by their names.

Returns:

The list of all cached Api objects