Class AccessCheckResource

java.lang.Object
esendex.sdk.java.service.resource.base.Resource
esendex.sdk.java.service.resource.access.AccessCheckResource

public class AccessCheckResource extends Resource
This resource is used to provide a simple method of checking if a user�s credentials or session ID are valid to access the Esendex API. It is a safe method of performing an operation on a resource with no side-effects.
Author:
Mike Whittaker
  • Constructor Details

    • AccessCheckResource

      public AccessCheckResource(Authenticator auth, String account)
      Instantiates a new access check resource.
      Parameters:
      auth - the authenticator
      account - the account
  • Method Details

    • getRequestMethod

      protected HttpRequestMethod getRequestMethod()
      Gets the HttpRequestMethod that this service stipulates eg GET, POST, PUT, DELETE.
      Specified by:
      getRequestMethod in class Resource
      Returns:
      the required HttpRequestMethod
    • getEndpointChild

      protected String getEndpointChild()
      Gets the child portion of the url required to access the resource. The child part is appended to the base url and must not start with a '/' The base url is of the form 'http://api.esendex.com/{version}/' where version maybe similar to 'v1.0'
      Specified by:
      getEndpointChild in class Resource
      Returns:
      the child portion of the url required to access this resource