InstanceActiveServiceMXBean (IBM Streams JMX API)

Skip navigation links

IBM Streams JMX API

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

All Superinterfaces:

ActiveServiceMXBean
```
public interface InstanceActiveServiceMXBean
extends ActiveServiceMXBean
```
InstanceActiveServiceMXBean provides attributes, operations, and notifications for managing an active Streams instance service.
ObjectNameBuilder.instanceActiveService(String, String, InstanceServiceMXBean.Type, String, String) can be used with a serviceType from InstanceServiceMXBean.Type to build the ObjectName for an InstanceActiveServiceMXBean.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String TYPE
TYPE is used to identify this bean as an active instance service bean when building the bean's ObjectName.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.lang.String`	`getInstance()` Returns the name of the instance which contains the service.
`InstanceServiceMXBean.Type`	`getType()` Returns the service type for the active service.
`void`	`move(java.lang.String toResourceId, java.lang.String listenerId)` Starts a service of this `type` on the specified resource and stops this active service.

Methods inherited from interface com.ibm.streams.management.ActiveServiceMXBean
createOperationListener, getDomain, getPid, getResource, getStartTime, getStatus, isLeader, restart

- Field Detail
  - TYPE
```
static final java.lang.String TYPE
```
    TYPE is used to identify this bean as an active instance service bean when building the bean's ObjectName. The value is "domain.instance.service.active"
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getInstance
```
java.lang.String getInstance()
```
    Returns the name of the instance which contains the service.
    
    Returns:
    
    the instance name.
  - getType
```
InstanceServiceMXBean.Type getType()
```
    Returns the service type for the active service.
    
    Returns:
    
    the service type.
  - move
```
void move(java.lang.String toResourceId,
          java.lang.String listenerId)
```
    Starts a service of this type on the specified resource and stops this active service.
    
    Parameters:
    
    resourceId - specifies the Streams unique identifier for the resource on which to start the service.
    
    listenerId - identifies an operation listener created using createOperationListener. Status messages relating to the progress of this operation are added to the listener as the operation runs. Any existing messages contained in the listener are cleared before the operation starts. If the value is null, this parameter is ignored.
    
    Throws:
    
    java.lang.NullPointerException - if toResourceId is null.