org.xins.server

Interface APIManagerMBean

All Known Implementing Classes:

APIManager

public interface APIManagerMBean

Management bean for the API.

Since:

XINS 1.5.0

Version:

$Revision: 1.12 $ $Date: 2010/09/29 17:21:48 $

Author:

Anthony Goubard

Method Summary

Methods

Modifier and Type	Method and Description
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.

Method Detail

getAPIVersion

String getAPIVersion()
                     throws IOException

Gets the version of the API.

Returns:

the version of the API running.

Throws:

IOException - if the connection to the MBean fails.

getXINSVersion

String getXINSVersion()
                      throws IOException

Gets the version of XINS which is running this API.

Returns:

the version of XINS running the API.

Throws:

IOException - if the connection to the MBean fails.

getAPIName

String getAPIName()
                  throws IOException

Gets the name of the API.

Returns:

the name the API.

Throws:

IOException - if the connection to the MBean fails.

getBootstrapProperties

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

Gets the bootstrap properties.

Returns:

the bootstrap properties for this API.

Throws:

IOException - if the connection to the MBean fails.

getRuntimeProperties

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

Gets the runtime properties.

Returns:

the runtime properties for this API.

Throws:

IOException - if the connection to the MBean fails.

getStartupTime

String getStartupTime()
                      throws IOException

Gets the time at which the API was started.

Returns:

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

Throws:

IOException - if the connection to the MBean fails.

getFunctionNames

String[] getFunctionNames()
                          throws IOException

Gets the list of the API functions.

Returns:

the list of the API function names.

Throws:

IOException - if the connection to the MBean fails.

getStatistics

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

Gets the statistics of the functions.

Returns:

the statistics of the functions.

Throws:

IOException - if the connection to the MBean fails.

noOp

void noOp()
          throws IOException,
                 NoSuchFunctionException,
                 AccessDeniedException

Executes the _NoOp meta function.

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

void reloadProperties()
                      throws IOException,
                             NoSuchFunctionException,
                             AccessDeniedException

Reloads the runtime properties if the file has changed.

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.