org.ogf.graap.wsag.server.api.impl
Class AgreementFactoryFacade

java.lang.Object
  org.ogf.graap.wsag.server.api.EngineComponent
      org.ogf.graap.wsag.server.api.impl.AbstractAgreementFactory
          org.ogf.graap.wsag.server.api.impl.AgreementFactoryFacade

All Implemented Interfaces:

AgreementFactory, IAgreementFactory, IEngineComponent

public class AgreementFactoryFacade
extends AbstractAgreementFactory

The agreement factory facade is an implementation of a IAgreementFactory. Calls are delegated to an AgreementFactory implementation. This class is used for backward compatibility.

Author:

Oliver Waeldrich

Constructor Summary

AgreementFactoryFacade(AgreementFactory factory)

Method Summary

Agreement	createAgreement(AgreementOffer offer, Map<String,Object> context) Creates a new agreement based on an offer.
Agreement	createPendingAgreement(AgreementOffer offer, PendingAgreementListener listener, Map<String,Object> context) Creates a new pending agreement based on an offer.
protected void	doInitialize()
AgreementFactory	getAgreementFactory()
AgreementTemplateType[]	getTemplates()
Negotiation	initiateNegotiation(NegotiationContextType context, org.apache.xmlbeans.XmlObject[] criticalExtensions, org.apache.xmlbeans.XmlObject[] nonCriticalExtensions, Map<String,Object> environment) Initializes a new negotiation instance.

Methods inherited from class org.ogf.graap.wsag.server.api.impl.AbstractAgreementFactory

getFactoryContext, setFactoryContext

Methods inherited from class org.ogf.graap.wsag.server.api.EngineComponent

getEngine, initialize

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ogf.graap.wsag.server.api.IEngineComponent

getEngine, initialize

Constructor Detail

AgreementFactoryFacade

public AgreementFactoryFacade(AgreementFactory factory)

Parameters:

factory - the factory implementation

Method Detail

getAgreementFactory

public AgreementFactory getAgreementFactory()

Returns:

The agreement factory object of this facade.

createAgreement

public Agreement createAgreement(AgreementOffer offer,
                                 Map<String,Object> context)
                          throws AgreementFactoryException

Creates a new agreement based on an offer.

Parameters:

offer - agreement offer

context - invocation context

Returns:

the created agreement instance

Throws:

AgreementFactoryException - Indicates that the agreement offer was rejected or another fault occurred.

createPendingAgreement

public Agreement createPendingAgreement(AgreementOffer offer,
                                        PendingAgreementListener listener,
                                        Map<String,Object> context)
                                 throws AgreementFactoryException

Creates a new pending agreement based on an offer.

Parameters:

offer - agreement offer

listener - the listener, when provided, receives the agreement acceptance events once the creation process is finished

context - invocation context

Returns:

the created agreement instance

Throws:

AgreementFactoryException - Indicates that the agreement offer was rejected or another fault occurred.

getTemplates

public AgreementTemplateType[] getTemplates()

Returns:

the agreement templates exposed by this factory

initiateNegotiation

public Negotiation initiateNegotiation(NegotiationContextType context,
                                       org.apache.xmlbeans.XmlObject[] criticalExtensions,
                                       org.apache.xmlbeans.XmlObject[] nonCriticalExtensions,
                                       Map<String,Object> environment)
                                throws NegotiationFactoryException

Initializes a new negotiation instance. This method creates a new negotiation instance based on the provided negotiation context, taking into account the critical and non-critical extensions.

Parameters:

context - The negotiation context defines the roles and obligations of the negotiating parties. Furthermore, it defines the nature of the negotiation process (e.g. negotiation or re-negotiation).

criticalExtensions - Critical extensions must be supported during the negotiation process. If a critical extension is not understood or supported by the negotiation factory, it must throw an @see NegotiationFactoryException.

nonCriticalExtensions - Non-critical extensions should be supported during the negotiation process. If a non-critical extension is not understood or supported by the negotiation factory, it can be ignored. Alternatively, an @see NegotiationFactoryException could be thrown.

environment - Provides access to additional variables provided by the calling instance. These environment variables are domain specific.

Returns:

the new initiated negotiation instance

Throws:

NegotiationFactoryException - indicates that an error occurred while instantiating the negotiation process

doInitialize

protected void doInitialize()
                     throws Exception

Specified by:

doInitialize in class EngineComponent

Throws:

Exception