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

Class KrbToken

java.lang.Object

org.apache.kerby.asn1.type.Asn1Object

org.apache.kerby.asn1.type.Asn1Encodeable

org.apache.kerby.asn1.type.AbstractAsn1Type<org.apache.kerby.asn1.type.Asn1CollectionType>

org.apache.kerby.asn1.type.Asn1CollectionType

org.apache.kerby.asn1.type.Asn1SequenceType

org.apache.kerby.kerberos.kerb.type.KrbSequenceType

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

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

All Implemented Interfaces:

org.apache.kerby.asn1.Asn1Dumpable, org.apache.kerby.asn1.type.Asn1Type, AuthToken

public class KrbToken
extends KrbTokenBase
implements AuthToken

KRB-TOKEN_VALUE ::= SEQUENCE { token-format [0] INTEGER, token-value [1] OCTET STRING, }

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.kerby.kerberos.kerb.type.base.KrbTokenBase

KrbTokenBase.KrbTokenField

Nested classes/interfaces inherited from interface org.apache.kerby.asn1.type.Asn1Type

org.apache.kerby.asn1.type.Asn1Type.EncodingType

Field Summary

Fields inherited from class org.apache.kerby.asn1.type.Asn1Encodeable

bodyLength, outerEncodeable

Constructor Summary

Constructors

Constructor and Description
KrbToken() Default constructor.
KrbToken(AuthToken authToken, TokenFormat format) Construct with prepared authToken and token format.

Method Summary

Modifier and Type	Method and Description
void	addAttribute(String name, Object value) Add a token attribute.
void	decode(org.apache.kerby.asn1.parse.Asn1ParseResult parseResult)
Map<String,Object>	getAttributes() Get token attributes.
List<String>	getAudiences() Get token audiences
AuthToken	getAuthToken() Get AuthToken.
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
protected static TokenDecoder	getTokenDecoder(TokenFormat format) Get token decoder.
protected static TokenEncoder	getTokenEncoder(TokenFormat format) Get token encoder.
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	setInnerToken(AuthToken authToken)
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
void	setTokenType() Set token type.

Methods inherited from class org.apache.kerby.kerberos.kerb.type.base.KrbTokenBase

getTokenFormat, getTokenValue, setTokenFormat, setTokenValue

Methods inherited from class org.apache.kerby.kerberos.kerb.type.KrbSequenceType

getFieldAsInt, getFieldAsTime, setField, setFieldAsString, setFieldAsTime

Methods inherited from class org.apache.kerby.asn1.type.Asn1SequenceType

createCollection

Methods inherited from class org.apache.kerby.asn1.type.Asn1CollectionType

decodeBody, dumpWith, encodeBody, encodingBodyLength, getFieldAs, getFieldAsAny, getFieldAsInteger, getFieldAsObjId, getFieldAsOctets, getFieldAsString, setAnyFieldValueType, setFieldAs, setFieldAsAny, setFieldAsInt, setFieldAsInt, setFieldAsObjId, setFieldAsOctets

Methods inherited from class org.apache.kerby.asn1.type.AbstractAsn1Type

getValue, setValue, toString

Methods inherited from class org.apache.kerby.asn1.type.Asn1Encodeable

decode, decode, encode, encode, encodingHeaderLength, encodingLength, getBodyLength, getHeaderLength, isBER, isCER, isDefinitiveLength, isDER, isImplicit, isPrimitive, resetBodyLength, taggedDecode, taggedDecode, taggedDecode, taggedEncode, taggedEncode, taggedEncodingLength, useBER, useCER, useDefinitiveLength, useDER, useImplicit, usePrimitive

Methods inherited from class org.apache.kerby.asn1.type.Asn1Object

isAppSpecific, isCollection, isContextSpecific, isEOC, isNull, isSimple, isTagSpecific, isUniversal, simpleInfo, tag, tagFlags, tagNo

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.kerby.asn1.type.Asn1Type

tag

Constructor Detail

KrbToken

public KrbToken()

Default constructor.

KrbToken

public KrbToken(AuthToken authToken,
                TokenFormat format)

Construct with prepared authToken and token format.

Parameters:

authToken - The authToken

format - The token format

Method Detail

getAuthToken

public AuthToken getAuthToken()

Get AuthToken.

Returns:

The inner token.

decode

public void decode(org.apache.kerby.asn1.parse.Asn1ParseResult parseResult)
            throws IOException

Overrides:

decode in class org.apache.kerby.asn1.type.Asn1Encodeable

Throws:

IOException

setTokenType

public void setTokenType()

Set token type.

getTokenEncoder

protected static TokenEncoder getTokenEncoder(TokenFormat format)

Get token encoder.

Returns:

The token encoder

getTokenDecoder

protected static TokenDecoder getTokenDecoder(TokenFormat format)

Get token decoder.

Returns:

The token decoder

getSubject

public String getSubject()

Get the token subject

Specified by:

getSubject in interface AuthToken

Returns:

token subject

setSubject

public void setSubject(String sub)

Set token subject

Specified by:

setSubject in interface AuthToken

Parameters:

sub - The token subject

getIssuer

public String getIssuer()

Get the token issuer

Specified by:

getIssuer in interface AuthToken

Returns:

token issuer

setIssuer

public void setIssuer(String issuer)

Set token issuer

Specified by:

setIssuer in interface AuthToken

Parameters:

issuer - The token issuer

getAudiences

public List<String> getAudiences()

Get token audiences

Specified by:

getAudiences in interface AuthToken

Returns:

token audiences

setAudiences

public void setAudiences(List<String> audiences)

Set token audiences

Specified by:

setAudiences in interface AuthToken

Parameters:

audiences - The token audiences

isIdToken

public boolean isIdToken()

Is an Identity Token ?

Specified by:

isIdToken in interface AuthToken

Returns:

true if it's an identity token, false otherwise

isIdToken

public void isIdToken(boolean isIdToken)

Specified by:

isIdToken in interface AuthToken

isAcToken

public boolean isAcToken()

Is an Access Token ?

Specified by:

isAcToken in interface AuthToken

Returns:

true if it's an access token, false otherwise

isAcToken

public void isAcToken(boolean isAcToken)

Specified by:

isAcToken in interface AuthToken

isBearerToken

public boolean isBearerToken()

Is a Bearer Token ?

Specified by:

isBearerToken in interface AuthToken

Returns:

true if it's an bearer token, false otherwise

isHolderOfKeyToken

public boolean isHolderOfKeyToken()

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

Specified by:

isHolderOfKeyToken in interface AuthToken

Returns:

true if it's a HOK token, false otherwise

getExpiredTime

public Date getExpiredTime()

Get token expired data time.

Specified by:

getExpiredTime in interface AuthToken

Returns:

expired time

setExpirationTime

public void setExpirationTime(Date exp)

Set token expired time

Specified by:

setExpirationTime in interface AuthToken

Parameters:

exp - The token expired time

getNotBeforeTime

public Date getNotBeforeTime()

Get token not before time.

Specified by:

getNotBeforeTime in interface AuthToken

Returns:

not before time

setNotBeforeTime

public void setNotBeforeTime(Date nbt)

Set token not before time.

Specified by:

setNotBeforeTime in interface AuthToken

Parameters:

nbt - The time

getIssueTime

public Date getIssueTime()

Get token issued at time when the token is issued.

Specified by:

getIssueTime in interface AuthToken

Returns:

issued at time

setIssueTime

public void setIssueTime(Date iat)

Set token issued at time.

Specified by:

setIssueTime in interface AuthToken

Parameters:

iat - Time time when token issued

getAttributes

public Map<String,Object> getAttributes()

Get token attributes.

Specified by:

getAttributes in interface AuthToken

Returns:

token attributes

addAttribute

public void addAttribute(String name,
                         Object value)

Add a token attribute.

Specified by:

addAttribute in interface AuthToken

Parameters:

name - The attribute name

value - The attribute value

setInnerToken

public void setInnerToken(AuthToken authToken)