Package com.verisign.epp.codec.emailFwd
Class EPPEmailFwdAddRemove
- java.lang.Object
-
- com.verisign.epp.codec.emailFwd.EPPEmailFwdAddRemove
-
- All Implemented Interfaces:
EPPCodecComponent
,java.io.Serializable
,java.lang.Cloneable
public class EPPEmailFwdAddRemove extends java.lang.Object implements EPPCodecComponent
Represents attributes to add, remove or change with aEPPEmailFwdUpdateCmd
. InEPPEmailFwdUpdateCmd
, an instance ofEPPEmailFwdAddRemove
is used to specify the attributes to add; an instance ofEPPEmailFwdAddRemove
is used to specify the attributes to remove, and an instance ofEPPEmailFwdAddRemove
is used to specify the attributes to change
The EmailFwdEmailFwd Mapping Specification describes the following attributes:
-
Zero or more <emailFwd:contact> elements that contain the registrant,
administrative, technical, and billing contact identiEmailFwdfiers to be
associated with the emailFwd. Use
getContacts
andsetContacts
to get and set the element. This attribute will only be allowed if the Contact Mapping is supported. -
One or two <emailFwd:status> elements that contain status values to be
applied to or removed from the emailFwd object. Use
getStatuses
andsetStatuses
to get and set the element. -
For
change
only, A <emailFwd:registrant> element that contains the identifier for the human or organizational social information (contact) object to be associated with the emailFwd object as the object registrant. This object identifier MUST be known to the server before the contact object can be associated with the emailFwd object. UsegetRegistrant
andsetRegistrant
to get and set the element. -
For
change
only, An OPTIONAL <emailFwd:fwdTo> element that contains the email forwardTo addresses. UsegetForwardTo
andsetForwardTo
to get and set the forwardTo addresses.
It is important to note that the maximum number of emailFwd attribute elements is subject to the number of values currently associated with the emailFwd object.EPPEmailFwdAddRemove
will delegate the validation of the cardinality of the emailFwd attributes elements to the EPP Server.- See Also:
EPPEmailFwdUpdateCmd
, Serialized Form
-
-
Constructor Summary
Constructors Constructor Description EPPEmailFwdAddRemove()
Default constructor forEPPEmailFwdAddRemove
.EPPEmailFwdAddRemove(java.lang.String aRegistrant, java.lang.String aForwardTo, EPPAuthInfo aAuthInfo)
Constructor forEPPEmailFwdAddRemove
that includes the attributes as arguments.EPPEmailFwdAddRemove(java.util.Vector someContacts, java.util.Vector someStatuses)
Constructor forEPPEmailFwdAddRemove
that includes the attributes as arguments.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
clone()
CloneEPPEmailFwdAddRemove
.boolean
contactsSupported()
Return if EmailFwd Contacts is supported.void
decode(org.w3c.dom.Element aElement)
Decode theEPPEmailFwdAddRemove
attributes from the aElement DOM Element tree.org.w3c.dom.Element
encode(org.w3c.dom.Document aDocument)
Encode a DOM Element tree from the attributes of theEPPEmailFwdAddRemove
instance.boolean
equals(java.lang.Object aObject)
implements a deepEPPEmailFwdAddRemove
compare.EPPAuthInfo
getAuthInfo()
Get authorization information for the change modejava.util.Vector
getContacts()
Gets the contacts to add or remove.java.lang.String
getForwardTo()
Get forwardTo Addressjava.lang.String
getNamespace()
Returns the XML namespace associated with theEPPCodecComponent
.java.lang.String
getRegistrant()
Get registrant for the change modejava.util.Vector
getStatuses()
Gets the statuses to add or remove.void
setAuthInfo(EPPAuthInfo newAuthInfo)
Set authorization information for the change modevoid
setContacts(java.util.Vector aContacts)
Sets the contacts to add or remove.void
setForwardTo(java.lang.String newForwardTo)
Set forwardTo Address for the change modevoid
setRegistrant(java.lang.String newRegistrant)
Set registrant for the change modevoid
setStatuses(java.util.Vector aStatuses)
Sets the statuses to add or remove.java.lang.String
toString()
Implementation ofObject.toString
, which will result in an indented XMLString
representation of the concreteEPPCodecComponent
.
-
-
-
Constructor Detail
-
EPPEmailFwdAddRemove
public EPPEmailFwdAddRemove()
Default constructor forEPPEmailFwdAddRemove
. All of the attribute default tonull
to indicate no modification.
-
EPPEmailFwdAddRemove
public EPPEmailFwdAddRemove(java.util.Vector someContacts, java.util.Vector someStatuses)
Constructor forEPPEmailFwdAddRemove
that includes the attributes as arguments.- Parameters:
someContacts
- Vector ofEPPEmailFwdContact
instances. Isnull
or empty for no modifications. If the Contact Mapping is not supported, this value should benull
.someStatuses
- Vector of statusString
's. One of theEPPEmailFwdInfoResp.STATUS_
contants can be used for each of the status values. Isnull
or empty for no modifications.
-
EPPEmailFwdAddRemove
public EPPEmailFwdAddRemove(java.lang.String aRegistrant, java.lang.String aForwardTo, EPPAuthInfo aAuthInfo)
Constructor forEPPEmailFwdAddRemove
that includes the attributes as arguments.- Parameters:
aRegistrant
-String
registrant for the change modeaForwardTo
-String
forwardTo address of the email.aAuthInfo
-EPPAuthInfo
authorization information for the change mode
-
-
Method Detail
-
getContacts
public java.util.Vector getContacts()
Gets the contacts to add or remove.- Returns:
- Vector of
EPPEmailFwdContact
instances.
-
setContacts
public void setContacts(java.util.Vector aContacts)
Sets the contacts to add or remove.- Parameters:
aContacts
- DOCUMENT ME!
-
getStatuses
public java.util.Vector getStatuses()
Gets the statuses to add or remove. TheEPPEmailFwdInfoResp.STATUS_
constants can be used for the statuses.- Returns:
- Vector of status
String
instances.
-
setStatuses
public void setStatuses(java.util.Vector aStatuses)
Sets the statuses to add or remove. TheEPPEmailFwdInfoResp.STATUS_
constants can be used for the statuses.- Parameters:
aStatuses
- Vector of statusString
instances.
-
contactsSupported
public boolean contactsSupported()
Return if EmailFwd Contacts is supported.- Returns:
true
if contacts are supported;false
otherwise.
-
encode
public org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
Encode a DOM Element tree from the attributes of theEPPEmailFwdAddRemove
instance.- Specified by:
encode
in interfaceEPPCodecComponent
- Parameters:
aDocument
- DOM Document that is being built. Used as an Element factory.- Returns:
- Root DOM Element representing the
EPPEmailFwdAddRemove
instance. - Throws:
EPPEncodeException
- Unable to encodeEPPEmailFwdAddRemove
instance.
-
decode
public void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
Decode theEPPEmailFwdAddRemove
attributes from the aElement DOM Element tree.- Specified by:
decode
in interfaceEPPCodecComponent
- Parameters:
aElement
- Root DOM Element to decodeEPPEmailFwdAddRemove
from.- Throws:
EPPDecodeException
- Unable to decode aElement.
-
equals
public boolean equals(java.lang.Object aObject)
implements a deepEPPEmailFwdAddRemove
compare.- Overrides:
equals
in classjava.lang.Object
- Parameters:
aObject
-EPPEmailFwdAddRemove
instance to compare with- Returns:
- DOCUMENT ME!
-
clone
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
CloneEPPEmailFwdAddRemove
.- Specified by:
clone
in interfaceEPPCodecComponent
- Overrides:
clone
in classjava.lang.Object
- Returns:
- clone of
EPPEmailFwdAddRemove
- Throws:
java.lang.CloneNotSupportedException
- standard Object.clone exception
-
toString
public java.lang.String toString()
Implementation ofObject.toString
, which will result in an indented XMLString
representation of the concreteEPPCodecComponent
.- Overrides:
toString
in classjava.lang.Object
- Returns:
- Indented XML
String
if successful;ERROR
otherwise.
-
getAuthInfo
public EPPAuthInfo getAuthInfo()
Get authorization information for the change mode- Returns:
- com.verisign.epp.codec.emailFwd.EPPEmailFwdAuthInfo
-
getRegistrant
public java.lang.String getRegistrant()
Get registrant for the change mode- Returns:
- java.lang.String
-
getForwardTo
public java.lang.String getForwardTo()
Get forwardTo Address- Returns:
- java.lang.String
-
setAuthInfo
public void setAuthInfo(EPPAuthInfo newAuthInfo)
Set authorization information for the change mode- Parameters:
newAuthInfo
- com.verisign.epp.codec.emailFwd.EPPEmailFwdAuthInfo
-
setRegistrant
public void setRegistrant(java.lang.String newRegistrant)
Set registrant for the change mode- Parameters:
newRegistrant
- java.lang.String
-
setForwardTo
public void setForwardTo(java.lang.String newForwardTo)
Set forwardTo Address for the change mode- Parameters:
newForwardTo
- java.lang.String
-
getNamespace
public java.lang.String getNamespace()
Returns the XML namespace associated with theEPPCodecComponent
.- Specified by:
getNamespace
in interfaceEPPCodecComponent
- Returns:
- XML namespace for the
EPPCodecComponent
.
-
-