gr.iccs.isense.circ4life.rest.client

Class RESTWebServiceClient

java.lang.Object

gr.iccs.isense.circ4life.rest.client.RESTWebServiceClient

public abstract class RESTWebServiceClient
extends Object

Common REST Web Service client functionality.

Author:

Miltiadis Koutsokeras, miltos.koutsokeras@iccs.gr

Field Summary

Fields

Modifier and Type	Field and Description
static Logger	logger Logger.

Constructor Summary

Constructors

Constructor and Description
RESTWebServiceClient()

Method Summary

Modifier and Type	Method and Description
protected javax.ws.rs.client.Client	buildJerseyClient(javax.ws.rs.ext.ContextResolver<com.fasterxml.jackson.databind.ObjectMapper> jsoncxtresolver) Build a JAX-RS Client from Jersey Builder instead of automatic service provider client.
boolean	endSession() End a user session by contacting the Access Control Manager using the current authorization session tokens.
abstract String	getClientID()
String	getPassword()
String	getUsername()
boolean	refreshSession() Refresh a user session to avoid expiration of access.
abstract void	setHTTPHeader(String name, String value) Set HTTP header for all subsequent requests (e.g.
void	setPassword(String password) Set the password to use for the authorized HTTP session.
protected void	setSession(AccessControlManager.AccessTokens accesstokens) Set the access tokens of this client to the specified ones.
void	setUsername(String username) Set the username to use for the authorized HTTP session.
boolean	startSession() Start a user session by contacting the Access Control Manager for authentication using the credentials set with setUsername(String) and setPassword(String).

Methods inherited from class java.lang.Object

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

Field Detail

logger

public static final Logger logger

Logger.

Constructor Detail

RESTWebServiceClient

public RESTWebServiceClient()

Method Detail

getClientID

public abstract String getClientID()

Returns:

the Access Control Manager registered Client ID this client should use.

setHTTPHeader

public abstract void setHTTPHeader(String name,
                                   String value)

Set HTTP header for all subsequent requests (e.g. Authorization).

Parameters:

name - the name of the HTTP header.

value - the value of the HTTP header.

getUsername

public String getUsername()

Returns:

the username to use for the authorized HTTP session.

setUsername

public void setUsername(String username)

Set the username to use for the authorized HTTP session.

Parameters:

username - the username to use for the authorized HTTP session.

getPassword

public String getPassword()

Returns:

the password to use for the authorized HTTP session.

setPassword

public void setPassword(String password)

Set the password to use for the authorized HTTP session.

Parameters:

password - the password to use for the authorized HTTP session.

startSession

public boolean startSession()

Start a user session by contacting the Access Control Manager for authentication using the credentials set with setUsername(String) and setPassword(String). Once this method returns true all requests to the web service will be performed with proper authorization and protected resources will be available.

Returns:

true if user session is authenticated, false otherwise.

endSession

public boolean endSession()

End a user session by contacting the Access Control Manager using the current authorization session tokens. Once this method returns true the user session is finished and all requests to the web service will only succeed for unprotected resources and fail for protected ones.

Returns:

true if user session is properly ended, false otherwise.

refreshSession

public boolean refreshSession()

Refresh a user session to avoid expiration of access.

Returns:

true if session access is refreshed successfully, false otherwise.

setSession

protected void setSession(AccessControlManager.AccessTokens accesstokens)

Set the access tokens of this client to the specified ones. End the current session if it is active. If the provided object is null, nothing is done.

Parameters:

accesstokens - valid access tokens.

buildJerseyClient

protected javax.ws.rs.client.Client buildJerseyClient(javax.ws.rs.ext.ContextResolver<com.fasterxml.jackson.databind.ObjectMapper> jsoncxtresolver)

Build a JAX-RS Client from Jersey Builder instead of automatic service provider client.

Parameters:

jsoncxtresolver - the JSON object mapper context resolver.

Returns:

a new Client object from the JerseyClientBuilder.