Class UserSessionMessageAuthentication

java.lang.Object
com.highdeal.hci.UserSessionMessageAuthentication
All Implemented Interfaces:
MessageAuthentication, XMLMarshallable
public class UserSessionMessageAuthentication extends Object implements MessageAuthentication
This class represents the authentication marker for the "user-session" scheme. It indicates that user session authentication is being used. The actual session ID is stored in the originator element (not in this authentication marker). This is an explicit authentication type that indicates user session mode, where authentication is based on a session ID instead of a password.

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="authUserSession">
  <xs:complexType>
    <xs:attribute name="scheme" type="xs:string" default="user-session"/>
  </xs:complexType>
</xs:element>

  • Field Details

  • Constructor Details

    • UserSessionMessageAuthentication

      public UserSessionMessageAuthentication()

  • Method Details

    • getScheme

      public MessageAuthentication.MessageAuthScheme getScheme()
      Returns the authentication scheme defined in this class: "user-session".
      Specified by:
      getScheme in interface MessageAuthentication
      Returns:
      "user-session"

    • setAttributes

      public void setAttributes(XMLAttributes atts)
      Sets the attributes of the XML representation of the tag being processed.
      Specified by:
      setAttributes in interface XMLMarshallable
      Parameters:
      atts - The XML attributes of the current tag

    • addChild

      public void addChild(String tagName, XMLMarshallable child)
      Adds a child to the objects, the child represents the marshallable object to be added into the content tree.
      Specified by:
      addChild in interface XMLMarshallable
      Parameters:
      tagName - The name of tag for the child
      child - The child to be added

    • addCharacterData

      public void addCharacterData(String cData)
      Adds character data to the content element. User session marker ignores any character data.
      Specified by:
      addCharacterData in interface XMLMarshallable
      Parameters:
      cData - The character data to be ignored

    • marshal

      public void marshal(XMLOutputter output)
      Gives an XML representation of this object. The user session marker is just an empty element indicating the user session scheme.
      Specified by:
      marshal in interface XMLMarshallable
      Parameters:
      output - The XML output to marshal the object into