org.ogf.graap.wsag.client.api
Class RemoteClient

java.lang.Object
  org.ogf.graap.wsag.client.api.RemoteClient

Direct Known Subclasses:

LocalWsClient, RestRemoteClient, WsrfAgreementFactoryClient, WsrfResourceClient

public class RemoteClient
extends Object

Interface of a remote client. A remote client encapsulates the client object used for communicating with the server application. Different remote technologies can be supported, i.e. REST (HTTP) or SOAP based services.

Author:

Oliver Waeldrich

Constructor Summary

RemoteClient(EndpointReferenceType reference)
Constructs a new remote client with the given reference.

RemoteClient(EndpointReferenceType reference, Properties properties, ISecurityProperties securityProperties)
Constructs a new remote client with the given properties and reference.

RemoteClient(String reference)
Constructs a new remote client with the given remote reference.

RemoteClient(String reference, Properties properties, ISecurityProperties securityProperties)
Constructs a new remote client with the given properties and reference.

Method Summary

Properties	getProperties() Returns the properties used by the web-service client.
EndpointReferenceType	getRemoteReference() Returns the endpoint of the client instance.
ISecurityProperties	getSecurityProperties() Returns the security properties used by the web-service client.
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	setSecurityProperties(ISecurityProperties securityProperties) Sets the security properties used by the web-service client.
void	setTrace(boolean trace) Sets the clients trace mode.

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteClient

public RemoteClient(EndpointReferenceType reference)

Constructs a new remote client with the given reference.

Parameters:

reference - the remote reference

RemoteClient

public RemoteClient(String reference)

Constructs a new remote client with the given remote reference.

Parameters:

reference - the remote reference

RemoteClient

public RemoteClient(EndpointReferenceType reference,
                    Properties properties,
                    ISecurityProperties securityProperties)

Constructs a new remote client with the given properties and reference.

Parameters:

reference - the remote reference

properties - the client properties

securityProperties - the security properties associated with the remote client

RemoteClient

public RemoteClient(String reference,
                    Properties properties,
                    ISecurityProperties securityProperties)

Constructs a new remote client with the given properties and reference.

Parameters:

reference - the remote reference

properties - the client properties

securityProperties - the security properties associated with the remote client

Method Detail

getSecurityProperties

public ISecurityProperties getSecurityProperties()

Returns the security properties used by the web-service client.

Returns:

the security properties for this client

setSecurityProperties

public void setSecurityProperties(ISecurityProperties securityProperties)

Sets the security properties used by the web-service client.

Parameters:

securityProperties - the security properties for this client

getProperties

public Properties getProperties()

Returns the properties used by the web-service client.

Returns:

a list of properties associated with the client

setProperties

public void setProperties(Properties properties)

Sets the properties used for the web-service client.

Parameters:

properties - Sets the properties for this client

getRemoteReference

public EndpointReferenceType getRemoteReference()

Returns the endpoint of the client instance.

Returns:

Returns the endpoint reference for this WS resource.

isUsingTrace

public boolean isUsingTrace()

Determines whether or not a client prints the web-service messages to the console.

Returns:

true, if the web service client traces the incoming/outgoing messages.

setTrace

public void setTrace(boolean trace)

Sets the clients trace mode.

Parameters:

trace - true, if the web service client should traces incoming/outgoing messages.