com.ibm.streams.operator.control

Class ControlPlaneManagement

  • java.lang.Object
    • com.ibm.streams.operator.control.ControlPlaneManagement

  • public final class ControlPlaneManagement
extends java.lang.Object
    Utilities for the Job Control Plane.
    Since:
    InfoSphere® Streams Version 4.0

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String CONTROL_PLANE_METRIC
      Name of the custom gauge metric ("controlPlaneConnection") created for an operator when it connections to the Job Control Plane.
      static java.lang.String DOMAIN
      The domain ("com.ibm.streams.control") for MBeans registered by the Job Control Plane itself.
      static java.lang.String IBM_COPYRIGHT 
      static java.lang.String JOB_CONTROL_PLANE
      Nameservice prefix for the entries that correspond to JMX URLS for the Job Control Plane.
      static javax.management.ObjectName JOB_NAME
      The ObjectName name for the com.ibm.streams.management.job.JobMXBean that is registered in the Job Control Plane MBean server.
      static javax.management.ObjectName MGMT_NAME
      The ObjectName name for the ControlPlaneMXBean that is registered in the Job Control Plane MBean server.
      static javax.management.ObjectName MLET_NAME
      The ObjectName name for the javax.management.loading.MLetMBean that is registered in the Job Control Plane MBean server.
      static java.lang.String RESERVED_DOMAIN
      The domain ("com.ibm.streams.control.reserved") for MBeans registered by the Job Control Plane itself for internal use.
      static javax.management.ObjectName TIMER_NAME
      The ObjectName name for the javax.management.timer.TimerMBean that is registered in the Job Control Bean MBean server.

    • Method Summary

      Methods 
      Modifier and Type Method and Description
      static javax.management.ObjectName getPEName(java.math.BigInteger peId)
      Get the ObjectName for a com.ibm.streams.management.job.PeMXBean in this job in the Job Control Plane.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • DOMAIN

        public static final java.lang.String DOMAIN
        The domain ("com.ibm.streams.control") for MBeans registered by the Job Control Plane itself. Operators register MBeans using a domain specific to the application or toolkit.
        See Also:
        Constant Field Values

      • RESERVED_DOMAIN

        public static final java.lang.String RESERVED_DOMAIN
        The domain ("com.ibm.streams.control.reserved") for MBeans registered by the Job Control Plane itself for internal use. Any MBeans in this domain are not part of the public API and are subject to changes between releases.
        See Also:
        Constant Field Values

      • CONTROL_PLANE_METRIC

        public static final java.lang.String CONTROL_PLANE_METRIC
        Name of the custom gauge metric ("controlPlaneConnection") created for an operator when it connections to the Job Control Plane. When this custom metric exists for an operator it has requested a connection to the Job Control Plane. It can take these values:
        • 0 - The operator is not connected to the Job Control Plane.
        • 1 - The operator is connected to the Job Control Plane.
        See Also:
        Constant Field Values

      • JOB_CONTROL_PLANE

        public static final java.lang.String JOB_CONTROL_PLANE
        Nameservice prefix for the entries that correspond to JMX URLS for the Job Control Plane. The Streams nameservice will contain one entry for each Job Control Plane.
        com.ibm.streams.control.job.jobId
        See Also:
        ProcessingElement.getJobId(), Constant Field Values

      • MGMT_NAME

        public static final javax.management.ObjectName MGMT_NAME
        The ObjectName name for the ControlPlaneMXBean that is registered in the Job Control Plane MBean server. The name is:
        com.ibm.streams.control:type=mgmt

      • JOB_NAME

        public static final javax.management.ObjectName JOB_NAME
        The ObjectName name for the com.ibm.streams.management.job.JobMXBean that is registered in the Job Control Plane MBean server. This Mbean is a proxy for the JobMXBean in this job's domain JMX server. The name is:
        com.ibm.streams.control:type=job

      • MLET_NAME

        public static final javax.management.ObjectName MLET_NAME
        The ObjectName name for the javax.management.loading.MLetMBean that is registered in the Job Control Plane MBean server. The name is:
        com.ibm.streams.control:type=mlet

      • TIMER_NAME

        public static final javax.management.ObjectName TIMER_NAME
        The ObjectName name for the javax.management.timer.TimerMBean that is registered in the Job Control Bean MBean server. The name is:
        com.ibm.streams.control:type=timer

    • Method Detail

      • getPEName

        public static javax.management.ObjectName getPEName(java.math.BigInteger peId)
        Get the ObjectName for a com.ibm.streams.management.job.PeMXBean in this job in the Job Control Plane. The PeMXBean is a proxy to the corresponding MBean in the Domain JMX.
        Parameters:
        peId - Identifier for a PE in this job
        Returns:
        ObjectName for a PeMXBean in this job