Package com.opencloud.slee.resources.sis.management

Interface ConfigurationManagementMBean

All Known Subinterfaces:

SipConfigurationManagementMBean

public interface ConfigurationManagementMBean

Configuration attributes shared by all SIS implementations.

Field Summary

Fields

Modifier and Type	Field	Description
static String	SIS_MANAGEMENT_TYPE	The type of this MBean.

Method Summary

Modifier and Type	Method	Description
AuditLevel	getAuditLevel()	Determine the level of audit logging configured for the SIS RA entity.
long	getDefaultServiceTimeout()	Get the default service timeout for the SIS RA entity.
String	getDescription()	Get the SIS RA entity description.
boolean	getFineGrainedTracingEnabled()	Determine if fine-grained tracing has been enabled for the SIS RA entity.
void	setAuditLevel(AuditLevel level)	Set the level of audit logging for the SIS RA entity.
void	setDefaultServiceTimeout(long timeout)	Set the default service timeout for the SIS RA entity.
void	setDescription(String desc)	Set the SIS RA entity description.
void	setFineGrainedTracingEnabled(boolean enabled)	Enable or disable fine-grained tracing for the SIS RA entity.

Field Detail

SIS_MANAGEMENT_TYPE

static final String SIS_MANAGEMENT_TYPE

The type of this MBean. This value is used as part of the MBean's Object Name.

See Also:

Constant Field Values

Method Detail

getDescription

String getDescription()
               throws ManagementException

Get the SIS RA entity description. The description has no operation effect on the SIS. It is purely for informational purposes only.

Returns:

the description.

Throws:

ManagementException - if an error occurs communicating with the management server.

See Also:

setDescription(java.lang.String)

setDescription

void setDescription(String desc)
             throws ManagementException

Set the SIS RA entity description.

Parameters:

desc - the new description. May be null.

Throws:

ManagementException - if an error occurs communicating with the management server.

See Also:

getDescription()

getFineGrainedTracingEnabled

boolean getFineGrainedTracingEnabled()
                              throws ManagementException

Determine if fine-grained tracing has been enabled for the SIS RA entity. Any debug level associated with a selected component (composition, subscription etc) is ignored by the SIS unless fine-grained tracing has been enabled.

Returns:

true if fine-grained tracing is enabled, false otherwise.

Throws:

ManagementException - if an error occurs communicating with the management server.

See Also:

setFineGrainedTracingEnabled(boolean)

setFineGrainedTracingEnabled

void setFineGrainedTracingEnabled(boolean enabled)
                           throws ManagementException

Enable or disable fine-grained tracing for the SIS RA entity.

The SIS RA's configuration must be reloaded before the configuration changes caused by this method take effect.

Parameters:

enabled - boolean value indicating whether fine-grained tracing should be enabled or not.

Throws:

ManagementException - if an error occurs communicating with the management server.

See Also:

getFineGrainedTracingEnabled()

getAuditLevel

AuditLevel getAuditLevel()
                  throws ManagementException

Determine the level of audit logging configured for the SIS RA entity.

Returns:

the AuditLevel configured for the SIS RA entity.

Throws:

ManagementException - if an error occurs communicating with the management server.

See Also:

AuditLevel

setAuditLevel

void setAuditLevel(AuditLevel level)
            throws ManagementException

Set the level of audit logging for the SIS RA entity.

The SIS RA's configuration must be reloaded before the configuration changes caused by this method take effect.

Parameters:

level - the desired AuditLevel for the SIS RA entity.

Throws:

ManagementException - if an error occurs communicating with the management server.

See Also:

AuditLevel

getDefaultServiceTimeout

long getDefaultServiceTimeout()
                       throws ManagementException

Get the default service timeout for the SIS RA entity. This is the timeout used when the SIS is waiting for a response from a service. The default timeout is used if a specific timeout has not been set for the particular service via ServiceRefManagementMBean.setDefaultTimeout(com.opencloud.slee.resources.sis.components.ServiceRefID, long).

Returns:

the default service timeout.

Throws:

ManagementException - if an error occurs communicating with the management server.

See Also:

setDefaultServiceTimeout(long)

setDefaultServiceTimeout

void setDefaultServiceTimeout(long timeout)
                       throws IllegalArgumentException,
                              ManagementException

Set the default service timeout for the SIS RA entity.

The SIS RA's configuration must be reloaded before the configuration changes caused by this method take effect..

Parameters:

timeout - the timeout, measured in milliseconds. Must be at least 100ms.

Throws:

IllegalArgumentException - if timeout < 100.

ManagementException - if an error occurs communicating with the management server.

See Also:

getDefaultServiceTimeout()