Package org.apache.cxf.rs.security.oauth2.grants.code

Class ServerAuthorizationCodeGrant

java.lang.Object

org.apache.cxf.rs.security.oauth2.grants.code.AuthorizationCodeGrant

org.apache.cxf.rs.security.oauth2.grants.code.ServerAuthorizationCodeGrant

All Implemented Interfaces:

Serializable, AccessTokenGrant

@Entity
public class ServerAuthorizationCodeGrant
extends AuthorizationCodeGrant

The Authorization Code Grant representation visible to the server

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ServerAuthorizationCodeGrant()
ServerAuthorizationCodeGrant(Client client, long lifetime)
ServerAuthorizationCodeGrant(Client client, String code, long expiresIn, long issuedAt)

Method Summary

Modifier and Type	Method	Description
List<String>	getApprovedScopes()	Gets the scopes explicitly approved by the end user
String	getAudience()
Client	getClient()	Returns the reference to Client
String	getClientCodeChallenge()
String	getClientCodeChallengeMethod()
long	getExpiresIn()	Returns the number of seconds this grant can be valid after it was issued
Map<String,String>	getExtraProperties()
long	getIssuedAt()	Returns the time (in seconds) this grant was issued at
String	getNonce()
List<String>	getRequestedScopes()
String	getResponseType()
UserSubject	getSubject()	Gets the user subject representing the end user
boolean	isPreauthorizedTokenAvailable()
void	setApprovedScopes(List<String> scopes)	Sets the scopes explicitly approved by the end user.
void	setAudience(String audience)
void	setClient(Client c)
void	setClientCodeChallenge(String clientCodeChallenge)
void	setClientCodeChallengeMethod(String clientCodeChallengeMethod)
void	setExpiresIn(long expiresIn)
void	setExtraProperties(Map<String,String> extraProperties)
void	setIssuedAt(long issuedAt)
void	setNonce(String nonce)
void	setPreauthorizedTokenAvailable(boolean preauthorizedTokenAvailable)
void	setRequestedScopes(List<String> requestedScopes)
void	setResponseType(String responseType)
void	setSubject(UserSubject subject)	Sets the user subject representing the end user

Methods inherited from class org.apache.cxf.rs.security.oauth2.grants.code.AuthorizationCodeGrant

getCode, getCodeVerifier, getRedirectUri, getType, setCode, setCodeVerifier, setRedirectUri, toMap

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerAuthorizationCodeGrant

public ServerAuthorizationCodeGrant()

ServerAuthorizationCodeGrant

public ServerAuthorizationCodeGrant(Client client,
                                    long lifetime)

ServerAuthorizationCodeGrant

public ServerAuthorizationCodeGrant(Client client,
                                    String code,
                                    long expiresIn,
                                    long issuedAt)

Method Detail

getIssuedAt

public long getIssuedAt()

Returns the time (in seconds) this grant was issued at

Returns:

the seconds

setIssuedAt

public void setIssuedAt(long issuedAt)

getExpiresIn

public long getExpiresIn()

Returns the number of seconds this grant can be valid after it was issued

Returns:

the seconds this grant will be valid for

setExpiresIn

public void setExpiresIn(long expiresIn)

getClient

public Client getClient()

Returns the reference to Client

Returns:

the client

setClient

public void setClient(Client c)

getApprovedScopes

public List<String> getApprovedScopes()

Gets the scopes explicitly approved by the end user

Returns:

the approved scopes

setApprovedScopes

public void setApprovedScopes(List<String> scopes)

Sets the scopes explicitly approved by the end user. If this list is empty then the end user had no way to down-scope.

Parameters:

scopes - the approved scopes

getSubject

public UserSubject getSubject()

Gets the user subject representing the end user

Returns:

the subject

setSubject

public void setSubject(UserSubject subject)

Sets the user subject representing the end user

Parameters:

subject - the subject

getAudience

public String getAudience()

setAudience

public void setAudience(String audience)

getClientCodeChallenge

public String getClientCodeChallenge()

setClientCodeChallenge

public void setClientCodeChallenge(String clientCodeChallenge)

getRequestedScopes

public List<String> getRequestedScopes()

setRequestedScopes

public void setRequestedScopes(List<String> requestedScopes)

getNonce

public String getNonce()

setNonce

public void setNonce(String nonce)

isPreauthorizedTokenAvailable

public boolean isPreauthorizedTokenAvailable()

setPreauthorizedTokenAvailable

public void setPreauthorizedTokenAvailable(boolean preauthorizedTokenAvailable)

getExtraProperties

public Map<String,String> getExtraProperties()

setExtraProperties

public void setExtraProperties(Map<String,String> extraProperties)

getResponseType

public String getResponseType()

setResponseType

public void setResponseType(String responseType)

getClientCodeChallengeMethod

public String getClientCodeChallengeMethod()

setClientCodeChallengeMethod

public void setClientCodeChallengeMethod(String clientCodeChallengeMethod)