OAuth2Message (Apache Shindig Gadget Renderer 2.5.2 API)

All Known Implementing Classes:

BasicOAuth2Message
```
public interface OAuth2Message
```
Interface representing an OAuth2Message parser that is injected into the OAuth2Request layer. It also contains the OAuth 2.0 constants. With the simplicity of the OAuth 2.0 client it is unlikely that another version of this class will need to be injected, but it can be with com.google.inject.Provider

Field Summary

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

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 jsonString)` Populates an OAuth2Message from a JSON response body.
`void`	`parseQuery(String queryString)` 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)`

- Field Detail
  - ACCESS_DENIED
```
static final String ACCESS_DENIED
```
    See Also:
    Constant Field Values
  - ACCESS_TOKEN
```
static final String ACCESS_TOKEN
```
    See Also:
    Constant Field Values
  - AUTHORIZATION
```
static final String AUTHORIZATION
```
    See Also:
    Constant Field Values
  - AUTHORIZATION_CODE
```
static final String AUTHORIZATION_CODE
```
    See Also:
    Constant Field Values
  - AUTHORIZATION_HEADER
```
static final String AUTHORIZATION_HEADER
```
    See Also:
    Constant Field Values
  - BASIC_AUTH_TYPE
```
static final String BASIC_AUTH_TYPE
```
    See Also:
    Constant Field Values
  - BEARER_TOKEN_TYPE
```
static final String BEARER_TOKEN_TYPE
```
    See Also:
    Constant Field Values
  - BODYHASH
```
static final String BODYHASH
```
    See Also:
    Constant Field Values
  - CLIENT_CREDENTIALS
```
static final String CLIENT_CREDENTIALS
```
    See Also:
    Constant Field Values
  - CLIENT_ID
```
static final String CLIENT_ID
```
    See Also:
    Constant Field Values
  - CLIENT_SECRET
```
static final String CLIENT_SECRET
```
    See Also:
    Constant Field Values
  - CONFIDENTIAL_CLIENT_TYPE
```
static final String CONFIDENTIAL_CLIENT_TYPE
```
    See Also:
    Constant Field Values
  - ERROR
```
static final String ERROR
```
    See Also:
    Constant Field Values
  - ERROR_DESCRIPTION
```
static final String ERROR_DESCRIPTION
```
    See Also:
    Constant Field Values
  - ERROR_URI
```
static final String ERROR_URI
```
    See Also:
    Constant Field Values
  - EXPIRES_IN
```
static final String EXPIRES_IN
```
    See Also:
    Constant Field Values
  - GRANT_TYPE
```
static final String GRANT_TYPE
```
    See Also:
    Constant Field Values
  - HMAC_SHA_1
```
static final String HMAC_SHA_1
```
    See Also:
    Constant Field Values
  - HMAC_SHA_256
```
static final String HMAC_SHA_256
```
    See Also:
    Constant Field Values
  - ID
```
static final String ID
```
    See Also:
    Constant Field Values
  - INVALID_CLIENT
```
static final String INVALID_CLIENT
```
    See Also:
    Constant Field Values
  - INVALID_GRANT
```
static final String INVALID_GRANT
```
    See Also:
    Constant Field Values
  - INVALID_REQUEST
```
static final String INVALID_REQUEST
```
    See Also:
    Constant Field Values
  - INVALID_SCOPE
```
static final String INVALID_SCOPE
```
    See Also:
    Constant Field Values
  - MAC
```
static final String MAC
```
    See Also:
    Constant Field Values
  - MAC_ALGORITHM
```
static final String MAC_ALGORITHM
```
    See Also:
    Constant Field Values
  - MAC_EXT
```
static final String MAC_EXT
```
    See Also:
    Constant Field Values
  - MAC_HEADER
```
static final String MAC_HEADER
```
    See Also:
    Constant Field Values
  - MAC_SECRET
```
static final String MAC_SECRET
```
    See Also:
    Constant Field Values
  - MAC_TOKEN_TYPE
```
static final String MAC_TOKEN_TYPE
```
    See Also:
    Constant Field Values
  - NO_GRANT_TYPE
```
static final String NO_GRANT_TYPE
```
    See Also:
    Constant Field Values
  - NONCE
```
static final String NONCE
```
    See Also:
    Constant Field Values
  - PUBLIC_CLIENT_TYPE
```
static final String PUBLIC_CLIENT_TYPE
```
    See Also:
    Constant Field Values
  - REDIRECT_URI
```
static final String REDIRECT_URI
```
    See Also:
    Constant Field Values
  - REFRESH_TOKEN
```
static final String REFRESH_TOKEN
```
    See Also:
    Constant Field Values
  - RESPONSE_TYPE
```
static final String RESPONSE_TYPE
```
    See Also:
    Constant Field Values
  - SCOPE
```
static final String SCOPE
```
    See Also:
    Constant Field Values
  - SERVER_ERROR
```
static final String SERVER_ERROR
```
    See Also:
    Constant Field Values
  - SHARED_TOKEN
```
static final String SHARED_TOKEN
```
    See Also:
    Constant Field Values
  - STANDARD_AUTH_TYPE
```
static final String STANDARD_AUTH_TYPE
```
    See Also:
    Constant Field Values
  - STATE
```
static final String STATE
```
    See Also:
    Constant Field Values
  - TEMPORARILY_UNAVAILABLE
```
static final String TEMPORARILY_UNAVAILABLE
```
    See Also:
    Constant Field Values
  - TOKEN_RESPONSE
```
static final String TOKEN_RESPONSE
```
    See Also:
    Constant Field Values
  - TOKEN_TYPE
```
static final String TOKEN_TYPE
```
    See Also:
    Constant Field Values
  - UNAUTHORIZED_CLIENT
```
static final String UNAUTHORIZED_CLIENT
```
    See Also:
    Constant Field Values
  - UNSUPPORTED_GRANT_TYPE
```
static final String UNSUPPORTED_GRANT_TYPE
```
    See Also:
    Constant Field Values
  - UNSUPPORTED_RESPONSE_TYPE
```
static final String UNSUPPORTED_RESPONSE_TYPE
```
    See Also:
    Constant Field Values
- Method Detail
  - getAccessToken
```
String getAccessToken()
```
    After a message is parsed it may contain an access token.
    
    Returns:
    the access_token in the message
  - getAuthorization
```
String getAuthorization()
```
    If this is an Authorization Code flow this method will return the authorization_code from the message.
    
    Returns:
    authorization_code in the message
  - getError
```
OAuth2Error getError()
```
    null error indicates the message parsed cleanly and the service provider did not return an error.
    
    Returns:
    the error from the service provider
  - getErrorDescription
```
String getErrorDescription()
```
    Returns:
    the optional error_description from the service provider
  - getErrorUri
```
String getErrorUri()
```
    Returns:
    the optional error_uri from the service provider
  - getExpiresIn
```
String getExpiresIn()
```
    Returns:
    "expires_in" parameter in the message
  - getMacAlgorithm
```
String getMacAlgorithm()
```
    The MAC Algorithm http://tools.ietf.org/html/draft-hammer-oauth-v2-mac-token-05#section-5
    
    Returns:
  - getMacSecret
```
String getMacSecret()
```
    The MAC Secret http://tools.ietf.org/html/draft-hammer-oauth-v2-mac-token-05#section-5
    
    Returns:
  - getParameters
```
Map<String,String> getParameters()
```
    Returns:
    a general Map of all parameters in the message
  - getRefreshToken
```
String getRefreshToken()
```
    Returns:
    the "refresh_token" in the message
  - getState
```
String getState()
```
    Returns:
    the optional state string in the message
  - getTokenType
```
String getTokenType()
```
    Returns:
    the "token_type" type in the message
  - getUnparsedProperties
```
Map<String,String> getUnparsedProperties()
```
    Additional properties that went unparsed (i.e. aren't part of the core OAuth2, Bearer Token or MAC Token specs.
    
    Returns:
  - parseFragment
```
void parseFragment(String fragment)
```
    Populates an OAuth2Message from a query fragment. Not very useful in shindig.
    
    Parameters:
    fragment -
  - parseJSON
```
void parseJSON(String jsonString)
```
    Populates an OAuth2Message from a JSON response body.
    
    Parameters:
    jsonString - returned from token endpoint request
  - parseQuery
```
void parseQuery(String queryString)
```
    Populates an OAuth2Message from a URL query string.
    
    Parameters:
    queryString - from redirect_uri called by servcie provider
  - parseRequest
```
void parseRequest(javax.servlet.http.HttpServletRequest request)
```
    Populates an OAuth2Message from the entire HttpServletRequest
    
    Parameters:
    request - to parse
  - setError
```
void setError(OAuth2Error error)
```
    Parameters:
    error -
  - setErrorDescription
```
void setErrorDescription(String errorDescription)
```
    Parameters:
    errorDescription -
  - setErrorUri
```
void setErrorUri(String errorUri)
```
    Parameters:
    errorUri -

Interface OAuth2Message

Field Summary

Method Summary

Field Detail

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

Method Detail

getAccessToken

getAuthorization

getError

getErrorDescription

getErrorUri

getExpiresIn

getMacAlgorithm

getMacSecret

getParameters

getRefreshToken

getState

getTokenType

getUnparsedProperties

parseFragment

parseJSON

parseQuery

parseRequest

setError

setErrorDescription

setErrorUri