com.highdeal.hci

Class DelegatedMessageAuthentication

java.lang.Object

com.highdeal.hci.DelegatedMessageAuthentication

All Implemented Interfaces:

MessageAuthentication, XMLMarshallable

public class DelegatedMessageAuthentication
extends java.lang.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>

Nested Class Summary

Nested classes/interfaces inherited from interface com.highdeal.hci.MessageAuthentication

MessageAuthentication.MessageAuthScheme

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TAG_NAME

Constructor Summary

Constructors

Constructor and Description
DelegatedMessageAuthentication() Initializes an empty Delegated Message Authentication.
DelegatedMessageAuthentication(java.lang.String name, java.lang.String password) Initializes a Delegated Message Authentication with a name and password.

Method Summary

Modifier and Type	Method and Description
void	addCharacterData(java.lang.String cData) Adds character data to the content element.
void	addChild(java.lang.String tagName, XMLMarshallable child) Adds a child to the object, the child representing the marshallable object which must be added to the element.
java.lang.String[]	getCredentials() Returns the credentials as a string array containing the name and the password.
MessageAuthentication.MessageAuthScheme	getScheme() Returns the name of the scheme used for authentication.
void	marshal(XMLOutputter output) Gives an XML representation of this object, including its children.
void	setAttributes(XMLAttributes atts) Sets the attributes of the XML representation of the element being processed.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TAG_NAME

public static final java.lang.String TAG_NAME

See Also:

Constant Field Values

Constructor Detail

DelegatedMessageAuthentication

public DelegatedMessageAuthentication()

Initializes an empty Delegated Message Authentication.

DelegatedMessageAuthentication

public DelegatedMessageAuthentication(java.lang.String name,
                                      java.lang.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 Detail

getCredentials

public java.lang.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(java.lang.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(java.lang.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