Class EPPSecDNSExtUpdate
- java.lang.Object
-
- com.verisign.epp.codec.secdnsext.v11.EPPSecDNSExtUpdate
-
- All Implemented Interfaces:
EPPCodecComponent
,java.io.Serializable
,java.lang.Cloneable
public class EPPSecDNSExtUpdate extends java.lang.Object implements EPPCodecComponent
The EPPSecDNSExtUpdate is the EPPCodecComponent that knows how to encode and decode secDNS update elements from/to XML and object instance.Title: EPP 1.0 secDNS
Description: secDNS Extension to the EPP SDK
Copyright: Copyright (c) 2010
Company: VeriSign
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ELM_ADD
Element tag name for the addstatic java.lang.String
ELM_CHG
Element tag name for the chgstatic java.lang.String
ELM_MAX_SIG_LIFE
The element tag name for maxSigLifestatic java.lang.String
ELM_NAME
Element tag name for the updatestatic java.lang.String
ELM_REM
Element tag name for the remstatic int
MAX_MAX_SIG_LIFE
Maximum maxSigLife valuestatic int
MIN_MAX_SIG_LIFE
Minimum maxSigLife valuestatic int
UNSPEC_MAX_SIG_LIFE
Unspecified maxSigLife value
-
Constructor Summary
Constructors Constructor Description EPPSecDNSExtUpdate()
Instantiate a new instance of EPPSecDNSExtUpdate
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
appendAddDsData(EPPSecDNSExtDsData aDsData)
Appends to theList
of DS DataEPPSecDNSExtDsData
instances to add.void
appendAddKeyData(EPPSecDNSExtKeyData aKeyData)
Appends to theList
of Key DataEPPSecDNSExtKeyData
instances to add.void
appendRemDsData(EPPSecDNSExtDsData aDsData)
Appends to theList
of DS DataEPPSecDNSExtDsData
instances to remove.void
appendRemKeyData(EPPSecDNSExtKeyData aKeyData)
Appends to theList
of Key DataEPPSecDNSExtKeyData
instances to remove.java.lang.Object
clone()
CloneEPPSecDNSExtUpdate
.void
decode(org.w3c.dom.Element aElement)
Populate the data of this instance with the data stored in the given Element of the DOM treeorg.w3c.dom.Element
encode(org.w3c.dom.Document aDocument)
Append all data from this secDNS update to the given DOM Documentboolean
equals(java.lang.Object aObject)
implements a deepEPPSecDNSExtUpdate
compare.java.util.List
getAddDsData()
Gets the dsData add list.java.util.List
getAddKeyData()
Gets the keyData add list.int
getMaxSigLife()
Get secDNS:maxSigLife valuejava.lang.String
getNamespace()
The namespace associated with this secDNS update.java.util.List
getRemDsData()
Gets the dsData remove list.java.util.List
getRemKeyData()
Gets the keyData remove list.boolean
hasAddDsData()
Is there dsData contained in the dsData add list?boolean
hasAddKeyData()
Is there keyData contained in the keyData add list?boolean
hasChg()
Is there are change (chg) element included in the update.boolean
hasMaxSigLife()
Does secDNS:chg include optional secDNS:maxSigLife?boolean
hasRemDsData()
Is there dsData contained in the dsData remove list?boolean
hasRemKeyData()
Is there keyData contained in the keyData remove list?boolean
isRemAllData()
Remove all DS / Key Data?boolean
isUrgent()
Is the update request urgent?void
setAddDsData(java.util.List aAddDsData)
Sets theList
of DS DataEPPSecDNSExtDsData
instances to add.void
setAddKeyData(java.util.List aAddKeyData)
Sets theList
of Key DataEPPSecDNSExtKeyData
instances to add.void
setMaxSigLife(int maxSigLife)
Set secDNS:maxSigLife valuevoid
setRemAllData(boolean aRemAllData)
Sets the flag for removing all DS / Key Data.void
setRemDsData(java.util.List aRemDsData)
Sets theList
of DS DataEPPSecDNSExtDsData
instances to remove.void
setRemKeyData(java.util.List aRemKeyData)
Sets theList
of Key DataEPPSecDNSExtKeyData
instances to remove.void
setUrgent(boolean urgent)
Sets the urgent attribute.java.lang.String
toString()
Implementation ofObject.toString
, which will result in an indented XMLString
representation of the concreteEPPCodecComponent
.
-
-
-
Field Detail
-
UNSPEC_MAX_SIG_LIFE
public static final int UNSPEC_MAX_SIG_LIFE
Unspecified maxSigLife value- See Also:
- Constant Field Values
-
MIN_MAX_SIG_LIFE
public static final int MIN_MAX_SIG_LIFE
Minimum maxSigLife value- See Also:
- Constant Field Values
-
MAX_MAX_SIG_LIFE
public static final int MAX_MAX_SIG_LIFE
Maximum maxSigLife value- See Also:
- Constant Field Values
-
ELM_NAME
public static final java.lang.String ELM_NAME
Element tag name for the update- See Also:
- Constant Field Values
-
ELM_ADD
public static final java.lang.String ELM_ADD
Element tag name for the add- See Also:
- Constant Field Values
-
ELM_CHG
public static final java.lang.String ELM_CHG
Element tag name for the chg- See Also:
- Constant Field Values
-
ELM_REM
public static final java.lang.String ELM_REM
Element tag name for the rem- See Also:
- Constant Field Values
-
ELM_MAX_SIG_LIFE
public static final java.lang.String ELM_MAX_SIG_LIFE
The element tag name for maxSigLife- See Also:
- Constant Field Values
-
-
Method Detail
-
getNamespace
public java.lang.String getNamespace()
The namespace associated with this secDNS update.- Specified by:
getNamespace
in interfaceEPPCodecComponent
- Returns:
- The namespace associated with secDNS component
-
encode
public org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
Append all data from this secDNS update to the given DOM Document- Specified by:
encode
in interfaceEPPCodecComponent
- Parameters:
aDocument
- The DOM Document to append data to- Returns:
- Encoded DOM
Element
- Throws:
EPPEncodeException
- Thrown when errors occur during the encode attempt or if the instance is invalid.
-
decode
public void decode(org.w3c.dom.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 interfaceEPPCodecComponent
- Parameters:
aElement
- The root element of the report fragment of XML- Throws:
EPPDecodeException
- Thrown if any errors occur during decoding.
-
equals
public boolean equals(java.lang.Object aObject)
implements a deepEPPSecDNSExtUpdate
compare.- Overrides:
equals
in classjava.lang.Object
- Parameters:
aObject
-EPPSecDNSExtUpdate
instance to compare with- Returns:
- true if equal false otherwise
-
clone
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
CloneEPPSecDNSExtUpdate
.- Specified by:
clone
in interfaceEPPCodecComponent
- Overrides:
clone
in classjava.lang.Object
- Returns:
- clone of
EPPSecDNSExtUpdate
- Throws:
java.lang.CloneNotSupportedException
- standard Object.clone exception
-
hasAddDsData
public boolean hasAddDsData()
Is there dsData contained in the dsData add list?- Returns:
true
if add list ofEPPSecDNSExtDsData
is notnull
and not empty;false
otherwise.
-
getAddDsData
public java.util.List getAddDsData()
Gets the dsData add list.- Returns:
List
of dsDataEPPSecDNSExtDsData
instances if defined;null
otherwise.
-
setAddDsData
public void setAddDsData(java.util.List aAddDsData)
Sets theList
of DS DataEPPSecDNSExtDsData
instances to add.- Parameters:
aAddDsData
-List
ofEPPSecDNSExtDsData
instances
-
appendAddDsData
public void appendAddDsData(EPPSecDNSExtDsData aDsData)
Appends to theList
of DS DataEPPSecDNSExtDsData
instances to add.- Parameters:
aDsData
-EPPSecDNSExtDsData
instance
-
hasRemDsData
public boolean hasRemDsData()
Is there dsData contained in the dsData remove list?- Returns:
true
if remove list ofEPPSecDNSExtDsData
is notnull
and not empty;false
otherwise.
-
getRemDsData
public java.util.List getRemDsData()
Gets the dsData remove list.- Returns:
List
of dsDataEPPSecDNSExtDsData
instances if defined;null
otherwise.
-
setRemDsData
public void setRemDsData(java.util.List aRemDsData)
Sets theList
of DS DataEPPSecDNSExtDsData
instances to remove.- Parameters:
aRemDsData
-List
ofEPPSecDNSExtDsData
instances
-
appendRemDsData
public void appendRemDsData(EPPSecDNSExtDsData aDsData)
Appends to theList
of DS DataEPPSecDNSExtDsData
instances to remove.- Parameters:
aDsData
-EPPSecDNSExtDsData
instance
-
setRemAllData
public void setRemAllData(boolean aRemAllData)
Sets the flag for removing all DS / Key Data.- Parameters:
aRemAllData
-true
to remove all DS / Key Data;false
otherwise.
-
isRemAllData
public boolean isRemAllData()
Remove all DS / Key Data?- Returns:
true
to remove all DS / Key Data;false
otherwise.
-
hasAddKeyData
public boolean hasAddKeyData()
Is there keyData contained in the keyData add list?- Returns:
true
if add list ofEPPSecDNSExtKeyData
is notnull
and not empty;false
otherwise.
-
getAddKeyData
public java.util.List getAddKeyData()
Gets the keyData add list.- Returns:
List
of keyDataEPPSecDNSExtKeyData
instances if defined;null
otherwise.
-
setAddKeyData
public void setAddKeyData(java.util.List aAddKeyData)
Sets theList
of Key DataEPPSecDNSExtKeyData
instances to add.- Parameters:
aAddKeyData
-List
ofEPPSecDNSExtKeyData
instances
-
appendAddKeyData
public void appendAddKeyData(EPPSecDNSExtKeyData aKeyData)
Appends to theList
of Key DataEPPSecDNSExtKeyData
instances to add.- Parameters:
aKeyData
-EPPSecDNSExtKeyData
instance
-
hasRemKeyData
public boolean hasRemKeyData()
Is there keyData contained in the keyData remove list?- Returns:
true
if remove list ofEPPSecDNSExtKeyData
is notnull
and not empty;false
otherwise.
-
getRemKeyData
public java.util.List getRemKeyData()
Gets the keyData remove list.- Returns:
List
of dsDataEPPSecDNSExtKeyData
instances if defined;null
otherwise.
-
setRemKeyData
public void setRemKeyData(java.util.List aRemKeyData)
Sets theList
of Key DataEPPSecDNSExtKeyData
instances to remove.- Parameters:
aRemKeyData
-List
ofEPPSecDNSExtKeyData
instances
-
appendRemKeyData
public void appendRemKeyData(EPPSecDNSExtKeyData aKeyData)
Appends to theList
of Key DataEPPSecDNSExtKeyData
instances to remove.- Parameters:
aKeyData
-EPPSecDNSExtKeyData
instance
-
isUrgent
public boolean isUrgent()
Is the update request urgent?- Returns:
- Returns
true
if the client has asked the server operator to process the update command with a high priority;false
otherwise.
-
setUrgent
public void setUrgent(boolean urgent)
Sets the urgent attribute.- Parameters:
urgent
- The urgent value to set.
-
getMaxSigLife
public int getMaxSigLife()
Get secDNS:maxSigLife value- Returns:
- an
int
value representing secDNS:maxSigLife - See Also:
hasMaxSigLife()
,UNSPEC_MAX_SIG_LIFE
-
setMaxSigLife
public void setMaxSigLife(int maxSigLife)
Set secDNS:maxSigLife value- Parameters:
maxSigLife
- anint
value representing secDNS:maxSigLife
-
hasMaxSigLife
public boolean hasMaxSigLife()
Does secDNS:chg include optional secDNS:maxSigLife?- Returns:
- true if secDNS:maxSigLife is specified, otherwise false
- See Also:
UNSPEC_MAX_SIG_LIFE
-
hasChg
public boolean hasChg()
Is there are change (chg) element included in the update. Currently the only change element is secDNS:maxSigLife.- Returns:
true
if a change element is defined;false
otherwise.
-
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.
-
-