Package com.ibm.websphere.kernel.server
Interface ServerEndpointControlMBean
public interface ServerEndpointControlMBean
The ServerEndpointControlMBean provides control over the state of endpoints of the server.
Endpoints represent inbound communication to the server, like http and messaging.
The ObjectName for this MBean is "WebSphere:feature=kernel,name=ServerEndpointControl".
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringA String representing theObjectNamethat this MBean maps to. -
Method Summary
Modifier and TypeMethodDescriptionbooleanQuery the state of the specified server endpoints.booleanisPaused()Query the state of all registered server endpoints.booleanQuery whether the specified server endpoints have been paused.Returns the name of all endpoints that can be paused/resumed.voidpause()Pauses all registered server endpointsvoidPauses the specified server endpointsvoidresume()Resumes all registered server endpointsvoidResumes the specified server endpoints
-
Field Details
-
OBJECT_NAME
A String representing theObjectNamethat this MBean maps to.- See Also:
-
-
Method Details
-
pause
Pauses all registered server endpoints- Throws:
MBeanException- if not all registered endpoints could be paused
-
pause
Pauses the specified server endpoints- Parameters:
targets- Comma separated list of one or more names of endpoints.- Throws:
MBeanException- If each of the specified targets couldn't be paused, or if the list of target names is empty or are not all valid
-
resume
Resumes all registered server endpoints- Throws:
MBeanException- if not all registered endpoints could be resumed
-
resume
Resumes the specified server endpoints- Parameters:
targets- Comma separated list of one or more names of endpoints.- Throws:
MBeanException- If each of the specified targets couldn't be resumed, or if the list of target names is empty or are not all valid
-
isPaused
boolean isPaused()Query the state of all registered server endpoints.- Returns:
- True if the cumulative state of all registered endpoints is paused, otherwise false.
-
isPaused
Query whether the specified server endpoints have been paused.- Parameters:
targets- Comma separated list of one or more names of endpoints.- Returns:
- If a single target is specified, returns the state of the specified target, if multiple targets are specified, returns true only all specified targets are paused
- Throws:
MBeanException- If each of the specified targets couldn't be queried, or if the list of target names is empty or are not all valid
-
listEndpoints
Returns the name of all endpoints that can be paused/resumed.- Returns:
- List of names of all endpoints that can be paused/resumed.
-
isActive
Query the state of the specified server endpoints.- Parameters:
targets- Comma separated list of one or more names of endpoints.- Returns:
- If a single target is specified, returns true if the target exists, has started, and is not paused. If multiple targets are specified, returns true only if all specified targets exist, are started, and are not paused.
-