org.safs.rest

Class REST

java.lang.Object

org.safs.rest.REST

public class REST
extends java.lang.Object

Author:

Carl Nagle

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	REST.DELETE
static class	REST.GET
static class	REST.HEAD
static class	REST.PATCH
static class	REST.POST
static class	REST.PUT

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DELETE_METHOD
static java.lang.String	GET_METHOD
static java.lang.String	HEAD_METHOD
static java.lang.String	PATCH_METHOD
static java.lang.String	POST_METHOD
static java.lang.String	PUT_METHOD
static RESTImpl	restImpl

Constructor Summary

Constructors

Constructor and Description
REST()

Method Summary

Modifier and Type	Method and Description
static void	EndServiceSession(java.lang.String serviceId) End an existing named Service session with a specific web service. This doesn't actually make any type of Connection or call to the web service.
static Response	request(java.lang.String serviceId, java.lang.String requestMethod, java.lang.String relativeURI, java.lang.String headers, java.lang.Object body)
static Service	StartServiceSession(java.lang.String serviceId, java.lang.String baseURL) Start a named Service session with a specific web service. This doesn't actually make any type of Connection or call to the web service.
static Service	StartServiceSession(java.lang.String serviceId, java.lang.String baseURL, java.lang.String protocolVersion) Start a named Service session with a specific web service. This doesn't actually make any type of Connection or call to the web service.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

GET_METHOD

public static final java.lang.String GET_METHOD

See Also:

Constant Field Values

POST_METHOD

public static final java.lang.String POST_METHOD

See Also:

Constant Field Values

DELETE_METHOD

public static final java.lang.String DELETE_METHOD

See Also:

Constant Field Values

PUT_METHOD

public static final java.lang.String PUT_METHOD

See Also:

Constant Field Values

HEAD_METHOD

public static final java.lang.String HEAD_METHOD

See Also:

Constant Field Values

PATCH_METHOD

public static final java.lang.String PATCH_METHOD

See Also:

Constant Field Values

restImpl

public static RESTImpl restImpl

Constructor Detail

REST

public REST()

Method Detail

StartServiceSession

public static Service StartServiceSession(java.lang.String serviceId,
                                          java.lang.String baseURL)
                                   throws java.lang.IllegalArgumentException

Start a named Service session with a specific web service.
This doesn't actually make any type of Connection or call to the web service.

Parameters:

serviceId - - unique name of the new Service session.

baseURL - -- root URL used to interact with the service.

Returns:

Service

Throws:

java.lang.IllegalArgumentException - if the serviceId is null or already exists.

See Also:

EndServiceSession(String), Services.getService(String)

StartServiceSession

public static Service StartServiceSession(java.lang.String serviceId,
                                          java.lang.String baseURL,
                                          java.lang.String protocolVersion)
                                   throws java.lang.IllegalArgumentException

Start a named Service session with a specific web service.
This doesn't actually make any type of Connection or call to the web service.

Parameters:

serviceId - - unique name of the new Service session.

baseURL - -- root URL used to interact with the service.

Returns:

Service

Throws:

java.lang.IllegalArgumentException - if the serviceId is null or already exists.

See Also:

EndServiceSession(String), Services.getService(String)

EndServiceSession

public static void EndServiceSession(java.lang.String serviceId)
                              throws java.lang.IllegalArgumentException

End an existing named Service session with a specific web service.
This doesn't actually make any type of Connection or call to the web service.

Parameters:

serviceId - - unique name of the Service session.

Throws:

java.lang.IllegalArgumentException - if the serviceId is null or does NOT exists.

See Also:

StartServiceSession(String, String)

request

public static Response request(java.lang.String serviceId,
                               java.lang.String requestMethod,
                               java.lang.String relativeURI,
                               java.lang.String headers,
                               java.lang.Object body)