Package com.adaptris.tester.runtime.clients

Class JMXTestClient

java.lang.Object

com.adaptris.tester.runtime.clients.JMXTestClient

All Implemented Interfaces:

TestClient, java.io.Closeable, java.lang.AutoCloseable

Direct Known Subclasses:

EmbeddedTestClient, ExternalJMXTestClient, LocalTestClient

public abstract class JMXTestClient
extends java.lang.Object
implements TestClient

Abstract class for TestClient implementations over JMX.

Constructor Summary

Constructors

Constructor	Description
JMXTestClient()

Method Summary

Modifier and Type	Method	Description
TestMessage	applyService(java.lang.String xml, TestMessage message)	Apply the service to the input message and return outputted message, method uses AdapterComponentCheckerMBean.applyService(String, com.adaptris.interlok.types.SerializableMessage).
abstract void	close()	Close connection initialised in init(ServiceTestConfig config).
JMXTestClient	init(ServiceTestConfig config)	Initialises the JMX test client.
abstract javax.management.MBeanServerConnection	initMBeanServerConnection(ServiceTestConfig config)	Implementations should initialise and return the MBeanServerConnection to be used in init(ServiceTestConfig config)

Methods inherited from class java.lang.Object

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

Constructor Detail

JMXTestClient

public JMXTestClient()

Method Detail

init

public final JMXTestClient init(ServiceTestConfig config)
                         throws ServiceTestException

Initialises the JMX test client. Test client initialisation includes configuring and connecting to client needed in applyService(String, TestMessage). Method makes a call to initMBeanServerConnection(ServiceTestConfig config) which is abstract method.

Specified by:

init in interface TestClient

Returns:

an initialised TestClient instance for try-with-resources...

Throws:

ServiceTestException - wrapping any thrown exception

initMBeanServerConnection

public abstract javax.management.MBeanServerConnection initMBeanServerConnection(ServiceTestConfig config)
                                                                          throws ServiceTestException

Implementations should initialise and return the MBeanServerConnection to be used in init(ServiceTestConfig config)

Returns:

MBeanServerConnection to be used in init(ServiceTestConfig config)

Throws:

ServiceTestException - wrapping any thrown exception

close

public abstract void close()
                    throws java.io.IOException

Close connection initialised in init(ServiceTestConfig config).

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

Throws:

java.io.IOException - wrapping any thrown exception (dictated by Closeable.close()

applyService

public final TestMessage applyService(java.lang.String xml,
                                      TestMessage message)
                               throws CoreException

Apply the service to the input message and return outputted message, method uses AdapterComponentCheckerMBean.applyService(String, com.adaptris.interlok.types.SerializableMessage).

Specified by:

applyService in interface TestClient

Parameters:

xml - Interlok service configuration

message - Input TestMessage to test with

Returns:

TestMessage returned by executing service

Throws:

CoreException - thrown by AdapterComponentCheckerMBean.applyService(String, com.adaptris.interlok.types.SerializableMessage)