com.wallee.android.sdk.credentials

Class Credentials

java.lang.Object

com.wallee.android.sdk.credentials.Credentials

All Implemented Interfaces:

android.os.Parcelable, java.io.Serializable

public final class Credentials
extends java.lang.Object
implements java.io.Serializable, android.os.Parcelable

The credentials represents the authentication details which allows to invoke the wallee API. The credentials are valid for a limit time and only for a particular transaction.

The credentials are unmodifiable.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static android.os.Parcelable.Creator<Credentials>	CREATOR
static long	THRESHOLD The threshold which is used to check if the credentials are still valid.

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
Credentials(java.lang.String credentials) Constructor which takes as input the formatted string as provided by the wallee API.

Method Summary

Modifier and Type	Method and Description
void	checkCredentials(Credentials other) This method checks if the provided other credential is a valid replacement of this credentials.
int	describeContents()
java.lang.String	getCredentials()
long	getSpaceId()
long	getTimestamp()
long	getTransactionId()
boolean	isValid()
java.lang.String	toString()
void	writeToParcel(android.os.Parcel dest, int flags)

Methods inherited from class java.lang.Object

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

Field Detail

THRESHOLD

public static final long THRESHOLD

The threshold which is used to check if the credentials are still valid. The threshold defines the minimum time in milliseconds which the credentials need to be valid.

See Also:

Constant Field Values

CREATOR

public static final android.os.Parcelable.Creator<Credentials> CREATOR

Constructor Detail

Credentials

public Credentials(java.lang.String credentials)
            throws InvalidCredentialsException

Constructor which takes as input the formatted string as provided by the wallee API. The constructor parses the credentials into a structured form.

Parameters:

credentials - the credential string which should be parsed.

Throws:

InvalidCredentialsException - thrown when the provided credential string is not valid.

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

writeToParcel

public void writeToParcel(android.os.Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface android.os.Parcelable

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable

isValid

public boolean isValid()

Returns:

true when the credentials are still valid otherwise the method returns false.

checkCredentials

public void checkCredentials(Credentials other)
                      throws java.lang.IllegalStateException

This method checks if the provided other credential is a valid replacement of this credentials. Means the method checks whether the other credentials belongs to the same transaction as this.

Parameters:

other - the other credential pair which should be checked.

Throws:

java.lang.IllegalStateException - thrown when the provided other is not a valid replacement.

getCredentials

public java.lang.String getCredentials()

Returns:

the credentials as they are provided through the wallee web service

getTransactionId

public long getTransactionId()

Returns:

the transaction ID for which the credentials are build for. This is the transaction id to which the credentials give access to.

getSpaceId

public long getSpaceId()

Returns:

the ID of the space to which the transaction belongs to.

getTimestamp

public long getTimestamp()

Returns:

the timestamp (milliseconds since 1970-01-01) when the credentials will expire on.