Package net.shibboleth.idp.plugin.authn.oidc.rp.principal

Class OAuth2AccessTokenPrincipal

java.lang.Object

net.shibboleth.idp.plugin.authn.oidc.rp.principal.OAuth2AccessTokenPrincipal

All Implemented Interfaces:

Cloneable, Principal, net.shibboleth.idp.authn.principal.CloneablePrincipal

public class OAuth2AccessTokenPrincipal
extends Object
implements net.shibboleth.idp.authn.principal.CloneablePrincipal

Principal based on an OAuth 2.0 access token.

Field Summary

Fields

Modifier and Type	Field	Description
private String	accessToken	The access_token.
private String	accessTokenType	The token_type.
private Duration	expiresIn	The duration in seconds when the access token expires.

Constructor Summary

Constructors

Constructor	Description
OAuth2AccessTokenPrincipal(String token, String tokenType, Duration expiresInDuration)	Constructor.

Method Summary

Modifier and Type	Method	Description
OAuth2AccessTokenPrincipal	clone()
boolean	equals(Object other)
String	getAccessTokenType()	Get the token_type.
Duration	getExpiresIn()	Get the number of seconds since the response was generated the access_token expires.
String	getName()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.security.Principal

implies

Field Detail

accessToken

@Nonnull
@NotEmpty
private String accessToken

The access_token.

accessTokenType

@Nonnull
@NotEmpty
private String accessTokenType

The token_type.

expiresIn

@Nullable
private Duration expiresIn

The duration in seconds when the access token expires.

Constructor Detail

OAuth2AccessTokenPrincipal

public OAuth2AccessTokenPrincipal(@Nonnull @NotEmpty @ParameterName(name="accessToken")
                                  String token,
                                  @Nonnull @NotEmpty @ParameterName(name="accessToken")
                                  String tokenType,
                                  @Nullable @ParameterName(name="expiresIn")
                                  Duration expiresInDuration)

Constructor.

Parameters:

token - the access_token

tokenType - the token_type

expiresInDuration - the expires_in in seconds since the response was generated

Method Detail

getName

@Nonnull
@NotEmpty
public String getName()

Specified by:

getName in interface Principal

getAccessTokenType

@Nonnull
public String getAccessTokenType()

Get the token_type.

Returns:

the token_type

getExpiresIn

@Nullable
public Duration getExpiresIn()

Get the number of seconds since the response was generated the access_token expires.

Returns:

the expires_in

hashCode

public int hashCode()

Specified by:

hashCode in interface Principal

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Specified by:

equals in interface Principal

Overrides:

equals in class Object

toString

public String toString()

Specified by:

toString in interface Principal

Overrides:

toString in class Object

clone

public OAuth2AccessTokenPrincipal clone()
                                 throws CloneNotSupportedException

Specified by:

clone in interface net.shibboleth.idp.authn.principal.CloneablePrincipal

Overrides:

clone in class Object

Throws:

CloneNotSupportedException