cytoscape.data.webservice
Class WebServiceClientImpl<S>

java.lang.Object
  cytoscape.data.webservice.WebServiceClientImpl<S>

Type Parameters:

S - Stub object type. This is service dependent.

All Implemented Interfaces:

CyWebServiceEventListener, WebServiceClient<S>, Serializable, EventListener

Direct Known Subclasses:

WebServiceClientImplWithGUI

public abstract class WebServiceClientImpl<S>
extends Object
implements Serializable, WebServiceClient<S>, CyWebServiceEventListener

Abstract class for all web service clients. All clients MUST extend this class.

Since:

Cytoscape 2.6

Version:

0.5

Author:

Keiichiro Ono

See Also:

Serialized Form

Field Summary

protected Collection<Method>	availableMethods
protected String	clientID
protected S	clientStub
protected static String	DEF_DISPLAY_NAME
protected static String	DEF_NAME
protected String	description
protected String	displayName
protected ModuleProperties	props
protected WebServiceClientManager.ClientType[]	type

Constructor Summary

WebServiceClientImpl()
Creates a new WebServiceClientImpl object.

WebServiceClientImpl(String serviceName, String displayName)
Creates a new WebServiceClientImpl object.

WebServiceClientImpl(String serviceName, String displayName, WebServiceClientManager.ClientType[] types)
Creates a new WebServiceClientImpl object.

WebServiceClientImpl(String serviceName, String displayName, WebServiceClientManager.ClientType[] types, ModuleProperties props)
Creates a new WebServiceClientImpl object.

WebServiceClientImpl(String serviceName, String displayName, WebServiceClientManager.ClientType[] types, ModuleProperties props, S clientStub)
Creates a new WebServiceClientImpl object.

Method Summary

abstract void	executeService(CyWebServiceEvent e) Execute the service through event handling system.
Collection<Method>	getAccessibleMethods() DOCUMENT ME!
String	getClientID() DOCUMENT ME!
S	getClientStub() Client stub will be returned from this.
WebServiceClientManager.ClientType[]	getClientType() DOCUMENT ME!
String	getDescription() DOCUMENT ME!
String	getDisplayName() DOCUMENT ME!
ModuleProperties	getProps() DOCUMENT ME!
boolean	isCompatibleType(WebServiceClientManager.ClientType ct) DOCUMENT ME!
void	setClientStub(S stub) Set stub to this client.
void	setDescription(String description) DOCUMENT ME!
void	setProps(ModuleProperties props) DOCUMENT ME!

Methods inherited from class java.lang.Object

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

Field Detail

DEF_NAME

protected static final String DEF_NAME

See Also:

Constant Field Values

DEF_DISPLAY_NAME

protected static final String DEF_DISPLAY_NAME

See Also:

Constant Field Values

clientStub

protected S clientStub

clientID

protected String clientID

displayName

protected String displayName

type

protected WebServiceClientManager.ClientType[] type

props

protected ModuleProperties props

availableMethods

protected Collection<Method> availableMethods

description

protected String description

Constructor Detail

WebServiceClientImpl

public WebServiceClientImpl()

Creates a new WebServiceClientImpl object.

WebServiceClientImpl

public WebServiceClientImpl(String serviceName,
                            String displayName)

Creates a new WebServiceClientImpl object.

Parameters:

serviceName - DOCUMENT ME!

displayName - DOCUMENT ME!

WebServiceClientImpl

public WebServiceClientImpl(String serviceName,
                            String displayName,
                            WebServiceClientManager.ClientType[] types)

Creates a new WebServiceClientImpl object.

Parameters:

serviceName - DOCUMENT ME!

displayName - DOCUMENT ME!

types - DOCUMENT ME!

WebServiceClientImpl

public WebServiceClientImpl(String serviceName,
                            String displayName,
                            WebServiceClientManager.ClientType[] types,
                            ModuleProperties props)

Creates a new WebServiceClientImpl object.

Parameters:

serviceName - DOCUMENT ME!

displayName - DOCUMENT ME!

types - DOCUMENT ME!

props - DOCUMENT ME!

WebServiceClientImpl

public WebServiceClientImpl(String serviceName,
                            String displayName,
                            WebServiceClientManager.ClientType[] types,
                            ModuleProperties props,
                            S clientStub)

Creates a new WebServiceClientImpl object.

Parameters:

serviceName - DOCUMENT ME!

displayName - DOCUMENT ME!

types - DOCUMENT ME!

props - DOCUMENT ME!

Method Detail

getAccessibleMethods

public Collection<Method> getAccessibleMethods()

DOCUMENT ME!

Specified by:

getAccessibleMethods in interface WebServiceClient<S>

Returns:

DOCUMENT ME!

getDisplayName

public String getDisplayName()

DOCUMENT ME!

Specified by:

getDisplayName in interface WebServiceClient<S>

Returns:

DOCUMENT ME!

getClientID

public String getClientID()

DOCUMENT ME!

Specified by:

getClientID in interface WebServiceClient<S>

Returns:

DOCUMENT ME!

getClientType

public WebServiceClientManager.ClientType[] getClientType()

DOCUMENT ME!

Specified by:

getClientType in interface WebServiceClient<S>

Returns:

DOCUMENT ME!

See Also:

WebServiceClientManager.ClientType

isCompatibleType

public boolean isCompatibleType(WebServiceClientManager.ClientType ct)

DOCUMENT ME!

Specified by:

isCompatibleType in interface WebServiceClient<S>

Parameters:

ct - DOCUMENT ME!

Returns:

DOCUMENT ME!

getClientStub

public S getClientStub()

Client stub will be returned from this. All services are accessible thorough this stub.

Specified by:

getClientStub in interface WebServiceClient<S>

Returns:

DOCUMENT ME!

getProps

public ModuleProperties getProps()

DOCUMENT ME!

Specified by:

getProps in interface WebServiceClient<S>

Returns:

DOCUMENT ME!

setProps

public void setProps(ModuleProperties props)

DOCUMENT ME!

Specified by:

setProps in interface WebServiceClient<S>

Parameters:

props - DOCUMENT ME!

getDescription

public String getDescription()

DOCUMENT ME!

Specified by:

getDescription in interface WebServiceClient<S>

Returns:

DOCUMENT ME!

setDescription

public void setDescription(String description)

DOCUMENT ME!

Specified by:

setDescription in interface WebServiceClient<S>

Parameters:

description - DOCUMENT ME!

setClientStub

public void setClientStub(S stub)

Description copied from interface: WebServiceClient

Set stub to this client.

Specified by:

setClientStub in interface WebServiceClient<S>

executeService

public abstract void executeService(CyWebServiceEvent e)
                             throws CyWebServiceException

Execute the service through event handling system.

Specified by:

executeService in interface CyWebServiceEventListener

Parameters:

e - DOCUMENT ME!

Throws:

CyWebServiceException