Package com.helger.as2lib.session

Class AS2Session

java.lang.Object

com.helger.as2lib.session.AS2Session

All Implemented Interfaces:

IAS2Session

@NotThreadSafe
public class AS2Session
extends Object
implements IAS2Session

Default implementation of IAS2Session

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COMPONENT_ID_CERTIFICATE_FACTORY
static final String	COMPONENT_ID_MESSAGE_PROCESSOR
static final String	COMPONENT_ID_PARTNERSHIP_FACTORY
static final boolean	DEFAULT_CRYPTO_SIGN_INCLUDE_CERTIFICATE_IN_BODY_PART
static final boolean	DEFAULT_CRYPTO_VERIFY_USE_CERTIFICATE_IN_BODY_PART

Constructor Summary

Constructors

Constructor	Description
AS2Session()	Constructor

Method Summary

Modifier and Type	Method	Description
final void	addComponent(String sComponentID, IDynamicComponent aComponent)	Registers a component to a specified ID.
protected final com.helger.commons.collection.impl.ICommonsMap<String,IDynamicComponent>	components()	All modifications done here, have impact on the whole session
final com.helger.commons.collection.impl.ICommonsMap<String,IDynamicComponent>	getAllComponents()	Return a map of component ID's to Component objects.
final String	getAS2VersionID()
final ICertificateFactory	getCertificateFactory()	Short-cut method to retrieve a certificate factory.
final IDynamicComponent	getComponent(String sComponentID)	Gets the Component currently registered with an ID
final Proxy	getHttpProxy()	Get the optional HTTP/HTTPS proxy settings to be used for sending AS2 messages and asynchronous MDNs.
final IMessageProcessor	getMessageProcessor()	Short-cut method to retrieve a processor.
final IPartnershipFactory	getPartnershipFactory()	Short-cut method to retrieve a partner factory.
final boolean	isCryptoSignIncludeCertificateInBodyPart()
final boolean	isCryptoVerifyUseCertificateInBodyPart()
static void	makeAS2CommandMapChanges()
void	resetToDefault()
final void	setAS2VersionID(String sAS2Version)
void	setCertificateFactory(ICertificateFactory aCertFactory)
final void	setCryptoSignIncludeCertificateInBodyPart(boolean bCryptoSignIncludeCertificateInBodyPart)	Settings flag, whether a the signing certificate should be included in the signed MIME body part or not.
final void	setCryptoVerifyUseCertificateInBodyPart(boolean bCryptoVerifyUseCertificateInBodyPart)	Settings flag, whether a contained certificate is used for message verification.
final void	setHttpProxy(Proxy aHttpProxy)	Set the optional HTTP/HTTPS proxy settings to be used for sending AS2 messages and asynchronous MDNs.
void	setMessageProcessor(IMessageProcessor aMsgProcessor)
void	setPartnershipFactory(IPartnershipFactory aPartnershipFactory)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

COMPONENT_ID_CERTIFICATE_FACTORY

public static final String COMPONENT_ID_CERTIFICATE_FACTORY

See Also:

• Constant Field Values

COMPONENT_ID_PARTNERSHIP_FACTORY

public static final String COMPONENT_ID_PARTNERSHIP_FACTORY

See Also:

• Constant Field Values

COMPONENT_ID_MESSAGE_PROCESSOR

public static final String COMPONENT_ID_MESSAGE_PROCESSOR

See Also:

• Constant Field Values

DEFAULT_CRYPTO_SIGN_INCLUDE_CERTIFICATE_IN_BODY_PART

public static final boolean DEFAULT_CRYPTO_SIGN_INCLUDE_CERTIFICATE_IN_BODY_PART

See Also:

• Constant Field Values

DEFAULT_CRYPTO_VERIFY_USE_CERTIFICATE_IN_BODY_PART

public static final boolean DEFAULT_CRYPTO_VERIFY_USE_CERTIFICATE_IN_BODY_PART

See Also:

• Constant Field Values

Constructor Details

AS2Session

public AS2Session()

Constructor

Method Details

makeAS2CommandMapChanges

public static void makeAS2CommandMapChanges()

addComponent

public final void addComponent(@Nonnull @Nonempty
 String sComponentID,
 @Nonnull
 IDynamicComponent aComponent)
                        throws AS2ComponentDuplicateException

Description copied from interface: IAS2Session

Registers a component to a specified ID.

Specified by:

addComponent in interface IAS2Session

Parameters:

sComponentID - registers the component to this ID

aComponent - component to register

Throws:

AS2ComponentDuplicateException - In case a component with the same ID is already present

See Also:

• IDynamicComponent

setCertificateFactory

public void setCertificateFactory(@Nonnull
 ICertificateFactory aCertFactory)
                           throws AS2ComponentDuplicateException

Throws:

AS2ComponentDuplicateException

setPartnershipFactory

public void setPartnershipFactory(@Nonnull
 IPartnershipFactory aPartnershipFactory)
                           throws AS2ComponentDuplicateException

Throws:

AS2ComponentDuplicateException

setMessageProcessor

public void setMessageProcessor(@Nonnull
 IMessageProcessor aMsgProcessor)
                         throws AS2ComponentDuplicateException

Throws:

AS2ComponentDuplicateException

getComponent

@Nonnull
public final IDynamicComponent getComponent(@Nonnull @Nonempty
 String sComponentID)
                                     throws AS2ComponentNotFoundException

Description copied from interface: IAS2Session

Gets the Component currently registered with an ID

Specified by:

getComponent in interface IAS2Session

Parameters:

sComponentID - ID to search for

Returns:

the component registered to the ID and never null.

Throws:

AS2ComponentNotFoundException - If a component is not registered with the ID

components

@Nonnull
@ReturnsMutableObject
protected final com.helger.commons.collection.impl.ICommonsMap<String,IDynamicComponent> components()

All modifications done here, have impact on the whole session

Returns:

The mutual component map. Never null handle with care.

getAllComponents

@Nonnull
@ReturnsMutableCopy
public final com.helger.commons.collection.impl.ICommonsMap<String,IDynamicComponent> getAllComponents()

Description copied from interface: IAS2Session

Return a map of component ID's to Component objects.

Specified by:

getAllComponents in interface IAS2Session

Returns:

all registered components, mapped by ID

getCertificateFactory

@Nonnull
public final ICertificateFactory getCertificateFactory()
                                                throws AS2ComponentNotFoundException

Description copied from interface: IAS2Session

Short-cut method to retrieve a certificate factory.

Specified by:

getCertificateFactory in interface IAS2Session

Returns:

the currently registered CertificateFactory component

Throws:

AS2ComponentNotFoundException - If a CertificateFactory component has not been registered

See Also:

• ICertificateFactory
• IDynamicComponent

getPartnershipFactory

@Nonnull
public final IPartnershipFactory getPartnershipFactory()
                                                throws AS2ComponentNotFoundException

Description copied from interface: IAS2Session

Short-cut method to retrieve a partner factory.

Specified by:

getPartnershipFactory in interface IAS2Session

Returns:

the currently registered PartnerFactory component

Throws:

AS2ComponentNotFoundException - If a PartnerFactory component has not been registered

See Also:

• IPartnershipFactory
• IDynamicComponent

getMessageProcessor

@Nonnull
public final IMessageProcessor getMessageProcessor()
                                            throws AS2ComponentNotFoundException

Description copied from interface: IAS2Session

Short-cut method to retrieve a processor.

Specified by:

getMessageProcessor in interface IAS2Session

Returns:

the currently registered Processor component

Throws:

AS2ComponentNotFoundException - If a Processor component has not been registered

See Also:

• IMessageProcessor
• IDynamicComponent

isCryptoSignIncludeCertificateInBodyPart

public final boolean isCryptoSignIncludeCertificateInBodyPart()

Specified by:

isCryptoSignIncludeCertificateInBodyPart in interface IAS2Session

Returns:

true if the certificate used for signing a message should be included in the signed MIME body part or not. Defaults to true.

See Also:

• IAS2Session.setCryptoSignIncludeCertificateInBodyPart(boolean)

setCryptoSignIncludeCertificateInBodyPart

public final void setCryptoSignIncludeCertificateInBodyPart(boolean bCryptoSignIncludeCertificateInBodyPart)

Description copied from interface: IAS2Session

Settings flag, whether a the signing certificate should be included in the signed MIME body part or not.

Specified by:

setCryptoSignIncludeCertificateInBodyPart in interface IAS2Session

Parameters:

bCryptoSignIncludeCertificateInBodyPart - true to include the signing certificate in the signed MIME body part, false to not do so.

See Also:

• IAS2Session.isCryptoSignIncludeCertificateInBodyPart()

isCryptoVerifyUseCertificateInBodyPart

public final boolean isCryptoVerifyUseCertificateInBodyPart()

Specified by:

isCryptoVerifyUseCertificateInBodyPart in interface IAS2Session

Returns:

true if any certificate passed in a message body is used for certificate verification or false if only the certificate present in the partnership factory is to be used. Defaults to true.

See Also:

• IAS2Session.setCryptoVerifyUseCertificateInBodyPart(boolean)

setCryptoVerifyUseCertificateInBodyPart

public final void setCryptoVerifyUseCertificateInBodyPart(boolean bCryptoVerifyUseCertificateInBodyPart)

Description copied from interface: IAS2Session

Settings flag, whether a contained certificate is used for message verification.

Specified by:

setCryptoVerifyUseCertificateInBodyPart in interface IAS2Session

Parameters:

bCryptoVerifyUseCertificateInBodyPart - true if any certificate passed in a message body is used for certificate verification or false if only the certificate present in the partnership factory is to be used.

See Also:

• IAS2Session.isCryptoVerifyUseCertificateInBodyPart()

getHttpProxy

@Nullable
public final Proxy getHttpProxy()

Description copied from interface: IAS2Session

Get the optional HTTP/HTTPS proxy settings to be used for sending AS2 messages and asynchronous MDNs.

Specified by:

getHttpProxy in interface IAS2Session

Returns:

The HTTP/HTTPS proxy object to be used. May be null.

See Also:

• IAS2Session.setHttpProxy(Proxy)

setHttpProxy

public final void setHttpProxy(@Nullable
 Proxy aHttpProxy)

Description copied from interface: IAS2Session

Set the optional HTTP/HTTPS proxy settings to be used for sending AS2 messages and asynchronous MDNs.

Specified by:

setHttpProxy in interface IAS2Session

Parameters:

aHttpProxy - The HTTP/HTTPS proxy object to be used. May be null.

See Also:

• IAS2Session.getHttpProxy()

getAS2VersionID

@Nonnull
@Nonempty
public final String getAS2VersionID()

Specified by:

getAS2VersionID in interface IAS2Session

Returns:

The AS2 version to use. The default is CAS2Header.DEFAULT_AS2_VERSION. Neither null nor empty.

setAS2VersionID

public final void setAS2VersionID(@Nonnull @Nonempty
 String sAS2Version)

Specified by:

setAS2VersionID in interface IAS2Session

Parameters:

sAS2Version - Set the AS2 version to use. May neither be null nor empty.

resetToDefault

@OverridingMethodsMustInvokeSuper
public void resetToDefault()

toString

public String toString()

Overrides:

toString in class Object