com.opencloud.rhino.facilities.sas

Interface SasManagementMBean

public interface SasManagementMBean

The SasManagementMBean provides access to the SAS server configuration.

A SasManagementMBean instance always manages the SAS server configuration for the currently active namespace for the client connection. It is not necessary to get a different MBean for different namespaces.

Field Summary

Fields

Modifier and Type	Field and Description
static String	MBEAN_NAME The name of this MBean, equal to the string "SAS".
static String	OBJECT_NAME The JMX Object Name of this MBean.

Method Summary

Modifier and Type	Method and Description
void	addServer(String server) Add a server to the set of configured SAS servers.
boolean	getAppendNodeID()
String	getBundlePrefixMapping(String name) Gets a bundle prefix mapping.
int	getQueueSize()
String	getResourceIdentifier() Returns the SAS resource-identifier associated with events sent to SAS.
String	getServer() Deprecated. Use getServers instead. Warning: will be removed
String[]	getServers() Get the set of configured SAS servers
String	getSystemName() gets the current System name sent to SAS on connection
boolean	isTracingEnabled() Returns true if the SAS facility is current configured to send trace messages to SAS.
TabularData	listBundlePrefixMappings() Lists all the bundle prefix mappings
void	removeBundlePrefixMapping(String name) Removes a bundle prefix mapping.
boolean	removeServer(String server) Remove a server from the set of configured SAS servers.
String[]	reportUnmappedBundles() Get a list of all unmapped bundles present
void	setAppendNodeID(boolean appendNodeID) In order to provide SAS with a unique system name per Rhino node in the cluster there is the option to append the node ID to system name.
void	setBundlePrefixMapping(String name, String prefix) Adds or updates a bundle prefix mapping.
void	setQueueSize(int queueSize)
void	setResourceIdentifier(String resourceIdentifier) Sets the resource-identifier of the SAS resource bundle to associate with events sent to the SAS server
void	setServer(String server) Deprecated. Use addServer and removeServer or setServers instead. Warning: will be removed
void	setServers(String[] server) Sets the hostnames/addresses of the SAS servers the SAS facility should send trace messages to
void	setSystemName(String systemName) SystemName to use when connecting to SAS
void	setTracingEnabled(boolean sasTracingEnabled, boolean force) Sets the state of the SAS facility

Field Detail

MBEAN_NAME

static final String MBEAN_NAME

The name of this MBean, equal to the string "SAS".

See Also:

Constant Field Values

OBJECT_NAME

static final String OBJECT_NAME

The JMX Object Name of this MBean.

Method Detail

isTracingEnabled

boolean isTracingEnabled()
                  throws ConfigurationException

Returns true if the SAS facility is current configured to send trace messages to SAS.

Throws:

ConfigurationException - if the SAS configuration could not be read.

setTracingEnabled

void setTracingEnabled(boolean sasTracingEnabled,
                       boolean force)
                throws ConfigurationException

Sets the state of the SAS facility

Parameters:

sasTracingEnabled - if true, the SAS facility will send trace messages to the configured server

force - if true, ignore SLEE state

Throws:

ConfigurationException - if the SAS configuration could not be read or updated. if the SLEE is not stopped, and sasTracingEnabled is @code{False}

getQueueSize

int getQueueSize()
          throws ConfigurationException

Throws:

ConfigurationException

setQueueSize

void setQueueSize(int queueSize)
           throws ConfigurationException

Throws:

ConfigurationException

getSystemName

String getSystemName()
              throws ConfigurationException

gets the current System name sent to SAS on connection

Returns:

the system name sent to SAS on connection

Throws:

ConfigurationException

setSystemName

void setSystemName(String systemName)
            throws ConfigurationException

SystemName to use when connecting to SAS

Parameters:

systemName - to use when connecting to SAS

Throws:

ConfigurationException

getAppendNodeID

boolean getAppendNodeID()
                 throws ConfigurationException

Returns:

true if the node ID should be appended to the system name. False otherwise

Throws:

ConfigurationException

setAppendNodeID

void setAppendNodeID(boolean appendNodeID)
              throws ConfigurationException

In order to provide SAS with a unique system name per Rhino node in the cluster there is the option to append the node ID to system name.

Parameters:

appendNodeID - true if the node ID should be appended to System name. False otherwise

Throws:

ConfigurationException

addServer

void addServer(String server)
        throws ConfigurationException

Add a server to the set of configured SAS servers. Optionally, include a port in the format hostname:port

Parameters:

server - Hostname or IP of the server to add.

Throws:

ConfigurationException

removeServer

boolean removeServer(String server)
              throws ConfigurationException

Remove a server from the set of configured SAS servers. This must exactly match the server entry, including port if any.

Parameters:

server - Hostname or IP of the server to remove.

Throws:

ConfigurationException

getServer

String getServer()
          throws ConfigurationException

Deprecated. Use getServers instead. Warning: will be removed

Returns the hostname/address of the configured SAS server.

Throws:

ConfigurationException - if the SAS configuration could not be read.

setServer

void setServer(String server)
        throws ConfigurationException

Deprecated. Use addServer and removeServer or setServers instead. Warning: will be removed

Sets the hostname/address of the SAS server the SAS facility should send trace messages to

Parameters:

server - the hostname or IP address of the SAS server

Throws:

ConfigurationException - if the SAS configuration could not be read or updated.

setServers

void setServers(String[] server)
         throws ConfigurationException

Sets the hostnames/addresses of the SAS servers the SAS facility should send trace messages to

Parameters:

server - the hostname or IP address of the SAS server

Throws:

ConfigurationException - if the SAS configuration could not be read or updated.

getServers

String[] getServers()
             throws ConfigurationException

Get the set of configured SAS servers

Returns:

A string array containing the hostnames or IP addresses of the configured servers

Throws:

ConfigurationException

getResourceIdentifier

String getResourceIdentifier()
                      throws ConfigurationException

Returns the SAS resource-identifier associated with events sent to SAS.

Throws:

ConfigurationException - if the SAS configuration could not be read.

setResourceIdentifier

void setResourceIdentifier(String resourceIdentifier)
                    throws ConfigurationException

Sets the resource-identifier of the SAS resource bundle to associate with events sent to the SAS server

Parameters:

resourceIdentifier - the resource-identifier to associate with the SAS connection e.g. com.metaswitch.volte-tas

Throws:

ConfigurationException - if the SAS configuration could not be read or updated.

setBundlePrefixMapping

void setBundlePrefixMapping(String name,
                            String prefix)
                     throws MappingAlreadyExistsException,
                            ConfigurationException

Adds or updates a bundle prefix mapping. Prefix is a number in the range 0x0001 to 0xFFFF

Parameters:

name -

prefix -

Throws:

MappingAlreadyExistsException - when the specified prefix has already been associated with the target name

ConfigurationException

getBundlePrefixMapping

String getBundlePrefixMapping(String name)
                       throws ConfigurationException

Gets a bundle prefix mapping.

Parameters:

name -

Throws:

ConfigurationException

listBundlePrefixMappings

TabularData listBundlePrefixMappings()
                              throws ConfigurationException

Lists all the bundle prefix mappings

Throws:

ConfigurationException

removeBundlePrefixMapping

void removeBundlePrefixMapping(String name)
                        throws ConfigurationException,
                               IllegalArgumentException

Removes a bundle prefix mapping.

Parameters:

name -

Throws:

ConfigurationException

IllegalArgumentException

reportUnmappedBundles

String[] reportUnmappedBundles()
                        throws ConfigurationException

Get a list of all unmapped bundles present

Returns:

String[] containing any unmapped bundle names, empty if none unmapped

Throws:

ConfigurationException