Class SessionResource
java.lang.Object
esendex.sdk.java.service.resource.base.Resource
esendex.sdk.java.service.resource.base.XmlResponderResource<SessionDto>
esendex.sdk.java.service.resource.access.SessionResource
The Session Constructor resource is used to generate a unique Esendex API
session GUID. A successful HTTP POST request to the Constructor URI requires
a valid Basic Authentication header of Base64 encoded username and password
to be supplied.
- Author:
- Mike Whittaker
-
Constructor Summary
ConstructorsConstructorDescriptionThe session resource must be authenticated with Basic Authentication. -
Method Summary
Modifier and TypeMethodDescriptionprotected String
Gets the child portion of the url required to access the resource.protected HttpRequestMethod
Gets the HttpRequestMethod that this service stipulates eg GET, POST, PUT, DELETE.Methods inherited from class esendex.sdk.java.service.resource.base.XmlResponderResource
execute, getResponseObject
Methods inherited from class esendex.sdk.java.service.resource.base.Resource
getAccount, getEndpoint, getId, getRequestData, getResponse, isHttpOkay
-
Constructor Details
-
SessionResource
The session resource must be authenticated with Basic Authentication. Thereafter other resources may be authenticated with a SessionAuthenticator.- Parameters:
auth
- the authenticator
-
-
Method Details
-
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 classResource
- Returns:
- the child portion of the url required to access this resource
-
getRequestMethod
Gets the HttpRequestMethod that this service stipulates eg GET, POST, PUT, DELETE.- Specified by:
getRequestMethod
in classResource
- Returns:
- the required HttpRequestMethod
-