ServerAuthorizationCodeGrant (Apache CXF JavaDoc 3.1.0 API)

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
```
public class ServerAuthorizationCodeGrant
extends AuthorizationCodeGrant
```
The Authorization Code Grant representation visible to the server

See Also:
Serialized Form

Constructor Summary

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

Method Summary

Methods
Modifier and Type	Method and Description
`List<String>`	`getApprovedScopes()` Gets the scopes explicitly approved by the end user
`String`	`getAudience()`
`Client`	`getClient()` Returns the reference to `Client`
`String`	`getClientCodeChallenge()`
`long`	`getExpiresIn()` Returns the number of seconds this grant can be valid after it was issued
`long`	`getIssuedAt()` Returns the time (in seconds) this grant was issued at
`long`	`getLifetime()` Deprecated.
`List<String>`	`getRequestedScopes()`
`UserSubject`	`getSubject()` Gets the user subject representing the end user
`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`	`setExpiresIn(long expiresIn)`
`void`	`setIssuedAt(long issuedAt)`
`void`	`setRequestedScopes(List<String> requestedScopes)`
`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, getRedirectUri, getType, setCode, 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)
```
  - getLifetime
```
@Deprecated
public long getLifetime()
```
    Deprecated.
    
    Returns the number of seconds this grant can be valid after it was issued
    
    Returns:
    the seconds this grant will be valid for
  - 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)
```
  - 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:
    approvedScope - the approved scopes
  - getApprovedScopes
```
public List<String> getApprovedScopes()
```
    Gets the scopes explicitly approved by the end user
    
    Returns:
    the approved scopes
  - setSubject
```
public void setSubject(UserSubject subject)
```
    Sets the user subject representing the end user
    
    Parameters:
    subject - the subject
  - getSubject
```
public UserSubject getSubject()
```
    Gets the user subject representing the end user
    
    Returns:
    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)
```

Class ServerAuthorizationCodeGrant

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

ServerAuthorizationCodeGrant

ServerAuthorizationCodeGrant

ServerAuthorizationCodeGrant

Method Detail

getIssuedAt

setIssuedAt

getLifetime

getExpiresIn

setExpiresIn

getClient

setClient

setApprovedScopes

getApprovedScopes

setSubject

getSubject

getAudience

setAudience

getClientCodeChallenge

setClientCodeChallenge

getRequestedScopes

setRequestedScopes