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

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.AgreementCapability

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 AgreementCapability
extends WSAG4JCapability

Default implementation of the WS-Agreement port type.

Author:

Oliver Waeldrich

Constructor Summary

AgreementCapability()

Method Summary

Element	getAgreementId()
Element	getAgreementState()
Element	getContext()
Element[]	getGuaranteeTermState()
String	getName()
QName[]	getPropertyNames()
Element[]	getServiceTermState()
Element	getTerms()
TerminateOutputType	terminate(TerminateInputDocument input) Terminates an agreement.

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

AgreementCapability

public AgreementCapability()

Method Detail

getPropertyNames

public QName[] getPropertyNames()

Overrides:

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

Returns:

the resource property QNames

terminate

public TerminateOutputType terminate(TerminateInputDocument input)
                              throws org.apache.muse.ws.addressing.soap.SoapFault

Terminates an agreement.

Parameters:

input - the input document, which may contain an optional termination reason

Returns:

the response document, this is an empty document

Throws:

org.apache.muse.ws.addressing.soap.SoapFault - indicates a fault terminating the agreement

getName

public String getName()
               throws org.apache.muse.ws.resource.faults.ResourceUnknownFault,
                      org.apache.muse.ws.resource.faults.ResourceUnavailableFault

Returns:

the agreement name

Throws:

org.apache.muse.ws.resource.faults.ResourceUnknownFault - the referenced resource is unknown

org.apache.muse.ws.resource.faults.ResourceUnavailableFault - the referenced resource is unavailable

getAgreementId

public Element getAgreementId()
                       throws org.apache.muse.ws.resource.faults.ResourceUnknownFault,
                              org.apache.muse.ws.resource.faults.ResourceUnavailableFault

Returns:

the agreement id

Throws:

org.apache.muse.ws.resource.faults.ResourceUnknownFault - the referenced resource is unknown

org.apache.muse.ws.resource.faults.ResourceUnavailableFault - the referenced resource is unavailable

getContext

public Element getContext()
                   throws org.apache.muse.ws.resource.faults.ResourceUnknownFault,
                          org.apache.muse.ws.resource.faults.ResourceUnavailableFault

Returns:

the agreement context

Throws:

org.apache.muse.ws.resource.faults.ResourceUnknownFault - the referenced resource is unknown

org.apache.muse.ws.resource.faults.ResourceUnavailableFault - the referenced resource is unavailable

getTerms

public Element getTerms()
                 throws org.apache.muse.ws.resource.faults.ResourceUnknownFault,
                        org.apache.muse.ws.resource.faults.ResourceUnavailableFault

Returns:

the agreement terms

Throws:

org.apache.muse.ws.resource.faults.ResourceUnknownFault - the referenced resource is unknown

org.apache.muse.ws.resource.faults.ResourceUnavailableFault - the referenced resource is unavailable

getAgreementState

public Element getAgreementState()
                          throws org.apache.muse.ws.resource.faults.ResourceUnknownFault,
                                 org.apache.muse.ws.resource.faults.ResourceUnavailableFault

Returns:

the agreement state

Throws:

org.apache.muse.ws.resource.faults.ResourceUnknownFault - the referenced resource is unknown

org.apache.muse.ws.resource.faults.ResourceUnavailableFault - the referenced resource is unavailable

getGuaranteeTermState

public Element[] getGuaranteeTermState()
                                throws org.apache.muse.ws.resource.faults.ResourceUnknownFault,
                                       org.apache.muse.ws.resource.faults.ResourceUnavailableFault

Returns:

the agreement guarantee term states

Throws:

org.apache.muse.ws.resource.faults.ResourceUnknownFault - the referenced resource is unknown

org.apache.muse.ws.resource.faults.ResourceUnavailableFault - the referenced resource is unavailable

getServiceTermState

public Element[] getServiceTermState()
                              throws org.apache.muse.ws.resource.faults.ResourceUnknownFault,
                                     org.apache.muse.ws.resource.faults.ResourceUnavailableFault

Returns:

the agreement service term states

Throws:

org.apache.muse.ws.resource.faults.ResourceUnknownFault - the referenced resource is unknown

org.apache.muse.ws.resource.faults.ResourceUnavailableFault - the referenced resource is unavailable