com.adaptris.core.services.metadata

Class AddNamespaceObjectMetadata

java.lang.Object

com.adaptris.core.ServiceImp

com.adaptris.core.services.metadata.AddNamespaceObjectMetadata

All Implemented Interfaces:

AdaptrisComponent, ComponentLifecycle, ComponentLifecycleExtension, MessageEventGenerator, Service, StateManagedComponent

@ComponentProfile(summary="Add an XML namespace as object metadata",
                  tag="service,metadata,xml")
public class AddNamespaceObjectMetadata
extends ServiceImp

Implementation of Service that adds a static NamespaceContext to object metadata for use by other services.

In the adapter configuration file this class is aliased as add-namespace-object-metadata 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 and Description
AddNamespaceObjectMetadata()
AddNamespaceObjectMetadata(KeyValuePairSet elements)

Method Summary

Modifier and Type	Method and Description
protected void	closeService()
void	doService(AdaptrisMessage msg) Apply the service to the message.
KeyValuePairSet	getNamespaceContext()
protected void	initService()
void	prepare() Prepare for initialisation.
void	setNamespaceContext(KeyValuePairSet kvps) Set the namespace context for resolving namespaces.

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, start, stop

Methods inherited from class java.lang.Object

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

Constructor Detail

AddNamespaceObjectMetadata

public AddNamespaceObjectMetadata()

AddNamespaceObjectMetadata

public AddNamespaceObjectMetadata(KeyValuePairSet elements)

Method Detail

doService

public void doService(AdaptrisMessage msg)
               throws ServiceException

Description copied from interface: Service

Apply the service to the message.

Parameters:

msg - the AdaptrisMessage to process

Throws:

ServiceException - wrapping any underlying Exceptions

initService

protected void initService()
                    throws CoreException

Specified by:

initService in class ServiceImp

Throws:

CoreException

closeService

protected void closeService()

Specified by:

closeService in class ServiceImp

getNamespaceContext

public KeyValuePairSet getNamespaceContext()

Returns:

the namespaceContext

setNamespaceContext

public void setNamespaceContext(KeyValuePairSet kvps)

Set the namespace context for resolving namespaces.

• The key is the namespace prefix
• The value is the namespace uri

Parameters:

kvps - the namespace context

See Also:

SimpleNamespaceContext.create(KeyValuePairSet)

prepare

public void prepare()
             throws CoreException

Description copied from interface: ComponentLifecycleExtension

Prepare for initialisation.

Throws:

CoreException