Package org.springframework.extensions.webscripts

Class ScriptRemoteConnector

java.lang.Object
org.springframework.extensions.webscripts.ScriptRemoteConnector
public final class ScriptRemoteConnector extends Object
Describes a connector to a remote endpoint. This is a wrapper around the true connector object and it provides Script-style interfaces for working with buffered response strings and the like.
Author:
muzquiano, kevinr

  • Constructor Details

    • ScriptRemoteConnector

      public ScriptRemoteConnector(Connector connector, RemoteConfigElement.EndpointDescriptor descriptor)
      Constructor
      Parameters:
      connector - The Connector to wrap
      descriptor - The description of the endpoint this connector is managing

  • Method Details

    • call

      public Response call(String uri)
      Invokes a URI on the endpoint via a GET request.
      Parameters:
      uri - the uri
      Returns:
      Response object from the call Response

    • get

      public Response get(String uri)
      Invokes a GET request URI on the endpoint.
      Parameters:
      uri - the uri
      Returns:
      Response object from the call Response

    • post

      public Response post(String uri, String body)
      Invokes a URI on a remote service, passing the supplied body as a POST request.
      Parameters:
      uri - Uri to call on the endpoint
      body - Body of the POST request.
      Returns:
      Response object from the call Response

    • post

      public Response post(String uri, String body, String contentType)
      Invokes a URI on a remote service, passing the supplied body as a POST request.
      Parameters:
      uri - Uri to call on the endpoint
      body - Body of the POST request.
      contentType - Content mimetype of the request body
      Returns:
      Response object from the call Response

    • put

      public Response put(String uri, String body)
      Invokes a URI on a remote service, passing the supplied body as a PUT request.
      Parameters:
      uri - Uri to call on the endpoint
      body - Body of the PUT request.
      Returns:
      Response object from the call Response

    • put

      public Response put(String uri, String body, String contentType)
      Invokes a URI on a remote service, passing the supplied body as a PUT request.
      Parameters:
      uri - Uri to call on the endpoint
      body - Body of the PUT request.
      contentType - Content mimetype of the request
      Returns:
      Response object from the call Response

    • del

      public Response del(String uri)
      Invokes a URI on a remote service as DELETE request. NOTE: the name of the method is 'del' not 'delete' so as to not interfere with JavaScript Object.delete() method.
      Parameters:
      uri - Uri to call on the endpoint
      Returns:
      Response object from the call Response

    • getEndpoint

      public String getEndpoint()
      Returns the endpoint string
      Returns:
      endpoint

    • getDescriptor

      public RemoteConfigElement.EndpointDescriptor getDescriptor()
      Returns:
      the endpoint descriptor object