|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.verisign.epp.codec.secdnsext.v11.EPPSecDNSExtKeyData
public class EPPSecDNSExtKeyData
The EPPSecDNSExtKeyData is the EPPCodecComponent that knows how to encode and decode secDNS keyData 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
Field Summary | |
---|---|
static int |
DEFAULT_PROTOCOL
The default protocol vale. |
static int |
FLAGS_ZONE_KEY
Bit 7 of the Flags field is the Zone Key flag. |
static int |
FLAGS_ZONE_KEY_SEP
Bit 15 of the Flags field is the Secure Entry Point flag. |
static int |
MAX_ALG
Maximum alg value |
static int |
MAX_FLAGS
Maximum flags value |
static int |
MAX_PROTOCOL
Maximum protocol value |
static int |
MIN_ALG
Minimum alg value |
static int |
MIN_FLAGS
Minimum flags value |
static int |
MIN_PROTOCOL
Minimum protocol value |
static int |
UNSPEC_ALG
Unspecified alg value |
static int |
UNSPEC_FLAGS
Unspecified flags value |
static int |
UNSPEC_PROTOCOL
Unspecified protocol value |
Constructor Summary | |
---|---|
EPPSecDNSExtKeyData()
Create a new instance of EPPSecDNSExtKeyData |
|
EPPSecDNSExtKeyData(EPPSecDNSExtKeyData keyData)
Create a new instance (copy) of EPPSecDNSExtKeyData |
|
EPPSecDNSExtKeyData(int flags,
int protocol,
int alg,
java.lang.String pubKey)
Create a new instance of EPPSecDNSExtKeyData with the given values. |
Method Summary | |
---|---|
java.lang.Object |
clone()
Clone EPPSecDNSExtKeyData . |
void |
decode(org.w3c.dom.Element aElement)
Populate the data of this instance with the data stored in the given Element of the DOM tree |
org.w3c.dom.Element |
encode(org.w3c.dom.Document aDocument)
Append all data from this secDNS:keyData to the given DOM Document |
boolean |
equals(java.lang.Object aObject)
implements a deep EPPSecDNSExtKeyData compare. |
int |
getAlg()
Get secDNS:alg value |
int |
getFlags()
Get secDNS:flags value |
int |
getProtocol()
Get secDNS:protocol value |
java.lang.String |
getPubKey()
Get secDNS:pubKey value |
void |
setAlg(int alg)
Set secDNS:alg value |
void |
setFlags(int flags)
Set secDNS:flags value |
void |
setProtocol(int protocol)
Set secDNS:protocol value |
void |
setPubKey(java.lang.String pubKey)
Set secDNS:pubKey value This method will remove all whitespace in an effort to produce the canonical representation for base64Binary as defined by http://www.w3.org/TR/xmlschema-2/#base64Binary |
EPPSecDNSExtDsData |
toDsData(java.lang.String aDomainName,
int aDigestType)
Generates a EPPSecDNSExtDsData with the key data utilizing the
domain name (aDomainName ) and the desired digest type (
aDigestType ). |
int |
toKeyTag()
Generate the key tag used in the DS data and included in the EPPSecDNSExtDsData return by toDsData(String, int) . |
java.lang.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 Detail |
---|
public static final int DEFAULT_PROTOCOL
public static final int FLAGS_ZONE_KEY
public static final int FLAGS_ZONE_KEY_SEP
public static final int UNSPEC_FLAGS
public static final int MIN_FLAGS
public static final int MAX_FLAGS
public static final int UNSPEC_PROTOCOL
public static final int MIN_PROTOCOL
public static final int MAX_PROTOCOL
public static final int UNSPEC_ALG
public static final int MIN_ALG
public static final int MAX_ALG
Constructor Detail |
---|
public EPPSecDNSExtKeyData()
public EPPSecDNSExtKeyData(EPPSecDNSExtKeyData keyData)
keyData
- EPPSecDNSExtKeyData
instancepublic EPPSecDNSExtKeyData(int flags, int protocol, int alg, java.lang.String pubKey)
flags
- the flags value to use for this instance.protocol
- the protocol value to use for this instance.alg
- the algorithm value to use for this instance.pubKey
- the public key value to use for this instance.Method Detail |
---|
public org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
encode
in interface EPPCodecComponent
aDocument
- The DOM Document to append data to
Element
EPPEncodeException
- Thrown when errors occur during the
encode attempt or if the instance is invalid.public void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
decode
in interface EPPCodecComponent
aElement
- The root element of the fragment of XML
EPPDecodeException
- Thrown if any errors occur during decoding.public boolean equals(java.lang.Object aObject)
EPPSecDNSExtKeyData
compare.
equals
in class java.lang.Object
aObject
- EPPSecDNSExtKeyData
instance to compare with
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
EPPSecDNSExtKeyData
.
clone
in interface EPPCodecComponent
clone
in class java.lang.Object
EPPSecDNSExtKeyData
java.lang.CloneNotSupportedException
- standard Object.clone exceptionpublic int getFlags()
int
value representing secDNS:flagsUNSPEC_FLAGS
public void setFlags(int flags)
flags
- an int
value representing secDNS:flagsFLAGS_ZONE_KEY_SEP
,
FLAGS_ZONE_KEY
public int getProtocol()
int
value representing secDNS:protocolDEFAULT_PROTOCOL
,
UNSPEC_PROTOCOL
public void setProtocol(int protocol)
protocol
- an int
value representing secDNS:protocolpublic int getAlg()
int
value representing secDNS:algUNSPEC_ALG
public void setAlg(int alg)
alg
- an int
value representing secDNS:algpublic java.lang.String getPubKey()
setPubKey(String pubKey)
public void setPubKey(java.lang.String pubKey)
pubKey
- an String
value representing the base64Binary secDNS:pubKeyEPPUtil.removeWhitespace(String inString)
public java.lang.String toString()
Object.toString
, which will result in an
indented XML String
representation of the concrete
EPPCodecComponent
.
toString
in class java.lang.Object
String
if successful;
ERROR
otherwise.public EPPSecDNSExtDsData toDsData(java.lang.String aDomainName, int aDigestType) throws EPPCodecException
EPPSecDNSExtDsData
with the key data utilizing the
domain name (aDomainName
) and the desired digest type (
aDigestType
). The DS data is generated based on RFC 4032,
where the DS digest is calculated as shown below:"|" denotes concatenation
digest = digest_algorithm( DNSKEY owner name | DNSKEY RDATA);
DNSKEY RDATA = Flags | Protocol | Algorithm | Public Key
aDomainName
- Domain name / owner name of DNSKEYaDigestType
- Desired digest type of generated DS using a
EPPSecDNSExtDsData
DIGEST_TYPE
constant
like EPPSecDNSExtDsData.SHA1_DIGEST_TYPE
or
EPPSecDNSExtDsData.SHA256_DIGEST_TYPE
.
EPPSecDNSExtDsData
representing the generated
DS data
EPPException
- On error generating the DS data
EPPCodecException
public int toKeyTag() throws EPPCodecException
EPPSecDNSExtDsData
return by toDsData(String, int)
.
EPPCodecException
- On error generating the key tag
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |