Class AbstractWebServiceClient
- java.lang.Object
-
- org.cytoscape.io.webservice.client.AbstractWebServiceClient
-
- All Implemented Interfaces:
WebServiceClient
- Direct Known Subclasses:
AbstractWebServiceGUIClient
public abstract class AbstractWebServiceClient extends Object implements WebServiceClient
Abstract class for all web service clients. All clients MUST extend this class.Module:
webservice-api
To use this in your app, include the following dependency in your POM:
<dependency> <groupId>org.cytoscape</groupId> <artifactId>webservice-api</artifactId> </dependency>
Cytoscape Backwards Compatibility (Abstract Class): This class is abstract and meant to be extended by users. This means that we may add methods for minor version updates. Methods will only be removed for major version updates.
-
-
Constructor Summary
Constructors Constructor Description AbstractWebServiceClient(String uri, String displayName, String description)
Constructs this AbstractWebServiceClient.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getDescription()
Get human-readable description of this client.String
getDisplayName()
Returns display name of this client.URI
getServiceLocation()
Returns resource location of this service, i.e., service URL.String
toString()
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.cytoscape.io.webservice.WebServiceClient
createTaskIterator
-
-
-
-
Method Detail
-
getDisplayName
public final String getDisplayName()
Description copied from interface:WebServiceClient
Returns display name of this client. This is more human readable name for this client. This may not be unique.- Specified by:
getDisplayName
in interfaceWebServiceClient
- Returns:
- display name for this client.
-
getDescription
public final String getDescription()
Description copied from interface:WebServiceClient
Get human-readable description of this client.- Specified by:
getDescription
in interfaceWebServiceClient
- Returns:
- Description as a string. Users should write parser for this return value.
-
getServiceLocation
public final URI getServiceLocation()
Description copied from interface:WebServiceClient
Returns resource location of this service, i.e., service URL. This is guaranteed to be globally unique and can be used as identifier.- Specified by:
getServiceLocation
in interfaceWebServiceClient
- Returns:
- URI of the service.
-
-