com.ibm.ia.connectivity.management

Interface OutboundBufferManagerMXBean


  • @MXBean
public interface OutboundBufferManagerMXBean

    The interface used to manage outbound endpoint buffers. The MBean is available on any container server to which the ia:iaDispatcher feature is deployed, using the name com.ibm.ia:type=OutboundBufferManager

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String MXBEAN_OBJECT_NAME
      The object name by which a JMX client can find the OutboundBufferManagerMXBean

    • Method Summary

      Methods 
      Modifier and Type Method and Description
      void discardPendingOutboundEvents(java.lang.String solutionName, java.lang.String endpointName)
      Discards all pending outbound events in the buffer for the outbound endpoint of a solution.
      java.lang.Long getPendingOutboundEventCount(java.lang.String solutionName, java.lang.String endpointName)
      Returns the number of events in the buffer for the outbound endpoint of a solution.
      java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Long>> listOutboundEndpointBuffers(java.lang.String solutionName, long eventCountFilter, boolean includeUnusedEndpointsOnly)
      Returns a summary of the outbound endpoint buffers that match a solution name, including the pending event counts.

    • Field Detail

      • MXBEAN_OBJECT_NAME

        static final java.lang.String MXBEAN_OBJECT_NAME
        The object name by which a JMX client can find the OutboundBufferManagerMXBean
        See Also:
        Constant Field Values

    • Method Detail

      • listOutboundEndpointBuffers

        java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Long>> listOutboundEndpointBuffers(java.lang.String solutionName,
                                                                                                         long eventCountFilter,
                                                                                                         boolean includeUnusedEndpointsOnly)
                                                                                                           throws java.lang.IllegalStateException

        Returns a summary of the outbound endpoint buffers that match a solution name, including the pending event counts.

        The buffers that are included in the results can be selected according to several criteria:

        • You can terminate the solution name in a * wildcard character to match multiple solutions.
        • You can filter the results to omit buffers that contain fewer than a specified number of pending events.
        • You can choose to omit buffers that are defined by active solutions and hence only include unused endpoints (e.g. have been removed from the solution).

        The operation is performed across all grid partitions and will return an approximation when the system is under load.

        Throws:
        java.lang.IllegalStateException - if the operation cannot be performed.
        Parameters:
        solutionName - the name of the solution, or wildcard pattern.
        eventCountFilter - If greater than 0, the buffers that contain fewer than the specified number of events are omitted.
        includeUnusedEndpointsOnly - If true the buffers for the outbound endpoints defined by active solutions are omitted.
        Returns:
        a map in which the key is a solution name and the value is a map of endpoint name to the number of pending events in the buffer.

      • getPendingOutboundEventCount

        java.lang.Long getPendingOutboundEventCount(java.lang.String solutionName,
                                          java.lang.String endpointName)
                                            throws java.lang.IllegalStateException
        Returns the number of events in the buffer for the outbound endpoint of a solution. The returned value is calculated by summing the number of pending events contained in each grid partition and will be an approximation when the system is under load.
        Throws:
        java.lang.IllegalStateException - if the operation cannot be performed.
        Parameters:
        solutionName - the name of the solution.
        endpointName - the name of the outbound endpoint.
        Returns:
        the number of pending events.

      • discardPendingOutboundEvents

        void discardPendingOutboundEvents(java.lang.String solutionName,
                                java.lang.String endpointName)
                                  throws java.lang.IllegalStateException
        Discards all pending outbound events in the buffer for the outbound endpoint of a solution. The operation is performed across all grid partitions.
        Throws:
        java.lang.IllegalStateException - if the operation cannot be performed.
        Parameters:
        solutionName - the name of the solution.
        endpointName - the name of the outbound endpoint.
Decision Server Insights

© Copyright IBM 2016