Class EPPEncodedSignedCodeValue
- java.lang.Object
-
- com.verisign.epp.codec.verificationcode.EPPSignedCode
-
- com.verisign.epp.codec.verificationcode.EPPEncodedSignedCodeValue
-
- All Implemented Interfaces:
EPPCodecComponent
,java.io.Serializable
,java.lang.Cloneable
public class EPPEncodedSignedCodeValue extends EPPSignedCode
Class for the encoded signed code, which contains the code and theXMLSignature
itself. This class extendsEPPSignedCode
.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ELM_LOCALNAME
Constant for the code local name for encoded signedCode elementstatic java.lang.String
ELM_NAME
Constant for the code tag for signedCode element-
Fields inherited from class com.verisign.epp.codec.verificationcode.EPPSignedCode
ELM_SIGNED_CODE, ELM_SIGNED_CODE_LOCALNAME
-
-
Constructor Summary
Constructors Constructor Description EPPEncodedSignedCodeValue()
Create anEPPEncodedSignedCodeValue
instance.EPPEncodedSignedCodeValue(byte[] aEncodedSignedCodeArray)
Creates anEPPEncodedSignedCodeValue
that is initialized by decoding the inputbyte[]
.EPPEncodedSignedCodeValue(EPPSignedCode aSignedCode)
Construct Encoded SignedCode object from SignedCode object.EPPEncodedSignedCodeValue(EPPVerificationCode aCode)
Create anEPPEncodedSignedCodeValue
with the code of the signed code.EPPEncodedSignedCodeValue(java.io.InputStream aScode)
Creates anEPPEncodedSignedCodeValue
by decoding the a Signed Code Data (SMD) that is in a PEM-like input stream that includes the encoded signed code with a leading line "-----BEGIN ENCODED SCODE-----" and a trailing "-----END ENCODED SCODE-----".EPPEncodedSignedCodeValue(java.lang.String aCode, java.lang.String aType)
Create anEPPEncodedSignedCodeValue
with the code and type of the signed code.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
clone()
CloneEPPEncodedSignedCodeValue
.void
decode(org.w3c.dom.Element aElement)
Decode theEPPSignedCode
componentvoid
decodeValue(byte[] aBase64SignedCode)
Decode the Base64 encoded signed code value with no wrapping XML.void
decodeValue(java.lang.String aBase64SignedCode)
Decode the Base64 encoded signed code value with no wrapping XML.byte[]
encode()
Encode the encoded signed code to abyte[]
.org.w3c.dom.Element
encode(org.w3c.dom.Document aDocument)
Sets all this instance's data in the given XML documentjava.lang.String
encodeValue()
Encodes the Base64 signed code value without the wrapping XML elementsjava.lang.String
encodeValue(boolean aIsChunked)
Encodes the Base64 signed code value without the wrapping XML elements, and with the option for chunking the Base64 into 76 character blocks.byte[]
encodeValueByteArray()
Encodes the Base64 signed code value without the wrapping XML elementsbyte[]
encodeValueByteArray(boolean aIsChunked)
Encodes the Base64 signed code value without the wrapping XML elements, and with the option for chunking the Base64 into 76 character blocks.-
Methods inherited from class com.verisign.epp.codec.verificationcode.EPPSignedCode
decode, equals, getAttrIdValue, getCode, getCodeType, getCodeValue, getLocalName, getNamespace, getTrustAnchor, hasTrustAnchor, sign, sign, toString, validate, validate, validate
-
-
-
-
Field Detail
-
ELM_LOCALNAME
public static final java.lang.String ELM_LOCALNAME
Constant for the code local name for encoded signedCode element- See Also:
- Constant Field Values
-
ELM_NAME
public static final java.lang.String ELM_NAME
Constant for the code tag for signedCode element- See Also:
- Constant Field Values
-
-
Constructor Detail
-
EPPEncodedSignedCodeValue
public EPPEncodedSignedCodeValue()
Create anEPPEncodedSignedCodeValue
instance.
-
EPPEncodedSignedCodeValue
public EPPEncodedSignedCodeValue(EPPSignedCode aSignedCode) throws EPPEncodeException, EPPDecodeException
Construct Encoded SignedCode object from SignedCode object.- Parameters:
aSignedCode
- SignedCode object- Throws:
EPPEncodeException
- Error encoding the SignedCodebyte[]
.EPPDecodeException
- Error decoding the encoded SignedCodebyte[]
.
-
EPPEncodedSignedCodeValue
public EPPEncodedSignedCodeValue(EPPVerificationCode aCode) throws EPPEncodeException
Create anEPPEncodedSignedCodeValue
with the code of the signed code.- Parameters:
aCode
- Verification code- Throws:
EPPEncodeException
- Thrown if any errors prevent encoding.
-
EPPEncodedSignedCodeValue
public EPPEncodedSignedCodeValue(java.lang.String aCode, java.lang.String aType) throws EPPEncodeException
Create anEPPEncodedSignedCodeValue
with the code and type of the signed code.- Parameters:
aCode
- Verification codeaType
- Verification code type.- Throws:
EPPEncodeException
- Thrown if any errors prevent encoding.
-
EPPEncodedSignedCodeValue
public EPPEncodedSignedCodeValue(byte[] aEncodedSignedCodeArray) throws EPPDecodeException
Creates anEPPEncodedSignedCodeValue
that is initialized by decoding the inputbyte[]
.- Parameters:
aEncodedSignedCodeArray
-byte[]
to decode the attribute values- Throws:
EPPDecodeException
- Error decoding the inputbyte[]
.
-
EPPEncodedSignedCodeValue
public EPPEncodedSignedCodeValue(java.io.InputStream aScode) throws EPPDecodeException
Creates anEPPEncodedSignedCodeValue
by decoding the a Signed Code Data (SMD) that is in a PEM-like input stream that includes the encoded signed code with a leading line "-----BEGIN ENCODED SCODE-----" and a trailing "-----END ENCODED SCODE-----".- Parameters:
aScode
-InputStream
containing a Signed Code (SCODE)- Throws:
EPPDecodeException
- Error decoding the Signed Code (SCODE)
-
-
Method Detail
-
decode
public void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
Decode theEPPSignedCode
component- Specified by:
decode
in interfaceEPPCodecComponent
- Overrides:
decode
in classEPPSignedCode
- Parameters:
aElement
- Root element of theEPPSignedCode
- Throws:
EPPDecodeException
- Error decoding theEPPSignedCode
-
decodeValue
public void decodeValue(byte[] aBase64SignedCode) throws EPPDecodeException
Decode the Base64 encoded signed code value with no wrapping XML.- Parameters:
aBase64SignedCode
- Base64 encodedEPPSignedCode
, which does not include the wrapper <verificationCode:code> XML element.- Throws:
EPPDecodeException
- Error decoding the Base64 encodedEPPSignedCode
-
decodeValue
public void decodeValue(java.lang.String aBase64SignedCode) throws EPPDecodeException
Decode the Base64 encoded signed code value with no wrapping XML.- Parameters:
aBase64SignedCode
- Base64 encodedEPPSignedCode
, which does not include the wrapper <verificationCode:code> XML element.- Throws:
EPPDecodeException
- Error decoding the Base64 encodedEPPSignedCode
-
encode
public byte[] encode() throws EPPEncodeException
Encode the encoded signed code to abyte[]
. This returns the XML with the wrapping <verificationCode:code> element with the Base64 encoded signed code value.- Overrides:
encode
in classEPPSignedCode
- Returns:
- Encoded signed code XML
- Throws:
EPPEncodeException
- Error encoding the signed code
-
encode
public org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
Sets all this instance's data in the given XML document- Specified by:
encode
in interfaceEPPCodecComponent
- Overrides:
encode
in classEPPSignedCode
- Parameters:
aDocument
- a DOM Document to attach data to.- Returns:
- The root element of this component.
- Throws:
EPPEncodeException
- Thrown if any errors prevent encoding.
-
encodeValueByteArray
public byte[] encodeValueByteArray(boolean aIsChunked) throws EPPEncodeException
Encodes the Base64 signed code value without the wrapping XML elements, and with the option for chunking the Base64 into 76 character blocks.- Parameters:
aIsChunked
- Chunk the Base64 output into 76 character blocks?- Returns:
- Base64 signed code value as a
String
- Throws:
EPPEncodeException
- Error encoding the Base64 signed code value
-
encodeValueByteArray
public byte[] encodeValueByteArray() throws EPPEncodeException
Encodes the Base64 signed code value without the wrapping XML elements- Returns:
- Base64 signed code value as a
String
that is chunked into 76 character blocks. - Throws:
EPPEncodeException
- Error encoding the Base64 signed code value
-
encodeValue
public java.lang.String encodeValue(boolean aIsChunked) throws EPPEncodeException
Encodes the Base64 signed code value without the wrapping XML elements, and with the option for chunking the Base64 into 76 character blocks.- Parameters:
aIsChunked
- Chunk the Base64 output into 76 character blocks?- Returns:
- Base64 signed code value as a
String
- Throws:
EPPEncodeException
- Error encoding the Base64 signed code value
-
encodeValue
public java.lang.String encodeValue() throws EPPEncodeException
Encodes the Base64 signed code value without the wrapping XML elements- Returns:
- Base64 signed code value as a
String
that is chunked into 76 character blocks. - Throws:
EPPEncodeException
- Error encoding the Base64 signed code value
-
clone
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
CloneEPPEncodedSignedCodeValue
.- Specified by:
clone
in interfaceEPPCodecComponent
- Overrides:
clone
in classEPPSignedCode
- Returns:
- clone of
EPPEncodedSignedCodeValue
- Throws:
java.lang.CloneNotSupportedException
- standard Object.clone exception
-
-