Interface URISpecifier

    • Method Detail

      • getResourceType

        java.lang.String getResourceType()
        Retrieves the type of Resource (e.g. Analysis Engine, CAS Consumer) that the service at this URI is expected to implement. This is optional, but useful for clients to know what to do with the URISpecifier.
        Returns:
        the type of Resource. This should be one of the constants on this class, or null if the resource type is not specified.
      • setResourceType

        void setResourceType​(java.lang.String aResourceType)
        Sets the type of Resource (e.g. Analysis Engine, CAS Consumer) that the service at this URI is expected to implement. This is optional, but useful for clients to know what to do with the URISpecifier.
        Parameters:
        aResourceType - the type of Resource. This should be one of the constants on this class, or null to indicate that the resource type is not specified.
      • getUri

        java.lang.String getUri()
        Retrieves the URI at which a Resource may be located.
        Returns:
        a URI string
      • getProtocol

        java.lang.String getProtocol()
        Gets the name of the Protocol used to communicate with the service. Protocol names are defined in the Constants class.
        Returns:
        the name of the protocol.
      • getTimeout

        java.lang.Integer getTimeout()
        Gets the timeout period in milliseconds. If a call takes longer than this amount of time, an exception will be thrown.
        Returns:
        the timeout period in milliseconds. A null value indicates that the transport layer's default value will be used.
      • setUri

        void setUri​(java.lang.String aUri)
        Sets the URI at which a Resource may be located.
        Parameters:
        aUri - a URI string
      • setProtocol

        void setProtocol​(java.lang.String aProtocol)
        Sets the name of the Protocol used to communicate with the service. Protocol names are defined in the Constants class.
        Parameters:
        aProtocol - the name of the protocol.
      • setTimeout

        void setTimeout​(java.lang.Integer aTimeout)
        Sets the timeout period in milliseconds. If a call takes longer than this amount of time, an exception will be thrown.
        Parameters:
        aTimeout - the timeout period in milliseconds. A null value indicates that the transport layer's default value will be used.
      • getParameters

        Parameter[] getParameters()
        Returns:
        Returns the Parameters.
      • setParameters

        void setParameters​(Parameter[] parameters)
        Parameters:
        parameters - The Parameters to set.