org.ogf.graap.wsag.wsrf.impl
Class NegotiationCapability

java.lang.Object
  org.apache.muse.core.AbstractCapability
      org.apache.muse.ws.resource.impl.AbstractWsResourceCapability
          org.ogf.graap.wsag.wsrf.WSAG4JCapability
              org.ogf.graap.wsag.wsrf.impl.NegotiationCapability

All Implemented Interfaces:

org.apache.muse.core.Capability, org.apache.muse.core.Initialization, org.apache.muse.core.InitializationParameters, org.apache.muse.core.Shutdown, org.apache.muse.ws.resource.WsResourceCapability

public class NegotiationCapability
extends WSAG4JCapability

Default implementation of the WS-Agreement Negotiation port type.

Author:

hrasheed

Constructor Summary

NegotiationCapability()

Method Summary

Element	advertise(AdvertiseInputDocument in) Advertises a set of negotiation offers to a negotiation participator.
Element[]	getNegotiableTemplate() Returns the negotiable templates supported by this negotiation instance.
Element	getNegotiationContext() Returns the context of this negotiation instance.
Element[]	getNegotiationOffer() Returns a history of exchanged negotiation offers.
QName[]	getPropertyNames()
Element	negotiate(NegotiateInputDocument in) Negotiates a set of offers and creates c set of counter offers.
Element	terminate(TerminateInputDocument in) Terminates a negotiation process.

Methods inherited from class org.ogf.graap.wsag.wsrf.WSAG4JCapability

toElement, toElementArray

Methods inherited from class org.apache.muse.ws.resource.impl.AbstractWsResourceCapability

createGettersAndSetters, deleteProperty, getGetter, getProperty, getPropertyElements, getSetter, getWsResource, initialize, insertProperty, invokeMethod, setResource, updateProperty

Methods inherited from class org.apache.muse.core.AbstractCapability

getActions, getCapabilityURI, getEnvironment, getInitializationParameter, getInitializationParameters, getLog, getMessageHandler, getPersistence, getResource, hasBeenInitialized, hasBeenShutdown, initializeCompleted, prepareShutdown, setCapabilityURI, setEnvironment, setInitializationParameters, setLog, setMessageHandler, setMessageHandlers, setPersistence, shutdown

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.muse.core.Capability

getActions, getCapabilityURI, getEnvironment, getLog, getMessageHandler, getPersistence, getResource, initializeCompleted, prepareShutdown, setCapabilityURI, setEnvironment, setLog, setMessageHandlers, setPersistence

Methods inherited from interface org.apache.muse.core.Initialization

hasBeenInitialized

Methods inherited from interface org.apache.muse.core.InitializationParameters

getInitializationParameter, getInitializationParameters, setInitializationParameters

Methods inherited from interface org.apache.muse.core.Shutdown

hasBeenShutdown, shutdown

Constructor Detail

NegotiationCapability

public NegotiationCapability()

Method Detail

getPropertyNames

public QName[] getPropertyNames()

Overrides:

getPropertyNames in class org.apache.muse.ws.resource.impl.AbstractWsResourceCapability

Returns:

the resource property QNames

getNegotiationContext

public Element getNegotiationContext()
                              throws org.apache.muse.ws.resource.faults.ResourceUnavailableFault

Returns the context of this negotiation instance.

Returns:

the context of this negotiation instance

Throws:

org.apache.muse.ws.resource.faults.ResourceUnavailableFault - the negotiation resource is not available

getNegotiableTemplate

public Element[] getNegotiableTemplate()
                                throws org.apache.muse.ws.resource.faults.ResourceUnavailableFault

Returns the negotiable templates supported by this negotiation instance.

Returns:

the negotiable templates

Throws:

org.apache.muse.ws.resource.faults.ResourceUnavailableFault - the negotiation resource is not available

getNegotiationOffer

public Element[] getNegotiationOffer()
                              throws org.apache.muse.ws.resource.faults.ResourceUnavailableFault

Returns a history of exchanged negotiation offers.

Returns:

the negotiation offers history

Throws:

org.apache.muse.ws.resource.faults.ResourceUnavailableFault - the negotiation resource is not available

To Do:

not implemented yet

negotiate

public Element negotiate(NegotiateInputDocument in)
                  throws org.apache.muse.ws.addressing.soap.SoapFault

Negotiates a set of offers and creates c set of counter offers.

Parameters:

in - the input document

Returns:

the response document

Throws:

org.apache.muse.ws.addressing.soap.SoapFault - generic SOAP fault

advertise

public Element advertise(AdvertiseInputDocument in)
                  throws org.apache.muse.ws.addressing.soap.SoapFault

Advertises a set of negotiation offers to a negotiation participator.

Parameters:

in - the input document

Returns:

the response document

Throws:

org.apache.muse.ws.addressing.soap.SoapFault - generic SOAP fault

terminate

public Element terminate(TerminateInputDocument in)
                  throws org.apache.muse.ws.addressing.soap.SoapFault

Terminates a negotiation process.

Parameters:

in - the termination reason

Returns:

the termination response document

Throws:

org.apache.muse.ws.addressing.soap.SoapFault - generic SOAP fault