com.adaptris.core.runtime

Interface AdapterRegistryMBean

All Superinterfaces:

BaseComponentMBean

All Known Implementing Classes:

AdapterRegistry

public interface AdapterRegistryMBean
extends BaseComponentMBean

A registry of Adapters that are available for management.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	JMX_REGISTRY_TYPE The type for the adapter registry.
static java.lang.String	REGISTRY_PREFIX
static java.lang.String	STANDARD_REGISTRY_JMX_NAME The Standard Name for the Adapter Registry "com.adaptris:type=Registry,id=AdapterRegistry"

Method Summary

Modifier and Type	Method and Description
void	addAdapter(AdapterManagerMBean adapter) Add an AdapterManagerMBean instance to the registry.
void	addConfiguration(java.util.Properties p)
javax.management.ObjectName	createAdapter(java.lang.String xml) Deprecated. since 3.6.1 get it via getBuilder(Properties) instead.
javax.management.ObjectName	createAdapter(URLString url) Deprecated. since 3.6.1 get it via getBuilder(Properties) instead.
javax.management.ObjectName	createAdapterFromUrl(java.lang.String url) Deprecated. since 3.6.1
void	destroyAdapter(AdapterManagerMBean adapter) Close the underlying adapter and unregister from JMX.
void	destroyAdapter(javax.management.ObjectName adapter) Close the underlying adapter and unregister from JMX.
java.util.Set<javax.management.ObjectName>	getAdapters() Get all the adapters that have been registered.
javax.management.ObjectName	getBuilder(javax.management.ObjectName p) Get a reference to the AdapterBuilderMBean instance that built the corresponding AdapterManagerMBean instance.
AdapterBuilderMBean	getBuilder(java.util.Properties p) Get the AdapterBuilderMBean associated with given Properties object.
AdapterBuilderMBean	getBuilderMBean(javax.management.ObjectName p) Get a reference to the AdapterBuilderMBean instance that built the corresponding AdapterManagerMBean instance.
java.util.Set<javax.management.ObjectName>	getBuilders() Get All the builders.
java.lang.String	getClassDefinition(java.lang.String className) In JSON format return the full class description, including subclasses and annotation detail.
java.util.Properties	getConfiguration() Deprecated. since 3.6.1 get it via getBuilder(ObjectName) instead.
URLString	getConfigurationURL(javax.management.ObjectName adapterName) Get the URL that was used to create the adapter associated with that ObjectName.
java.lang.String	getConfigurationURLString(javax.management.ObjectName adapterName) Get the URL that was used to create the adapter associated with that ObjectName.
java.lang.String	getVersionControl() Return the version control system that is currently in use based on RuntimeVersionControl.getImplementationName()
void	persist(java.lang.String data, URLString url) Persist some data the given URL.
void	persistAdapter(AdapterManagerMBean adapter, java.lang.String url) Persist the adapter to the given URL.
void	persistAdapter(AdapterManagerMBean adapter, URLString url) Persist the adapter to the given URL.
void	persistAdapter(javax.management.ObjectName adapter, java.lang.String url) Persist the adapter to the given URL.
void	persistAdapter(javax.management.ObjectName adapter, URLString url) Persist the adapter to the given URL.
void	putConfigurationURL(javax.management.ObjectName adapterName, java.lang.String url) Register a URL against a given ObjectName.
void	putConfigurationURL(javax.management.ObjectName adapterName, URLString url) Register a URL against a given ObjectName.
java.util.Set<javax.management.ObjectName>	reloadFromConfig() Recreate all adapters associated with this AdapterRegistry from their associated bootstrap file.
javax.management.ObjectName	reloadFromConfig(javax.management.ObjectName obj) Recreate the adapters associated with the specified objectname from their associated bootstrap file.
void	reloadFromVersionControl() Recreate all adapters associated with this AdapterRegistry from version control.
javax.management.ObjectName	reloadFromVersionControl(javax.management.ObjectName obj) Recreate the adapter associated with the specified objectname from their associated bootstrap file.
boolean	removeConfigurationURL(javax.management.ObjectName adapterName) Remove the URL that was used to create the adapter associated with the ObjectName.
void	validateConfig(java.lang.String config) Attempts to unmarshal the component within this target runtime unit.

Methods inherited from interface com.adaptris.core.runtime.BaseComponentMBean

createObjectName, registerMBean, unregisterMBean

Field Detail

JMX_REGISTRY_TYPE

static final java.lang.String JMX_REGISTRY_TYPE

The type for the adapter registry.

See Also:

Constant Field Values

REGISTRY_PREFIX

static final java.lang.String REGISTRY_PREFIX

See Also:

Constant Field Values

STANDARD_REGISTRY_JMX_NAME

static final java.lang.String STANDARD_REGISTRY_JMX_NAME

The Standard Name for the Adapter Registry "com.adaptris:type=Registry,id=AdapterRegistry"

See Also:

Constant Field Values

Method Detail

getAdapters

java.util.Set<javax.management.ObjectName> getAdapters()

Get all the adapters that have been registered.

Returns:

set of ObjectNames that can be looked up in JMX.

persistAdapter

void persistAdapter(AdapterManagerMBean adapter,
                    URLString url)
             throws java.io.IOException,
                    CoreException

Persist the adapter to the given URL.

Parameters:

adapter - the adapter Manager.

url - the url.

Throws:

java.io.IOException

CoreException

persistAdapter

void persistAdapter(AdapterManagerMBean adapter,
                    java.lang.String url)
             throws java.io.IOException,
                    CoreException

Persist the adapter to the given URL.

Parameters:

adapter - the adapter Manager.

url - the url.

Throws:

java.io.IOException

CoreException

persistAdapter

void persistAdapter(javax.management.ObjectName adapter,
                    URLString url)
             throws java.io.IOException,
                    CoreException

Persist the adapter to the given URL.

Parameters:

adapter - the AdapterManagerMBean ObjectName.

url - the url.

Throws:

java.io.IOException

CoreException

persistAdapter

void persistAdapter(javax.management.ObjectName adapter,
                    java.lang.String url)
             throws java.io.IOException,
                    CoreException

Persist the adapter to the given URL.

Parameters:

adapter - the AdapterManagerMBean ObjectName.

url - the url.

Throws:

java.io.IOException

CoreException

persist

void persist(java.lang.String data,
             URLString url)
      throws java.io.IOException,
             CoreException

Persist some data the given URL.

Parameters:

data - the data.

url - the url.

Throws:

java.io.IOException

CoreException

Since:

3.0.3

createAdapter

@Deprecated
javax.management.ObjectName createAdapter(URLString url)
                                               throws java.io.IOException,
                                                      javax.management.MalformedObjectNameException,
                                                      CoreException

Deprecated. since 3.6.1 get it via getBuilder(Properties) instead.

Create an adapter from the given URL.

Create an adapter from the given URL; the license associated with this adapter is one that was derived from bootstrap.properties.

Parameters:

url - the url

Returns:

the object name representing for the associated AdapterManagerMBean

Throws:

java.io.IOException - an error accessing the URL.

CoreException - an error creating the underlying adapter.

javax.management.MalformedObjectNameException - if there was a problem

createAdapterFromUrl

@Deprecated
javax.management.ObjectName createAdapterFromUrl(java.lang.String url)
                                                      throws java.io.IOException,
                                                             javax.management.MalformedObjectNameException,
                                                             CoreException

Deprecated. since 3.6.1

Create an adapter from the given URL.

Create an adapter from the given URL; the license associated with this adapter is one that was derived from bootstrap.properties.

Parameters:

url - the url

Returns:

the object name representing for the associated AdapterManagerMBean

Throws:

java.io.IOException - an error accessing the URL.

CoreException - an error creating the underlying adapter.

javax.management.MalformedObjectNameException - if there was a problem

getConfigurationURL

URLString getConfigurationURL(javax.management.ObjectName adapterName)

Get the URL that was used to create the adapter associated with that ObjectName.

When attempting to persist an adapter instance, you can use this method to query for the URL that was used to create the associated adapter. This will be the URL used to create the adapter initially (i.e. the adapterConfigURL that was resolved from bootstrap.properties) unless the adapter was created with createAdapter(String xml) in the first instance (in which case, you need to figure out where you want to persist the adapter in a different way).

Internally, the URLs are keyed against the ObjectName, which means that if create adapters that have the same logical object name, then a URLString will be returned regardless of "how" you created the adapter. So the code below will return http://my/url if the two ObjectName instances are considered the same.

 {
   @code
   ObjectName on = createAdapter(new URLString("http://my/url"));
   ObjectName on2 = createAdapter("<adapter>...</adapter>");
   URLString url = getConfigurationURL(on2);
 }
 

Parameters:

adapterName - object name representation for the associated AdapterManagerMBean

Returns:

the URL that was used to create the object, or null, if createAdapter(String xml) was used to create a new adapter.

Since:

3.0.2

getConfigurationURLString

java.lang.String getConfigurationURLString(javax.management.ObjectName adapterName)

Get the URL that was used to create the adapter associated with that ObjectName.

When attempting to persist an adapter instance, you can use this method to query for the URL that was used to create the associated adapter. This will be the URL used to create the adapter initially (i.e. the adapterConfigURL that was resolved from bootstrap.properties) unless the adapter was created with createAdapter(String xml) in the first instance (in which case, you need to figure out where you want to persist the adapter in a different way).

Internally, the URLs are keyed against the ObjectName, which means that if create adapters that have the same logical object name, then a URL will be returned regardless of "how" you created the adapter. So the code below will return http://my/url if the two ObjectName instances are considered the same.

 
 ObjectName on = createAdapter(new URL("http://my/url"));
 ObjectName on2 = createAdapter("<adapter>...</adapter>");
 URL url = getConfigurationURL(on2);
 
 

Parameters:

adapterName - object name representation for the associated AdapterManagerMBean

Returns:

the URL that was used to create the object, or null, if createAdapter(String xml) was used to create a new adapter.

Since:

3.0.2

removeConfigurationURL

boolean removeConfigurationURL(javax.management.ObjectName adapterName)

Remove the URL that was used to create the adapter associated with the ObjectName.

Note that calling either destroyAdapter(AdapterManagerMBean) or destroyAdapter(ObjectName) will NOT

Parameters:

adapterName - object name representation for the associated AdapterManagerMBean

Returns:

true if the URL was removed.

Since:

3.0.3

putConfigurationURL

void putConfigurationURL(javax.management.ObjectName adapterName,
                         URLString url)

Register a URL against a given ObjectName.

Where you have used createAdapter(String); there will not be an URL associated with the newly created adapter. Use this to register a URL against the given ObjectName, which means that getConfigurationURL(ObjectName) will not return a null object.

Parameters:

adapterName - object name representation for the associated AdapterManagerMBean

url - the URL to be stored against the objectname

putConfigurationURL

void putConfigurationURL(javax.management.ObjectName adapterName,
                         java.lang.String url)
                  throws java.io.IOException

Register a URL against a given ObjectName.

Where you have used createAdapter(String); there will not be an URL associated with the newly created adapter. Use this to register a URL against the given ObjectName, which means that getConfigurationURL(ObjectName) will not return a null object.

Parameters:

adapterName - object name representation for the associated AdapterManagerMBean

url - the URL to be stored against the objectname

Throws:

java.io.IOException

createAdapter

@Deprecated
javax.management.ObjectName createAdapter(java.lang.String xml)
                                               throws java.io.IOException,
                                                      javax.management.MalformedObjectNameException,
                                                      CoreException

Deprecated. since 3.6.1 get it via getBuilder(Properties) instead.

Create an adapter from the given string representation.

Create an adapter from the given string; the license associated with this adapter is one that was derived from bootstrap.properties.

Parameters:

xml - the string representation (generally XML).

Returns:

the object name representing for the associated AdapterManagerMBean

Throws:

java.io.IOException - an error accessing the URL.

CoreException - an error creating the underlying adapter.

javax.management.MalformedObjectNameException - if there was a problem with the objectname.

addAdapter

void addAdapter(AdapterManagerMBean adapter)
         throws javax.management.MalformedObjectNameException,
                CoreException

Add an AdapterManagerMBean instance to the registry.

Parameters:

adapter - the AdapterManagerMBean instance.

Throws:

javax.management.MalformedObjectNameException - if there was a problem with the objectname

CoreException - if the objectname already exists in the registry.

destroyAdapter

void destroyAdapter(AdapterManagerMBean adapter)
             throws CoreException,
                    javax.management.MalformedObjectNameException

Close the underlying adapter and unregister from JMX.

Note that this uses AdapterComponentMBean.requestClose() which will block until the adapter is closed; if a timeout is required, then make sure to use AdapterComponentMBean.requestClose(long) and possibly AdapterManagerMBean.forceClose() before invoking this method.

Parameters:

adapter - the AdapterManagerMBean.

Throws:

CoreException - an error accessing the underlying adapter.

javax.management.MalformedObjectNameException - if there was a problem with the objectname.

destroyAdapter

void destroyAdapter(javax.management.ObjectName adapter)
             throws javax.management.MalformedObjectNameException,
                    CoreException

Close the underlying adapter and unregister from JMX.

Note that this uses AdapterComponentMBean.requestClose() which will block until the adapter is closed; if a timeout is required, then make sure to use AdapterComponentMBean.requestClose(long) and possibly AdapterManagerMBean.forceClose() before invoking this method.

Parameters:

adapter - the AdapterManagerMBean.

Throws:

javax.management.MalformedObjectNameException - if there was a problem with the objectname.

CoreException - an error accessing the underlying adapter.

See Also:

destroyAdapter(AdapterManagerMBean)

getConfiguration

@Deprecated
java.util.Properties getConfiguration()

Deprecated. since 3.6.1 get it via getBuilder(ObjectName) instead.

Return the BootstrapProperties instance that was used to create this registry.

Returns:

a set of properties.

Since:

3.0.3

getVersionControl

java.lang.String getVersionControl()

Return the version control system that is currently in use based on RuntimeVersionControl.getImplementationName()

Returns:

the version control system that is currently configured for adapter runtime (null if none is available).

Since:

3.0.3

reloadFromVersionControl

void reloadFromVersionControl()
                       throws javax.management.MalformedObjectNameException,
                              CoreException,
                              java.net.MalformedURLException,
                              java.io.IOException

Recreate all adapters associated with this AdapterRegistry from version control.

Note that the adapters will not be started as part of this process; this needs to be done separately.

Throws:

javax.management.MalformedObjectNameException - if there was a problem with any objectname.

CoreException - an error creating the underlying adapter(s).

java.io.IOException - if there was a with reading the URL where the adapter is hosted.

java.net.MalformedURLException - if there was a problem with the URL found from config.

Since:

3.0.3

reloadFromConfig

java.util.Set<javax.management.ObjectName> reloadFromConfig()
                                                     throws javax.management.MalformedObjectNameException,
                                                            CoreException,
                                                            java.net.MalformedURLException,
                                                            java.io.IOException

Recreate all adapters associated with this AdapterRegistry from their associated bootstrap file.

Note that the adapters will not be started as part of this process; this needs to be done separately.

Returns:

a set of object name representing for the associated AdapterManagerMBean instances created.

Throws:

javax.management.MalformedObjectNameException - if there was a problem with any objectname.

CoreException - an error creating the underlying adapter(s).

java.io.IOException - if there was a with reading the URL where the adapter is hosted.

java.net.MalformedURLException - if there was a problem with the URL found from config.

Since:

3.4.1

validateConfig

void validateConfig(java.lang.String config)
             throws CoreException

Attempts to unmarshal the component within this target runtime unit.

This will verify that the component that was configured can be unmarshalled within the target runtime system. It is largely similar to the createAdapter(String) method, however it does not try to register a new AdapterManagerMBean as part of the operation.

Parameters:

config - the String representation of a component.

Throws:

CoreException - if there was an exception unmarshalling.

Since:

3.0.5

See Also:

createAdapter(String)

getClassDefinition

java.lang.String getClassDefinition(java.lang.String className)
                             throws CoreException

In JSON format return the full class description, including subclasses and annotation detail.

Parameters:

className - - fully qualified

Returns:

JSON class definition.

Throws:

CoreException

Since:

3.6.0

reloadFromConfig

javax.management.ObjectName reloadFromConfig(javax.management.ObjectName obj)
                                      throws javax.management.MalformedObjectNameException,
                                             CoreException,
                                             java.io.IOException,
                                             java.net.MalformedURLException

Recreate the adapters associated with the specified objectname from their associated bootstrap file.

Note that the adapter will not be started as part of this process; this needs to be done separately.

Parameters:

obj - the ObjectName to reload from config.

Returns:

The ObjectName representing for the associated AdapterManagerMBean instances created.

Throws:

javax.management.MalformedObjectNameException - if there was a problem with any objectname.

CoreException - an error creating the underlying adapter(s).

java.io.IOException - if there was a with reading the URL where the adapter is hosted.

java.net.MalformedURLException - if there was a problem with the URL found from config.

Since:

3.6.1

reloadFromVersionControl

javax.management.ObjectName reloadFromVersionControl(javax.management.ObjectName obj)
                                              throws javax.management.MalformedObjectNameException,
                                                     CoreException,
                                                     java.io.IOException,
                                                     java.net.MalformedURLException

Recreate the adapter associated with the specified objectname from their associated bootstrap file.

Note that the adapter will not be started as part of this process; this needs to be done separately.

Parameters:

obj - the ObjectName to restart.

Returns:

The ObjectName representing for the associated AdapterManagerMBean instances created.

Throws:

javax.management.MalformedObjectNameException - if there was a problem with any objectname.

CoreException - an error creating the underlying adapter(s).

java.io.IOException - if there was a with reading the URL where the adapter is hosted.

java.net.MalformedURLException - if there was a problem with the URL found from config.

Since:

3.6.1

addConfiguration

void addConfiguration(java.util.Properties p)
               throws javax.management.MalformedObjectNameException,
                      CoreException

Throws:

javax.management.MalformedObjectNameException

CoreException

getBuilder

javax.management.ObjectName getBuilder(javax.management.ObjectName p)
                                throws javax.management.InstanceNotFoundException

Get a reference to the AdapterBuilderMBean instance that built the corresponding AdapterManagerMBean instance.

Parameters:

p - a reference to the AdapterManagerMBean

Returns:

a reference to the AdapterBuilderMBean

Throws:

javax.management.InstanceNotFoundException - if there was no associated builder.

getBuilderMBean

AdapterBuilderMBean getBuilderMBean(javax.management.ObjectName p)
                             throws javax.management.InstanceNotFoundException

Get a reference to the AdapterBuilderMBean instance that built the corresponding AdapterManagerMBean instance.

Parameters:

p - a reference to the AdapterManagerMBean

Returns:

a reference to the AdapterBuilderMBean

Throws:

javax.management.InstanceNotFoundException - if there was no associated builder.

getBuilder

AdapterBuilderMBean getBuilder(java.util.Properties p)
                        throws javax.management.InstanceNotFoundException

Get the AdapterBuilderMBean associated with given Properties object.

Throws:

javax.management.InstanceNotFoundException

getBuilders

java.util.Set<javax.management.ObjectName> getBuilders()

Get All the builders.

Returns:

all the available builders.