TokenIssueResponse (com.authlete:authlete-java-common 2.51 API)

java.lang.Object
- com.authlete.common.dto.ApiResponse
- - com.authlete.common.dto.TokenIssueResponse

All Implemented Interfaces:

Serializable
```
public class TokenIssueResponse
extends ApiResponse
```
Response from Authlete's /auth/token/issue endpoint.
Authlete's /auth/token/issue endpoint returns JSON which can be mapped to this class. The service implementation should retrieve the value of "action" from the response and take the following steps according to the value.
INTERNAL_SERVER_ERROR
When the value of "action" is "INTERNAL_SERVER_ERROR", it means that the request from the service implementation was wrong or that an error occurred in Authlete.

In either case, from the viewpoint of the client application, it is an error on the server side. Therefore, the service implementation should generate a response to the client application with the HTTP status of "500 Internal Server Error".

getResponseContent() returns a JSON string which describes the error, so it can be used as the entity body of the response.

The following illustrates the response which the service implementation should generate and return to the client application.
```
 HTTP/1.1 500 Internal Server Error
 Content-Type: application/json
 Cache-Control: no-store
 Pragma: no-cache

 (The value returned from getResponseContent())
```
OK
When the value of "action" is "OK", it means that Authlete's /auth/token/issue API successfully generated an access token.

The HTTP status of the response returned to the client application must be "200 OK" and the content type must be "application/json".

getResponseContent() returns a JSON string which contains an access token, so it can be used as the entity body of the response.

The following illustrates the response which the service implementation should generate and return to the client application.
```
 HTTP/1.1 200 OK
 Content-Type: application/json
 Cache-Control: no-store
 Pragma: no-cache

 (The value returned from getResponseContent())
```
Author:

Takahiko Kawasaki

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class TokenIssueResponse.Action
The next action that the service implementation should take.

Nested Classes
Modifier and Type	Class and Description
`static class`	`TokenIssueResponse.Action` The next action that the service implementation should take.

Constructor Summary

Constructors
Constructor and Description

TokenIssueResponse()

Constructors
Constructor and Description
`TokenIssueResponse()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAccessToken()` Get the newly issued access token.
`long`	`getAccessTokenDuration()` Get the duration of the access token in seconds.
`long`	`getAccessTokenExpiresAt()` Get the date in milliseconds since the Unix epoch (1970-01-01) at which the access token will expire.
`TokenIssueResponse.Action`	`getAction()` Get the next action that the service implementation should take.
`long`	`getClientId()` Get the client ID.
`String`	`getClientIdAlias()` Get the client ID alias.
`String`	`getJwtAccessToken()` Get the newly issued access token in JWT format.
`Property[]`	`getProperties()` Get the extra properties associated with the access token.
`String`	`getRefreshToken()` Get the refresh token.
`long`	`getRefreshTokenDuration()` Get the duration of the refresh token in seconds.
`long`	`getRefreshTokenExpiresAt()` Get the date in milliseconds since the Unix epoch (1970-01-01) at which the refresh token will expire.
`String`	`getResponseContent()` Get the response content which can be used as the entity body of the response returned to the client application.
`String[]`	`getScopes()` Get the scopes covered by the access token.
`String`	`getSubject()` Get the subject (= resource owner's ID) of the access token.
`boolean`	`isClientIdAliasUsed()` Get the flag which indicates whether the client ID alias was used when the token request was made.
`void`	`setAccessToken(String accessToken)` Set the newly issued access token.
`void`	`setAccessTokenDuration(long duration)` Set the duration of the access token in seconds.
`void`	`setAccessTokenExpiresAt(long expiresAt)` Set the date in milliseconds since the Unix epoch (1970-01-01) at which the access token will expire.
`void`	`setAction(TokenIssueResponse.Action action)` Set the next action that the service implementation should take.
`void`	`setClientId(long clientId)` Set the client ID.
`void`	`setClientIdAlias(String alias)` Set the client ID alias.
`void`	`setClientIdAliasUsed(boolean used)` Set the flag which indicates whether the client ID alias was used when the token request was made.
`void`	`setJwtAccessToken(String jwtAccessToken)` Set the newly issued access token in JWT format.
`void`	`setProperties(Property[] properties)` Set the extra properties associated with the access token.
`void`	`setRefreshToken(String refreshToken)` Set the refresh token.
`void`	`setRefreshTokenDuration(long duration)` Set the duration of the refresh token in seconds.
`void`	`setRefreshTokenExpiresAt(long expiresAt)` Set the date in milliseconds since the Unix epoch (1970-01-01) at which the refresh token will expire.
`void`	`setResponseContent(String responseContent)` Set the response content which can be used as the entity body of the response returned to the client application.
`void`	`setScopes(String[] scopes)` Set the scopes covered by the access token.
`void`	`setSubject(String subject)` Set the subject (= resource owner's ID).
`String`	`summarize()` Get the summary of this instance.

Methods inherited from class com.authlete.common.dto.ApiResponse
getResultCode, getResultMessage, setResultCode, setResultMessage

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

- Constructor Detail
  - TokenIssueResponse
```
public TokenIssueResponse()
```
- Method Detail
  - getAction
```
public TokenIssueResponse.Action getAction()
```
    Get the next action that the service implementation should take.
  - setAction
```
public void setAction(TokenIssueResponse.Action action)
```
    Set the next action that the service implementation should take.
  - getResponseContent
```
public String getResponseContent()
```
    Get the response content which can be used as the entity body of the response returned to the client application.
  - setResponseContent
```
public void setResponseContent(String responseContent)
```
    Set the response content which can be used as the entity body of the response returned to the client application.
  - summarize
```
public String summarize()
```
    Get the summary of this instance.
  - getAccessToken
```
public String getAccessToken()
```
    Get the newly issued access token. This method returns a non-null value only when getAction() returns TokenIssueResponse.Action.OK.
    If the service is configured to issue JWT-based access tokens, a JWT-based access token is issued additionally. In the case, getJwtAccessToken() returns the JWT-based access token.
    
    Returns:
    
    The newly issued access token.
    
    Since:
    
    1.34
    
    See Also:
    
    getJwtAccessToken()
  - setAccessToken
```
public void setAccessToken(String accessToken)
```
    Set the newly issued access token.
    
    Parameters:
    
    accessToken - The newly issued access token.
    
    Since:
    
    1.34
  - getAccessTokenExpiresAt
```
public long getAccessTokenExpiresAt()
```
    Get the date in milliseconds since the Unix epoch (1970-01-01) at which the access token will expire.
    
    Returns:
    
    The expiration date in milliseconds since the Unix epoch (1970-01-01) at which the access token will expire.
    
    Since:
    
    1.34
  - setAccessTokenExpiresAt
```
public void setAccessTokenExpiresAt(long expiresAt)
```
    Set the date in milliseconds since the Unix epoch (1970-01-01) at which the access token will expire.
    
    Parameters:
    
    expiresAt - The expiration date in milliseconds since the Unix epoch (1970-01-01) at which the access token will expire.
    
    Since:
    
    1.34
  - getAccessTokenDuration
```
public long getAccessTokenDuration()
```
    Get the duration of the access token in seconds.
    
    Returns:
    
    Duration in seconds.
    
    Since:
    
    1.34
  - setAccessTokenDuration
```
public void setAccessTokenDuration(long duration)
```
    Set the duration of the access token in seconds.
    
    Parameters:
    
    duration - Duration in seconds.
    
    Since:
    
    1.34
  - getRefreshToken
```
public String getRefreshToken()
```
    Get the refresh token. This method returns a non-null value only when getAction() returns TokenIssueResponse.Action.OK and the service supports the refresh token flow.
    If "Refresh Token Continuous Use" configuration parameter is NO (= `refreshTokenKept=false`), a new refresh token is issued and the old refresh token used in the refresh token flow is invalidated. On the contrary, if the configuration parameter is YES, the refresh token itself is not refreshed.
    
    Returns:
    
    The refresh token.
    
    Since:
    
    1.34
  - setRefreshToken
```
public void setRefreshToken(String refreshToken)
```
    Set the refresh token.
    
    Parameters:
    
    refreshToken - The refresh token.
    
    Since:
    
    1.34
  - getRefreshTokenExpiresAt
```
public long getRefreshTokenExpiresAt()
```
    Get the date in milliseconds since the Unix epoch (1970-01-01) at which the refresh token will expire.
    
    Returns:
    
    The expiration date in milliseconds since the Unix epoch (1970-01-01) at which the refresh token will expire. If the refresh token is null, this method returns 0.
    
    Since:
    
    1.34
  - setRefreshTokenExpiresAt
```
public void setRefreshTokenExpiresAt(long expiresAt)
```
    Set the date in milliseconds since the Unix epoch (1970-01-01) at which the refresh token will expire.
    
    Parameters:
    
    expiresAt - The expiration date in milliseconds since the Unix epoch (1970-01-01) at which the refresh token will expire. If the refresh token is null, this method returns 0.
    
    Since:
    
    1.34
  - getRefreshTokenDuration
```
public long getRefreshTokenDuration()
```
    Get the duration of the refresh token in seconds.
    
    Returns:
    
    Duration in seconds.
    
    Since:
    
    1.34
  - setRefreshTokenDuration
```
public void setRefreshTokenDuration(long duration)
```
    Set the duration of the refresh token in seconds.
    
    Parameters:
    
    duration - Duration in seconds.
    
    Since:
    
    1.34
  - getClientId
```
public long getClientId()
```
    Get the client ID.
    
    Since:
    
    2.8
  - setClientId
```
public void setClientId(long clientId)
```
    Set the client ID.
    
    Since:
    
    2.8
  - getClientIdAlias
```
public String getClientIdAlias()
```
    Get the client ID alias.
    If the client did not have an alias, this method returns null.
    
    Returns:
    
    The client ID alias.
    
    Since:
    
    2.8
  - setClientIdAlias
```
public void setClientIdAlias(String alias)
```
    Set the client ID alias.
    
    Parameters:
    
    alias - The client ID alias.
    
    Since:
    
    2.8
  - isClientIdAliasUsed
```
public boolean isClientIdAliasUsed()
```
    Get the flag which indicates whether the client ID alias was used when the token request was made.
    
    Returns:
    
    true if the client ID alias was used when the token request was made.
    
    Since:
    
    2.8
  - setClientIdAliasUsed
```
public void setClientIdAliasUsed(boolean used)
```
    Set the flag which indicates whether the client ID alias was used when the token request was made.
    
    Parameters:
    
    used - true if the client ID alias was used when the token request was made.
    
    Since:
    
    2.8
  - getSubject
```
public String getSubject()
```
    Get the subject (= resource owner's ID) of the access token.
    
    Since:
    
    2.8
  - setSubject
```
public void setSubject(String subject)
```
    Set the subject (= resource owner's ID).
    
    Since:
    
    2.8
  - getScopes
```
public String[] getScopes()
```
    Get the scopes covered by the access token.
    
    Since:
    
    2.8
  - setScopes
```
public void setScopes(String[] scopes)
```
    Set the scopes covered by the access token.
    
    Since:
    
    2.8
  - getProperties
```
public Property[] getProperties()
```
    Get the extra properties associated with the access token. This method returns null when no extra property is associated with the issued access token.
    
    Returns:
    
    Extra properties associated with the issued access token.
    
    Since:
    
    2.8
  - setProperties
```
public void setProperties(Property[] properties)
```
    Set the extra properties associated with the access token.
    
    Parameters:
    
    properties - Extra properties.
    
    Since:
    
    2.8
  - getJwtAccessToken
```
public String getJwtAccessToken()
```
    Get the newly issued access token in JWT format.
    If the authorization server is configured to issue JWT-based access tokens (= if Service.getAccessTokenSignAlg() returns a non-null value), a JWT-based access token is issued along with the original random-string one.
    
    Regarding the detailed format of the JWT-based access token, see the description of the Service class.
    
    Returns:
    
    The newly issued access token in JWT format. If the service is not configured to issue JWT-based access tokens, this method always returns null.
    
    Since:
    
    2.37
    
    See Also:
    
    getAccessToken()
  - setJwtAccessToken
```
public void setJwtAccessToken(String jwtAccessToken)
```
    Set the newly issued access token in JWT format.
    
    Parameters:
    
    jwtAccessToken - The newly issued access token in JWT format.
    
    Since:
    
    2.37

Class TokenIssueResponse

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class com.authlete.common.dto.ApiResponse

Methods inherited from class java.lang.Object

Constructor Detail

TokenIssueResponse

Method Detail

getAction

setAction

getResponseContent

setResponseContent

summarize

getAccessToken

setAccessToken

getAccessTokenExpiresAt

setAccessTokenExpiresAt

getAccessTokenDuration

setAccessTokenDuration

getRefreshToken

setRefreshToken

getRefreshTokenExpiresAt

setRefreshTokenExpiresAt

getRefreshTokenDuration

setRefreshTokenDuration

getClientId

setClientId

getClientIdAlias

setClientIdAlias

isClientIdAliasUsed

setClientIdAliasUsed

getSubject

setSubject

getScopes

setScopes

getProperties

setProperties

getJwtAccessToken

setJwtAccessToken