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

Class EPPAuthTokenMfa

java.lang.Object

com.verisign.epp.codec.authtoken.v01.EPPAuthTokenMfa

All Implemented Interfaces:

EPPCodecComponent, Serializable, Cloneable

public class EPPAuthTokenMfa
extends Object
implements EPPCodecComponent

The EPPAuthTokenMfa 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_LOCALNAME
static final String	MFA_TYPE_BIOMETRIC	TOTP as biometric type
static final String	MFA_TYPE_CUSTOM	Custom as mfa type
static final String	MFA_TYPE_DEVICE	TOTP as device type
static final String	MFA_TYPE_KEY	Key as mfa type
static final String	MFA_TYPE_PUSH	Push as mfa type
static final String	MFA_TYPE_TOTP	TOTP as mfa type

Constructor Summary

Constructors

Constructor	Description
EPPAuthTokenMfa()
EPPAuthTokenMfa(String aValue)
EPPAuthTokenMfa(String aValue, String aType)
EPPAuthTokenMfa(String aValue, String aType, String aCustom)

Method Summary

Modifier and Type	Method	Description
Object	clone()	clone an EPPCodecComponent.
void	decode(Element aElement)	Populate the data of this instance with the data stored in the given Element of the DOM tree
Element	encode(Document aDocument)	Sets this instance's data in the given XML document
String	getCustomValue()	return the name of this custom type
String	getMfaType()	get type of this mfa
String	getMfaValue()	get the actual mfa value
String	getNamespace()	Gets the EPP namespace associated with the EPPCodecComponent.
boolean	hasCustomType()
void	setCustomValue(String customValue)	set custom value
void	setMfaType(String aType)	set the type of mfa
void	setMfaValue(String mfaValue)	set mfa value as string
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

MFA_TYPE_TOTP

public static final String MFA_TYPE_TOTP

TOTP as mfa type

See Also:

• Constant Field Values

MFA_TYPE_KEY

public static final String MFA_TYPE_KEY

Key as mfa type

See Also:

• Constant Field Values

MFA_TYPE_BIOMETRIC

public static final String MFA_TYPE_BIOMETRIC

TOTP as biometric type

See Also:

• Constant Field Values

MFA_TYPE_DEVICE

public static final String MFA_TYPE_DEVICE

TOTP as device type

See Also:

• Constant Field Values

MFA_TYPE_PUSH

public static final String MFA_TYPE_PUSH

Push as mfa type

See Also:

• Constant Field Values

MFA_TYPE_CUSTOM

public static final String MFA_TYPE_CUSTOM

Custom as mfa type

See Also:

• Constant Field Values

ELM_LOCALNAME

public static final String ELM_LOCALNAME

See Also:

• Constant Field Values

Constructor Details

EPPAuthTokenMfa

public EPPAuthTokenMfa()

EPPAuthTokenMfa

public EPPAuthTokenMfa(String aValue)

EPPAuthTokenMfa

public EPPAuthTokenMfa(String aValue,
 String aType)

EPPAuthTokenMfa

public EPPAuthTokenMfa(String aValue,
 String aType,
 String aCustom)

Method Details

hasCustomType

public boolean hasCustomType()

encode

public Element encode(Document aDocument)
               throws EPPEncodeException

Sets this instance's data in the given XML document

Specified by:

encode in interface EPPCodecComponent

Parameters:

aDocument - DOM document used as a factory of DOM objects.

Returns:

instance root DOM element along with attribute child nodes.

Throws:

EPPEncodeException - Error encoding the DOM element tree.

decode

public void decode(Element aElement)
            throws EPPDecodeException

Populate the data of this instance with the data stored in the given Element of the DOM tree

Specified by:

decode in interface EPPCodecComponent

Parameters:

aElement - The root element of the fragment of XML

Throws:

EPPDecodeException - Thrown if any errors occur during decoding.

getNamespace

public String getNamespace()

Gets the EPP namespace associated with the EPPCodecComponent.

Specified by:

getNamespace in interface EPPCodecComponent

Returns:

Namespace URI associated with the EPPCodecComponent.

setMfaType

public void setMfaType(String aType)

set the type of mfa

Parameters:

aType -

getMfaType

public String getMfaType()

get type of this mfa

Returns:

string value of mfa type

getMfaValue

public String getMfaValue()

get the actual mfa value

Returns:

string

setMfaValue

public void setMfaValue(String mfaValue)

set mfa value as string

Parameters:

mfaValue - string representing the value

getCustomValue

public String getCustomValue()

return the name of this custom type

Returns:

setCustomValue

public void setCustomValue(String customValue)

set custom value

Parameters:

customValue -

clone

public Object clone()
             throws CloneNotSupportedException

clone an EPPCodecComponent.

Specified by:

clone in interface EPPCodecComponent

Overrides:

clone in class Object

Returns:

clone of concrete EPPCodecComponent

Throws:

CloneNotSupportedException - standard Object.clone exception

toString

public String toString()

Overrides:

toString in class Object