Apache CXF API

org.apache.cxf.rs.security.oauth2.common
Class ClientAccessToken

java.lang.Object
  extended by org.apache.cxf.rs.security.oauth2.common.AccessToken
      extended by org.apache.cxf.rs.security.oauth2.common.ClientAccessToken
All Implemented Interfaces:
Serializable

public class ClientAccessToken
extends AccessToken

Represents the extended client view of AccessToken. It may contain the actual scope value assigned to the access token, the refresh token key, and other properties such as when this token will expire, etc.

See Also:
Serialized Form

Constructor Summary
ClientAccessToken(String tokenType, String tokenKey)
           
 
Method Summary
 String getApprovedScope()
          Gets the actual scope assigned to the access token.
 void setApprovedScope(String approvedScope)
          Sets the actual scope assigned to the access token.
 
Methods inherited from class org.apache.cxf.rs.security.oauth2.common.AccessToken
getExpiresIn, getIssuedAt, getParameters, getRefreshToken, getTokenKey, getTokenType, setExpiresIn, setIssuedAt, setParameters, setRefreshToken, setTokenKey, setTokenType
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ClientAccessToken

public ClientAccessToken(String tokenType,
                         String tokenKey)
Method Detail

setApprovedScope

public void setApprovedScope(String approvedScope)
Sets the actual scope assigned to the access token. For example, it can be down-scoped in which case the client may need to adjust the way it works with the end user.

Parameters:
approvedScope - the actual scope

getApprovedScope

public String getApprovedScope()
Gets the actual scope assigned to the access token.

Returns:
the scope

Apache CXF API

Apache CXF