Package com.verisign.epp.codec.validate.v02

Class EPPValidateAuthInfo

java.lang.Object

com.verisign.epp.codec.validate.v02.EPPValidateAuthInfo

All Implemented Interfaces:

EPPCodecComponent, Serializable, Cloneable

public class EPPValidateAuthInfo
extends Object
implements EPPCodecComponent

Represents authorization information that is used for validate.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	ATTR_ROID	XML Element roid attribute name of EPPValidateAuthInfo root element.
protected static final String	ELM_EXT	XML Element name extensible authorization type
static final String	ELM_LOCALNAME	Constant for the AuthInfo local name
static final String	ELM_NAME	Constant for the authInfo tag
protected static final String	ELM_PW	XML Element name password authorization type
protected EPPCodecComponent	ext	Extension authorization information.
protected String	password	Password authorization information.
protected String	roid	roid.
protected short	type	Type, and default value is TYPE_PW
static final short	TYPE_EXT	Extensible auth info type.
static final short	TYPE_PW	password auth info type

Constructor Summary

Constructors

Constructor	Description
EPPValidateAuthInfo()	Default constructor that must have the password or extension attributes set before calling encode.
EPPValidateAuthInfo(EPPCodecComponent aExt)	Constructor that takes just the authorization extension.
EPPValidateAuthInfo(String aPassword)	Constructor that takes just the authorization password.
EPPValidateAuthInfo(String aPassword, String aRoid)	Constructor the authorization password and the roid.

Method Summary

Modifier and Type	Method	Description
Object	clone()	Clone EPPValidateAuthInfo.
void	decode(Element aElement)	Decode the EPPValidateAuthInfo attributes from the aElement DOM Element tree.
Element	encode(Document aDocument)	Encode a DOM Element tree from the attributes of the EPPValidateAuthInfo instance.
boolean	equals(Object aObject)	implements a deep EPPValidateAuthInfo compare.
EPPCodecComponent	getExt()	Gets the extension authorization.
String	getNamespace()	Returns the XML namespace associated with the EPPCodecComponent.
String	getPassword()	Gets the password authorization information.
String	getRoid()	Get Registry Object IDentifier (ROID).
short	getType()	Get the type of the auth info.
void	setExt(EPPCodecComponent aExt)	Sets the extension authorization information.
void	setPassword(String aPassword)	Sets the password authorization information.
void	setRoid(String aRoid)	Set Registry Object IDentifier (ROID).
void	setType(short aType)	Set auth info type.
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

TYPE_PW

public static final short TYPE_PW

password auth info type

See Also:

• Constant Field Values

TYPE_EXT

public static final short TYPE_EXT

Extensible auth info type.

See Also:

• Constant Field Values

ELM_LOCALNAME

public static final String ELM_LOCALNAME

Constant for the AuthInfo local name

See Also:

• Constant Field Values

ELM_NAME

public static final String ELM_NAME

Constant for the authInfo tag

See Also:

• Constant Field Values

ELM_PW

protected static final String ELM_PW

XML Element name password authorization type

See Also:

• Constant Field Values

ELM_EXT

protected static final String ELM_EXT

XML Element name extensible authorization type

See Also:

• Constant Field Values

ATTR_ROID

protected static final String ATTR_ROID

XML Element roid attribute name of EPPValidateAuthInfo root element.

See Also:

• Constant Field Values

password

protected String password

Password authorization information.

ext

protected EPPCodecComponent ext

Extension authorization information.

type

protected short type

Type, and default value is TYPE_PW

roid

protected String roid

roid.

Constructor Details

EPPValidateAuthInfo

public EPPValidateAuthInfo()

Default constructor that must have the password or extension attributes set before calling encode.

EPPValidateAuthInfo

public EPPValidateAuthInfo(String aPassword)

Constructor that takes just the authorization password.

Parameters:

aPassword - Authorization password

EPPValidateAuthInfo

public EPPValidateAuthInfo(String aPassword,
 String aRoid)

Constructor the authorization password and the roid.

Parameters:

aPassword - Authorization password

aRoid - Roid of the Registrant

EPPValidateAuthInfo

public EPPValidateAuthInfo(EPPCodecComponent aExt)

Constructor that takes just the authorization extension.

Parameters:

aExt - Extension authorization element

Method Details

getRoid

public String getRoid()

Get Registry Object IDentifier (ROID).

Returns:

Registry Object IDentifier (ROID)

setRoid

public void setRoid(String aRoid)

Set Registry Object IDentifier (ROID).

Parameters:

aRoid - The Registry Object IDentifier (ROID) value.

getPassword

public String getPassword()

Gets the password authorization information.

Returns:

Authorization password

setPassword

public void setPassword(String aPassword)

Sets the password authorization information.

Parameters:

aPassword - Authorization password

getExt

public EPPCodecComponent getExt()

Gets the extension authorization.

Returns:

Authorization extension

setExt

public void setExt(EPPCodecComponent aExt)

Sets the extension authorization information.

Parameters:

aExt - Authorization extension

getType

public short getType()

Get the type of the auth info.

Returns:

One of the TYPE_ constants.

setType

public void setType(short aType)

Set auth info type. The default value is TYPE_PW.

Parameters:

aType - One of the TYPE_ constants

clone

public Object clone()
             throws CloneNotSupportedException

Clone EPPValidateAuthInfo.

Specified by:

clone in interface EPPCodecComponent

Overrides:

clone in class Object

Returns:

clone of EPPValidateAuthInfo

Throws:

CloneNotSupportedException - standard Object.clone exception

encode

public Element encode(Document aDocument)
               throws EPPEncodeException

Encode a DOM Element tree from the attributes of the EPPValidateAuthInfo instance.

Specified by:

encode in interface EPPCodecComponent

Parameters:

aDocument - - DOM Document that is being built. Used as an Element factory.

Returns:

Element - Root DOM Element representing the EPPValidateAuthInfo instance.

Throws:

EPPEncodeException - - Unable to encode EPPValidateAuthInfo instance.

decode

public void decode(Element aElement)
            throws EPPDecodeException

Decode the EPPValidateAuthInfo attributes from the aElement DOM Element tree.

Specified by:

decode in interface EPPCodecComponent

Parameters:

aElement - - Root DOM Element to decode EPPDomainContact from.

Throws:

EPPDecodeException - - Unable to decode aElement.

equals

public boolean equals(Object aObject)

implements a deep EPPValidateAuthInfo compare.

Overrides:

equals in class Object

Parameters:

aObject - EPPValidateAuthInfo instance to compare with

Returns:

true if equal; false otherwise

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.

getNamespace

public String getNamespace()

Returns the XML namespace associated with the EPPCodecComponent.

Specified by:

getNamespace in interface EPPCodecComponent

Returns:

XML namespace for the EPPCodecComponent.