|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.ogf.graap.wsag.client.impl.AgreementImpl
public abstract class AgreementImpl
AgreementImpl
Constructor Summary | |
---|---|
protected |
AgreementImpl(AgreementService agreementClient)
Creates an agreement client for the given agreement service implementation. |
Method Summary | |
---|---|
abstract AgreementClient |
clone()
Returns a copy of the client. |
void |
destroy()
Destroys agreement instance. |
String |
getAgreementId()
Returns the id of the agreement instance. |
AgreementContextType |
getContext()
Returns the context of the agreement instance. |
EndpointReferenceType |
getEndpoint()
Returns the endpoint of the client instance. |
GuaranteeTermStateType |
getGuaranteeTermState(String name)
Returns the guarantee term with the given name. |
GuaranteeTermStateType[] |
getGuaranteeTermStates()
Returns the state for the individual guarantee terms of the agreement instance. |
String |
getName()
Returns the name of the agreement instance. |
Properties |
getProperties()
Returns the properties used by the web-service client. |
ISecurityProperties |
getSecurityProperties()
Returns the security properties used by the web-service client. |
ServiceTermStateType |
getServiceTermState(String name)
Returns the service description term with the given name. |
ServiceTermStateType[] |
getServiceTermStates()
Returns the state for the individual service terms of the agreement instance. |
AgreementStateType |
getState()
Returns the state of the agreement instance. |
TermTreeType |
getTerms()
Returns the terms of the agreement instance. |
boolean |
isUsingTrace()
Determines whether or not a client prints the web-service messages to the console. |
void |
setProperties(Properties properties)
Sets the properties used for the web-service client. |
void |
setTrace(boolean trace)
Sets the clients trace mode. |
void |
terminate()
Terminates an agreement. |
void |
terminate(TerminateInputType reason)
Terminates the agreement instance. |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.ogf.graap.wsag.api.client.AgreementService |
---|
getWebServiceClient |
Constructor Detail |
---|
protected AgreementImpl(AgreementService agreementClient)
agreementClient
- the agreement service clientMethod Detail |
---|
public abstract AgreementClient clone() throws CloneNotSupportedException
clone
in interface AgreementClient
clone
in class Object
CloneNotSupportedException
- indicates that the client implementation does not support cloningpublic AgreementContextType getContext() throws ResourceUnknownException, ResourceUnavailableException
getContext
in interface AgreementService
ResourceUnknownException
- the remote resource is unknown
ResourceUnavailableException
- the remote resource is unavailablepublic GuaranteeTermStateType[] getGuaranteeTermStates() throws ResourceUnknownException, ResourceUnavailableException
getGuaranteeTermStates
in interface AgreementService
ResourceUnknownException
- the remote resource is unknown
ResourceUnavailableException
- the remote resource is unavailablepublic GuaranteeTermStateType getGuaranteeTermState(String name) throws ResourceUnknownException, ResourceUnavailableException
getGuaranteeTermState
in interface AgreementClient
name
- the name of the guarantee term to retrieve
ResourceUnknownException
- the remote resource is unknown
ResourceUnavailableException
- the remote resource is unavailablepublic String getAgreementId() throws ResourceUnknownException, ResourceUnavailableException
getAgreementId
in interface AgreementService
ResourceUnknownException
- the remote resource is unknown
ResourceUnavailableException
- the remote resource is unavailablepublic String getName() throws ResourceUnknownException, ResourceUnavailableException
getName
in interface AgreementService
ResourceUnknownException
- the remote resource is unknown
ResourceUnavailableException
- the remote resource is unavailablepublic ServiceTermStateType[] getServiceTermStates() throws ResourceUnknownException, ResourceUnavailableException
getServiceTermStates
in interface AgreementService
ResourceUnknownException
- the remote resource is unknown
ResourceUnavailableException
- the remote resource is unavailablepublic ServiceTermStateType getServiceTermState(String name) throws ResourceUnknownException, ResourceUnavailableException
getServiceTermState
in interface AgreementClient
name
- the name of the service description term to retrieve
ResourceUnknownException
- the remote resource is unknown
ResourceUnavailableException
- the remote resource is unavailablepublic AgreementStateType getState() throws ResourceUnknownException, ResourceUnavailableException
getState
in interface AgreementService
ResourceUnknownException
- the remote resource is unknown
ResourceUnavailableException
- the remote resource is unavailablepublic TermTreeType getTerms() throws ResourceUnknownException, ResourceUnavailableException
getTerms
in interface AgreementService
ResourceUnknownException
- the remote resource is unknown
ResourceUnavailableException
- the remote resource is unavailablepublic void terminate() throws ResourceUnknownException, ResourceUnavailableException
terminate
in interface AgreementClient
ResourceUnknownException
- the remote resource is unknown
ResourceUnavailableException
- the remote resource is unavailablepublic void terminate(TerminateInputType reason) throws ResourceUnknownException, ResourceUnavailableException
terminate
in interface AgreementService
reason
- a domain-specific termination reason
ResourceUnknownException
- the remote resource is unknown
ResourceUnavailableException
- the remote resource is unavailablepublic void destroy() throws ResourceUnknownException, ResourceUnavailableException
destroy
in interface AgreementService
ResourceUnknownException
- the remote resource is unknown
ResourceUnavailableException
- the remote resource is unavailablepublic EndpointReferenceType getEndpoint()
getEndpoint
in interface WsClient
public Properties getProperties()
getProperties
in interface WsClient
public void setProperties(Properties properties)
setProperties
in interface WsClient
properties
- Sets the properties for this clientpublic boolean isUsingTrace()
isUsingTrace
in interface WsClient
public void setTrace(boolean trace)
setTrace
in interface WsClient
trace
- true, if the web service client should traces incoming/outgoing messages.public ISecurityProperties getSecurityProperties()
getSecurityProperties
in interface WsClient
WsrfResourceClient.getSecurityProperties()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |