com.ibm.streams.operator.management

Interface ProcessingElementMXBean

public interface ProcessingElementMXBean

The management interface for a ProcessingElement. A ProcessingElementMXBean represents the containing processing element (PE). The management bean is automatically registered with the platform MBeanServer before Operator.initialize(OperatorContext) is called. The management bean is unregistered automatically once Operator.shutdown() completes.

The ObjectName for uniquely identifying the MXBean for a PE in the PE's platform MBean Server is:
com.ibm.streams.operator:type=pe

Since:

InfoSphere® Streams Version 3.0

See Also:

OperatorManagement.STREAMS_OPERATOR_JMX_DOMAIN, OperatorManagement.Type.PE, ProcessingElement

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TRACE_LEVEL Notification the SPL trace level has changed.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getApplicationDirectory() Return the absolute path of the application directory for the SPL application.
java.lang.String	getApplicationName() Return the name of the application the PE is running.
java.lang.String	getApplicationScope() Return the application scope for the job the PE is running in.
java.lang.String	getConfiguredHostName() Get the host name this PE is executing on.
java.lang.String	getDataDirectory() Return the absolute path of the data directory for the SPL application.
java.lang.String	getDomainId() Return the Streams domain identifier for this PE.
java.lang.String	getInstanceId() Return the Streams instance identifier for this PE.
java.lang.String	getJobGroup() Return the name of the job group for the job the PE is running in.
java.lang.String	getJobId() Get the runtime identifier for job containing this processing element.
java.lang.String	getJobName() Return the name of the job the PE is running in.
java.lang.String	getOutputDirectory() Return the absolute path of the output directory for the compiled SPL application.
java.lang.String	getPEId() Get the runtime identifier for this processing element.
int	getRelaunchCount() Return the number of times this PE has been relaunched.
boolean	isStandalone() Return true if this processing element is running in standalone mode.

Field Detail

TRACE_LEVEL

static final java.lang.String TRACE_LEVEL

Notification the SPL trace level has changed.
The notification's userData will be the value of Level.getName() of the new SPL trace level.
The value of this notification identifier is "com.ibm.streams.operator.pe.traceLevel".

Since:

InfoSphere® Streams Version 3.1

See Also:

Constant Field Values

Method Detail

getJobGroup

java.lang.String getJobGroup()

Return the name of the job group for the job the PE is running in.

Returns:

name of the job group for the job the PE is running in

Since:

InfoSphere® Streams Version 4.1

getJobId

java.lang.String getJobId()

Get the runtime identifier for job containing this processing element.

Returns:

The job identifier for the current application.

getJobName

java.lang.String getJobName()

Return the name of the job the PE is running in.

Returns:

name for the job the PE is running in

Since:

InfoSphere® Streams Version 4.0.1

getPEId

java.lang.String getPEId()

Get the runtime identifier for this processing element.

Returns:

The identifier for the this PE.

getOutputDirectory

java.lang.String getOutputDirectory()

Return the absolute path of the output directory for the compiled SPL application.

Returns:

Output directory of the application.

getDataDirectory

java.lang.String getDataDirectory()

Return the absolute path of the data directory for the SPL application.

Returns:

Data directory of the application.

getApplicationDirectory

java.lang.String getApplicationDirectory()

Return the absolute path of the application directory for the SPL application.

Returns:

application directory for the SPL application.

getApplicationName

java.lang.String getApplicationName()

Return the name of the application the PE is running.

Returns:

name of the application the PE is running

Since:

InfoSphere® Streams Version 4.1

getApplicationScope

java.lang.String getApplicationScope()

Return the application scope for the job the PE is running in.

Returns:

application scope for the job the PE is running in

isStandalone

boolean isStandalone()

Return true if this processing element is running in standalone mode.

Returns:

True if this processing element is running in standalone mode, false otherwise.

getRelaunchCount

int getRelaunchCount()

Return the number of times this PE has been relaunched. For the first execution, the value will be 0.

Returns:

number of times this PE has been relaunched.

getInstanceId

java.lang.String getInstanceId()

Return the Streams instance identifier for this PE. When in standalone this will be the current operating system user identifier.

Returns:

Instance identifier for this PE or the user identifier for standalone mode.

getConfiguredHostName

java.lang.String getConfiguredHostName()
                                       throws java.net.UnknownHostException

Get the host name this PE is executing on.

When running in distributed mode this returns the host name for the interface configured for application use by the Streams instance. This may differ from from java.net.InetAddress.getLocalHost().getCanonicalHostName() if there are multiple network interfaces on this host.

When running in standalone or using the test framework, this returns java.net.InetAddress.getLocalHost().getCanonicalHostName().

Returns:

Host name this PE is executing on

Throws:

java.net.UnknownHostException

Since:

InfoSphere® Streams Version 4.0

getDomainId

java.lang.String getDomainId()

Return the Streams domain identifier for this PE. When in standalone this will be the current operating system user identifier.

Returns:

Domain identifier for this PE or the user identifier for standalone mode.

Since:

InfoSphere® Streams Version 4.0