org.apache.shindig.gadgets.oauth2

Class BasicOAuth2Message

java.lang.Object

org.apache.shindig.gadgets.oauth2.BasicOAuth2Message

All Implemented Interfaces:

OAuth2Message

public class BasicOAuth2Message
extends Object
implements OAuth2Message

See OAuth2Message

Field Summary

Fields inherited from interface org.apache.shindig.gadgets.oauth2.OAuth2Message

ACCESS_DENIED, ACCESS_TOKEN, AUTHORIZATION, AUTHORIZATION_CODE, AUTHORIZATION_HEADER, BASIC_AUTH_TYPE, BEARER_TOKEN_TYPE, BODYHASH, CLIENT_CREDENTIALS, CLIENT_ID, CLIENT_SECRET, CONFIDENTIAL_CLIENT_TYPE, ERROR, ERROR_DESCRIPTION, ERROR_URI, EXPIRES_IN, GRANT_TYPE, HMAC_SHA_1, HMAC_SHA_256, ID, INVALID_CLIENT, INVALID_GRANT, INVALID_REQUEST, INVALID_SCOPE, MAC, MAC_ALGORITHM, MAC_EXT, MAC_HEADER, MAC_SECRET, MAC_TOKEN_TYPE, NO_GRANT_TYPE, NONCE, PUBLIC_CLIENT_TYPE, REDIRECT_URI, REFRESH_TOKEN, RESPONSE_TYPE, SCOPE, SERVER_ERROR, SHARED_TOKEN, STANDARD_AUTH_TYPE, STATE, TEMPORARILY_UNAVAILABLE, TOKEN_RESPONSE, TOKEN_TYPE, UNAUTHORIZED_CLIENT, UNSUPPORTED_GRANT_TYPE, UNSUPPORTED_RESPONSE_TYPE

Constructor Summary

Constructors

Constructor and Description
BasicOAuth2Message()

Method Summary

Methods

Modifier and Type	Method and Description
String	getAccessToken() After a message is parsed it may contain an access token.
String	getAuthorization() If this is an Authorization Code flow this method will return the authorization_code from the message.
OAuth2Error	getError() null error indicates the message parsed cleanly and the service provider did not return an error.
String	getErrorDescription()
String	getErrorUri()
String	getExpiresIn()
String	getMacAlgorithm() The MAC Algorithm http://tools.ietf.org/html/draft-hammer-oauth-v2-mac-token-05#section-5
String	getMacSecret() The MAC Secret http://tools.ietf.org/html/draft-hammer-oauth-v2-mac-token-05#section-5
Map<String,String>	getParameters()
String	getRefreshToken()
String	getState()
String	getTokenType()
Map<String,String>	getUnparsedProperties() Additional properties that went unparsed (i.e.
void	parseFragment(String fragment) Populates an OAuth2Message from a query fragment.
void	parseJSON(String response) Populates an OAuth2Message from a JSON response body.
void	parseQuery(String query) Populates an OAuth2Message from a URL query string.
void	parseRequest(javax.servlet.http.HttpServletRequest request) Populates an OAuth2Message from the entire HttpServletRequest
void	setError(OAuth2Error error)
void	setErrorDescription(String errorDescription)
void	setErrorUri(String errorUri)

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicOAuth2Message

public BasicOAuth2Message()

Method Detail

getAccessToken

public String getAccessToken()

Description copied from interface: OAuth2Message

After a message is parsed it may contain an access token.

Specified by:

getAccessToken in interface OAuth2Message

Returns:

the access_token in the message

getAuthorization

public String getAuthorization()

Description copied from interface: OAuth2Message

If this is an Authorization Code flow this method will return the authorization_code from the message.

Specified by:

getAuthorization in interface OAuth2Message

Returns:

authorization_code in the message

getError

public OAuth2Error getError()

Description copied from interface: OAuth2Message

null error indicates the message parsed cleanly and the service provider did not return an error.

Specified by:

getError in interface OAuth2Message

Returns:

the error from the service provider

getErrorDescription

public String getErrorDescription()

Specified by:

getErrorDescription in interface OAuth2Message

Returns:

the optional error_description from the service provider

getErrorUri

public String getErrorUri()

Specified by:

getErrorUri in interface OAuth2Message

Returns:

the optional error_uri from the service provider

getExpiresIn

public String getExpiresIn()

Specified by:

getExpiresIn in interface OAuth2Message

Returns:

"expires_in" parameter in the message

getMacAlgorithm

public String getMacAlgorithm()

Description copied from interface: OAuth2Message

The MAC Algorithm http://tools.ietf.org/html/draft-hammer-oauth-v2-mac-token-05#section-5

Specified by:

getMacAlgorithm in interface OAuth2Message

Returns:

getMacSecret

public String getMacSecret()

Description copied from interface: OAuth2Message

The MAC Secret http://tools.ietf.org/html/draft-hammer-oauth-v2-mac-token-05#section-5

Specified by:

getMacSecret in interface OAuth2Message

Returns:

getParameters

public Map<String,String> getParameters()

Specified by:

getParameters in interface OAuth2Message

Returns:

a general Map of all parameters in the message

getRefreshToken

public String getRefreshToken()

Specified by:

getRefreshToken in interface OAuth2Message

Returns:

the "refresh_token" in the message

getState

public String getState()

Specified by:

getState in interface OAuth2Message

Returns:

the optional state string in the message

getTokenType

public String getTokenType()

Specified by:

getTokenType in interface OAuth2Message

Returns:

the "token_type" type in the message

getUnparsedProperties

public Map<String,String> getUnparsedProperties()

Description copied from interface: OAuth2Message

Additional properties that went unparsed (i.e. aren't part of the core OAuth2, Bearer Token or MAC Token specs.

Specified by:

getUnparsedProperties in interface OAuth2Message

Returns:

parseFragment

public void parseFragment(String fragment)

Description copied from interface: OAuth2Message

Populates an OAuth2Message from a query fragment. Not very useful in shindig.

Specified by:

parseFragment in interface OAuth2Message

parseJSON

public void parseJSON(String response)

Description copied from interface: OAuth2Message

Populates an OAuth2Message from a JSON response body.

Specified by:

parseJSON in interface OAuth2Message

Parameters:

response - returned from token endpoint request

parseQuery

public void parseQuery(String query)

Description copied from interface: OAuth2Message

Populates an OAuth2Message from a URL query string.

Specified by:

parseQuery in interface OAuth2Message

Parameters:

query - from redirect_uri called by servcie provider

parseRequest

public void parseRequest(javax.servlet.http.HttpServletRequest request)

Description copied from interface: OAuth2Message

Populates an OAuth2Message from the entire HttpServletRequest

Specified by:

parseRequest in interface OAuth2Message

Parameters:

request - to parse

setError

public void setError(OAuth2Error error)

Specified by:

setError in interface OAuth2Message

setErrorDescription

public void setErrorDescription(String errorDescription)

Specified by:

setErrorDescription in interface OAuth2Message

setErrorUri

public void setErrorUri(String errorUri)

Specified by:

setErrorUri in interface OAuth2Message