Package com.adaptris.core.runtime

Class AdapterRegistry

java.lang.Object

com.adaptris.core.runtime.AdapterRegistry

All Implemented Interfaces:

AdapterRegistryMBean, BaseComponentMBean

public class AdapterRegistry
extends Object
implements AdapterRegistryMBean

Field Summary

Fields inherited from interface com.adaptris.core.runtime.AdapterRegistryMBean

JMX_REGISTRY_TYPE, REGISTRY_PREFIX, STANDARD_REGISTRY_JMX_NAME

Method Summary

Modifier and Type	Method	Description
void	addAdapter(AdapterManagerMBean adapterManager)	Add an AdapterManagerMBean instance to the registry.
void	addConfiguration(Properties cfg)
void	addManagementComponentInfo(ManagementComponentInfo componentInfo)
Set<com.adaptris.core.runtime.AdapterBuilder>	builders()	Get All the builders.
static void	close(Set<ObjectName> adapterManagers)	Convenience method to close a set of adapter managers that uses AdapterComponentMBean.requestClose()
ObjectName	createAdapter(URLString url)	Create an adapter from the given URL.
ObjectName	createAdapter(String xml)	Create an adapter from the given string representation.
ObjectName	createAdapterFromUrl(String url)	Create an adapter from the given URL.
ObjectName	createObjectName()	Create the object name representation of the mbean.
void	destroyAdapter(AdapterManagerMBean adapter)	Close the underlying adapter and unregister from JMX.
void	destroyAdapter(ObjectName adapterName)	Close the underlying adapter and unregister from JMX.
static AdapterRegistryMBean	findInstance(Properties cfg)
Set<ObjectName>	getAdapters()	Get all the adapters that have been registered.
AdapterBuilderMBean	getBuilder(Properties p)	Get the AdapterBuilderMBean associated with given Properties object.
ObjectName	getBuilder(ObjectName p)	Get a reference to the AdapterBuilderMBean instance that built the corresponding AdapterManagerMBean instance.
AdapterBuilderMBean	getBuilderMBean(ObjectName p)	Get a reference to the AdapterBuilderMBean instance that built the corresponding AdapterManagerMBean instance.
Set<ObjectName>	getBuilders()	Get All the builders object names.
String	getClassDefinition(String className)	In JSON format return the full class description, including subclasses and annotation detail.
Properties	getConfiguration()	Return the BootstrapProperties instance that was used to create this registry.
URLString	getConfigurationURL(ObjectName adapterName)	Get the URL that was used to create the adapter associated with that ObjectName.
String	getConfigurationURLString(ObjectName adapterName)	Get the URL that was used to create the adapter associated with that ObjectName.
List<ManagementComponentInfo>	getManagementComponentInfo()	Will return a Map of ManagementComponentInfo's.
String	getVersionControl()	Return the version control system that is currently in use based on RuntimeVersionControl.getImplementationName()
void	persist(String data, URLString configUrl)	Persist some data the given URL.
void	persistAdapter(AdapterManagerMBean adapter, URLString url)	Persist the adapter to the given URL.
void	persistAdapter(AdapterManagerMBean adapter, String url)	Persist the adapter to the given URL.
void	persistAdapter(ObjectName adapter, URLString url)	Persist the adapter to the given URL.
void	persistAdapter(ObjectName adapter, String url)	Persist the adapter to the given URL.
void	putConfigurationURL(ObjectName adapterName, URLString configUrl)	Register a URL against a given ObjectName.
void	putConfigurationURL(ObjectName adapterName, String configUrl)	Register a URL against a given ObjectName.
void	registerMBean()	Register this component (and all children) against the default Platform MBeanServer.
Set<ObjectName>	reloadFromConfig()	Recreate all adapters associated with this AdapterRegistry from their associated bootstrap file.
ObjectName	reloadFromConfig(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.
ObjectName	reloadFromVersionControl(ObjectName obj)	Recreate the adapter associated with the specified objectname from their associated bootstrap file.
boolean	removeConfigurationURL(ObjectName adapterName)	Remove the URL that was used to create the adapter associated with the ObjectName.
static void	sendShutdownEvent(Set<ObjectName> adapterManagers)	Convenience method for sending a shutdown event for every adapter.
void	setManagementComponentInfo(List<ManagementComponentInfo> managementComponentInfo)	Set the list of configured management components.
static void	start(Set<ObjectName> adapterManagers)	Convenience method to start a set of adapter managers that uses AdapterComponentMBean.requestStart()
static void	stop(Set<ObjectName> adapterManagers)	Convenience method to close a set of adapter managers that uses AdapterComponentMBean.requestStop()
static void	unregister(Set<ObjectName> adapterManagers)	Convenience method to close a set of adapter managers that uses BaseComponentMBean.unregisterMBean()
void	unregisterMBean()	Unregister this component (and all children) from the default Platform MBeanServer.
void	validateConfig(String config)	Attempts to unmarshal the component within this target runtime unit.

Methods inherited from class java.lang.Object

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

Method Details

findInstance

public static AdapterRegistryMBean findInstance(Properties cfg)
                                         throws MalformedObjectNameException,
CoreException

Throws:

MalformedObjectNameException

CoreException

createObjectName

public ObjectName createObjectName()

Description copied from interface: BaseComponentMBean

Create the object name representation of the mbean.

Specified by:

createObjectName in interface BaseComponentMBean

Returns:

the object name.

registerMBean

public void registerMBean()
                   throws CoreException

Description copied from interface: BaseComponentMBean

Register this component (and all children) against the default Platform MBeanServer.

Specified by:

registerMBean in interface BaseComponentMBean

Throws:

CoreException - wrapping any exception

See Also:

• ManagementFactory.getPlatformMBeanServer()

unregisterMBean

public void unregisterMBean()
                     throws CoreException

Description copied from interface: BaseComponentMBean

Unregister this component (and all children) from the default Platform MBeanServer.

Specified by:

unregisterMBean in interface BaseComponentMBean

Throws:

CoreException - wrapping any exception

See Also:

• ManagementFactory.getPlatformMBeanServer()

getAdapters

public Set<ObjectName> getAdapters()

Description copied from interface: AdapterRegistryMBean

Get all the adapters that have been registered.

Specified by:

getAdapters in interface AdapterRegistryMBean

Returns:

set of ObjectNames that can be looked up in JMX.

getConfigurationURL

public URLString getConfigurationURL(ObjectName adapterName)

Description copied from interface: AdapterRegistryMBean

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 AdapterRegistryMBean.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);
 }
 

Specified by:

getConfigurationURL in interface AdapterRegistryMBean

Parameters:

adapterName - object name representation for the associated AdapterManagerMBean

Returns:

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

getConfigurationURLString

public String getConfigurationURLString(ObjectName adapterName)

Description copied from interface: AdapterRegistryMBean

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 AdapterRegistryMBean.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);
 
 

Specified by:

getConfigurationURLString in interface AdapterRegistryMBean

Parameters:

adapterName - object name representation for the associated AdapterManagerMBean

Returns:

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

removeConfigurationURL

public boolean removeConfigurationURL(ObjectName adapterName)

Description copied from interface: AdapterRegistryMBean

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

Note that calling either AdapterRegistryMBean.destroyAdapter(AdapterManagerMBean) or AdapterRegistryMBean.destroyAdapter(ObjectName) will NOT remove the URL from the internal map (as you are likely to invoke those methods to stop/close the adapter prior to creating a new one), so this method is available for you to manually clean up if desired.

Specified by:

removeConfigurationURL in interface AdapterRegistryMBean

Parameters:

adapterName - object name representation for the associated AdapterManagerMBean

Returns:

true if the URL was removed.

putConfigurationURL

public void putConfigurationURL(ObjectName adapterName,
 URLString configUrl)

Description copied from interface: AdapterRegistryMBean

Register a URL against a given ObjectName.

Where you have used AdapterRegistryMBean.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 AdapterRegistryMBean.getConfigurationURL(ObjectName) will not return a null object.

Specified by:

putConfigurationURL in interface AdapterRegistryMBean

Parameters:

adapterName - object name representation for the associated AdapterManagerMBean

configUrl - the URL to be stored against the objectname

putConfigurationURL

public void putConfigurationURL(ObjectName adapterName,
 String configUrl)
                         throws IOException

Description copied from interface: AdapterRegistryMBean

Register a URL against a given ObjectName.

Where you have used AdapterRegistryMBean.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 AdapterRegistryMBean.getConfigurationURL(ObjectName) will not return a null object.

Specified by:

putConfigurationURL in interface AdapterRegistryMBean

Parameters:

adapterName - object name representation for the associated AdapterManagerMBean

configUrl - the URL to be stored against the objectname

Throws:

IOException

persistAdapter

public void persistAdapter(AdapterManagerMBean adapter,
 URLString url)
                    throws CoreException,
IOException

Description copied from interface: AdapterRegistryMBean

Persist the adapter to the given URL.

Specified by:

persistAdapter in interface AdapterRegistryMBean

Parameters:

adapter - the adapter Manager.

url - the url.

Throws:

CoreException

IOException

persistAdapter

public void persistAdapter(AdapterManagerMBean adapter,
 String url)
                    throws CoreException,
IOException

Description copied from interface: AdapterRegistryMBean

Persist the adapter to the given URL.

Specified by:

persistAdapter in interface AdapterRegistryMBean

Parameters:

adapter - the adapter Manager.

url - the url.

Throws:

CoreException

IOException

persistAdapter

public void persistAdapter(ObjectName adapter,
 URLString url)
                    throws CoreException,
IOException

Description copied from interface: AdapterRegistryMBean

Persist the adapter to the given URL.

Specified by:

persistAdapter in interface AdapterRegistryMBean

Parameters:

adapter - the AdapterManagerMBean ObjectName.

url - the url.

Throws:

CoreException

IOException

persistAdapter

public void persistAdapter(ObjectName adapter,
 String url)
                    throws CoreException,
IOException

Description copied from interface: AdapterRegistryMBean

Persist the adapter to the given URL.

Specified by:

persistAdapter in interface AdapterRegistryMBean

Parameters:

adapter - the AdapterManagerMBean ObjectName.

url - the url.

Throws:

CoreException

IOException

persist

public void persist(String data,
 URLString configUrl)
             throws CoreException,
IOException

Description copied from interface: AdapterRegistryMBean

Persist some data the given URL.

Specified by:

persist in interface AdapterRegistryMBean

Parameters:

data - the data.

configUrl - the url.

Throws:

CoreException

IOException

createAdapter

public ObjectName createAdapter(URLString url)
                         throws IOException,
MalformedObjectNameException,
CoreException

Description copied from interface: AdapterRegistryMBean

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.

Specified by:

createAdapter in interface AdapterRegistryMBean

Parameters:

url - the url

Returns:

the object name representing for the associated AdapterManagerMBean

Throws:

IOException - an error accessing the URL.

MalformedObjectNameException - if there was a problem

CoreException - an error creating the underlying adapter.

createAdapterFromUrl

public ObjectName createAdapterFromUrl(String url)
                                throws IOException,
MalformedObjectNameException,
CoreException

Description copied from interface: AdapterRegistryMBean

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.

Specified by:

createAdapterFromUrl in interface AdapterRegistryMBean

Parameters:

url - the url

Returns:

the object name representing for the associated AdapterManagerMBean

Throws:

IOException - an error accessing the URL.

MalformedObjectNameException - if there was a problem

CoreException - an error creating the underlying adapter.

createAdapter

public ObjectName createAdapter(String xml)
                         throws IOException,
MalformedObjectNameException,
CoreException

Description copied from interface: AdapterRegistryMBean

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.

Specified by:

createAdapter in interface AdapterRegistryMBean

Parameters:

xml - the string representation (generally XML).

Returns:

the object name representing for the associated AdapterManagerMBean

Throws:

IOException - an error accessing the URL.

MalformedObjectNameException - if there was a problem with the objectname.

CoreException - an error creating the underlying adapter.

addAdapter

public void addAdapter(AdapterManagerMBean adapterManager)
                throws MalformedObjectNameException,
CoreException

Description copied from interface: AdapterRegistryMBean

Add an AdapterManagerMBean instance to the registry.

Specified by:

addAdapter in interface AdapterRegistryMBean

Parameters:

adapterManager - the AdapterManagerMBean instance.

Throws:

MalformedObjectNameException - if there was a problem with the objectname

CoreException - if the objectname already exists in the registry.

destroyAdapter

public void destroyAdapter(AdapterManagerMBean adapter)
                    throws CoreException,
MalformedObjectNameException

Description copied from interface: AdapterRegistryMBean

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.

Specified by:

destroyAdapter in interface AdapterRegistryMBean

Parameters:

adapter - the AdapterManagerMBean.

Throws:

CoreException - an error accessing the underlying adapter.

MalformedObjectNameException - if there was a problem with the objectname.

destroyAdapter

public void destroyAdapter(ObjectName adapterName)
                    throws MalformedObjectNameException,
CoreException

Description copied from interface: AdapterRegistryMBean

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.

Specified by:

destroyAdapter in interface AdapterRegistryMBean

Parameters:

adapterName - the AdapterManagerMBean.

Throws:

MalformedObjectNameException - if there was a problem with the objectname.

CoreException - an error accessing the underlying adapter.

See Also:

• AdapterRegistryMBean.destroyAdapter(AdapterManagerMBean)

sendShutdownEvent

public static void sendShutdownEvent(Set<ObjectName> adapterManagers)

Convenience method for sending a shutdown event for every adapter.

Parameters:

adapterManagers - set of managers.

start

public static void start(Set<ObjectName> adapterManagers)
                  throws CoreException

Convenience method to start a set of adapter managers that uses AdapterComponentMBean.requestStart()

Parameters:

adapterManagers - set of managers.

Throws:

CoreException

close

public static void close(Set<ObjectName> adapterManagers)
                  throws CoreException

Convenience method to close a set of adapter managers that uses AdapterComponentMBean.requestClose()

Parameters:

adapterManagers - set of managers.

Throws:

CoreException - wrapping other exceptions

stop

public static void stop(Set<ObjectName> adapterManagers)
                 throws CoreException

Convenience method to close a set of adapter managers that uses AdapterComponentMBean.requestStop()

Parameters:

adapterManagers - set of managers.

Throws:

CoreException - wrapping other exceptions

unregister

public static void unregister(Set<ObjectName> adapterManagers)
                       throws CoreException

Convenience method to close a set of adapter managers that uses BaseComponentMBean.unregisterMBean()

Parameters:

adapterManagers - set of managers.

Throws:

CoreException - wrapping other exceptions

getConfiguration

public Properties getConfiguration()

Description copied from interface: AdapterRegistryMBean

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

Specified by:

getConfiguration in interface AdapterRegistryMBean

Returns:

a set of properties.

getVersionControl

public String getVersionControl()

Description copied from interface: AdapterRegistryMBean

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

Specified by:

getVersionControl in interface AdapterRegistryMBean

Returns:

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

reloadFromVersionControl

public void reloadFromVersionControl()
                              throws MalformedObjectNameException,
CoreException,
MalformedURLException,
IOException

Description copied from interface: AdapterRegistryMBean

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.

Specified by:

reloadFromVersionControl in interface AdapterRegistryMBean

Throws:

MalformedObjectNameException - if there was a problem with any objectname.

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

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

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

reloadFromConfig

public Set<ObjectName> reloadFromConfig()
                                 throws MalformedObjectNameException,
CoreException,
MalformedURLException,
IOException

Description copied from interface: AdapterRegistryMBean

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.

Specified by:

reloadFromConfig in interface AdapterRegistryMBean

Returns:

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

Throws:

MalformedObjectNameException - if there was a problem with any objectname.

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

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

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

reloadFromConfig

public ObjectName reloadFromConfig(ObjectName obj)
                            throws MalformedObjectNameException,
CoreException,
IOException

Description copied from interface: AdapterRegistryMBean

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.

Specified by:

reloadFromConfig in interface AdapterRegistryMBean

Parameters:

obj - the ObjectName to reload from config.

Returns:

The ObjectName representing for the associated AdapterManagerMBean instances created.

Throws:

MalformedObjectNameException - if there was a problem with any objectname.

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

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

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

reloadFromVersionControl

public ObjectName reloadFromVersionControl(ObjectName obj)
                                    throws MalformedObjectNameException,
CoreException,
IOException

Description copied from interface: AdapterRegistryMBean

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.

Specified by:

reloadFromVersionControl in interface AdapterRegistryMBean

Parameters:

obj - the ObjectName to restart.

Returns:

The ObjectName representing for the associated AdapterManagerMBean instances created.

Throws:

MalformedObjectNameException - if there was a problem with any objectname.

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

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

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

addConfiguration

public void addConfiguration(Properties cfg)
                      throws MalformedObjectNameException,
CoreException

Specified by:

addConfiguration in interface AdapterRegistryMBean

Throws:

MalformedObjectNameException

CoreException

validateConfig

public void validateConfig(String config)
                    throws CoreException

Description copied from interface: AdapterRegistryMBean

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 AdapterRegistryMBean.createAdapter(String) method, however it does not try to register a new AdapterManagerMBean as part of the operation.

Specified by:

validateConfig in interface AdapterRegistryMBean

Parameters:

config - the String representation of a component.

Throws:

CoreException - if there was an exception unmarshalling.

See Also:

• AdapterRegistryMBean.createAdapter(String)

getClassDefinition

public String getClassDefinition(String className)
                          throws CoreException

Description copied from interface: AdapterRegistryMBean

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

Specified by:

getClassDefinition in interface AdapterRegistryMBean

Parameters:

className - - fully qualified

Returns:

JSON class definition.

Throws:

CoreException

getBuilders

public Set<ObjectName> getBuilders()

Description copied from interface: AdapterRegistryMBean

Get All the builders object names.

Specified by:

getBuilders in interface AdapterRegistryMBean

Returns:

all the available builders object names.

getBuilder

public ObjectName getBuilder(ObjectName p)
                      throws InstanceNotFoundException

Description copied from interface: AdapterRegistryMBean

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

Specified by:

getBuilder in interface AdapterRegistryMBean

Parameters:

p - a reference to the AdapterManagerMBean

Returns:

a reference to the AdapterBuilderMBean

Throws:

InstanceNotFoundException - if there was no associated builder.

getBuilderMBean

public AdapterBuilderMBean getBuilderMBean(ObjectName p)
                                    throws InstanceNotFoundException

Description copied from interface: AdapterRegistryMBean

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

Specified by:

getBuilderMBean in interface AdapterRegistryMBean

Parameters:

p - a reference to the AdapterManagerMBean

Returns:

a reference to the AdapterBuilderMBean

Throws:

InstanceNotFoundException - if there was no associated builder.

getBuilder

public AdapterBuilderMBean getBuilder(Properties p)
                               throws InstanceNotFoundException

Description copied from interface: AdapterRegistryMBean

Get the AdapterBuilderMBean associated with given Properties object.

Specified by:

getBuilder in interface AdapterRegistryMBean

Throws:

InstanceNotFoundException

builders

public Set<com.adaptris.core.runtime.AdapterBuilder> builders()

Description copied from interface: AdapterRegistryMBean

Get All the builders.

Specified by:

builders in interface AdapterRegistryMBean

Returns:

all the available builders.

addManagementComponentInfo

public void addManagementComponentInfo(ManagementComponentInfo componentInfo)

getManagementComponentInfo

public List<ManagementComponentInfo> getManagementComponentInfo()

Description copied from interface: AdapterRegistryMBean

Will return a Map of ManagementComponentInfo's. The key to the map is the name of the configured management component.

Specified by:

getManagementComponentInfo in interface AdapterRegistryMBean

Returns:

Basic information on configured management components

setManagementComponentInfo

public void setManagementComponentInfo(List<ManagementComponentInfo> managementComponentInfo)

Description copied from interface: AdapterRegistryMBean

Set the list of configured management components.

Specified by:

setManagementComponentInfo in interface AdapterRegistryMBean