Package org.apereo.cas.ticket.refreshtoken

Interface OAuth20RefreshToken

All Superinterfaces:

org.apereo.cas.ticket.AuthenticationAwareTicket, java.lang.Comparable<org.apereo.cas.ticket.Ticket>, OAuth20Token, java.io.Serializable, org.apereo.cas.ticket.ServiceTicket, org.apereo.cas.ticket.Ticket

public interface OAuth20RefreshToken
extends OAuth20Token

A refresh token is an OAuth token which can be used multiple times and has a very long lifetime. It is used to create new access tokens.

Since:

5.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	PREFIX	The prefix for refresh tokens.

Method Summary

Modifier and Type	Method	Description
default java.util.Set<java.lang.String>	getAccessTokens()	Gets descendant OAuth access tokens.

Methods inherited from interface org.apereo.cas.ticket.AuthenticationAwareTicket

getAuthentication

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.apereo.cas.ticket.OAuth20Token

getClaims, getClientId, getGrantType, getResponseType, getScopes

Methods inherited from interface org.apereo.cas.ticket.ServiceTicket

getService, grantProxyGrantingTicket, isFromNewLogin

Methods inherited from interface org.apereo.cas.ticket.Ticket

getCountOfUses, getCreationTime, getExpirationPolicy, getId, getPrefix, getTicketGrantingTicket, isExpired, markTicketExpired

Field Detail

PREFIX

static final java.lang.String PREFIX

The prefix for refresh tokens.

See Also:

Constant Field Values

Method Detail

getAccessTokens

default java.util.Set<java.lang.String> getAccessTokens()

Gets descendant OAuth access tokens. The revocation of a refresh token may cause the revocation of related tokens and the underlying authorization grant. If a refresh token is revoked, the authorization server SHOULD also invalidate all access tokens based on the same authorization grant. Here, we track the access tokens.

Returns:

the access tokens

Since:

6.2