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

      Fields 
      Modifier and Type Field Description
      static java.lang.String OBJECT_NAME
      A String representing the ObjectName that this MBean maps to.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean isPaused()
      Query the state of all registered server endpoints.
      boolean isPaused​(java.lang.String targets)
      Query the state of the specified server endpoints.
      java.util.List<java.lang.String> listEndpoints()
      Returns the name of all endpoints that can be paused/resumed.
      void pause()
      Pauses all registered server endpoints
      void pause​(java.lang.String targets)
      Pauses the specified server endpoints
      void resume()
      Resumes all registered server endpoints
      void resume​(java.lang.String targets)
      Resumes the specified server endpoints
    • Field Detail

      • OBJECT_NAME

        static final java.lang.String OBJECT_NAME
        A String representing the ObjectName that this MBean maps to.
        See Also:
        Constant Field Values
    • Method Detail

      • pause

        void pause()
            throws javax.management.MBeanException
        Pauses all registered server endpoints
        Throws:
        javax.management.MBeanException - if not all registered endpoints could be paused
      • pause

        void pause​(java.lang.String targets)
            throws javax.management.MBeanException
        Pauses the specified server endpoints
        Parameters:
        targets - Comma separated list of one or more names of endpoints.
        Throws:
        javax.management.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

        void resume()
             throws javax.management.MBeanException
        Resumes all registered server endpoints
        Throws:
        javax.management.MBeanException - if not all registered endpoints could be resumed
      • resume

        void resume​(java.lang.String targets)
             throws javax.management.MBeanException
        Resumes the specified server endpoints
        Parameters:
        targets - Comma separated list of one or more names of endpoints.
        Throws:
        javax.management.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

        boolean isPaused​(java.lang.String targets)
                  throws javax.management.MBeanException
        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 the state of the specified target, if multiple targets are specified, returns true only all specified targets are paused
        Throws:
        javax.management.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

        java.util.List<java.lang.String> listEndpoints()
        Returns the name of all endpoints that can be paused/resumed.
        Returns:
        List of names of all endpoints that can be paused/resumed.