JmxOperationCallService (Interlok Core/Base)

java.lang.Object
- com.adaptris.core.ServiceImp
- - com.adaptris.core.services.jmx.JmxOperationImpl
  - - com.adaptris.core.services.jmx.JmxOperationServiceImpl
    - - com.adaptris.core.services.jmx.JmxOperationCallService

All Implemented Interfaces:

AdaptrisComponent, ComponentLifecycle, ComponentLifecycleExtension, ConnectedService, MessageEventGenerator, Service, StateManagedComponent
```
@ComponentProfile(summary="Execute a JMX operation",
                  tag="service,jmx",
                  recommended=JmxConnection.class)
public class JmxOperationCallService
extends JmxOperationServiceImpl
```
Allows you to make a remote call on a JMX operation.

You can set parameters for the call using ValueTranslator's and also a single ValueTranslator to help translate the result back into the Message.

If you do not wish to translate the result of the operation, simply omit the "result-value-translator".

Since:

3.0.3

In the adapter configuration file this class is aliased as jmx-operation-call-service which is the preferred alternative to the fully qualified classname when building your configuration.

Field Summary
- Fields inherited from class com.adaptris.core.ServiceImp
  log

Constructor Summary

Constructors
Constructor Description

JmxOperationCallService()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`doService(AdaptrisMessage message)`	Apply the service to the message.
`ValueTranslator`	`getResultValueTranslator()`
`void`	`setResultValueTranslator(ValueTranslator resultValueTranslator)`

Methods inherited from class com.adaptris.core.services.jmx.JmxOperationServiceImpl
closeService, getConnection, initService, prepare, setConnection, start, stop

Methods inherited from class com.adaptris.core.services.jmx.JmxOperationImpl
getObjectName, getOperationName, getOperationParameters, parametersToArray, parametersToTypeArray, setObjectName, setOperationName, setOperationParameters

Methods inherited from class com.adaptris.core.ServiceImp
changeState, close, continueOnFailure, createName, createQualifier, getContinueOnFail, getIsTrackingEndpoint, getUniqueId, init, isBranching, isTrackingEndpoint, requestClose, requestInit, requestStart, requestStop, retrieveComponentState, setContinueOnFail, setIsTrackingEndpoint, setUniqueId

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.adaptris.core.AdaptrisComponent
getUniqueId

Methods inherited from interface com.adaptris.core.ComponentLifecycle
close, init

Methods inherited from interface com.adaptris.core.MessageEventGenerator
createName, createQualifier, isTrackingEndpoint

Methods inherited from interface com.adaptris.core.Service
continueOnFailure, isBranching, setUniqueId

Methods inherited from interface com.adaptris.core.StateManagedComponent
changeState, requestClose, requestInit, requestStart, requestStop, retrieveComponentState

- Constructor Detail
  - JmxOperationCallService
```
public JmxOperationCallService()
```
- Method Detail
  - doService
```
public void doService(AdaptrisMessage message)
               throws ServiceException
```
    Description copied from interface: Service
    
    Apply the service to the message.
    
    Parameters:
    
    message - the AdaptrisMessage to process
    
    Throws:
    
    ServiceException - wrapping any underlying Exceptions
  - getResultValueTranslator
```
public ValueTranslator getResultValueTranslator()
```
  - setResultValueTranslator
```
public void setResultValueTranslator(ValueTranslator resultValueTranslator)
```