org.resthub.web.oauth2

Class OAuth2RequestFilter

java.lang.Object

org.resthub.web.oauth2.OAuth2RequestFilter

All Implemented Interfaces:

com.ning.http.client.filter.RequestFilter

public class OAuth2RequestFilter
extends Object
implements com.ning.http.client.filter.RequestFilter

HTTP client filter that deals with OAuth2.0 Token authentication

See Also:

OAuth2Config

Field Summary

Fields

Modifier and Type	Field and Description
protected String	accessTokenEndPoint
protected long	acquireTime
static String	CLIENT_ID_PARAMETER_NAME
static String	CLIENT_SECRET_PARAMETER_NAME
protected String	clientId
protected String	clientSecret
static String	GRANT_TYPE_PARAMETER_NAME
protected String	password
static String	PASSWORD_PARAMETER_NAME
static String	PASSWORD_PARAMETER_VALUE
protected String	scheme_name
static String	SCOPE_PARAMETER_NAME
protected OAuth2Token	token
protected String	username
static String	USERNAME_PARAMETER_NAME

Constructor Summary

Constructors

Constructor and Description
OAuth2RequestFilter(String accessTokenEndPoint, String clientId, String clientSecret) Request filter that acquires an OAuth token if: no token has been acquired the current token is expired, given its "ExpiresIn" information

Method Summary

Methods

Modifier and Type	Method and Description
com.ning.http.client.filter.FilterContext	filter(com.ning.http.client.filter.FilterContext ctx)
String	getAccessTokenEndPoint()
String	getClientId()
String	getClientSecret()
String	getSchemeName()
void	setAccessTokenEndPoint(String accessTokenEndPoint)
void	setClientId(String clientId)
void	setClientSecret(String clientSecret)
void	setCredentials(String username, String password)
void	setSchemeName(String scheme_name)

Methods inherited from class java.lang.Object

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

Field Detail

GRANT_TYPE_PARAMETER_NAME

public static final String GRANT_TYPE_PARAMETER_NAME

See Also:

Constant Field Values

CLIENT_ID_PARAMETER_NAME

public static final String CLIENT_ID_PARAMETER_NAME

See Also:

Constant Field Values

CLIENT_SECRET_PARAMETER_NAME

public static final String CLIENT_SECRET_PARAMETER_NAME

See Also:

Constant Field Values

USERNAME_PARAMETER_NAME

public static final String USERNAME_PARAMETER_NAME

See Also:

Constant Field Values

PASSWORD_PARAMETER_NAME

public static final String PASSWORD_PARAMETER_NAME

See Also:

Constant Field Values

SCOPE_PARAMETER_NAME

public static final String SCOPE_PARAMETER_NAME

See Also:

Constant Field Values

PASSWORD_PARAMETER_VALUE

public static final String PASSWORD_PARAMETER_VALUE

See Also:

Constant Field Values

accessTokenEndPoint

protected String accessTokenEndPoint

clientId

protected String clientId

clientSecret

protected String clientSecret

scheme_name

protected String scheme_name

username

protected String username

password

protected String password

acquireTime

protected long acquireTime

token

protected OAuth2Token token

Constructor Detail

OAuth2RequestFilter

public OAuth2RequestFilter(String accessTokenEndPoint,
                   String clientId,
                   String clientSecret)

Request filter that acquires an OAuth token if:

• no token has been acquired
• the current token is expired, given its "ExpiresIn" information

Parameters:

accessTokenEndPoint - URL where the OAuth2.0 client should request access tokens

clientId - id of the OAuth2.0 client

clientSecret - secret of the OAuth2.0 client

Method Detail

setCredentials

public void setCredentials(String username,
                  String password)

getAccessTokenEndPoint

public String getAccessTokenEndPoint()

setAccessTokenEndPoint

public void setAccessTokenEndPoint(String accessTokenEndPoint)

getClientId

public String getClientId()

setClientId

public void setClientId(String clientId)

getClientSecret

public String getClientSecret()

setClientSecret

public void setClientSecret(String clientSecret)

getSchemeName

public String getSchemeName()

setSchemeName

public void setSchemeName(String scheme_name)

filter

public com.ning.http.client.filter.FilterContext filter(com.ning.http.client.filter.FilterContext ctx)
                                                 throws com.ning.http.client.filter.FilterException

Specified by:

filter in interface com.ning.http.client.filter.RequestFilter

Throws:

com.ning.http.client.filter.FilterException