BasicOAuth2Accessor (Apache Shindig Gadget Renderer 2.5.2 API)

java.lang.Object
- org.apache.shindig.gadgets.oauth2.BasicOAuth2Accessor

All Implemented Interfaces:

Serializable, OAuth2Accessor
```
public class BasicOAuth2Accessor
extends Object
implements OAuth2Accessor
```
see OAuth2Accessor

See Also:
Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface org.apache.shindig.gadgets.oauth2.OAuth2Accessor
  OAuth2Accessor.Type

Constructor Summary

Constructors
Constructor and Description
`BasicOAuth2Accessor()`
`BasicOAuth2Accessor(OAuth2Accessor accessor)`
`BasicOAuth2Accessor(String gadgetUri, String serviceName, String user, String scope, boolean allowModuleOverrides, OAuth2Store store, String globalRedirectUri, Authority authority, String contextRoot)`

Method Summary

Methods
Modifier and Type	Method and Description
`OAuth2Token`	`getAccessToken()`
`Map<String,String>`	`getAdditionalRequestParams()`
`String[]`	`getAllowedDomains()` gets the domains of allowed resource servers
`String`	`getAuthorizationUrl()`
`String`	`getClientAuthenticationType()` see `ClientAuthenticationHandler`
`String`	`getClientId()`
`byte[]`	`getClientSecret()`
`OAuth2Error`	`getError()`
`String`	`getErrorContextMessage()`
`Throwable`	`getErrorException()`
`String`	`getErrorUri()`
`String`	`getGadgetUri()`
`String`	`getGrantType()`
`String`	`getRedirectUri()`
`OAuth2Token`	`getRefreshToken()`
`String`	`getScope()` if the gadget request or gadget spec specifies a scope it will be set here See `http://tools.ietf.org/html/draft-ietf-oauth-v2-21#section-3.3`
`String`	`getServiceName()`
`OAuth2CallbackState`	`getState()`
`String`	`getTokenUrl()`
`OAuth2Accessor.Type`	`getType()`
`String`	`getUser()`
`void`	`invalidate()` invalidates the accessor once the request is done.
`boolean`	`isAllowModuleOverrides()`
`boolean`	`isAuthorizationHeader()` Indicates the service provider wants the access token in an "Authorization:" header, per the spec.
`boolean`	`isErrorResponse()`
`boolean`	`isRedirecting()` is this accessor in the middle of a authorize redirect?
`boolean`	`isUrlParameter()` Indicates the service provider wants the access token in an URL Parameter.
`boolean`	`isValid()`
`void`	`setAccessToken(OAuth2Token accessToken)` updates the access token for the request (does not add it to `OAuth2Store`)
`void`	`setAdditionalRequestParams(Map<String,String> additionalRequestParams)` set the oauth2 request parameters
`void`	`setAllowedDomains(String[] allowedDomains)` sets the domains of allowed resource servers
`void`	`setAuthorizationHeader(boolean authorizationHeader)`
`void`	`setAuthorizationUrl(String authorizationUrl)` updates the authorization endpoint url
`void`	`setClientAuthenticationType(String clientAuthenticationType)`
`void`	`setClientId(String clientId)`
`void`	`setClientSecret(byte[] clientSecret)`
`void`	`setErrorResponse(Throwable exception, OAuth2Error error, String contextMessage, String errorUri)`
`void`	`setErrorUri(String errorUri)`
`void`	`setGrantType(String grantType)`
`void`	`setRedirecting(boolean redirecting)` Used to communicate that we are in a redirect authorization flow and the accessor should be preserved.
`void`	`setRedirectUri(String redirectUri)`
`void`	`setRefreshToken(OAuth2Token refreshToken)` updates the refresh token for the request (does not add it to `OAuth2Store`)
`void`	`setTokenUrl(String tokenUrl)` updates the token endpoint url
`void`	`setType(OAuth2Accessor.Type type)`
`void`	`setUrlParameter(boolean urlParameter)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - BasicOAuth2Accessor
```
public BasicOAuth2Accessor()
```
  - BasicOAuth2Accessor
```
public BasicOAuth2Accessor(OAuth2Accessor accessor)
```
  - BasicOAuth2Accessor
```
public BasicOAuth2Accessor(String gadgetUri,
                   String serviceName,
                   String user,
                   String scope,
                   boolean allowModuleOverrides,
                   OAuth2Store store,
                   String globalRedirectUri,
                   Authority authority,
                   String contextRoot)
```
- Method Detail
  - getAccessToken
```
public OAuth2Token getAccessToken()
```
    Specified by:
    
    getAccessToken in interface OAuth2Accessor
    
    Returns:
    the access OAuth2Token or null
  - getAuthorizationUrl
```
public String getAuthorizationUrl()
```
    Specified by:
    
    getAuthorizationUrl in interface OAuth2Accessor
    
    Returns:
    the authorization endpoint for this accessor.
  - getClientAuthenticationType
```
public String getClientAuthenticationType()
```
    Description copied from interface: OAuth2Accessor
    
    see ClientAuthenticationHandler
    
    Specified by:
    
    getClientAuthenticationType in interface OAuth2Accessor
    
    Returns:
    the type of client authentication the service provider expects
  - getClientId
```
public String getClientId()
```
    Specified by:
    
    getClientId in interface OAuth2Accessor
    
    Returns:
    the "client_id" for this accessor
  - getClientSecret
```
public byte[] getClientSecret()
```
    Specified by:
    
    getClientSecret in interface OAuth2Accessor
    
    Returns:
    the "client_secret" for this accessor
  - getError
```
public OAuth2Error getError()
```
    Specified by:
    
    getError in interface OAuth2Accessor
  - getErrorContextMessage
```
public String getErrorContextMessage()
```
    Specified by:
    
    getErrorContextMessage in interface OAuth2Accessor
  - getErrorException
```
public Throwable getErrorException()
```
    Specified by:
    
    getErrorException in interface OAuth2Accessor
    
    Returns:
    the error exception, if this is an error, otherwise null
  - getErrorUri
```
public String getErrorUri()
```
    Specified by:
    
    getErrorUri in interface OAuth2Accessor
    
    Returns:
    the error uri, if this is an error, otherwise null
  - getGadgetUri
```
public String getGadgetUri()
```
    Specified by:
    
    getGadgetUri in interface OAuth2Accessor
    
    Returns:
    the URI of the gadget issuing the request
  - getGrantType
```
public String getGrantType()
```
    Specified by:
    
    getGrantType in interface OAuth2Accessor
    
    Returns:
    grant_type of this client, e.g. "code" or "client_credentials"
  - getRedirectUri
```
public String getRedirectUri()
```
    Specified by:
    
    getRedirectUri in interface OAuth2Accessor
    
    Returns:
    redirect_uri of the client for this accessor
  - getRefreshToken
```
public OAuth2Token getRefreshToken()
```
    Specified by:
    
    getRefreshToken in interface OAuth2Accessor
    
    Returns:
    the refresh OAuth2Token or null
  - getAdditionalRequestParams
```
public Map<String,String> getAdditionalRequestParams()
```
    Specified by:
    
    getAdditionalRequestParams in interface OAuth2Accessor
    
    Returns:
    the additional oauth2 request params (never null)
  - getScope
```
public String getScope()
```
    Description copied from interface: OAuth2Accessor
    
    if the gadget request or gadget spec specifies a scope it will be set here See http://tools.ietf.org/html/draft-ietf-oauth-v2-21#section-3.3
    
    Specified by:
    
    getScope in interface OAuth2Accessor
    
    Returns:
    scope of the request, or "" if none was specified
  - getServiceName
```
public String getServiceName()
```
    Specified by:
    
    getServiceName in interface OAuth2Accessor
    
    Returns:
    the service name from the gadget spec, defaults to ""
  - getState
```
public OAuth2CallbackState getState()
```
    Specified by:
    
    getState in interface OAuth2Accessor
    
    Returns:
    the state to include on authorization requests
  - getTokenUrl
```
public String getTokenUrl()
```
    Specified by:
    
    getTokenUrl in interface OAuth2Accessor
    
    Returns:
    the token endpoint for this accessor.
  - getType
```
public OAuth2Accessor.Type getType()
```
    Specified by:
    
    getType in interface OAuth2Accessor
    
    Returns:
    the OAuth2Accessor.Type of client for this accessor
  - getUser
```
public String getUser()
```
    Specified by:
    
    getUser in interface OAuth2Accessor
    
    Returns:
    of the page viewer
  - invalidate
```
public void invalidate()
```
    Description copied from interface: OAuth2Accessor
    
    invalidates the accessor once the request is done.
    
    Specified by:
    
    invalidate in interface OAuth2Accessor
  - isAllowModuleOverrides
```
public boolean isAllowModuleOverrides()
```
    Specified by:
    
    isAllowModuleOverrides in interface OAuth2Accessor
    
    Returns:
    true if the gadget's can override accessor settings
  - isAuthorizationHeader
```
public boolean isAuthorizationHeader()
```
    Description copied from interface: OAuth2Accessor
    
    Indicates the service provider wants the access token in an "Authorization:" header, per the spec.
    
    Specified by:
    
    isAuthorizationHeader in interface OAuth2Accessor
    
    Returns:
  - isErrorResponse
```
public boolean isErrorResponse()
```
    Specified by:
    
    isErrorResponse in interface OAuth2Accessor
    
    Returns:
    if an error response needs to be sent to the client
  - isRedirecting
```
public boolean isRedirecting()
```
    Description copied from interface: OAuth2Accessor
    
    is this accessor in the middle of a authorize redirect?
    
    Specified by:
    
    isRedirecting in interface OAuth2Accessor
    
    Returns:
  - isUrlParameter
```
public boolean isUrlParameter()
```
    Description copied from interface: OAuth2Accessor
    
    Indicates the service provider wants the access token in an URL Parameter. This goes against the spec but Google, Facebook and Microsoft all expect it.
    
    Specified by:
    
    isUrlParameter in interface OAuth2Accessor
    
    Returns:
  - isValid
```
public boolean isValid()
```
    Specified by:
    
    isValid in interface OAuth2Accessor
  - setAccessToken
```
public void setAccessToken(OAuth2Token accessToken)
```
    Description copied from interface: OAuth2Accessor
    
    updates the access token for the request (does not add it to OAuth2Store)
    
    Specified by:
    
    setAccessToken in interface OAuth2Accessor
  - setAuthorizationHeader
```
public void setAuthorizationHeader(boolean authorizationHeader)
```
  - setAuthorizationUrl
```
public void setAuthorizationUrl(String authorizationUrl)
```
    Description copied from interface: OAuth2Accessor
    
    updates the authorization endpoint url
    
    Specified by:
    
    setAuthorizationUrl in interface OAuth2Accessor
  - setClientAuthenticationType
```
public void setClientAuthenticationType(String clientAuthenticationType)
```
  - setClientId
```
public void setClientId(String clientId)
```
  - setClientSecret
```
public void setClientSecret(byte[] clientSecret)
```
  - setErrorResponse
```
public void setErrorResponse(Throwable exception,
                    OAuth2Error error,
                    String contextMessage,
                    String errorUri)
```
    Specified by:
    
    setErrorResponse in interface OAuth2Accessor
  - setErrorUri
```
public void setErrorUri(String errorUri)
```
  - setGrantType
```
public void setGrantType(String grantType)
```
  - setRedirecting
```
public void setRedirecting(boolean redirecting)
```
    Description copied from interface: OAuth2Accessor
    
    Used to communicate that we are in a redirect authorization flow and the accessor should be preserved.
    
    Specified by:
    
    setRedirecting in interface OAuth2Accessor
  - setRedirectUri
```
public void setRedirectUri(String redirectUri)
```
  - setRefreshToken
```
public void setRefreshToken(OAuth2Token refreshToken)
```
    Description copied from interface: OAuth2Accessor
    
    updates the refresh token for the request (does not add it to OAuth2Store)
    
    Specified by:
    
    setRefreshToken in interface OAuth2Accessor
  - setAdditionalRequestParams
```
public void setAdditionalRequestParams(Map<String,String> additionalRequestParams)
```
    Description copied from interface: OAuth2Accessor
    
    set the oauth2 request parameters
    
    Specified by:
    
    setAdditionalRequestParams in interface OAuth2Accessor
  - setTokenUrl
```
public void setTokenUrl(String tokenUrl)
```
    Description copied from interface: OAuth2Accessor
    
    updates the token endpoint url
    
    Specified by:
    
    setTokenUrl in interface OAuth2Accessor
  - setType
```
public void setType(OAuth2Accessor.Type type)
```
  - setUrlParameter
```
public void setUrlParameter(boolean urlParameter)
```
  - setAllowedDomains
```
public void setAllowedDomains(String[] allowedDomains)
```
    Description copied from interface: OAuth2Accessor
    
    sets the domains of allowed resource servers
    
    Specified by:
    
    setAllowedDomains in interface OAuth2Accessor
  - getAllowedDomains
```
public String[] getAllowedDomains()
```
    Description copied from interface: OAuth2Accessor
    
    gets the domains of allowed resource servers
    
    Specified by:
    
    getAllowedDomains in interface OAuth2Accessor
    
    Returns:
    allowed domains, may be empty but never null

Class BasicOAuth2Accessor

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.shindig.gadgets.oauth2.OAuth2Accessor

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BasicOAuth2Accessor

BasicOAuth2Accessor

BasicOAuth2Accessor

Method Detail

getAccessToken

getAuthorizationUrl

getClientAuthenticationType

getClientId

getClientSecret

getError

getErrorContextMessage

getErrorException

getErrorUri

getGadgetUri

getGrantType

getRedirectUri

getRefreshToken

getAdditionalRequestParams

getScope

getServiceName

getState

getTokenUrl

getType

getUser

invalidate

isAllowModuleOverrides

isAuthorizationHeader

isErrorResponse

isRedirecting

isUrlParameter

isValid

setAccessToken

setAuthorizationHeader

setAuthorizationUrl

setClientAuthenticationType

setClientId

setClientSecret

setErrorResponse

setErrorUri

setGrantType

setRedirecting

setRedirectUri

setRefreshToken

setAdditionalRequestParams

setTokenUrl

setType

setUrlParameter

setAllowedDomains

getAllowedDomains