OAuthAuthorizationData (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 OAuthAuthorizationData

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

All Implemented Interfaces:: Serializable

public class OAuthAuthorizationData
extends Object
implements Serializable
extends Object
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
`OAuthAuthorizationData()`

Method Summary
`String`	`getApplicationCertificate()`
`String`	`getApplicationDescription()` Gets the application description
`String`	`getApplicationLogoUri()` Gets the application logo URI
`String`	`getApplicationName()` Sets the client application name
`String`	`getApplicationWebUri()` Gets the application web URI
`String`	`getAudience()`
`String`	`getAuthenticityToken()` Gets the authenticity token linking the authorization challenge to the current end user session
`String`	`getClientId()` Gets the client id which needs to be retained in a hidden form field
`String`	`getEndUserName()`
`Map<String,String>`	`getExtraApplicationProperties()`
`List<? extends Permission>`	`getPermissions()` Gets the list of scopes translated to `Permission` instances requested by the client application
`String`	`getProposedScope()` Gets the requested scope which needs to be retained in a hidden form field
`String`	`getRedirectUri()` Gets the redirect uri which needs to be retained in a hidden form field
`String`	`getReplyTo()` Gets the absolute URI where the authorization decision data will need to be sent to
`String`	`getState()` Gets the client state token which needs to be retained in a hidden form field
`void`	`setApplicationCertificate(String applicationCertificate)`
`void`	`setApplicationDescription(String applicationDescription)` Sets the application description
`void`	`setApplicationLogoUri(String applicationLogoUri)` Sets the application logo URI
`void`	`setApplicationName(String applicationName)` Sets the client application name
`void`	`setApplicationWebUri(String applicationWebUri)` Sets the application web URI
`void`	`setAudience(String audience)`
`void`	`setAuthenticityToken(String authenticityToken)` Sets the authenticity token linking the authorization challenge to the current end user session
`void`	`setClientId(String clientId)` Sets the client id which needs to be retained in a hidden form field
`void`	`setEndUserName(String endUserName)`
`void`	`setExtraApplicationProperties(Map<String,String> extraApplicationProperties)`
`void`	`setPermissions(List<? extends Permission> permissions)` Gets the list of scopes translated to `Permission` instances
`void`	`setProposedScope(String proposedScope)` Sets the requested scope which needs to be retained in a hidden form field
`void`	`setRedirectUri(String redirectUri)` Sets the redirect uri which needs to be retained in a hidden form field
`void`	`setReplyTo(String replyTo)` Sets the absolute URI where the authorization decision data will need to be sent to
`void`	`setState(String state)` Sets the client state token which needs to be retained in a hidden form field

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()

Sets the client application name

Returns:: application name

setApplicationName

public void setApplicationName(String applicationName)

Sets the client application name

Parameters:: applicationName - application name

getPermissions

public List<? extends Permission> getPermissions()

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

Returns:: the list of scopes

setPermissions

public void setPermissions(List<? extends Permission> permissions)

Gets the list of scopes translated to Permission instances

setAuthenticityToken

public void setAuthenticityToken(String authenticityToken)

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

Parameters:: authenticityToken - the session authenticity token

getAuthenticityToken

public String getAuthenticityToken()

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

Returns:: the session authenticity token

setApplicationDescription

public void setApplicationDescription(String applicationDescription)

Sets the application description

Parameters:: applicationDescription - the description

getApplicationDescription

public String getApplicationDescription()

Gets the application description

Returns:: the description

setClientId

public void setClientId(String clientId)

Sets the client id which needs to be retained in a hidden form field

Parameters:: clientId - the client id

getClientId

public String getClientId()

Gets the client id which needs to be retained in a hidden form field

Returns:: the client id

setRedirectUri

public void setRedirectUri(String redirectUri)

Sets the redirect uri which needs to be retained in a hidden form field

Parameters:: redirectUri - the redirect uri

getRedirectUri

public String getRedirectUri()

Gets the redirect uri which needs to be retained in a hidden form field

Returns:: the redirect uri

setState

public void setState(String state)

Sets the client state token which needs to be retained in a hidden form field

Parameters:: state - the state

getState

public String getState()

Gets the client state token which needs to be retained in a hidden form field

Returns:

setApplicationWebUri

public void setApplicationWebUri(String applicationWebUri)

Sets the application web URI

Parameters:: applicationWebUri - the application URI

getApplicationWebUri

public String getApplicationWebUri()

Gets the application web URI

Returns:: the application URI

setApplicationLogoUri

public void setApplicationLogoUri(String applicationLogoUri)

Sets the application logo URI

Parameters:: applicationLogoUri - the logo URI

getApplicationLogoUri

public String getApplicationLogoUri()

Gets the application logo URI

Returns:: the logo URI

setProposedScope

public void setProposedScope(String proposedScope)

Sets the requested scope which needs to be retained in a hidden form field

Parameters:: proposedScope - the scope

getProposedScope

public String getProposedScope()

Gets the requested scope which needs to be retained in a hidden form field

Returns:: the scope

setReplyTo

public void setReplyTo(String replyTo)

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

Parameters:: replyTo - authorization decision handler URI

getReplyTo

public String getReplyTo()

Gets 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)

getAudience

public String getAudience()

setAudience

public void setAudience(String audience)

getApplicationCertificate

public String getApplicationCertificate()

setApplicationCertificate

public void setApplicationCertificate(String applicationCertificate)