Package com.highdeal.hci

Class DelegatedMessageAuthentication

java.lang.Object
com.highdeal.hci.DelegatedMessageAuthentication
All Implemented Interfaces:
MessageAuthentication, XMLMarshallable
public class DelegatedMessageAuthentication extends Object implements MessageAuthentication
This class represents the authentication data used for the "delegated" schema, that is delegated to another user.

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="authDelegated">
   <xs:complexType>
     <xs:simpleContent>
       <xs:extension base="xs:string">
         <xs:attribute name="scheme" type="xs:string" default="delegated"/>
       </xs:extension>
     </xs:simpleContent>
   </xs:complexType>
 </xs:element>

  • Field Details

  • Constructor Details

    • DelegatedMessageAuthentication

      public DelegatedMessageAuthentication()
      Initializes an empty Delegated Message Authentication.

    • DelegatedMessageAuthentication

      public DelegatedMessageAuthentication(String name, String password)
      Initializes a Delegated Message Authentication with a name and password.
      Parameters:
      name - The name to which the authentication is delegated to
      password - The password

  • Method Details

    • getCredentials

      public String[] getCredentials()
      Returns the credentials as a string array containing the name and the password.
      Returns:
      the credentials as a string array or null if there is no credentials.

    • getScheme

      public MessageAuthentication.MessageAuthScheme getScheme()
      Description copied from interface: MessageAuthentication
      Returns the name of the scheme used for authentication.
      Specified by:
      getScheme in interface MessageAuthentication
      Returns:
      The name of the schema used for authentication

    • setAttributes

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

    • addChild

      public void addChild(String tagName, XMLMarshallable child)
      Description copied from interface: XMLMarshallable
      Adds a child to the object, the child representing the marshallable object which must be added to the element.
      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)
      Description copied from interface: XMLMarshallable
      Adds character data to the content element.
      Specified by:
      addCharacterData in interface XMLMarshallable
      Parameters:
      cData - The character data to be added

    • marshal

      public void marshal(XMLOutputter output)
      Description copied from interface: XMLMarshallable
      Gives an XML representation of this object, including its children.
      Specified by:
      marshal in interface XMLMarshallable
      Parameters:
      output - The XML output to marshal the object into