OAuthContext (Apache CXF JavaDoc 3.0.0 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Apache CXF API

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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

java.lang.Object
  org.apache.cxf.rs.security.oauth2.common.OAuthContext

public class OAuthContext
extends Object
extends Object

Captures the information about the current client request which custom filters may use to further protect the endpoints

Constructor Summary
`OAuthContext(UserSubject resourceOwnerSubject, UserSubject clientSubject, List<OAuthPermission> perms, String tokenGrantType)`

Method Summary
`String`	`getClientId()` Returns the client which obtained the access token
`UserSubject`	`getClientSubject()` Gets the `UserSubject` representing the client
`List<OAuthPermission>`	`getPermissions()` Gets the list of the permissions assigned to the current access token
`UserSubject`	`getSubject()` Gets the `UserSubject` representing the resource owner
`String`	`getTokenAudience()`
`String`	`getTokenGrantType()` Returns the grant type which was used to obtain the access token the client is using now during the current request
`String`	`getTokenKey()` Returns the access token the client is using now during the current request
`void`	`setClientId(String clientId)` Sets the client which obtained the access token
`void`	`setTokenAudience(String tokenAudience)`
`void`	`setTokenKey(String tokenKey)` Sets the access token the client is using now during the current request

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

Constructor Detail

OAuthContext

public OAuthContext(UserSubject resourceOwnerSubject,
                    UserSubject clientSubject,
                    List<OAuthPermission> perms,
                    String tokenGrantType)

Method Detail

getSubject

public UserSubject getSubject()

Gets the UserSubject representing the resource owner

Returns:: the subject

getClientSubject

public UserSubject getClientSubject()

Gets the UserSubject representing the client

Returns:: the subject

getPermissions

public List<OAuthPermission> getPermissions()

Gets the list of the permissions assigned to the current access token

Returns:: the permissions

getTokenGrantType

public String getTokenGrantType()

Returns the grant type which was used to obtain the access token the client is using now during the current request

Returns:: the grant type

getClientId

public String getClientId()

Returns the client which obtained the access token

Returns:: the client id

setClientId

public void setClientId(String clientId)

Sets the client which obtained the access token

Parameters:: clientId -

getTokenKey

public String getTokenKey()

Returns the access token the client is using now during the current request

Returns:: the token

setTokenKey

public void setTokenKey(String tokenKey)

Sets the access token the client is using now during the current request

Parameters:: tokenKey -

getTokenAudience

public String getTokenAudience()

setTokenAudience

public void setTokenAudience(String tokenAudience)