com.neulevel.epp.xri
Class EppXriAuthority

java.lang.Object
  com.neulevel.epp.core.EppEntity
      com.neulevel.epp.core.EppObject
          com.neulevel.epp.xri.EppXriAuthority

public class EppXriAuthority
extends EppObject

This EppXriAuthority class implements EPP XRI Authority objects.

Version:

$Revision: 1.9 $ $Date: 2008/04/08 15:56:17 $

Author:

Ning Zhang ning.zhang@neustar.com

Field Summary

static java.lang.String	STATUS_CLIENT_ASSOCIATE_PROHIBITED Authority status - clientAssociateProhibited
static java.lang.String	STATUS_CLIENT_DELETE_PROHIBITED Authority status - clientDeleteProhibited
static java.lang.String	STATUS_CLIENT_HOLD Authority status - clientHold
static java.lang.String	STATUS_CLIENT_TRANSFER_PROHIBITED Authority status - clientTransferProhibited
static java.lang.String	STATUS_CLIENT_UPDATE_PROHIBITED Authority status - clientUpdateProhibited
static java.lang.String	STATUS_LINKED Authority status - linked
static java.lang.String	STATUS_OK Authority status - ok
static java.lang.String	STATUS_PENDING_CREATE Authority status - pendingCreate
static java.lang.String	STATUS_PENDING_DELETE Authority status - pendingDelete
static java.lang.String	STATUS_PENDING_INAME_TRANSFER Authority status - pendingINameTransfer
static java.lang.String	STATUS_PENDING_TRANSFER Authority status - pendingTransfer
static java.lang.String	STATUS_PENDING_UPDATE Authority status - pendingUpdate
static java.lang.String	STATUS_SERVER_ASSOCIATE_PROHIBITED Authority status - serverAssociateProhibited
static java.lang.String	STATUS_SERVER_DELETE_PROHIBITED Authority status - serverDeleteProhibited
static java.lang.String	STATUS_SERVER_HOLD Authority status - serverHold
static java.lang.String	STATUS_SERVER_TRANSFER_PROHIBITED Authority status - serverTransferProhibited
static java.lang.String	STATUS_SERVER_UPDATE_PROHIBITED Authority status - serverUpdateProhibited

Fields inherited from class com.neulevel.epp.core.EppObject

authInfo, clID, CONTACT, crDate, crID, DOMAIN, exDate, HOST, roid, status, SVCSUB, trDate, upDate, upID, XRI_AUTHORITY, XRI_INAME, XRI_INUMBER, XRI_ISERVICE

Constructor Summary

EppXriAuthority()
Creates an EppXriAuthority object

EppXriAuthority(java.lang.String authId)
Creates an EppXriAuthority object with an XRI authority identifier

Method Summary

void	addEquivID(EppXriSynonym equivID) Adds a EquivID associated with the XRI authority object
void	addIName(java.lang.String iname) Adds an i-name associated with the XRI authority object
void	addINumber(EppXriNumberAttribute xin) Adds an i-number associated with the XRI authority object
void	addINumber(java.lang.String inumber) Adds an i-number associated with the XRI authority object
void	addINumber(java.lang.String inumber, int priority) Adds an i-number associated with the XRI authority object
void	addIService(java.lang.String iServiceId) Adds the identifier of an XRI I-Service object associated with the XRI authority object
void	addRedirect(EppXriURI redirect) Adds a Redirect associated with the XRI authority object
void	addRef(EppXriRef ref) Adds a Ref associated with the XRI authority object
void	addServiceEndpoint(EppXriServiceEndpoint sep) Adds a XRI service service endpoint (SEP) associated with the XRI authority object
void	addTrustee(EppXriTrustee trustee) Adds a trustee associated with the XRI authority object
static EppCommandCheckXriAuthority	check(java.lang.String xid) Creates an EppCommandCheckXriAuthority object for checking the existance of EPP XRI Authority objects in the registry.
static EppCommandDeleteXriAuthority	delete(java.lang.String authId, java.lang.String xid) Creates an EppCommandDeleteXriAuthority object for deleting an EPP XRI Authority object from the registry.
static EppEntity	fromXML(org.w3c.dom.Node root) Converts an XML element into an EppXriAuthority object.
java.lang.String	getAuthorityId() Gets the XRI authority identifier
java.lang.String	getCanonicalEquivID() Gets the XRI authority's CanonicalEquivID
EppXriTrustee	getContactAgent() Gets the XRI authority's contactAgent
java.util.Vector	getEquivID() Gets a list of EquivIDs associated with the XRI authority object
EppXriTrustee	getEscrowAgent() Gets the XRI authority's escrowAgent
java.lang.String	getExtension() Gets the XRI authority extension chunk.
java.util.Vector	getIName() Gets a list of i-names associated with the XRI authority object
java.util.Vector	getINumber() Gets a list of i-numbers associated with the XRI authority object
boolean	getIsContact() Gets the XRI authority isContact flag.
java.util.Vector	getIService() Gets a list of identifiers of XRI I-Service objects associated with the XRI authority object
boolean	getIsEscrow() Gets the XRI authority isEscrow flag.
java.util.Vector	getRedirect() Gets a list of Redirects associated with the XRI authority object
java.util.Vector	getRef() Gets a list of Refs associated with the XRI authority object
java.util.Vector	getServiceEndpoint() Gets a list of XRI service endpoint (SEP) associated with the XRI authority object
EppXriSocialData	getSocialData() Gets the social data associated with the XRI authority object
java.util.Vector	getTrustee() Gets a list of trustees associated with the XRI authority object
static EppCommandInfoXriAuthority	info(java.lang.String authId, java.lang.String xid) Creates an EppCommandInfoXriAuthority object for querying the details of an EPP XRI Authority object
void	setAuthorityId(java.lang.String authId) Sets the XRI authority identifier
void	setCanonicalEquivID(java.lang.String canonicalEquivID) Sets the XRI authority's CanonicalEquivID
void	setContactAgent(EppXriTrustee contactAgent) Sets the XRI authority's contactAgent
void	setEscrowAgent(EppXriTrustee escrowAgent) Sets the XRI authority's escrowAgent
void	setExtension(java.lang.String extension) Sets the XRI authority extension chunk.
void	setIsContact(boolean isContact) Sets the XRI authority isContact flag
void	setIsEscrow(boolean isEscrow) Sets the XRI authority isEscrow flag
void	setSocialData(EppXriSocialData socialData) Gets the social data associated with the XRI authority object
java.lang.String	toString()
org.w3c.dom.Element	toXML(org.w3c.dom.Document doc, java.lang.String tag) Converts the EppXriAuthority object into an XML element
static EppCommandTransferXriAuthority	transfer(java.lang.String authId, java.lang.String xid) Creates an EppCommandTransferXriAuthority object for transfering an EPP XRI Authority object in the registry.
static EppCommandUpdateXriAuthority	update(java.lang.String authId, java.lang.String xid) Creates an EppCommandUpdateXriAuthority object for updating an EPP Authority object in the registry.

Methods inherited from class com.neulevel.epp.core.EppObject

addStatus, create, fromXMLCommon, getAuthInfo, getClientId, getClientIdCreated, getClientIdUpdated, getDateCreated, getDateExpired, getDateTransferred, getDateUpdated, getRoid, getStatus, setAuthInfo, setClientId, setClientIdCreated, setClientIdUpdated, setDateCreated, setDateExpired, setDateTransferred, setDateUpdated, setRoid, toXMLCommon

Methods inherited from class com.neulevel.epp.core.EppEntity

toString

Methods inherited from class java.lang.Object

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

Field Detail

STATUS_CLIENT_ASSOCIATE_PROHIBITED

public static final java.lang.String STATUS_CLIENT_ASSOCIATE_PROHIBITED

Authority status - clientAssociateProhibited

See Also:

Constant Field Values

STATUS_CLIENT_DELETE_PROHIBITED

public static final java.lang.String STATUS_CLIENT_DELETE_PROHIBITED

Authority status - clientDeleteProhibited

See Also:

Constant Field Values

STATUS_CLIENT_HOLD

public static final java.lang.String STATUS_CLIENT_HOLD

Authority status - clientHold

See Also:

Constant Field Values

STATUS_CLIENT_TRANSFER_PROHIBITED

public static final java.lang.String STATUS_CLIENT_TRANSFER_PROHIBITED

Authority status - clientTransferProhibited

See Also:

Constant Field Values

STATUS_CLIENT_UPDATE_PROHIBITED

public static final java.lang.String STATUS_CLIENT_UPDATE_PROHIBITED

Authority status - clientUpdateProhibited

See Also:

Constant Field Values

STATUS_LINKED

public static final java.lang.String STATUS_LINKED

Authority status - linked

See Also:

Constant Field Values

STATUS_OK

public static final java.lang.String STATUS_OK

Authority status - ok

See Also:

Constant Field Values

STATUS_PENDING_CREATE

public static final java.lang.String STATUS_PENDING_CREATE

Authority status - pendingCreate

See Also:

Constant Field Values

STATUS_PENDING_DELETE

public static final java.lang.String STATUS_PENDING_DELETE

Authority status - pendingDelete

See Also:

Constant Field Values

STATUS_PENDING_INAME_TRANSFER

public static final java.lang.String STATUS_PENDING_INAME_TRANSFER

Authority status - pendingINameTransfer

See Also:

Constant Field Values

STATUS_PENDING_TRANSFER

public static final java.lang.String STATUS_PENDING_TRANSFER

Authority status - pendingTransfer

See Also:

Constant Field Values

STATUS_PENDING_UPDATE

public static final java.lang.String STATUS_PENDING_UPDATE

Authority status - pendingUpdate

See Also:

Constant Field Values

STATUS_SERVER_ASSOCIATE_PROHIBITED

public static final java.lang.String STATUS_SERVER_ASSOCIATE_PROHIBITED

Authority status - serverAssociateProhibited

See Also:

Constant Field Values

STATUS_SERVER_DELETE_PROHIBITED

public static final java.lang.String STATUS_SERVER_DELETE_PROHIBITED

Authority status - serverDeleteProhibited

See Also:

Constant Field Values

STATUS_SERVER_HOLD

public static final java.lang.String STATUS_SERVER_HOLD

Authority status - serverHold

See Also:

Constant Field Values

STATUS_SERVER_TRANSFER_PROHIBITED

public static final java.lang.String STATUS_SERVER_TRANSFER_PROHIBITED

Authority status - serverTransferProhibited

See Also:

Constant Field Values

STATUS_SERVER_UPDATE_PROHIBITED

public static final java.lang.String STATUS_SERVER_UPDATE_PROHIBITED

Authority status - serverUpdateProhibited

See Also:

Constant Field Values

Constructor Detail

EppXriAuthority

public EppXriAuthority()

Creates an EppXriAuthority object

EppXriAuthority

public EppXriAuthority(java.lang.String authId)

Creates an EppXriAuthority object with an XRI authority identifier

Method Detail

getAuthorityId

public java.lang.String getAuthorityId()

Gets the XRI authority identifier

setAuthorityId

public void setAuthorityId(java.lang.String authId)

Sets the XRI authority identifier

getIsEscrow

public boolean getIsEscrow()

Gets the XRI authority isEscrow flag. If the flag was never set, this method would return the default (false) value.

setIsEscrow

public void setIsEscrow(boolean isEscrow)

Sets the XRI authority isEscrow flag

getIsContact

public boolean getIsContact()

Gets the XRI authority isContact flag. If the flag was never set, this method returns the default value (false).

setIsContact

public void setIsContact(boolean isContact)

Sets the XRI authority isContact flag

getEscrowAgent

public EppXriTrustee getEscrowAgent()

Gets the XRI authority's escrowAgent

setEscrowAgent

public void setEscrowAgent(EppXriTrustee escrowAgent)

Sets the XRI authority's escrowAgent

getContactAgent

public EppXriTrustee getContactAgent()

Gets the XRI authority's contactAgent

setContactAgent

public void setContactAgent(EppXriTrustee contactAgent)

Sets the XRI authority's contactAgent

getSocialData

public EppXriSocialData getSocialData()

Gets the social data associated with the XRI authority object

setSocialData

public void setSocialData(EppXriSocialData socialData)

Gets the social data associated with the XRI authority object

getTrustee

public java.util.Vector getTrustee()

Gets a list of trustees associated with the XRI authority object

addTrustee

public void addTrustee(EppXriTrustee trustee)

Adds a trustee associated with the XRI authority object

Note: This method should be only called by the EPP server, and an EPP client should not perform this operation.

getRef

public java.util.Vector getRef()

Gets a list of Refs associated with the XRI authority object

addRef

public void addRef(EppXriRef ref)

Adds a Ref associated with the XRI authority object

Note: This method should be only called by the EPP server, and an EPP client should not perform this operation.

getRedirect

public java.util.Vector getRedirect()

Gets a list of Redirects associated with the XRI authority object

addRedirect

public void addRedirect(EppXriURI redirect)

Adds a Redirect associated with the XRI authority object

Note: This method should be only called by the EPP server, and an EPP client should not perform this operation.

getEquivID

public java.util.Vector getEquivID()

Gets a list of EquivIDs associated with the XRI authority object

addEquivID

public void addEquivID(EppXriSynonym equivID)

Adds a EquivID associated with the XRI authority object

Note: This method should be only called by the EPP server, and an EPP client should not perform this operation.

getCanonicalEquivID

public java.lang.String getCanonicalEquivID()

Gets the XRI authority's CanonicalEquivID

setCanonicalEquivID

public void setCanonicalEquivID(java.lang.String canonicalEquivID)

Sets the XRI authority's CanonicalEquivID

getServiceEndpoint

public java.util.Vector getServiceEndpoint()

Gets a list of XRI service endpoint (SEP) associated with the XRI authority object

addServiceEndpoint

public void addServiceEndpoint(EppXriServiceEndpoint sep)

Adds a XRI service service endpoint (SEP) associated with the XRI authority object

Note: This method should be only called by the EPP server, and an EPP client should not perform this operation.

getIName

public java.util.Vector getIName()

Gets a list of i-names associated with the XRI authority object

Note: This method should be only called by the EPP server, and an EPP client should not perform this operation.

addIName

public void addIName(java.lang.String iname)

Adds an i-name associated with the XRI authority object

Note: This method should be only called by the EPP server, and an EPP client should not perform this operation.

getINumber

public java.util.Vector getINumber()

Gets a list of i-numbers associated with the XRI authority object

addINumber

public void addINumber(java.lang.String inumber)

Adds an i-number associated with the XRI authority object

Note: This method should be only called by the EPP server, and an EPP client should not perform this operation.

addINumber

public void addINumber(java.lang.String inumber,
                       int priority)

Adds an i-number associated with the XRI authority object

Note: This method should be only called by the EPP server, and an EPP client should not perform this operation.

addINumber

public void addINumber(EppXriNumberAttribute xin)

Adds an i-number associated with the XRI authority object

Note: This method should be only called by the EPP server, and an EPP client should not perform this operation.

getIService

public java.util.Vector getIService()

Gets a list of identifiers of XRI I-Service objects associated with the XRI authority object

addIService

public void addIService(java.lang.String iServiceId)

Adds the identifier of an XRI I-Service object associated with the XRI authority object

Note: This method should be only called by the EPP server, and an EPP client should not perform this operation.

getExtension

public java.lang.String getExtension()

Gets the XRI authority extension chunk. If the extension was never set, this method returns null.

setExtension

public void setExtension(java.lang.String extension)

Sets the XRI authority extension chunk.

toXML

public org.w3c.dom.Element toXML(org.w3c.dom.Document doc,
                                 java.lang.String tag)

Converts the EppXriAuthority object into an XML element

Specified by:

toXML in class EppEntity

Parameters:

doc - the XML Document object

tag - the tag/element name for the EppXriAuthority object

Returns:

an Element object

fromXML

public static EppEntity fromXML(org.w3c.dom.Node root)

Converts an XML element into an EppXriAuthority object. The caller of this method must make sure that the root node is of the EPP Authority type.

Parameters:

root - root node for an EppXriAuthority object in XML format

Returns:

an EppXriAuthority object, or null if the node is invalid

toString

public java.lang.String toString()

Specified by:

toString in class EppEntity

delete

public static EppCommandDeleteXriAuthority delete(java.lang.String authId,
                                                  java.lang.String xid)

Creates an EppCommandDeleteXriAuthority object for deleting an EPP XRI Authority object from the registry.

Parameters:

authId - the identifier of the XRI authority object to be deleted

xid - the client transaction id associated with the operation

info

public static EppCommandInfoXriAuthority info(java.lang.String authId,
                                              java.lang.String xid)

Creates an EppCommandInfoXriAuthority object for querying the details of an EPP XRI Authority object

Parameters:

authId - the identifier of the XRI authority object to be queried

xid - the client transaction id associated with the operation

check

public static EppCommandCheckXriAuthority check(java.lang.String xid)

Creates an EppCommandCheckXriAuthority object for checking the existance of EPP XRI Authority objects in the registry. Identifiers of EPP XRI Authority objects can be added via the add or addAuthorityId methods.

Parameters:

xid - the client transaction id associated with the operation

transfer

public static EppCommandTransferXriAuthority transfer(java.lang.String authId,
                                                      java.lang.String xid)

Creates an EppCommandTransferXriAuthority object for transfering an EPP XRI Authority object in the registry. The operation type, transfer token, target authority and authorization information associated with the operation should be specified via setOperation, setTransferToken, setTarget, and setAuthInfo method.

Parameters:

authId - the identifier of the XRI authority object to be transferred

xid - the client transaction id associated with the operation

update

public static EppCommandUpdateXriAuthority update(java.lang.String authId,
                                                  java.lang.String xid)

Creates an EppCommandUpdateXriAuthority object for updating an EPP Authority object in the registry. The actual update information should be specified via the various methods defined for the EppCommandUpdateXriAuthority object.

Parameters:

authId - the identifier of the XRI authority object to be updated

xid - the client transaction id associated with the operation