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

Class OAuthAuthorizationData

java.lang.Object

org.apache.cxf.rs.security.oauth2.common.OAuthRedirectionState

org.apache.cxf.rs.security.oauth2.common.OAuthAuthorizationData

All Implemented Interfaces:

Serializable

public class OAuthAuthorizationData
extends OAuthRedirectionState
implements Serializable

This bean represents a resource owner authorization challenge. Typically, an HTML view will be returned to a resource owner who will authorize or deny the third-party client

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
OAuthAuthorizationData()

Method Summary

Modifier and Type	Method and Description
List<OAuthPermission>	getAllPermissions()
List<OAuthPermission>	getAlreadyAuthorizedPermissions() Get the list of scopes already approved by a user
List<String>	getAlreadyAuthorizedPermissionsAsStrings()
List<String>	getApplicationCertificates()
String	getApplicationDescription() Get the application description
String	getApplicationLogoUri() Get the application logo URI
String	getApplicationName() Get the client application name
String	getApplicationWebUri() Get the application web URI
String	getAuthenticityToken() Get the authenticity token linking the authorization challenge to the current end user session
String	getEndUserName()
Map<String,String>	getExtraApplicationProperties()
List<OAuthPermission>	getPermissions() Get the list of scopes translated to Permission instances requested by the client application
List<String>	getPermissionsAsStrings()
String	getPreauthorizedTokenKey()
String	getReplyTo() Get the absolute URI where the authorization decision data will need to be sent to
boolean	isApplicationRegisteredDynamically()
boolean	isHidePreauthorizedScopesInForm()
boolean	isImplicitFlow()
boolean	isSupportSinglePageApplications()
void	setAlreadyAuthorizedPermissions(List<OAuthPermission> perms) Set the list of scopes already approved by a user
void	setApplicationCertificates(List<String> applicationCertificates)
void	setApplicationDescription(String applicationDescription) Set the application description
void	setApplicationLogoUri(String applicationLogoUri) Set the application logo URI
void	setApplicationName(String applicationName) Set the client application name
void	setApplicationRegisteredDynamically(boolean applicationRegisteredDynamically)
void	setApplicationWebUri(String applicationWebUri) Set the application web URI
void	setAuthenticityToken(String authenticityToken) Set the authenticity token linking the authorization challenge to the current end user session
void	setEndUserName(String endUserName)
void	setExtraApplicationProperties(Map<String,String> extraApplicationProperties)
void	setHidePreauthorizedScopesInForm(boolean hidePreauthorizedScopesInForm)
void	setImplicitFlow(boolean implicitFlow)
void	setPermissions(List<OAuthPermission> permissions) Set the list of scopes translated to OAuthPermission instances
void	setPreauthorizedTokenKey(String preauthorizedTokenKey)
void	setReplyTo(String replyTo) Set the absolute URI where the authorization decision data will need to be sent to
void	setSupportSinglePageApplications(boolean supportSinglePageApplications)

Methods inherited from class org.apache.cxf.rs.security.oauth2.common.OAuthRedirectionState

getAudience, getClientCodeChallenge, getClientCodeChallengeMethod, getClientId, getExtraProperties, getNonce, getProposedScope, getRedirectUri, getResponseType, getState, setAudience, setClientCodeChallenge, setClientCodeChallengeMethod, setClientId, setExtraProperties, setNonce, setProposedScope, setRedirectUri, setResponseType, setState

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OAuthAuthorizationData

public OAuthAuthorizationData()

Method Detail

getApplicationName

public String getApplicationName()

Get the client application name

Returns:

application name

setApplicationName

public void setApplicationName(String applicationName)

Set the client application name

Parameters:

applicationName - application name

getPermissions

public List<OAuthPermission> getPermissions()

Get the list of scopes translated to Permission instances requested by the client application

Returns:

the list of scopes

setPermissions

public void setPermissions(List<OAuthPermission> permissions)

Set the list of scopes translated to OAuthPermission instances

getAlreadyAuthorizedPermissions

public List<OAuthPermission> getAlreadyAuthorizedPermissions()

Get the list of scopes already approved by a user

Returns:

the list of approved scopes

setAlreadyAuthorizedPermissions

public void setAlreadyAuthorizedPermissions(List<OAuthPermission> perms)

Set the list of scopes already approved by a user

Parameters:

perms - the list of approved scopes

setAuthenticityToken

public void setAuthenticityToken(String authenticityToken)

Set the authenticity token linking the authorization challenge to the current end user session

Parameters:

authenticityToken - the session authenticity token

getAuthenticityToken

public String getAuthenticityToken()

Get the authenticity token linking the authorization challenge to the current end user session

Returns:

the session authenticity token

setApplicationDescription

public void setApplicationDescription(String applicationDescription)

Set the application description

Parameters:

applicationDescription - the description

getApplicationDescription

public String getApplicationDescription()

Get the application description

Returns:

the description

setApplicationWebUri

public void setApplicationWebUri(String applicationWebUri)

Set the application web URI

Parameters:

applicationWebUri - the application URI

getApplicationWebUri

public String getApplicationWebUri()

Get the application web URI

Returns:

the application URI

setApplicationLogoUri

public void setApplicationLogoUri(String applicationLogoUri)

Set the application logo URI

Parameters:

applicationLogoUri - the logo URI

getApplicationLogoUri

public String getApplicationLogoUri()

Get the application logo URI

Returns:

the logo URI

setReplyTo

public void setReplyTo(String replyTo)

Set the absolute URI where the authorization decision data will need to be sent to

Parameters:

replyTo - authorization decision handler URI

getReplyTo

public String getReplyTo()

Get the absolute URI where the authorization decision data will need to be sent to

Returns:

authorization decision handler URI

getExtraApplicationProperties

public Map<String,String> getExtraApplicationProperties()

setExtraApplicationProperties

public void setExtraApplicationProperties(Map<String,String> extraApplicationProperties)

getEndUserName

public String getEndUserName()

setEndUserName

public void setEndUserName(String endUserName)

getApplicationCertificates

public List<String> getApplicationCertificates()

setApplicationCertificates

public void setApplicationCertificates(List<String> applicationCertificates)

isImplicitFlow

public boolean isImplicitFlow()

setImplicitFlow

public void setImplicitFlow(boolean implicitFlow)

isHidePreauthorizedScopesInForm

public boolean isHidePreauthorizedScopesInForm()

setHidePreauthorizedScopesInForm

public void setHidePreauthorizedScopesInForm(boolean hidePreauthorizedScopesInForm)

getPermissionsAsStrings

public List<String> getPermissionsAsStrings()

getAlreadyAuthorizedPermissionsAsStrings

public List<String> getAlreadyAuthorizedPermissionsAsStrings()

getAllPermissions

public List<OAuthPermission> getAllPermissions()

isApplicationRegisteredDynamically

public boolean isApplicationRegisteredDynamically()

setApplicationRegisteredDynamically

public void setApplicationRegisteredDynamically(boolean applicationRegisteredDynamically)

isSupportSinglePageApplications

public boolean isSupportSinglePageApplications()

setSupportSinglePageApplications

public void setSupportSinglePageApplications(boolean supportSinglePageApplications)

setPreauthorizedTokenKey

public void setPreauthorizedTokenKey(String preauthorizedTokenKey)

getPreauthorizedTokenKey

public String getPreauthorizedTokenKey()