com.opencloud.slee.resources.sis.management

Interface TriggerAddressTracingManagementMBean

public interface TriggerAddressTracingManagementMBean

SIS RA management interface for managing trigger addresses for fine-grained tracing.

Field Summary

Fields

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

Method Summary

Methods

Modifier and Type	Method and Description
int	getDebugLevel(String address) Get the debug level for the specified trigger address in the SIS RA entity.
TriggerAddressTracingSelector[]	getSelectors(boolean originating) Deprecated. use getSelectors(TriggerType) instead.
TriggerAddressTracingSelector[]	getSelectors(TriggerType triggerType) Get the trigger address tracing selectors for the SIS RA entity.
String	getTriggerAddressTracingProfileTableName() Get the name of the current trigger address tracing profile table in the SIS RA entity.
boolean	isAuditLoggingEnabled(String address) Determine whether audit logging is enabled for a trigger address.
void	setAuditLoggingEnabled(String address, boolean enabled) Set the audit logging flag for a trigger address.
void	setDebugLevel(String address, int debugLevel) Set the debug level for the specified trigger address in the SIS RA entity.
void	setSelectors(boolean originating, TriggerAddressTracingSelector[] selectors) Deprecated. use setSelectors(TriggerType, TriggerAddressTracingSelector[]) instead.
void	setSelectors(TriggerType triggerType, TriggerAddressTracingSelector[] selectors) Set the trigger address tracing selectors for the SIS RA entity.
void	setTriggerAddressTracingProfileTableName(String tableName) Set the name of the trigger address tracing profile table in 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

getTriggerAddressTracingProfileTableName

String getTriggerAddressTracingProfileTableName()
                                                throws ManagementException

Get the name of the current trigger address tracing profile table in the SIS RA entity.

Returns:

the name of the current trigger address tracing profile table, or null if none has been configured.

Throws:

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

See Also:

setTriggerAddressTracingProfileTableName(java.lang.String)

setTriggerAddressTracingProfileTableName

void setTriggerAddressTracingProfileTableName(String tableName)
                                              throws ManagementException

Set the name of the trigger address tracing profile table in the SIS RA entity.

Parameters:

tableName - the new name of the trigger address tracing profile table. May be null.

Throws:

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

See Also:

getTriggerAddressTracingProfileTableName()

getDebugLevel

int getDebugLevel(String address)
                  throws NullPointerException,
                         ManagementException

Get the debug level for the specified trigger address in the SIS RA entity.

Parameters:

address - the address.

Returns:

the debug level for the address.

Throws:

NullPointerException - if address is null.

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

See Also:

setDebugLevel(java.lang.String, int)

setDebugLevel

void setDebugLevel(String address,
                 int debugLevel)
                   throws NullPointerException,
                          IllegalArgumentException,
                          ManagementException

Set the debug level for the specified trigger address in the SIS RA entity. Fine-grained tracing debug levels are given in the package summary.

Parameters:

address - the address.

debugLevel - the debug level.

Throws:

NullPointerException - if address is null.

IllegalArgumentException - if debugLevel is not valid.

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

See Also:

getDebugLevel(java.lang.String)

isAuditLoggingEnabled

boolean isAuditLoggingEnabled(String address)
                              throws NullPointerException,
                                     ManagementException

Determine whether audit logging is enabled for a trigger address.

If enabled, and the SIS's audit logging level is set to AuditLevel.ALL or AuditLevel.COMPONENT, then an audit record will be logged for all calls that match the address.

Parameters:

address - the address.

Returns:

true if audit logging is enabled

Throws:

NullPointerException - if address is null.

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

See Also:

ConfigurationManagementMBean.setAuditLevel(com.opencloud.slee.resources.sis.management.AuditLevel)

setAuditLoggingEnabled

void setAuditLoggingEnabled(String address,
                          boolean enabled)
                            throws NullPointerException,
                                   ManagementException

Set the audit logging flag for a trigger address.

If enabled, and the SIS's audit logging level is set to AuditLevel.ALL or AuditLevel.COMPONENT, then an audit record will be logged for all calls that match the address.

Parameters:

address - the address.

enabled - boolean value to specify if audit logging should be enabled

Throws:

NullPointerException - if address is null.

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

See Also:

ConfigurationManagementMBean.setAuditLevel(com.opencloud.slee.resources.sis.management.AuditLevel)

getSelectors

@Deprecated
TriggerAddressTracingSelector[] getSelectors(boolean originating)
                                             throws ManagementException

Deprecated. use getSelectors(TriggerType) instead.

Get the trigger address tracing selectors for the SIS RA entity.

Parameters:

originating - if true, the selectors for originating triggers is obtained, otherwise the selectors for terminating triggers is obtained.

Returns:

the selectors for the specified trigger type.

Throws:

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

See Also:

setSelectors(boolean, com.opencloud.slee.resources.sis.management.TriggerAddressTracingSelector[])

getSelectors

TriggerAddressTracingSelector[] getSelectors(TriggerType triggerType)
                                             throws NullPointerException,
                                                    ManagementException

Get the trigger address tracing selectors for the SIS RA entity.

Parameters:

triggerType - the type of trigger to get the selectors for.

Returns:

the selectors for the specified trigger type.

Throws:

NullPointerException - if triggerType is null.

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

Since:

SIS 2.2.1

See Also:

setSelectors(boolean, com.opencloud.slee.resources.sis.management.TriggerAddressTracingSelector[])

setSelectors

@Deprecated
void setSelectors(boolean originating,
                           TriggerAddressTracingSelector[] selectors)
                  throws ManagementException

Deprecated. use setSelectors(TriggerType, TriggerAddressTracingSelector[]) instead.

Set the trigger address tracing selectors for the SIS RA entity. These identify the initial event parameters which will be examined if fine-grained tracing is enabled. For each selector, the debug level of the address in the selected parameter (if present) is obtained from the trigger address tracing profile table. The highest debug level found is used.

Parameters:

originating - if true, the selectors for originating triggers is updated, otherwise the selectors for terminating triggers is updated.

selectors - the selectors. May be null.

Throws:

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

See Also:

getSelectors(boolean)

setSelectors

void setSelectors(TriggerType triggerType,
                TriggerAddressTracingSelector[] selectors)
                  throws NullPointerException,
                         ManagementException

Set the trigger address tracing selectors for the SIS RA entity. These identify the initial event parameters which will be examined if fine-grained tracing is enabled. For each selector, the debug level of the address in the selected parameter (if present) is obtained from the trigger address tracing profile table. The highest debug level found is used.

Parameters:

triggerType - the type of trigger to set the selectors for.

selectors - the selectors. May be null.

Throws:

NullPointerException - if triggerType is null.

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

Since:

SIS 2.2.1

See Also:

getSelectors(boolean)