com.adaptris.core.services

Class UseXmlCharsetAsEncodingService

java.lang.Object

com.adaptris.core.ServiceImp

com.adaptris.core.services.UseXmlCharsetAsEncodingService

All Implemented Interfaces:

AdaptrisComponent, ComponentLifecycle, ComponentLifecycleExtension, MessageEventGenerator, Service, StateManagedComponent

@ComponentProfile(summary="Change the character encoding of a message based on the XML charset",
                  tag="service,xml,encoding")
public class UseXmlCharsetAsEncodingService
extends ServiceImp

Changes the character encoding associated with a message.

This service does nothing with the data, but simply changes the character encoding associated with the message using AdaptrisMessage.setCharEncoding(String) after parsing the XML via XMLStreamReader. If there is no encoding specified via XMLStreamReader.getCharacterEncodingScheme() then no change occurs.

In the adapter configuration file this class is aliased as use-xml-charset-as-encoding 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
UseXmlCharsetAsEncodingService()

Method Summary

Modifier and Type	Method and Description
protected void	closeService()
void	doService(AdaptrisMessage msg) Apply the service to the message.
protected void	initService()
void	prepare() Prepare for initialisation.

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

UseXmlCharsetAsEncodingService

public UseXmlCharsetAsEncodingService()

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

prepare

public void prepare()
             throws CoreException

Description copied from interface: ComponentLifecycleExtension

Prepare for initialisation.

Throws:

CoreException