Package com.verisign.epp.codec.verificationcode

Class EPPEncodedSignedCode

  • All Implemented Interfaces:
    EPPCodecComponent, java.io.Serializable, java.lang.Cloneable
    public class EPPEncodedSignedCode
extends java.lang.Object
implements EPPCodecComponent
    Class for the encoded signed code, which contains the code and the XMLSignature itself. This class extends EPPSignedCode.
    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 element
      static java.lang.String ELM_NAME
      Constant for the code tag for signedCode element

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addCode​(EPPEncodedSignedCodeValue aCode)
      Adds a encoded signed code to the list of encoded signed codes.
      java.lang.Object clone()
      Clone EPPEncodedSignedCode.
      void decode​(org.w3c.dom.Element aElement)
      Decode the EPPSignedCode component
      org.w3c.dom.Element encode​(org.w3c.dom.Document aDocument)
      Sets all this instance's data in the given XML document
      boolean equals​(java.lang.Object aObject)
      implements a deep EPPEncodedSignedCode compare.
      java.lang.String getNamespace()
      Returns the XML namespace associated with the EPPCodecComponent.
      java.util.List<EPPEncodedSignedCodeValue> getSignedCodes()
      Gets the list of encoded signed codes.
      boolean hasCodes()
      Are encoded signed codes defined?
      void setCode​(EPPEncodedSignedCodeValue aCode)
      Sets the encoded signed codes to a single code.
      void setSignedCodes​(java.util.List<EPPEncodedSignedCodeValue> aCodes)
      Sets the list of encoded signed codes.
      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

      • 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

      • EPPEncodedSignedCode

        public EPPEncodedSignedCode()
        Default constructor

      • EPPEncodedSignedCode

        public EPPEncodedSignedCode​(EPPEncodedSignedCodeValue aEncodedSignedCodeValue)
        Construct an encoded signed code with a single encoded signed code value.
        Parameters:
        aEncodedSignedCodeValue - Encoded signed code value to add to the list.

      • EPPEncodedSignedCode

        public EPPEncodedSignedCode​(EPPVerificationCode aCode)
                     throws EPPEncodeException
        Create an EPPEncodedSignedCode with the code of the signed code.
        Parameters:
        aCode - Verification code
        Throws:
        EPPEncodeException - Thrown if any errors prevent encoding.

      • EPPEncodedSignedCode

        public EPPEncodedSignedCode​(java.lang.String aCode,
                            java.lang.String aType)
                     throws EPPEncodeException
        Create an EPPEncodedSignedCode with the code of the signed code and code type.
        Parameters:
        aCode - Verification code
        aType - OPTIONAL verification code type. Set to null if no type is defined.
        Throws:
        EPPEncodeException - Thrown if any errors prevent encoding.

      • EPPEncodedSignedCode

        public EPPEncodedSignedCode​(java.util.List<EPPEncodedSignedCodeValue> aCodes)
        Create an EPPEncodedSignedCode with a list of encoded signed code values.
        Parameters:
        aCodes - List of encoded signed code values

    • Method Detail

      • hasCodes

        public boolean hasCodes()
        Are encoded signed codes defined?
        Returns:
        true if encoded signed codes are defined; false otherwise.

      • getSignedCodes

        public java.util.List<EPPEncodedSignedCodeValue> getSignedCodes()
        Gets the list of encoded signed codes.
        Returns:
        List of encoded signed codes if set; null otherwise.

      • setSignedCodes

        public void setSignedCodes​(java.util.List<EPPEncodedSignedCodeValue> aCodes)
        Sets the list of encoded signed codes.
        Parameters:
        aCodes - List of encoded signed codes

      • setCode

        public void setCode​(EPPEncodedSignedCodeValue aCode)
        Sets the encoded signed codes to a single code.
        Parameters:
        aCode - Encoded signed code to set

      • addCode

        public void addCode​(EPPEncodedSignedCodeValue aCode)
        Adds a encoded signed code to the list of encoded signed codes.
        Parameters:
        aCode - Encoded signed code to add to the list of encoded signed codes.

      • decode

        public void decode​(org.w3c.dom.Element aElement)
            throws EPPDecodeException
        Decode the EPPSignedCode component
        Specified by:
        decode in interface EPPCodecComponent
        Parameters:
        aElement - Root element of the EPPSignedCode
        Throws:
        EPPDecodeException - Error decoding the EPPSignedCode

      • 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 interface EPPCodecComponent
        Parameters:
        aDocument - a DOM Document to attach data to.
        Returns:
        The root element of this component.
        Throws:
        EPPEncodeException - Thrown if any errors prevent encoding.

      • equals

        public boolean equals​(java.lang.Object aObject)
        implements a deep EPPEncodedSignedCode compare.
        Overrides:
        equals in class java.lang.Object
        Parameters:
        aObject - EPPEncodedSignedCode instance to compare with
        Returns:
        true if equal false otherwise

      • clone

        public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
        Clone EPPEncodedSignedCode.
        Specified by:
        clone in interface EPPCodecComponent
        Overrides:
        clone in class java.lang.Object
        Returns:
        clone of EPPEncodedSignedCode
        Throws:
        java.lang.CloneNotSupportedException - standard Object.clone exception

      • toString

        public java.lang.String toString()
        Implementation of Object.toString, which will result in an indented XML String representation of the concrete EPPCodecComponent.
        Overrides:
        toString in class java.lang.Object
        Returns:
        Indented XML String if successful; ERROR otherwise.

      • getNamespace

        public java.lang.String getNamespace()
        Returns the XML namespace associated with the EPPCodecComponent.
        Specified by:
        getNamespace in interface EPPCodecComponent
        Returns:
        XML namespace for the EPPCodecComponent.