EndpointCentralManager MBean

Partial ObjectName:
WebSphere:*,type=EndpointCentralManager

MinimalAccessCheck:

true


MBean EndpointCentralManager

Provide management interface to start and stop Web service and endpoint listeners. It provides the ability to control throughput by starting and stopping individual service and endpoint listeners.


Operation Summary
java.util.ListstartListener(java.util.Properties queryProps, java.lang.String target)
           Start a service or endpoint listener on the target and return the new state.
java.util.ListstartListener(java.lang.String queryString, java.lang.String target)
           Start a service or endpoint listener on the target and return the new state.
java.util.ListstopListener(java.util.Properties queryProps, java.lang.String target)
           stop a service or endpoint listener on the target and return the new state.
java.util.ListstopListener(java.lang.String queryString, java.lang.String target)
           stop a service or endpoint listener on the target and return the new state.
java.util.ListgetListenerState(java.util.Properties props, java.lang.String props)
           Get the listener state for a service or endpoint on the specified target.
java.util.ListgetListenerState(java.lang.String props, java.lang.String props)
           Get the listener state for a service or endpoint on the specified target.
java.utils.ListgetServiceNames(java.util.Properties props)
           Get all service names for a given application and module.
java.utils.ListgetServiceNames(java.lang.String queryString)
           Get all service names for a given application and module.
java.utils.ListgetEndpointNames(java.util.Properties props)
           Get all logical endpoint, i.
java.utils.ListgetEndpointNames(java.lang.String queryString)
           Get all logical endpoint, i.
java.lang.StringgetEndpointType(java.util.Properties props)
           Get endpoint type for the specific service endpoint.
java.lang.StringgetEndpointType(java.lang.String props)
           Get endpoint type for the specific service endpoint.

Operation Detail

startListener

public java.util.List startListener(java.util.Properties queryProps, java.lang.String target)
Start a service or endpoint listener on the target and return the new state.
Parameters:
queryProps - Specify a service or endpoint containing the following property names: application, module, service, and optional logicalEndpoint.
target - Specify the target server or cluster in the format of cell=cellName,node=nodeName,server=serverName or cell=cellName,cluster=clusterName. For all targets, set target to be *.
Security Roles:
administrator
operator

startListener

public java.util.List startListener(java.lang.String queryString, java.lang.String target)
Start a service or endpoint listener on the target and return the new state.
Parameters:
queryString - Specify a service or endpoint in the format of application=appName,module=moduleName,service=serviceName,logicalEndpoint=endpointName. All but logicalEndpoint are required.
target - Specify the target server or cluster in the format of cell=cellName,node=nodeName,server=serverName or cell=cellName,cluster=clusterName. For all targets, set target to be *.
Security Roles:
administrator
operator

stopListener

public java.util.List stopListener(java.util.Properties queryProps, java.lang.String target)
stop a service or endpoint listener on the target and return the new state.
Parameters:
queryProps - Specify a service or endpoint containing the following property names: application, module, service, and optional logicalEndpoint.
target - Specify the target server or cluster in the format of cell=cellName,node=nodeName,server=serverName or cell=cellName,cluster=clusterName. For all targets, set target to be *.
Security Roles:
administrator
operator

stopListener

public java.util.List stopListener(java.lang.String queryString, java.lang.String target)
stop a service or endpoint listener on the target and return the new state.
Parameters:
queryString - Specify a service or endpoint in the format of application=appName,module=moduleName,service=serviceName,logicalEndpoint=endpointName. All but logicalEndpoint are required.
target - Specify the target server or cluster in the format of cell=cellName,node=nodeName,server=serverName or cell=cellName,cluster=clusterName. For all targets, set target to be *.
Security Roles:
administrator
operator

getListenerState

public java.util.List getListenerState(java.util.Properties props, java.lang.String props)
Get the listener state for a service or endpoint on the specified target.
Parameters:
props - Specify a service or endpoint containing the following property names: application, module, service, and optional logicalEndpoint.
props - Specify the target server or cluster in the format of cell=cellName,node=nodeName,server=serverName or cell=cellName,cluster=clusterName. For all targets, set target to be *.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getListenerState

public java.util.List getListenerState(java.lang.String props, java.lang.String props)
Get the listener state for a service or endpoint on the specified target.
Parameters:
props - Specify a service or endpoint in the format of application=appName,module=moduleName,service=serviceName,logicalEndpoint=endpointName. All but logicalEndpoint are required.
props - Specify the target server or cluster in the format of cell=cellName,node=nodeName,server=serverName or cell=cellName,cluster=clusterName. For all targets, set target to be *.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getServiceNames

public java.utils.List getServiceNames(java.util.Properties props)
Get all service names for a given application and module.
Parameters:
props - Specify a module containing the following property names: application and module.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getServiceNames

public java.utils.List getServiceNames(java.lang.String queryString)
Get all service names for a given application and module.
Parameters:
queryString - Specify a module in the format of application=appName,module=moduleName.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getEndpointNames

public java.utils.List getEndpointNames(java.util.Properties props)
Get all logical endpoint, i.e. port, names for a given service.
Parameters:
props - Specify a service containing the following property names: application, module, and service.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getEndpointNames

public java.utils.List getEndpointNames(java.lang.String queryString)
Get all logical endpoint, i.e. port, names for a given service.
Parameters:
queryString - Specify a service in the format of application=appName,module=moduleName,service=serviceName.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getEndpointType

public java.lang.String getEndpointType(java.util.Properties props)
Get endpoint type for the specific service endpoint.
Parameters:
props - Specify an endpoint containing the following property names: application, module, service, and logicalEndpoint.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getEndpointType

public java.lang.String getEndpointType(java.lang.String props)
Get endpoint type for the specific service endpoint.
Parameters:
props - Specify an endpoint in the format of application=appName,module=moduleName,service=serviceName,logicalEndpoint=endpointName.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

Copyright IBM Corp. 1996-2005