Package com.verisign.epp.codec.authtoken.v01

Class EPPAuthTokenPayload

java.lang.Object

com.verisign.epp.codec.authtoken.v01.EPPAuthTokenPayload

All Implemented Interfaces:

Serializable

public class EPPAuthTokenPayload
extends Object
implements Serializable

The EPPAuthTokenPayload is the EPPCodecComponent that knows how to encode and decode mfa element from/to XML and object instance.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ELM_ENTITLEMENTS	XML local name for EPPAuthTokenPayload.
static final String	ELM_EXPIRATION_TIME	XML local name for EPPAuthTokenPayload.
static final String	ELM_JWT_ID	XML local name for EPPAuthTokenPayload.
static final String	ELM_SUBJECT	XML local name for EPPAuthTokenPayload.

Constructor Summary

Constructors

Constructor	Description
EPPAuthTokenPayload()	Create a new instance of EPPAuthTokenPayload
EPPAuthTokenPayload(String aEncodedValue)
EPPAuthTokenPayload(String aJwtId, String aSubject, Date aExpirationTime, List<String> aEntitlements)	Create a new instance of EPPAuthTokenPayload with the optional system and domain data.

Method Summary

Modifier and Type	Method	Description
Object	clone()	Clone EPPAuthTokenPayload.
void	decode(String aEncodedPayload)	Populate the data of this instance with the data from the given encoded header
String	encode()	Return base64 encoded string representation of JWS header
boolean	equals(Object aObject)	implements a deep EPPAuthTokenPayload compare.
List<String>	getEntitlements()
Date	getExpirationTime()
String	getJwtId()
String	getSubject()
void	setEntitlements(List<String> entitlements)
void	setExpirationTime(Date expirationTime)
void	setJwtId(String jwtId)
void	setSubject(String subject)
String	toString()	Implementation of Object.toString, which will result in an indented XML String representation of the concrete EPPCodecComponent.

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

ELM_JWT_ID

public static final String ELM_JWT_ID

XML local name for EPPAuthTokenPayload.

See Also:

• Constant Field Values

ELM_SUBJECT

public static final String ELM_SUBJECT

XML local name for EPPAuthTokenPayload.

See Also:

• Constant Field Values

ELM_EXPIRATION_TIME

public static final String ELM_EXPIRATION_TIME

XML local name for EPPAuthTokenPayload.

See Also:

• Constant Field Values

ELM_ENTITLEMENTS

public static final String ELM_ENTITLEMENTS

XML local name for EPPAuthTokenPayload.

See Also:

• Constant Field Values

Constructor Details

EPPAuthTokenPayload

public EPPAuthTokenPayload()

Create a new instance of EPPAuthTokenPayload

EPPAuthTokenPayload

public EPPAuthTokenPayload(String aEncodedValue)
                    throws EPPDecodeException

Parameters:

aEncodedValue -

Throws:

EPPDecodeException

EPPAuthTokenPayload

public EPPAuthTokenPayload(String aJwtId,
 String aSubject,
 Date aExpirationTime,
 List<String> aEntitlements)

Create a new instance of EPPAuthTokenPayload with the optional system and domain data.

Method Details

encode

public String encode()
              throws EPPEncodeException

Return base64 encoded string representation of JWS header

Returns:

base64 encoded string.

Throws:

EPPEncodeException - Error encoding the header.

decode

public void decode(String aEncodedPayload)
            throws EPPDecodeException

Populate the data of this instance with the data from the given encoded header

Parameters:

aEncodedPayload - base64 encoded string

Throws:

EPPDecodeException - Thrown if any errors occur during decoding.

equals

public boolean equals(Object aObject)

implements a deep EPPAuthTokenPayload compare.

Overrides:

equals in class Object

Parameters:

aObject - EPPAuthTokenPayload instance to compare with

Returns:

true if equal false otherwise

clone

public Object clone()
             throws CloneNotSupportedException

Clone EPPAuthTokenPayload.

Overrides:

clone in class Object

Returns:

clone of EPPAuthTokenPayload

Throws:

CloneNotSupportedException - standard Object.clone exception

getJwtId

public String getJwtId()

setJwtId

public void setJwtId(String jwtId)

getSubject

public String getSubject()

setSubject

public void setSubject(String subject)

getExpirationTime

public Date getExpirationTime()

setExpirationTime

public void setExpirationTime(Date expirationTime)

getEntitlements

public List<String> getEntitlements()

setEntitlements

public void setEntitlements(List<String> entitlements)

toString

public String toString()

Implementation of Object.toString, which will result in an indented XML String representation of the concrete EPPCodecComponent.

Overrides:

toString in class Object

Returns:

Indented XML String if successful; ERROR otherwise.