public class AccessToken

  1. Object
  2. AccessToken

ImplementsExternalizable

This class represent an access token.

Constructors

public AccessToken(String token, String expires)Constructor with parameters
public AccessToken(String token, String expires, String refreshToken)Constructor with parameters
public AccessToken(String token, String expires, String refreshToken, String identityToken)Constructor with parameters
public AccessToken()

Methods

public static AccessToken createWithExpiryDate(String token, Date expiryDate)
public String getToken()Simple getter
public String getExpires()Simple getter
public int getVersion()Returns the version for the current persistance code, the version will be pased to internalized thus allowing the internalize method to recognize classes persisted in older revisions
public void externalize(DataOutputStream out) throws IOExceptionAllows us to store an object state, this method must be implemented in order to save the state of an object
public void internalize(int version, DataInputStream in) throws IOExceptionLoads the object from the input stream and allows deserialization
public String getRefreshToken()Gets refresh token.
public void setRefreshToken(String refreshToken)Sets refresh token.
public String getObjectId()The object id must be unique, it is used to identify the object when loaded even when it is obfuscated.
public boolean equals(Object obj)Indicates whether some other object is “equal to” this one.
public int hashCode()Returns a hash code value for the object.
public String toString()Returns a string representation of the object.
public Date getExpiryDate()Gets the expiry date of this token.
public void setExpiryDate(Date date)Sets the expiry date of this token.
public boolean isExpired()Checks to see if this token is expired.
public String getIdentityToken()
public void setIdentityToken(String identityToken)

Inherited methods

Constructor details

AccessToken

public AccessToken(String token, String expires)
Constructor with parameters

Parameters

token String
the token string
expires String
the access token expires date

AccessToken

public AccessToken(String token, String expires, String refreshToken)
Constructor with parameters

Parameters

token String
the token string
expires String
the access token expires date
refreshToken String
The refresh token.

AccessToken

public AccessToken(String token, String expires, String refreshToken, String identityToken)
Constructor with parameters

Parameters

token String
the token string
expires String
the access token expires date
refreshToken String
The refresh token.
identityToken String
The identity token

AccessToken

public AccessToken()

Method details

createWithExpiryDate

public static AccessToken createWithExpiryDate(String token, Date expiryDate)

Parameters

token String
Not documented.
expiryDate Date
The expiry date.

getToken

public String getToken()
Simple getter

Returns

the token string

getExpires

public String getExpires()
Simple getter

Returns

the expires date

getVersion

public int getVersion()
Returns the version for the current persistance code, the version will be pased to internalized thus allowing the internalize method to recognize classes persisted in older revisions

Returns

version number for the persistant code

externalize

public void externalize(DataOutputStream out) throws IOException
Allows us to store an object state, this method must be implemented in order to save the state of an object

Parameters

out DataOutputStream
the stream into which the object must be serialized

Throws

java.io.IOException
the method may throw an exception

internalize

public void internalize(int version, DataInputStream in) throws IOException
Loads the object from the input stream and allows deserialization

Parameters

version int
the version the class returned during the externalization processs
in DataInputStream
the input stream used to load the class

Throws

java.io.IOException
the method may throw an exception

getRefreshToken

public String getRefreshToken()
Gets refresh token.

Returns

Refresh token.

setRefreshToken

public void setRefreshToken(String refreshToken)
Sets refresh token.

Parameters

refreshToken String
The refresh token.

getObjectId

public String getObjectId()
The object id must be unique, it is used to identify the object when loaded even when it is obfuscated.

Returns

a unique id

equals

public boolean equals(Object obj)
Indicates whether some other object is “equal to” this one. The equals method implements an equivalence relation: It is reflexive: for any reference value x, x.equals(x) should return true. It is symmetric: for any reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true. It is transitive: for any reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true. It is consistent: for any reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the object is modified. For any non-null reference value x, x.equals(null) should return false. The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any reference values x and y, this method returns true if and only if x and y refer to the same object (x==y has the value true).

hashCode

public int hashCode()
Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable. The general contract of hashCode is: Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hashtables. As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the JavaTM programming language.)

toString

public String toString()
Returns a string representation of the object. In general, the toString method returns a string that “textually represents” this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method. The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@’, and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of: getClass().getName() + ‘@’ + Integer.toHexString(hashCode())

getExpiryDate

public Date getExpiryDate()
Gets the expiry date of this token.

Returns

The expiry date of this token or null.

setExpiryDate

public void setExpiryDate(Date date)
Sets the expiry date of this token.

Parameters

date Date
The expiry date of this token.

isExpired

public boolean isExpired()
Checks to see if this token is expired.

Returns

False if no expiry date is set or the expiryDate is before the current time.

getIdentityToken

public String getIdentityToken()

Returns

the identityToken

setIdentityToken

public void setIdentityToken(String identityToken)

Parameters

identityToken String
the identityToken to set