OAuth2TokenPersistence (Apache Shindig Gadget Renderer 2.5.2 API)

java.lang.Object
- org.apache.shindig.gadgets.oauth2.persistence.OAuth2TokenPersistence

All Implemented Interfaces:

Serializable, OAuth2Token
```
public class OAuth2TokenPersistence
extends Object
implements OAuth2Token
```
see OAuth2Token

See Also:
Serialized Form

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

Constructor Summary

Constructors
Constructor and Description

OAuth2TokenPersistence()

OAuth2TokenPersistence(OAuth2Encrypter encrypter)

Constructors
Constructor and Description
`OAuth2TokenPersistence()`
`OAuth2TokenPersistence(OAuth2Encrypter encrypter)`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`byte[]`	`getEncryptedMacSecret()`
`byte[]`	`getEncryptedSecret()`
`long`	`getExpiresAt()` issuedAt + expires_in or 0 if no expires_in was sent by server
`String`	`getGadgetUri()`
`long`	`getIssuedAt()` Used for creating MAC token nonces
`String`	`getMacAlgorithm()` For use with the MAC token specification.
`String`	`getMacExt()` For use with the MAC token specification.
`byte[]`	`getMacSecret()` For use with the MAC token specification.
`Map<String,String>`	`getProperties()` Contains any additional properties sent on the token.
`String`	`getScope()` See `http://tools.ietf.org/html/draft-ietf-oauth-v2-21#section-3.3`
`byte[]`	`getSecret()`
`String`	`getServiceName()`
`String`	`getTokenType()`
`OAuth2Token.Type`	`getType()`
`String`	`getUser()`
`int`	`hashCode()`
`void`	`setEncryptedMacSecret(byte[] encryptedSecret)`
`void`	`setEncryptedSecret(byte[] encryptedSecret)`
`void`	`setExpiresAt(long expiresAt)` Setter for expiresAt field
`void`	`setGadgetUri(String gadgetUri)` Setter for gadgetUri field
`void`	`setIssuedAt(long issuedAt)` Setter for issuedAt field
`void`	`setMacAlgorithm(String algorithm)` For use with the MAC token specification.
`void`	`setMacExt(String macExt)`
`void`	`setMacSecret(byte[] secret)` For use with the MAC token specification.
`void`	`setProperties(Map<String,String> properties)` Set the properties on the token
`void`	`setScope(String scope)` Setter for scope field
`void`	`setSecret(byte[] secret)` Setter for secret property
`void`	`setServiceName(String serviceName)` Setter for serviceName field
`void`	`setTokenType(String tokenType)` Setter for tokenType property
`void`	`setType(OAuth2Token.Type type)` Setter for type property
`void`	`setUser(String user)` Setter for user property
`String`	`toString()`

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

- Constructor Detail
  - OAuth2TokenPersistence
```
public OAuth2TokenPersistence()
```
  - OAuth2TokenPersistence
```
@Inject
public OAuth2TokenPersistence(OAuth2Encrypter encrypter)
```
- Method Detail
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - getEncryptedMacSecret
```
public byte[] getEncryptedMacSecret()
```
  - getEncryptedSecret
```
public byte[] getEncryptedSecret()
```
  - getExpiresAt
```
public long getExpiresAt()
```
    Description copied from interface: OAuth2Token
    
    issuedAt + expires_in or 0 if no expires_in was sent by server
    
    Specified by:
    
    getExpiresAt in interface OAuth2Token
    
    Returns:
    the time (in milliseconds) when the token expires
  - getGadgetUri
```
public String getGadgetUri()
```
    Specified by:
    
    getGadgetUri in interface OAuth2Token
    
    Returns:
    uri of the gadget the token applies to
  - getIssuedAt
```
public long getIssuedAt()
```
    Description copied from interface: OAuth2Token
    
    Used for creating MAC token nonces
    
    Specified by:
    
    getIssuedAt in interface OAuth2Token
    
    Returns:
    the time (in milliseconds) when the token was issued
  - getMacAlgorithm
```
public String getMacAlgorithm()
```
    Description copied from interface: OAuth2Token
    
    For use with the MAC token specification. See See http://tools.ietf.org/html/draft-hammer-oauth-v2-mac-token-05
    
    Specified by:
    
    getMacAlgorithm in interface OAuth2Token
    
    Returns:
    the Mac algorithm
  - getMacExt
```
public String getMacExt()
```
    Description copied from interface: OAuth2Token
    
    For use with the MAC token specification. See See http://tools.ietf.org/html/draft-hammer-oauth-v2-mac-token-05
    
    Specified by:
    
    getMacExt in interface OAuth2Token
    
    Returns:
    the mac ext
  - getMacSecret
```
public byte[] getMacSecret()
```
    Description copied from interface: OAuth2Token
    
    For use with the MAC token specification. See See http://tools.ietf.org/html/draft-hammer-oauth-v2-mac-token-05
    
    Specified by:
    
    getMacSecret in interface OAuth2Token
    
    Returns:
    the mac secret
  - getProperties
```
public Map<String,String> getProperties()
```
    Description copied from interface: OAuth2Token
    
    Contains any additional properties sent on the token.
    
    Specified by:
    
    getProperties in interface OAuth2Token
    
    Returns:
    properties sent on the token
  - getScope
```
public String getScope()
```
    Description copied from interface: OAuth2Token
    
    See http://tools.ietf.org/html/draft-ietf-oauth-v2-21#section-3.3
    
    Specified by:
    
    getScope in interface OAuth2Token
    
    Returns:
    scope the token applies to, or "" for no scope
  - getSecret
```
public byte[] getSecret()
```
    Specified by:
    
    getSecret in interface OAuth2Token
    
    Returns:
    the token secret (unencrypted or signed)
  - getServiceName
```
public String getServiceName()
```
    Specified by:
    
    getServiceName in interface OAuth2Token
    
    Returns:
    serviceName (in gadget spec) the token applies to
  - getTokenType
```
public String getTokenType()
```
    Specified by:
    
    getTokenType in interface OAuth2Token
    
    Returns:
    type of this token e.g. "Bearer"
  - getType
```
public OAuth2Token.Type getType()
```
    Specified by:
    
    getType in interface OAuth2Token
    
    Returns:
    if this is an Type.ACCESS or Type.REFRESH token
  - getUser
```
public String getUser()
```
    Specified by:
    
    getUser in interface OAuth2Token
    
    Returns:
    shindig user the token was issued for
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - setEncryptedMacSecret
```
public void setEncryptedMacSecret(byte[] encryptedSecret)
                           throws OAuth2EncryptionException
```
    Throws:
    
    OAuth2EncryptionException
  - setEncryptedSecret
```
public void setEncryptedSecret(byte[] encryptedSecret)
                        throws OAuth2EncryptionException
```
    Throws:
    
    OAuth2EncryptionException
  - setExpiresAt
```
public void setExpiresAt(long expiresAt)
```
    Description copied from interface: OAuth2Token
    
    Setter for expiresAt field
    
    Specified by:
    
    setExpiresAt in interface OAuth2Token
  - setGadgetUri
```
public void setGadgetUri(String gadgetUri)
```
    Description copied from interface: OAuth2Token
    
    Setter for gadgetUri field
    
    Specified by:
    
    setGadgetUri in interface OAuth2Token
  - setIssuedAt
```
public void setIssuedAt(long issuedAt)
```
    Description copied from interface: OAuth2Token
    
    Setter for issuedAt field
    
    Specified by:
    
    setIssuedAt in interface OAuth2Token
  - setMacAlgorithm
```
public void setMacAlgorithm(String algorithm)
```
    Description copied from interface: OAuth2Token
    
    For use with the MAC token specification. See See http://tools.ietf.org/html/draft-hammer-oauth-v2-mac-token-05
    
    Specified by:
    
    setMacAlgorithm in interface OAuth2Token
  - setMacExt
```
public void setMacExt(String macExt)
```
  - setMacSecret
```
public void setMacSecret(byte[] secret)
                  throws OAuth2RequestException
```
    Description copied from interface: OAuth2Token
    
    For use with the MAC token specification. See See http://tools.ietf.org/html/draft-hammer-oauth-v2-mac-token-05
    
    Specified by:
    
    setMacSecret in interface OAuth2Token
    
    Throws:
    
    OAuth2RequestException
  - setProperties
```
public void setProperties(Map<String,String> properties)
```
    Description copied from interface: OAuth2Token
    
    Set the properties on the token
    
    Specified by:
    
    setProperties in interface OAuth2Token
  - setScope
```
public void setScope(String scope)
```
    Description copied from interface: OAuth2Token
    
    Setter for scope field
    
    Specified by:
    
    setScope in interface OAuth2Token
  - setSecret
```
public void setSecret(byte[] secret)
               throws OAuth2RequestException
```
    Description copied from interface: OAuth2Token
    
    Setter for secret property
    
    Specified by:
    
    setSecret in interface OAuth2Token
    
    Throws:
    
    OAuth2RequestException
  - setServiceName
```
public void setServiceName(String serviceName)
```
    Description copied from interface: OAuth2Token
    
    Setter for serviceName field
    
    Specified by:
    
    setServiceName in interface OAuth2Token
  - setTokenType
```
public void setTokenType(String tokenType)
```
    Description copied from interface: OAuth2Token
    
    Setter for tokenType property
    
    Specified by:
    
    setTokenType in interface OAuth2Token
  - setType
```
public void setType(OAuth2Token.Type type)
```
    Description copied from interface: OAuth2Token
    
    Setter for type property
    
    Specified by:
    
    setType in interface OAuth2Token
  - setUser
```
public void setUser(String user)
```
    Description copied from interface: OAuth2Token
    
    Setter for user property
    
    Specified by:
    
    setUser in interface OAuth2Token
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class OAuth2TokenPersistence

Nested Class Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OAuth2TokenPersistence

OAuth2TokenPersistence

Method Detail

equals

getEncryptedMacSecret

getEncryptedSecret

getExpiresAt

getGadgetUri

getIssuedAt

getMacAlgorithm

getMacExt

getMacSecret

getProperties

getScope

getSecret

getServiceName

getTokenType

getType

getUser

hashCode

setEncryptedMacSecret

setEncryptedSecret

setExpiresAt

setGadgetUri

setIssuedAt

setMacAlgorithm

setMacExt

setMacSecret

setProperties

setScope

setSecret

setServiceName

setTokenType

setType

setUser

toString