Class AbstractWebServiceClient

  • All Implemented Interfaces:
    Direct Known Subclasses:

    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:


    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 Detail

      • AbstractWebServiceClient

        public AbstractWebServiceClient​(String uri,
                                        String displayName,
                                        String description)
        Constructs this AbstractWebServiceClient.
        uri - Service Location.
    • 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 interface WebServiceClient
        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 interface WebServiceClient
        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 interface WebServiceClient
        URI of the service.