com.helger.as2lib.partner

Class AbstractPartnershipFactory

java.lang.Object

com.helger.as2lib.AbstractDynamicComponent

com.helger.as2lib.partner.AbstractPartnershipFactory

All Implemented Interfaces:

IDynamicComponent, IPartnershipFactory

Direct Known Subclasses:

AbstractPartnershipFactoryWithPartners, SelfFillingPartnershipFactory

@ThreadSafe
public abstract class AbstractPartnershipFactory
extends AbstractDynamicComponent
implements IPartnershipFactory

Abstract IPartnershipFactory implementation using PartnershipMap as the underlying data storage object.

Author:

Philip Helger

Field Summary

Fields inherited from class com.helger.as2lib.AbstractDynamicComponent

m_aRWLock

Constructor Summary

Constructors

Constructor and Description
AbstractPartnershipFactory()

Method Summary

Modifier and Type	Method and Description
com.helger.commons.state.EChange	addPartnership(Partnership aPartnership) Add a partnership.
boolean	equals(Object o)
com.helger.commons.collection.impl.ICommonsSet<String>	getAllPartnershipNames()
com.helger.commons.collection.impl.ICommonsList<Partnership>	getAllPartnerships()
Partnership	getPartnership(Partnership aPartnership) Get the partnership identified by the provided stub partnership.
Partnership	getPartnershipByName(String sName) Find an existing partnership by its name.
IPartnershipMap	getPartnershipMap()
int	hashCode()
protected void	markAsChanged() Callback method that is invoked, when this object is modified.
com.helger.commons.state.EChange	removePartnership(Partnership aPartnership) Remove the specified partnership.
protected void	setPartnerships(PartnershipMap aPartnerships)
String	toString()
void	updatePartnership(IMessage aMsg, boolean bOverwrite) Looks up and fills in any header info for a specific msg's partnership.
void	updatePartnership(IMessageMDN aMdn, boolean bOverwrite) Looks up and fills in any header info for a specific MDN's partnership

Methods inherited from class com.helger.as2lib.AbstractDynamicComponent

attrs, getAttributeAsIntRequired, getAttributeAsStringRequired, getName, getSession, initDynamicComponent

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.helger.as2lib.IDynamicComponent

attrs, getName, getSession, initDynamicComponent

Constructor Detail

AbstractPartnershipFactory

public AbstractPartnershipFactory()

Method Detail

markAsChanged

@OverrideOnDemand
 @IsLocked(value=WRITE)
protected void markAsChanged()
                                                                  throws AS2Exception

Callback method that is invoked, when this object is modified. This method must be overridden to do something useful. A use case scenario could e.g. be automatic storage of changes.

Throws:

AS2Exception - In case anything goes wrong

getPartnership

@Nonnull
 @OverridingMethodsMustInvokeSuper
public Partnership getPartnership(@Nonnull
                                                                                Partnership aPartnership)
                                                                         throws AS2Exception

Description copied from interface: IPartnershipFactory

Get the partnership identified by the provided stub partnership.

Specified by:

getPartnership in interface IPartnershipFactory

Parameters:

aPartnership - Stub partnership which must contain either a name or a set of sender and receiver IDs.

Returns:

The Partnership as stored in this factory. Never null.

Throws:

AS2Exception - If no partnership matching the provided stub partnership can be found.

getPartnershipByName

@Nullable
public Partnership getPartnershipByName(@Nullable
                                                   String sName)

Description copied from interface: IPartnershipFactory

Find an existing partnership by its name.

Specified by:

getPartnershipByName in interface IPartnershipFactory

Parameters:

sName - The partnership name to be looked up. May be null.

Returns:

null if no such partnership exists.

getAllPartnershipNames

@Nonnull
 @ReturnsMutableCopy
public com.helger.commons.collection.impl.ICommonsSet<String> getAllPartnershipNames()

Specified by:

getAllPartnershipNames in interface IPartnershipFactory

Returns:

A set with all contained partnership names. Never null but maybe empty.

getAllPartnerships

@Nonnull
 @ReturnsMutableCopy
public com.helger.commons.collection.impl.ICommonsList<Partnership> getAllPartnerships()

Specified by:

getAllPartnerships in interface IPartnershipFactory

Returns:

A list of all contained partnerships. Never null but maybe empty.

getPartnershipMap

@Nonnull
public IPartnershipMap getPartnershipMap()

setPartnerships

protected final void setPartnerships(@Nonnull
                                     PartnershipMap aPartnerships)
                              throws AS2Exception

Throws:

AS2Exception

addPartnership

@Nonnull
public final com.helger.commons.state.EChange addPartnership(@Nonnull
                                                                       Partnership aPartnership)
                                                                throws AS2Exception

Description copied from interface: IPartnershipFactory

Add a partnership.

Specified by:

addPartnership in interface IPartnershipFactory

Parameters:

aPartnership - The partnership to be added. May not be null. The name of the partnership must be unique so that it gets added.

Returns:

EChange.CHANGED if adding was successfully, EChange.UNCHANGED if the name is already contained.

Throws:

AS2Exception - Generic error

removePartnership

@Nonnull
public final com.helger.commons.state.EChange removePartnership(@Nonnull
                                                                          Partnership aPartnership)
                                                                   throws AS2Exception

Description copied from interface: IPartnershipFactory

Remove the specified partnership.

Specified by:

removePartnership in interface IPartnershipFactory

Parameters:

aPartnership - The partnership to be removed.

Returns:

EChange.CHANGED if removal was successful, EChange.UNCHANGED if no such partnership to be removed is present.

Throws:

AS2Exception - Generic error

updatePartnership

public void updatePartnership(@Nonnull
                              IMessage aMsg,
                              boolean bOverwrite)
                       throws AS2Exception

Description copied from interface: IPartnershipFactory

Looks up and fills in any header info for a specific msg's partnership.

Specified by:

updatePartnership in interface IPartnershipFactory

Parameters:

aMsg - The message in which the partnership should be updated. May not be null and must already contain a partnership with at least name or sender and receiver IDs.

bOverwrite - true to also set the subject of the message with the subject stored in the partnership.

Throws:

AS2Exception - In case of an error

See Also:

IPartnershipFactory.getPartnership(Partnership)

updatePartnership

public final void updatePartnership(@Nonnull
                                    IMessageMDN aMdn,
                                    boolean bOverwrite)
                             throws AS2Exception

Description copied from interface: IPartnershipFactory

Looks up and fills in any header info for a specific MDN's partnership

Specified by:

updatePartnership in interface IPartnershipFactory

Parameters:

aMdn - The MDN of which the partnership information should be updated. May not be null and must already contain a partnership with at least name or sender and receiver IDs.

bOverwrite - has no effect currently

Throws:

AS2Exception - In case of an error

See Also:

IPartnershipFactory.getPartnership(Partnership)

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractDynamicComponent

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractDynamicComponent

toString

public String toString()

Overrides:

toString in class AbstractDynamicComponent