IBM WebSphere Application ServerTM
Release 7

com.ibm.wsspi.security.oauth20.token
Interface WSOAuth20Token


public interface WSOAuth20Token

This interface is responsible for the WebSphere OAuth20 token created by the OAuth Trust Association Interceptor (TAI)


Field Summary
static java.security.SecurityPermission GET_OAUTH_PERM
           
static java.security.SecurityPermission UPDATE_OAUTH_PERM
           
 
Method Summary
 java.lang.Object getAttribute(java.lang.String key)
          Get the oauth 2.0 token attribute by given key
 java.util.Map getAttributes()
          Get the oauth 2.0 token attributes
 java.lang.String getCacheKey()
          Get Token cache key
 java.lang.String getClientID()
          Get OAuth 2.0 client_id
 long getExpirationTime()
          Get the expiration time for the access_token
 java.lang.String getProperty(java.lang.String key)
          Get the custom property value by given key
 java.lang.String getProvider()
          Retrieves the OAuth 2.0 service provider name associated with the token
 java.lang.String[] getScope()
          Get OAuth 2.0 scopes authorized by resource owner
 java.lang.String getTokenString()
          Get OAuth 2.0 'access_token' issued by authorization server
 java.lang.String getUser()
          Get the resource owner name
 boolean isValid()
          Retrieves the flag that indicates validity of the access_token.
 

Field Detail

GET_OAUTH_PERM

static final java.security.SecurityPermission GET_OAUTH_PERM

UPDATE_OAUTH_PERM

static final java.security.SecurityPermission UPDATE_OAUTH_PERM
Method Detail

getUser

java.lang.String getUser()
Get the resource owner name

Returns:
user name

getTokenString

java.lang.String getTokenString()
Get OAuth 2.0 'access_token' issued by authorization server

Returns:
access_token string

getClientID

java.lang.String getClientID()
Get OAuth 2.0 client_id

Returns:
client id

getScope

java.lang.String[] getScope()
Get OAuth 2.0 scopes authorized by resource owner

Returns:
scope

getExpirationTime

long getExpirationTime()
Get the expiration time for the access_token

Returns:
access_token expiration time in the number of milliseconds since January 1, 1970

getProperty

java.lang.String getProperty(java.lang.String key)
Get the custom property value by given key

Returns:
property value by given key

getAttribute

java.lang.Object getAttribute(java.lang.String key)
Get the oauth 2.0 token attribute by given key

Returns:
attribute by given key

getAttributes

java.util.Map getAttributes()
Get the oauth 2.0 token attributes

Returns:
map of attributes

getCacheKey

java.lang.String getCacheKey()
Get Token cache key

Returns:
cache key

isValid

boolean isValid()
Retrieves the flag that indicates validity of the access_token. This method also checks if the access_token has expired

Returns:
token valid flag.

getProvider

java.lang.String getProvider()
Retrieves the OAuth 2.0 service provider name associated with the token

Returns:
provider name

IBM WebSphere Application ServerTM
Release 7