com.helger.as2lib.session

Interface IAS2Session

All Known Implementing Classes:

AS2Session

public interface IAS2Session

This interface provides configuration and resource information, and a means for components to access the functionality of other components.

Author:

Aaron Silinskas

See Also:

IDynamicComponent, ICertificateFactory, IPartnershipFactory, IMessageProcessor

Method Summary

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

Method Detail

addComponent

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

Registers a component to a specified ID.

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

getComponent

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

Gets the Component currently registered with an ID

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

getAllComponents

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

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

Returns:

all registered components, mapped by ID

getCertificateFactory

@Nonnull
ICertificateFactory getCertificateFactory()
                                             throws AS2ComponentNotFoundException

Short-cut method to retrieve a certificate factory.

Returns:

the currently registered CertificateFactory component

Throws:

AS2ComponentNotFoundException - If a CertificateFactory component has not been registered

See Also:

ICertificateFactory, IDynamicComponent

getPartnershipFactory

@Nonnull
IPartnershipFactory getPartnershipFactory()
                                             throws AS2ComponentNotFoundException

Short-cut method to retrieve a partner factory.

Returns:

the currently registered PartnerFactory component

Throws:

AS2ComponentNotFoundException - If a PartnerFactory component has not been registered

See Also:

IPartnershipFactory, IDynamicComponent

getMessageProcessor

@Nonnull
IMessageProcessor getMessageProcessor()
                                         throws AS2ComponentNotFoundException

Short-cut method to retrieve a processor.

Returns:

the currently registered Processor component

Throws:

AS2ComponentNotFoundException - If a Processor component has not been registered

See Also:

IMessageProcessor, IDynamicComponent

isCryptoSignIncludeCertificateInBodyPart

boolean isCryptoSignIncludeCertificateInBodyPart()

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:

setCryptoSignIncludeCertificateInBodyPart(boolean)

setCryptoSignIncludeCertificateInBodyPart

void setCryptoSignIncludeCertificateInBodyPart(boolean bCryptoSignIncludeCertificateInBodyPart)

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

Parameters:

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

See Also:

isCryptoSignIncludeCertificateInBodyPart()

isCryptoVerifyUseCertificateInBodyPart

boolean isCryptoVerifyUseCertificateInBodyPart()

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:

setCryptoVerifyUseCertificateInBodyPart(boolean)

setCryptoVerifyUseCertificateInBodyPart

void setCryptoVerifyUseCertificateInBodyPart(boolean bCryptoVerifyUseCertificateInBodyPart)

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

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:

isCryptoVerifyUseCertificateInBodyPart()

getHttpProxy

@Nullable
Proxy getHttpProxy()

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

Returns:

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

See Also:

setHttpProxy(Proxy)

setHttpProxy

void setHttpProxy(@Nullable
                  Proxy aHttpProxy)

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

Parameters:

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

See Also:

getHttpProxy()

getAS2VersionID

@Nonnull
 @Nonempty
String getAS2VersionID()

Returns:

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

Since:

4.6.1

setAS2VersionID

void setAS2VersionID(@Nonnull @Nonempty
                     String sAS2Version)

Parameters:

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

Since:

4.6.1