flexagon.ff.common.core.rest

Class FlexRESTClient

java.lang.Object

flexagon.ff.common.core.rest.FlexRESTClient

Direct Known Subclasses:

FlexRESTPost

public class FlexRESTClient
extends java.lang.Object

Uses Jersey 2.5.1 on server side and 2.24 for plugins. This was created based on various utilities that existed in FlexDeployPlugins to simplify coding when using REST API. Note that after executing a request the client will go stale and subsequent requests will need to generate a new client. FlexRESTClient client = new FlexRESTClient(url, path); client.get();

Constructor Summary

Constructors

Constructor and Description
FlexRESTClient()
FlexRESTClient(java.lang.String pURL)
FlexRESTClient(java.lang.String pURL, java.lang.String pPath)

Method Summary

Modifier and Type	Method and Description
FlexRESTClient	accept(MediaType pMediaType) Sets media type that will be used for builder.
FlexRESTClient	accept(java.lang.String pMediaType) Sets media type that will be used for builder.
FlexRESTClient	addHeader(java.lang.String pKey, java.lang.Object pValue) Adds one header to mHeaders that will be used for builder.
FlexRESTClient	addOverrideCode(int pOverrideCode) Adds an override code to mOverrideCodes that are used for the builder.
FlexRESTClient	addOverrideCodes(java.util.Set<java.lang.Integer> pOverrideCodes) Adds all override codes to mOverrideCodes that are used for the builder.
FlexRESTClient	addQueryParameter(java.lang.String pKey, java.lang.Object pValue) Adds one query parameter to mQueryParameters.
FlexRESTClient	basicauth(java.lang.String user, java.lang.String password) Creates a universal-mode Jersey 2.x HttpAuthenticationFeature for use in the getWebTarget method.
FlexRESTClient	basicauth(java.lang.String user, java.lang.String password, boolean isPreEmptive) Creates a PreEmptive Basic OR universal-mode Jersey 2.x HttpAuthenticationFeature for use in the getWebTarget method.
FlexRESTClient	bearerToken(java.lang.String pToken) Sets Authorization using Bearer token.
FlexRESTClient	clearOverrideCodes() Removes all override codes to mOverride codes that are used for the builder.
FlexRESTClient	cookie(java.lang.String name, java.lang.String value)
static Entity	createFormData(FormDataBodyPart bodyPart) Creates a form data entity and adds the FormDataBodyPart.
static Entity	createFormData(java.util.List<FormDataBodyPart> formData) Creates form data entity based on given list of FormDataBodyPart.
static Entity	createFormData(java.util.Map<java.lang.String,java.lang.Object> form)
static Entity	createFormDataWithInputStream(java.util.Map<java.lang.String,java.lang.Object> form, java.lang.String inputStreamFileName)
FlexRESTClientResponse	delete()
FlexRESTClientResponse	get()
FlexRESTClientResponse	head()
FlexRESTClient	headers(java.util.Map<java.lang.String,java.lang.Object> pHeaders) Sets headers that will be used for builder.
FlexRESTClient	hostnameVerifier(javax.net.ssl.HostnameVerifier verifier)
FlexRESTClient	mediatype(MediaType pMediaType) Sets media type that will be used for builder.
FlexRESTClient	mediatype(java.lang.String pMediaType) Sets media type that will be used for builder.
FlexRESTClient	oauth(java.lang.String pToken) Sets mAuth using the OAuth token provided that will be used for builder.
FlexRESTClientResponse	options()
FlexRESTClientResponse	patch(Entity pBody)
FlexRESTClientResponse	patch(java.lang.String pBody)
FlexRESTClient	path(java.lang.String pPath) Appends a path to the url
FlexRESTClientResponse	post(Entity pBody)
FlexRESTClientResponse	post(java.lang.String pBody)
FlexRESTClientResponse	put(Entity pBody)
FlexRESTClientResponse	put(java.lang.String pBody)
FlexRESTClient	queryparameters(java.util.Map<java.lang.String,java.lang.Object> pQueryParams) Sets mQueryParameters that are used for builder.
FlexRESTClient	queryparameters(java.lang.String pQueryParams)
FlexRESTClient	setConnectTimeout(int pConnectTimeout) Sets connect timeout on client.
FlexRESTClient	setIgnoreSSLErrors(boolean pIgnoreSSLErrors) Sets mIgnoreSSLErrors that is used for builder.
FlexRESTClient	setReadTimeout(int pReadTimeout) Sets read timeout on client.
FlexRESTClient	setRegisterGZip(boolean pRegisterGZip) Sets mRegisterGZip that is used for builder.
FlexRESTClient	setValidateResponse(boolean pValidateResponse)
FlexRESTClient	sslContext(javax.net.ssl.SSLContext sslContext)
FlexRESTClientResponse	trace()
FlexRESTClient	url(java.lang.String pUrl) Sets URL that is used for the builder.
protected void	validateResponse(FlexRESTClientResponse pResponse) Validates FlexRestResponse by checking response codes below 400 and throwing an error if the code number is overriden, then checking above 400 codes and throwing and error if the code number is not overriden.

Methods inherited from class java.lang.Object

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

Constructor Detail

FlexRESTClient

public FlexRESTClient()

FlexRESTClient

public FlexRESTClient(java.lang.String pURL)

FlexRESTClient

public FlexRESTClient(java.lang.String pURL,
                      java.lang.String pPath)

Method Detail

get

public FlexRESTClientResponse get()
                           throws FlexCheckedException,
                                  FlexRestException

Throws:

FlexCheckedException

FlexRestException

post

public FlexRESTClientResponse post(java.lang.String pBody)
                            throws FlexRestException,
                                   FlexCheckedException

Throws:

FlexRestException

FlexCheckedException

post

public FlexRESTClientResponse post(Entity pBody)
                            throws FlexRestException,
                                   FlexCheckedException

Throws:

FlexRestException

FlexCheckedException

put

public FlexRESTClientResponse put(java.lang.String pBody)
                           throws FlexRestException,
                                  FlexCheckedException

Throws:

FlexRestException

FlexCheckedException

put

public FlexRESTClientResponse put(Entity pBody)
                           throws FlexRestException,
                                  FlexCheckedException

Throws:

FlexRestException

FlexCheckedException

patch

public FlexRESTClientResponse patch(java.lang.String pBody)
                             throws FlexRestException,
                                    FlexCheckedException

Throws:

FlexRestException

FlexCheckedException

patch

public FlexRESTClientResponse patch(Entity pBody)
                             throws FlexRestException,
                                    FlexCheckedException

Throws:

FlexRestException

FlexCheckedException

delete

public FlexRESTClientResponse delete()
                              throws FlexRestException,
                                     FlexCheckedException

Throws:

FlexRestException

FlexCheckedException

head

public FlexRESTClientResponse head()
                            throws FlexRestException,
                                   FlexCheckedException

Throws:

FlexRestException

FlexCheckedException

trace

public FlexRESTClientResponse trace()
                             throws FlexRestException,
                                    FlexCheckedException

Throws:

FlexRestException

FlexCheckedException

options

public FlexRESTClientResponse options()
                               throws FlexRestException,
                                      FlexCheckedException

Throws:

FlexRestException

FlexCheckedException

url

public FlexRESTClient url(java.lang.String pUrl)

Sets URL that is used for the builder. You can set the host here and use path later or set the whole url.

Parameters:

pUrl - - Url for rest api.

Returns:

RestService after updating url.

path

public FlexRESTClient path(java.lang.String pPath)

Appends a path to the url

Parameters:

pPath - - Path/resource for rest api.

Returns:

RestService after updating url.

addOverrideCode

public FlexRESTClient addOverrideCode(int pOverrideCode)

Adds an override code to mOverrideCodes that are used for the builder.

Parameters:

pOverrideCode - - Rest response code that will be ignored if above 400 or cause an exception if under 400.

Returns:

RestService after updating mOverrideCodes.

addOverrideCodes

public FlexRESTClient addOverrideCodes(java.util.Set<java.lang.Integer> pOverrideCodes)

Adds all override codes to mOverrideCodes that are used for the builder.

Parameters:

pOverrideCodes - - Set of Rest response codes that will be ignored if above 400 or cause an exception if under 400.

Returns:

RestService after updating mOverrideCodes.

clearOverrideCodes

public FlexRESTClient clearOverrideCodes()

Removes all override codes to mOverride codes that are used for the builder.

Returns:

RestService after updating mOverrideCodes.

hostnameVerifier

public FlexRESTClient hostnameVerifier(javax.net.ssl.HostnameVerifier verifier)

sslContext

public FlexRESTClient sslContext(javax.net.ssl.SSLContext sslContext)

setIgnoreSSLErrors

public FlexRESTClient setIgnoreSSLErrors(boolean pIgnoreSSLErrors)

Sets mIgnoreSSLErrors that is used for builder.

Parameters:

pIgnoreSSLErrors - - boolean representing whether or not SSL errors will be ignored.

Returns:

RestService after updating mIgnoreSSLErrors.

setRegisterGZip

public FlexRESTClient setRegisterGZip(boolean pRegisterGZip)

Sets mRegisterGZip that is used for builder.

Parameters:

pRegisterGZip - - boolean representing whether or not register G zip is required.

Returns:

RestService after updating mRegisterGZip.

queryparameters

public FlexRESTClient queryparameters(java.util.Map<java.lang.String,java.lang.Object> pQueryParams)

Sets mQueryParameters that are used for builder.

Parameters:

pQueryParams - - Map of query parameters to use in REST request.

Returns:

RestService after updating mQueryParameters.

queryparameters

public FlexRESTClient queryparameters(java.lang.String pQueryParams)

addQueryParameter

public FlexRESTClient addQueryParameter(java.lang.String pKey,
                                        java.lang.Object pValue)

Adds one query parameter to mQueryParameters.

Parameters:

pKey -

pValue -

Returns:

RestService after updating mQueryParameters.

mediatype

public FlexRESTClient mediatype(java.lang.String pMediaType)

Sets media type that will be used for builder.

Parameters:

pMediaType - - Media type of the body that will be sent in the REST request.

Returns:

RestService after updating mMediaType.

mediatype

public FlexRESTClient mediatype(MediaType pMediaType)

Sets media type that will be used for builder.

Parameters:

pMediaType - - Media type of the body that will be sent in the REST request.

Returns:

RestService after updating mMediaType.

accept

public FlexRESTClient accept(java.lang.String pMediaType)

Sets media type that will be used for builder.

Parameters:

pMediaType - - Media type of the body that will be sent in the REST request.

Returns:

RestService after updating mMediaType.

accept

public FlexRESTClient accept(MediaType pMediaType)

Sets media type that will be used for builder.

Parameters:

pMediaType - - Media type of the body that will be sent in the REST request.

Returns:

RestService after updating mMediaType.

headers

public FlexRESTClient headers(java.util.Map<java.lang.String,java.lang.Object> pHeaders)

Sets headers that will be used for builder.

Parameters:

pHeaders - - Map of headers that will be sent in REST request.

Returns:

RestService after updating mHeaders.

addHeader

public FlexRESTClient addHeader(java.lang.String pKey,
                                java.lang.Object pValue)

Adds one header to mHeaders that will be used for builder.

Parameters:

pKey -

pValue -

Returns:

RestService after updating mHeaders.

setConnectTimeout

public FlexRESTClient setConnectTimeout(int pConnectTimeout)

Sets connect timeout on client. I.E. How long it should wait to establish a connection.

Parameters:

pConnectTimeout - - In milliseconds

Returns:

setReadTimeout

public FlexRESTClient setReadTimeout(int pReadTimeout)

Sets read timeout on client. I.E. How long should we wait to receive a response after establishing a connection.

Parameters:

pReadTimeout - - In milliseconds

Returns:

oauth

public FlexRESTClient oauth(java.lang.String pToken)

Sets mAuth using the OAuth token provided that will be used for builder.

Parameters:

pToken - - OAuth token that will be used for REST request.

Returns:

- RestService after updating mAuth.

bearerToken

public FlexRESTClient bearerToken(java.lang.String pToken)

Sets Authorization using Bearer token.

Parameters:

pToken - - OAuth token that will be used for REST request.

Returns:

- RestService after updating mAuth.

cookie

public FlexRESTClient cookie(java.lang.String name,
                             java.lang.String value)

basicauth

public FlexRESTClient basicauth(java.lang.String user,
                                java.lang.String password)

Creates a universal-mode Jersey 2.x HttpAuthenticationFeature for use in the getWebTarget method.

Parameters:

user -

password -

Returns:

- the RestService after updating mAuth

basicauth

public FlexRESTClient basicauth(java.lang.String user,
                                java.lang.String password,
                                boolean isPreEmptive)

Creates a PreEmptive Basic OR universal-mode Jersey 2.x HttpAuthenticationFeature for use in the getWebTarget method.

Parameters:

user - - username

password - - password

isPreEmptive -

Returns:

- the RestService after updating mAuth

setValidateResponse

public FlexRESTClient setValidateResponse(boolean pValidateResponse)

validateResponse

protected void validateResponse(FlexRESTClientResponse pResponse)
                         throws FlexRestException

Validates FlexRestResponse by checking response codes below 400 and throwing an error if the code number is overriden, then checking above 400 codes and throwing and error if the code number is not overriden.

Parameters:

pResponse - - response from REST request.

Throws:

FlexCheckedException

FlexRestException

createFormData

public static Entity createFormData(java.util.List<FormDataBodyPart> formData)

Creates form data entity based on given list of FormDataBodyPart.

Parameters:

formData -

Returns:

createFormData

public static Entity createFormData(FormDataBodyPart bodyPart)

Creates a form data entity and adds the FormDataBodyPart.

Parameters:

bodyPart -

Returns:

createFormDataWithInputStream

public static Entity createFormDataWithInputStream(java.util.Map<java.lang.String,java.lang.Object> form,
                                                   java.lang.String inputStreamFileName)

createFormData

public static Entity createFormData(java.util.Map<java.lang.String,java.lang.Object> form)