HPELControlService MBean

Partial ObjectName:
WebSphere:*,type=HPELControlService


MBean HPELControlService

Management and query interface for the RAS High Performance Extensible Logging (HPEL).


Attribute Summary
java.lang.StringtraceSpecification
           Trace specification.
booleanrawTraceFilterEnabled
           Sensitive Log and Trace Enablement

Operation Summary
java.lang.StringgetTraceSpecification(java.lang.String component)
           Return the current trace specification for the specified component or group.
voidappendTraceString(java.lang.String traceString)
           Add the specified trace string to the trace state already active in the process runtime, without first clearing the current state.
java.lang.String[]listAllRegisteredComponents()
           Return an array of Strings containing the fully qualified names of all individual components currently registered with Ras services.
java.lang.String[]listAllRegisteredGroups()
           Return an array of Strings containing the names of all Groups currently registered with Ras services.
java.util.HashMaplistComponentsInGroup(java.lang.String[] groups)
           For each specified group, return an array of Strings containing the fully qualified names of all components who have registered as members of the specified group.
java.lang.String[]listComponentsInGroup(java.lang.String group)
           Return an array of Strings containing the fully qualified names of all components who have registered as members of the specified group.
com.ibm.websphere.ras.TraceElementState[]getTracedComponents()
           Return an array of TraceElementState objects containing information about the currently registered individual components for which some type of trace is currently enabled.
com.ibm.websphere.ras.TraceElementState[]getTracedGroups()
           Return an array of TraceElementState objects containing information about the currently registered Groups for which some type of trace is currently enabled.
voidprocessDumpString(java.lang.String dumpString)
           Instruct dumpable components to write their current state.
voidcheckTraceString(java.lang.String traceString)
           Check the specified trace string to see if it conforms to the TraceString grammar.
com.ibm.websphere.logging.hpel.reader.RemoteAllResultsgetLogLists(com.ibm.websphere.logging.hpel.reader.LogQueryBean logQueryBean, com.ibm.websphere.logging.hpel.reader.RepositoryPointer after, java.lang.String serverContext)
           Remote call to get a list of server Instances meeting specific filter criteria.
com.ibm.websphere.logging.hpel.reader.RemoteInstanceResultgetLogListForServerInstance(com.ibm.websphere.logging.hpel.reader.RemoteInstanceDetails indicator, com.ibm.websphere.logging.hpel.reader.RepositoryPointer after, int offset, int maxRecords, java.util.Locale locale, java.lang.String serverContext)
           Remote call to get a list of records from a specific serverInstance of the server meeting specific filter criteria.

Attribute Detail

traceSpecification

public java.lang.String traceSpecification
Trace specification. Note that if sensitive log and trace is enabled some messages may still be filtered out even if trace specification enables them.
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
Setter:
administrator
operator

rawTraceFilterEnabled

public boolean rawTraceFilterEnabled
Sensitive Log and Trace Enablement
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
Setter:
administrator
operator

Operation Detail

getTraceSpecification

public java.lang.String getTraceSpecification(java.lang.String component)
Return the current trace specification for the specified component or group.
Parameters:
component - the String containing the name of the component or group.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

appendTraceString

public void appendTraceString(java.lang.String traceString)
Add the specified trace string to the trace state already active in the process runtime, without first clearing the current state. Note that if sensitive log and trace is enabled some messages may still be filtered out even if trace specification enables them.
Parameters:
traceString - a String that complies to the TraceString grammar and passes the checkTraceString() method.
Security Roles:
administrator
operator

listAllRegisteredComponents

public java.lang.String[] listAllRegisteredComponents()
Return an array of Strings containing the fully qualified names of all individual components currently registered with Ras services.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

listAllRegisteredGroups

public java.lang.String[] listAllRegisteredGroups()
Return an array of Strings containing the names of all Groups currently registered with Ras services.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

listComponentsInGroup

public java.util.HashMap listComponentsInGroup(java.lang.String[] groups)
For each specified group, return an array of Strings containing the fully qualified names of all components who have registered as members of the specified group.
Parameters:
groups - the complete names of the groups.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

listComponentsInGroup

public java.lang.String[] listComponentsInGroup(java.lang.String group)
Return an array of Strings containing the fully qualified names of all components who have registered as members of the specified group.
Parameters:
group - the complete name of the group.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getTracedComponents

public com.ibm.websphere.ras.TraceElementState[] getTracedComponents()
Return an array of TraceElementState objects containing information about the currently registered individual components for which some type of trace is currently enabled.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getTracedGroups

public com.ibm.websphere.ras.TraceElementState[] getTracedGroups()
Return an array of TraceElementState objects containing information about the currently registered Groups for which some type of trace is currently enabled.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

processDumpString

public void processDumpString(java.lang.String dumpString)
Instruct dumpable components to write their current state.
Parameters:
dumpString - a String in the specified format to process or null.
Security Roles:
administrator
operator

checkTraceString

public void checkTraceString(java.lang.String traceString)
Check the specified trace string to see if it conforms to the TraceString grammar.
Parameters:
traceString - a String that complies to the TraceString grammar.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getLogLists

public com.ibm.websphere.logging.hpel.reader.RemoteAllResults getLogLists(com.ibm.websphere.logging.hpel.reader.LogQueryBean logQueryBean, com.ibm.websphere.logging.hpel.reader.RepositoryPointer after, java.lang.String serverContext)
Remote call to get a list of server Instances meeting specific filter criteria.
Parameters:
logQueryBean - Query object, key parts of the query.
after - Cursor location for where to resume for multiCall queries.
serverContext - server context in form of cell-name/node-name/server-name to read repository of alternate server.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getLogListForServerInstance

public com.ibm.websphere.logging.hpel.reader.RemoteInstanceResult getLogListForServerInstance(com.ibm.websphere.logging.hpel.reader.RemoteInstanceDetails indicator, com.ibm.websphere.logging.hpel.reader.RepositoryPointer after, int offset, int maxRecords, java.util.Locale locale, java.lang.String serverContext)
Remote call to get a list of records from a specific serverInstance of the server meeting specific filter criteria.
Parameters:
indicator - Identification of the required server instance.
after - Cursor location for where to resume for multiCall queries.
offset - offset within resultSet to resume.
maxRecords - Maximun number of records to return with the query.
locale - Language records should be translated to in the result.
serverContext - server context in form of cell-name/node-name/server-name to read repository of alternate server.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

Copyright IBM Corp. 1996-2005