org.xins.server
Class APIManager

java.lang.Object
  org.xins.server.APIManager

All Implemented Interfaces:

APIManagerMBean

public final class APIManager

extends Object

implements APIManagerMBean

Management bean for the API.

Since:

XINS 1.5.0

Version:

$Revision: 1.19 $ $Date: 2006/10/31 14:57:27 $

Author:

Anthony Goubard

Method Summary

String	getAPIName() Gets the name of the API.
String	getAPIVersion() Gets the version of the API.
javax.management.openmbean.CompositeDataSupport	getBootstrapProperties() Gets the bootstrap properties.
String[]	getFunctionNames() Gets the list of the API functions.
javax.management.openmbean.CompositeDataSupport	getRuntimeProperties() Gets the runtime properties.
String	getStartupTime() Gets the time at which the API was started.
javax.management.openmbean.TabularDataSupport	getStatistics() Gets the statistics of the functions.
String	getXINSVersion() Gets the version of XINS which is running this API.
void	noOp() Executes the _NoOp meta function.
void	reloadProperties() Reloads the runtime properties if the file has changed.

Methods inherited from class java.lang.Object

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

Method Detail

getAPIVersion

public String getAPIVersion()
                     throws IOException

Gets the version of the API.

Specified by:

getAPIVersion in interface APIManagerMBean

Returns:

the version of the API running.

Throws:

IOException - if the connection to the MBean fails.

getXINSVersion

public String getXINSVersion()
                      throws IOException

Gets the version of XINS which is running this API.

Specified by:

getXINSVersion in interface APIManagerMBean

Returns:

the version of XINS running the API.

Throws:

IOException - if the connection to the MBean fails.

getAPIName

public String getAPIName()
                  throws IOException

Gets the name of the API.

Specified by:

getAPIName in interface APIManagerMBean

Returns:

the name the API.

Throws:

IOException - if the connection to the MBean fails.

getBootstrapProperties

public javax.management.openmbean.CompositeDataSupport getBootstrapProperties()
                                                                       throws IOException

Gets the bootstrap properties.

Specified by:

getBootstrapProperties in interface APIManagerMBean

Returns:

the bootstrap properties for this API.

Throws:

IOException - if the connection to the MBean fails.

getRuntimeProperties

public javax.management.openmbean.CompositeDataSupport getRuntimeProperties()
                                                                     throws IOException

Gets the runtime properties.

Specified by:

getRuntimeProperties in interface APIManagerMBean

Returns:

the runtime properties for this API.

Throws:

IOException - if the connection to the MBean fails.

getStartupTime

public String getStartupTime()
                      throws IOException

Gets the time at which the API was started.

Specified by:

getStartupTime in interface APIManagerMBean

Returns:

the time at which the API was started in the form YYYYMMDDThhmmssSSS+TZ.

Throws:

IOException - if the connection to the MBean fails.

getFunctionNames

public String[] getFunctionNames()
                          throws IOException

Gets the list of the API functions.

Specified by:

getFunctionNames in interface APIManagerMBean

Returns:

the list of the API function names.

Throws:

IOException - if the connection to the MBean fails.

getStatistics

public javax.management.openmbean.TabularDataSupport getStatistics()
                                                            throws IOException

Gets the statistics of the functions.

Specified by:

getStatistics in interface APIManagerMBean

Returns:

the statistics of the functions.

Throws:

IOException - if the connection to the MBean fails.

noOp

public void noOp()
          throws IOException,
                 NoSuchFunctionException,
                 AccessDeniedException

Executes the _NoOp meta function.

Specified by:

noOp in interface APIManagerMBean

Throws:

IOException - if the connection to the MBean fails.

NoSuchFunctionException - if the _noOp meta function is not found.

AccessDeniedException - if the JMX client is not in the ACLs to execute the _noOp meta function.

reloadProperties

public void reloadProperties()
                      throws IOException,
                             NoSuchFunctionException,
                             AccessDeniedException

Reloads the runtime properties if the file has changed.

Specified by:

reloadProperties in interface APIManagerMBean

Throws:

IOException - if the connection to the MBean fails.

NoSuchFunctionException - if the _ReloadProperties meta function is not found.

AccessDeniedException - if the JMX client is not in the ACLs to execute the _ReloadProperties meta function.