Class SessionData

java.lang.Object
com.verisign.epp.serverstub.SessionData
All Implemented Interfaces:
Serializable, Cloneable

public class SessionData extends Object implements Cloneable, Serializable
The SessionData is a utility class that contains data related to an established EPP client/server session.
See Also:
  • Constructor Details

    • SessionData

      public SessionData()
      Constructs a new SessionData instance
  • Method Details

    • clone

      public Object clone() throws CloneNotSupportedException
      Makes a copy of the invoking SessionData object
      Overrides:
      clone in class Object
      Returns:
      Clone of SessionData
      Throws:
      CloneNotSupportedException - Error cloning SessionData
    • hasLogoutOccured

      public boolean hasLogoutOccured()
      Returns the logout state of this session object.
      Returns:
      boolean True if a logout has occurred
    • setLogoutOccured

      public void setLogoutOccured(boolean aBool)
      Sets the logout state of this session object.
      Parameters:
      aBool - The new logout state
    • isLoggedIn

      public boolean isLoggedIn()
      Returns the login state of this session object
      Returns:
      boolean The login state of this session object
    • getLoginCmd

      public EPPLoginCmd getLoginCmd()
      Gets the EPPLoginCmd used for the authenticated session.
      Returns:
      EPPLoginCmd if set; null otherwise.
    • setLoginCmd

      public void setLoginCmd(EPPLoginCmd aLoginCmd)
      Sets the EPPLoginCmd used for the authenticated session.
      Parameters:
      aLoginCmd - EPPLoginCmd passed by the user for the authenticated session.
    • setLoggedIn

      public void setLoggedIn(boolean aBool)
      Sets the login state of this session object
      Parameters:
      aBool - The new login state
    • getGreeting

      public EPPGreeting getGreeting()
      Returns the EPPGreeting associated with this session
      Returns:
      EPPGreeting The greeting
    • setGreeting

      public void setGreeting(EPPGreeting aGreeting)
      Sets the greeting that will be sent to clients when they connect
      Parameters:
      aGreeting - The greeting that should be sent.
    • setAttribute

      public void setAttribute(String aName, Object aResource)
      Sets a session attribute by use an attribute name (key) along with an attribute value.
      Parameters:
      aName - Name of the attribute
      aResource - Value of the attribute
    • getAttribute

      public Object getAttribute(String aName)
      Gets a session attribute by attribute name.
      Parameters:
      aName - Name of attribute
      Returns:
      Value of attribute if defined; null otherwise.
    • hasMessage

      public boolean hasMessage()
      Has the message been set?
      Returns:
      true if the set date has been set; false otherwise.
    • getMessage

      public EPPMessage getMessage()
      Gets the EPPMessage decoded.
      Returns:
      Message decoded if set; null otherwise
    • setMessage

      public void setMessage(EPPMessage aMessage)
      Sets the EPPMessage decoded.
      Parameters:
      aMessage - Message decoded