com.adaptris.core.as2.services

Class AS2Service

java.lang.Object

com.adaptris.core.ServiceImp

com.adaptris.core.licensing.LicensedService

com.adaptris.core.as2.services.AS2Service

All Implemented Interfaces:

AdaptrisComponent, ComponentLifecycle, ComponentLifecycleExtension, JndiBindable, LicensedComponent, MessageEventGenerator, Service, StateManagedComponent

Direct Known Subclasses:

AddHeaderService, AS2Classifier, CheckAS2Addresses, CommitMessage, MessageBuilder, PrepareMessage, SecurityService, UnfoldHeaderService

public abstract class AS2Service
extends LicensedService

Abstract class that handles AS2 services.

If both failId and successId are set, then no exception will be thrown, and the service is treated as a branching service and the next service id will set to the failId on exception, and successId on successful processing

All concrete implementations of this service will require an Enterprise license.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String[]	AS2_HEADERS

Fields inherited from class com.adaptris.core.ServiceImp

log

Fields inherited from interface com.adaptris.core.MessageEventGenerator

CONFIRMATION_ID_KEY

Constructor Summary

Constructors

Constructor and Description
AS2Service() Default Constructor.

Method Summary

Modifier and Type	Method and Description
protected boolean	additionalDebug()
protected void	closeService()
protected static boolean	containsKey(AdaptrisMessage msg, java.lang.String key)
void	doService(AdaptrisMessage msg) Service the AdaptrisMessage.
protected <T> T	get(AdaptrisMessage msg, java.lang.Class<T> type)
java.lang.Boolean	getAdditionalDebug()
java.lang.String	getFailId()
protected <T> T	getQuietly(AdaptrisMessage msg, java.lang.Class<T> type)
java.lang.String	getSuccessId()
protected abstract void	handleService(AdaptrisMessage msg) Perform the actual service.
protected static boolean	hasFromTo(AdaptrisMessage msg)
protected void	initService()
boolean	isBranching()
boolean	isEnabled(License license)
protected void	logBodyPart(java.lang.String txt, javax.mail.internet.MimeBodyPart mbp)
protected java.lang.String	objectMetadataKey()
protected void	prepareService()
protected abstract void	serviceInit() Initialise the concrete implementation.
void	setAdditionalDebug(java.lang.Boolean b) Enable additional debug where available.
void	setFailId(java.lang.String s)
void	setSuccessId(java.lang.String s)

Methods inherited from class com.adaptris.core.licensing.LicensedService

prepare

Methods inherited from class com.adaptris.core.ServiceImp

changeState, close, continueOnFailure, createName, createQualifier, getContinueOnFail, getIsConfirmation, getIsTrackingEndpoint, getLookupName, getUniqueId, init, isConfirmation, isTrackingEndpoint, requestClose, requestInit, requestStart, requestStop, rethrowServiceException, retrieveComponentState, setContinueOnFail, setIsConfirmation, setIsTrackingEndpoint, setLookupName, setUniqueId, start, stop

Methods inherited from class java.lang.Object

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

Field Detail

AS2_HEADERS

protected static final java.lang.String[] AS2_HEADERS

Constructor Detail

AS2Service

public AS2Service()

Default Constructor.

Method Detail

initService

protected final void initService()
                          throws CoreException

Specified by:

initService in class ServiceImp

Throws:

CoreException

See Also:

ComponentLifecycle.init()

closeService

protected void closeService()

Specified by:

closeService in class ServiceImp

See Also:

ComponentLifecycle.close()

serviceInit

protected abstract void serviceInit()
                             throws CoreException

Initialise the concrete implementation.

Throws:

CoreException

See Also:

ServiceImp.init()

handleService

protected abstract void handleService(AdaptrisMessage msg)
                               throws java.lang.Exception

Perform the actual service.

Throws:

java.lang.Exception

See Also:

doService(AdaptrisMessage)

doService

public final void doService(AdaptrisMessage msg)
                     throws ServiceException

Service the AdaptrisMessage.

If both failId and successId are set, then no exception will be thrown, and the service is treated as a branching service and the next service id will set to the failId on exception, and successId on successful processing

Throws:

ServiceException

isEnabled

public final boolean isEnabled(License license)

prepareService

protected void prepareService()
                       throws CoreException

Specified by:

prepareService in class LicensedService

Throws:

CoreException

isBranching

public boolean isBranching()

Specified by:

isBranching in interface Service

Overrides:

isBranching in class ServiceImp

See Also:

ServiceImp.isBranching()

objectMetadataKey

protected java.lang.String objectMetadataKey()

Returns:

the objectMetadataKey

getFailId

public java.lang.String getFailId()

Returns:

the failId

setFailId

public void setFailId(java.lang.String s)

Parameters:

s - the failId to set

getSuccessId

public java.lang.String getSuccessId()

Returns:

the successId

setSuccessId

public void setSuccessId(java.lang.String s)

Parameters:

s - the successId to set

logBodyPart

protected void logBodyPart(java.lang.String txt,
                           javax.mail.internet.MimeBodyPart mbp)
                    throws javax.mail.MessagingException,
                           java.io.IOException

Throws:

javax.mail.MessagingException

java.io.IOException

additionalDebug

protected boolean additionalDebug()

getAdditionalDebug

public java.lang.Boolean getAdditionalDebug()

Returns:

the additionalDebug

setAdditionalDebug

public void setAdditionalDebug(java.lang.Boolean b)

Enable additional debug where available.

Parameters:

b - the additionalDebug to set

get

protected <T> T get(AdaptrisMessage msg,
                    java.lang.Class<T> type)
             throws ServiceException

Throws:

ServiceException

getQuietly

protected <T> T getQuietly(AdaptrisMessage msg,
                           java.lang.Class<T> type)

hasFromTo

protected static boolean hasFromTo(AdaptrisMessage msg)

containsKey

protected static boolean containsKey(AdaptrisMessage msg,
                                     java.lang.String key)