com.hortonworks.registries.auth.util

Class AuthToken

java.lang.Object

com.hortonworks.registries.auth.util.AuthToken

All Implemented Interfaces:

java.security.Principal

Direct Known Subclasses:

AuthenticationToken

public class AuthToken
extends java.lang.Object
implements java.security.Principal

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AuthToken()
	AuthToken(java.lang.String userName, java.lang.String principal, java.lang.String type) Creates an authentication token.

Method Summary

Modifier and Type	Method and Description
protected static void	checkForIllegalArgument(java.lang.String value, java.lang.String name) Check if the provided value is invalid.
long	getExpires() Returns the expiration time of the token.
java.lang.String	getName() Returns the principal name (this method name comes from the JDK Principal interface).
java.lang.String	getType() Returns the authentication mechanism of the token.
java.lang.String	getUserName() Returns the user name.
boolean	isExpired() Returns true if the token has expired.
static AuthToken	parse(java.lang.String tokenStr)
void	setExpires(long expires) Sets the expiration of the token.
java.lang.String	toString() Returns the string representation of the token.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.security.Principal

equals, hashCode, implies

Constructor Detail

AuthToken

protected AuthToken()

AuthToken

public AuthToken(java.lang.String userName,
                 java.lang.String principal,
                 java.lang.String type)

Creates an authentication token.

Parameters:

userName - user name.

principal - principal (commonly matches the user name, with Kerberos is the full/long principal name while the userName is the short name).

type - the authentication mechanism name. (System.currentTimeMillis() + validityPeriod).

Method Detail

checkForIllegalArgument

protected static void checkForIllegalArgument(java.lang.String value,
                                              java.lang.String name)

Check if the provided value is invalid. Throw an error if it is invalid, NOP otherwise.

Parameters:

value - the value to check.

name - the parameter name to use in an error message if the value is invalid.

setExpires

public void setExpires(long expires)

Sets the expiration of the token.

Parameters:

expires - expiration time of the token in milliseconds since the epoch.

isExpired

public boolean isExpired()

Returns true if the token has expired.

Returns:

true if the token has expired.

getUserName

public java.lang.String getUserName()

Returns the user name.

Returns:

the user name.

getName

public java.lang.String getName()

Returns the principal name (this method name comes from the JDK Principal interface).

Specified by:

getName in interface java.security.Principal

Returns:

the principal name.

getType

public java.lang.String getType()

Returns the authentication mechanism of the token.

Returns:

the authentication mechanism of the token.

getExpires

public long getExpires()

Returns the expiration time of the token.

Returns:

the expiration time of the token, in milliseconds since Epoc.

toString

public java.lang.String toString()

Returns the string representation of the token.

This string representation is parseable by the parse(java.lang.String) method.

Specified by:

toString in interface java.security.Principal

Overrides:

toString in class java.lang.Object

Returns:

the string representation of the token.

parse

public static AuthToken parse(java.lang.String tokenStr)
                       throws AuthenticationException

Throws:

AuthenticationException