org.ogf.graap.wsag.samples
Class SampleAgreementFactory

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

All Implemented Interfaces:

AgreementFactory, IAgreementFactory, IEngineComponent

Deprecated. the framework is customized by agreement actions only

@Deprecated
public class SampleAgreementFactory
extends AbstractAgreementFactory
implements AgreementFactory

Sample implementation of an agreement factory.

Author:

Oliver Waeldrich

Constructor Summary

SampleAgreementFactory()
Deprecated. default constructor

Method Summary

Agreement	createAgreement(AgreementOffer offer, Map<String,Object> context) Deprecated. Creates a new agreement based on an offer.
Agreement	createPendingAgreement(AgreementOffer offer, PendingAgreementListener listener, Map<String,Object> context) Deprecated. Creates a new pending agreement based on an offer.
protected void	doInitialize() Deprecated.
AgreementTemplateType[]	getTemplates() Deprecated.
Negotiation	initiateNegotiation(NegotiationContextType context, org.apache.xmlbeans.XmlObject[] criticalExtensions, org.apache.xmlbeans.XmlObject[] nonCriticalExtensions, Map<String,Object> environment) Deprecated. 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.api.AgreementFactory

getFactoryContext, setFactoryContext

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

getEngine, initialize

Constructor Detail

SampleAgreementFactory

public SampleAgreementFactory()

Deprecated.

default constructor

Method Detail

getTemplates

public AgreementTemplateType[] getTemplates()

Deprecated.

Specified by:

getTemplates in interface AgreementFactory

Returns:

the agreement templates exposed by this factory

createAgreement

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

Deprecated.

Creates a new agreement based on an offer.

Specified by:

createAgreement in interface AgreementFactory

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.

initiateNegotiation

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

Deprecated.

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.

Specified by:

initiateNegotiation in interface AgreementFactory

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

createPendingAgreement

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

Deprecated.

Description copied from interface: AgreementFactory

Creates a new pending agreement based on an offer.

Specified by:

createPendingAgreement in interface AgreementFactory

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.

doInitialize

protected void doInitialize()
                     throws Exception

Deprecated.

Specified by:

doInitialize in class EngineComponent

Throws:

Exception