org.apache.kerby.kerberos.kerb.type.base

Interface AuthToken

All Known Implementing Classes:

KrbToken

public interface AuthToken

This is the token definition API according to TokenPreauth draft.

Method Summary

Modifier and Type	Method and Description
void	addAttribute(String name, Object value) Add a token attribute.
Map<String,Object>	getAttributes() Get token attributes.
List<String>	getAudiences() Get token audiences
Date	getExpiredTime() Get token expired data time.
String	getIssuer() Get the token issuer
Date	getIssueTime() Get token issued at time when the token is issued.
Date	getNotBeforeTime() Get token not before time.
String	getSubject() Get the token subject
boolean	isAcToken() Is an Access Token ?
void	isAcToken(boolean isAcToken)
boolean	isBearerToken() Is a Bearer Token ?
boolean	isHolderOfKeyToken() Is an Holder-of-Key Token (HOK) ?
boolean	isIdToken() Is an Identity Token ?
void	isIdToken(boolean isIdToken)
void	setAudiences(List<String> audiences) Set token audiences
void	setExpirationTime(Date exp) Set token expired time
void	setIssuer(String issuer) Set token issuer
void	setIssueTime(Date iat) Set token issued at time.
void	setNotBeforeTime(Date nbt) Set token not before time.
void	setSubject(String sub) Set token subject

Method Detail

getSubject

String getSubject()

Get the token subject

Returns:

token subject

setSubject

void setSubject(String sub)

Set token subject

Parameters:

sub - The token subject

getIssuer

String getIssuer()

Get the token issuer

Returns:

token issuer

setIssuer

void setIssuer(String issuer)

Set token issuer

Parameters:

issuer - The token issuer

getAudiences

List<String> getAudiences()

Get token audiences

Returns:

token audiences

setAudiences

void setAudiences(List<String> audiences)

Set token audiences

Parameters:

audiences - The token audiences

isIdToken

boolean isIdToken()

Is an Identity Token ?

Returns:

true if it's an identity token, false otherwise

isIdToken

void isIdToken(boolean isIdToken)

isAcToken

boolean isAcToken()

Is an Access Token ?

Returns:

true if it's an access token, false otherwise

isAcToken

void isAcToken(boolean isAcToken)

isBearerToken

boolean isBearerToken()

Is a Bearer Token ?

Returns:

true if it's an bearer token, false otherwise

isHolderOfKeyToken

boolean isHolderOfKeyToken()

Is an Holder-of-Key Token (HOK) ?

Returns:

true if it's a HOK token, false otherwise

getExpiredTime

Date getExpiredTime()

Get token expired data time.

Returns:

expired time

setExpirationTime

void setExpirationTime(Date exp)

Set token expired time

Parameters:

exp - The token expired time

getNotBeforeTime

Date getNotBeforeTime()

Get token not before time.

Returns:

not before time

setNotBeforeTime

void setNotBeforeTime(Date nbt)

Set token not before time.

Parameters:

nbt - The time

getIssueTime

Date getIssueTime()

Get token issued at time when the token is issued.

Returns:

issued at time

setIssueTime

void setIssueTime(Date iat)

Set token issued at time.

Parameters:

iat - Time time when token issued

getAttributes

Map<String,Object> getAttributes()

Get token attributes.

Returns:

token attributes

addAttribute

void addAttribute(String name,
                  Object value)

Add a token attribute.

Parameters:

name - The attribute name

value - The attribute value