Package com.verisign.epp.codec.statusset.v02

Class EPPStatusSetAuthToken

java.lang.Object
com.verisign.epp.codec.statusset.v02.EPPStatusSetAuthToken
All Implemented Interfaces:
EPPCodecComponent, Serializable, Cloneable
public class EPPStatusSetAuthToken extends Object implements EPPCodecComponent
Contains the authentication token string that is created by the Authentication Token Mapping. This is a placeholder object that will be replaced with the the Authenticaiton Token from the Authentication Token Mapping.
See Also:

  • Field Details

  • Constructor Details

    • EPPStatusSetAuthToken

      public EPPStatusSetAuthToken()
      Default constructor for EPPStatusSetAuthToken.

    • EPPStatusSetAuthToken

      public EPPStatusSetAuthToken(String aAuthTokenValue)
      Constructor for EPPStatusSetAuthToken that takes the authentication token string value.
      Parameters:
      aAuthTokenValue - Authentication value string value

    • EPPStatusSetAuthToken

      public EPPStatusSetAuthToken(EPPAuthTokenData aToken)
      Converts an EPPAuthTokenData to an EPPStatusSetAuthToken, which only has the JWS Compact Serialization value.
      Parameters:
      aToken -

  • Method Details

    • getLocalName

      protected String getLocalName()
      Returns the local name "authToken" for the component.
      Returns:
      Local name "authToken" for the component.

    • hasValue

      public boolean hasValue()
      Is the authentication token string value defined?
      Returns:
      true if the authentication token string value is defined; false otherwise.

    • getValue

      public String getValue()
      Gets the authentication token string value.
      Returns:
      Authentication token string value if defined; null otherwise.

    • setValue

      public void setValue(String aAuthTokenValue)
      Sets the authentication token string value.
      Parameters:
      aAuthTokenValue - The authentication token value to set.

    • getAuthTokenData

      public EPPAuthTokenData getAuthTokenData() throws EPPDecodeException
      Gets the EPPAuthTokenData instance that is set with the auth token value.
      Returns:
      EPPAuthTokenData instance initialized with the auth token value.
      Throws:
      EPPDecodeException

    • encode

      public Element encode(Document aDocument) throws EPPEncodeException
      Encode instance into a DOM element tree. A DOM Document is passed as an argument and functions as a factory for DOM objects. The root element associated with the instance is created and each instance attribute is appended as a child node.
      Specified by:
      encode in interface EPPCodecComponent
      Parameters:
      aDocument - DOM Document, which acts is an Element factory
      Returns:
      Element Root element associated with the object
      Throws:
      EPPEncodeException - Error encoding EPPStatusSetAuthToken

    • decode

      public void decode(Element aElement) throws EPPDecodeException
      Decode a DOM element tree to initialize the instance attributes. The aElement argument represents the root DOM element and is used to traverse the DOM nodes for instance attribute values.
      Specified by:
      decode in interface EPPCodecComponent
      Parameters:
      aElement - Element to decode
      Throws:
      EPPDecodeException - Error decoding Element

    • clone

      public Object clone() throws CloneNotSupportedException
      clone an EPPCodecComponent.
      Specified by:
      clone in interface EPPCodecComponent
      Overrides:
      clone in class Object
      Returns:
      clone of concrete EPPStatusSetAuthToken
      Throws:
      CloneNotSupportedException - standard Object.clone exception

    • toString

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

    • equals

      public boolean equals(Object aObject)
      Compare an instance of EPPStatusSetAuthToken with this instance.
      Overrides:
      equals in class Object
      Parameters:
      aObject - Object to compare with.
      Returns:
      true if equal; false otherwise.

    • getNamespace

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