com.edustructures.sifworks.infra
Class AuthenticationInfo

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFKeyedElement
              com.edustructures.sifworks.infra.AuthenticationInfo

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class AuthenticationInfo
extends SIFKeyedElement

The authentication information for one system.

Since:

1.5r1

Version:

2.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.edustructures.sifworks.Element

CURRENT_SERIALIZE_VERSION

Constructor Summary

AuthenticationInfo()
Constructor

AuthenticationInfo(AuthSystem system)
Constructor that accepts values for all mandatory fields

Method Summary

java.lang.String	getDistinguishedName() Gets the value of the <DistinguishedName> element.
java.lang.String	getKey() Gets the key of this object
ElementDef[]	getKeyFields() Gets the metadata fields that make up the key of this object
PasswordList	getPasswordList() Gets the value of the <PasswordList> element.
AuthSystem	getSystem() Gets the value of the <System> element.
java.lang.String	getUsername() Gets the value of the <Username> element.
void	removePasswordList() Removes the PasswordList child element previously created by calling setPasswordList
void	removeSystem() Removes the System child element previously created by calling setSystem
void	setDistinguishedName(java.lang.String value) Sets the value of the <DistinguishedName> element.
void	setPasswordList(PasswordList value) Sets the value of the <PasswordList> element.
void	setSystem(AuthSystem value) Sets the value of the <System> element.
void	setSystem(AuthSystemType type, java.lang.String value) Sets the value of the <System> child element.
void	setUsername(java.lang.String value) Sets the value of the <Username> element.

Methods inherited from class com.edustructures.sifworks.SIFElement

addChild, addChild, clone, compareGraphTo, create, effectiveSIFVersion, getChild, getChild, getChild, getChild, getChild, getChildCount, getChildList, getChildList, getChildList, getChildren, getChildren, getContent, getContent, getField, getField, getFieldCount, getFields, getFieldValue, getSIFValue, getSIFVersion, getTextValue, getXmlId, hasTextValue, removeChild, removeChild, removeChild, removeChild, restoreImplementationDef, setChanged, setChildren, setEmpty, setField, setField, setField, setField, setSIFValue, setSIFVersion, setTextValue, setXmlId, tag

Methods inherited from class com.edustructures.sifworks.Element

compareTo, getElementDef, getParent, getRoot, isChanged, isDoNotEncode, isEmpty, setChanged, setDoNotEncode, setElementDef, setEmpty, setParent, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthenticationInfo

public AuthenticationInfo()

Constructor

AuthenticationInfo

public AuthenticationInfo(AuthSystem system)

Constructor that accepts values for all mandatory fields

Parameters:

system - An identifying string for the system that supports this authentication information.

Method Detail

getKey

public java.lang.String getKey()

Gets the key of this object

Overrides:

getKey in class SIFElement

Returns:

The value of the object's Mandatory or Required attribute. If an object has more than one such attribute, the key is a period- delimited concatenation of the attribute values in sequential order

getKeyFields

public ElementDef[] getKeyFields()

Gets the metadata fields that make up the key of this object

Returns:

an array of metadata fields that make up the object's key

setSystem

public void setSystem(AuthSystem value)

Sets the value of the <System> element.

The SIF specification defines the meaning of this element as: "An identifying string for the system that supports this authentication information."

Parameters:

value - A AuthSystem object

Since:

1.5r1

setSystem

public void setSystem(AuthSystemType type,
                      java.lang.String value)

Sets the value of the <System> child element. This form of setSystem is provided as a convenience method that is functionally equivalent to the version of setSystem that accepts a single AuthSystem object.

Parameters:

type - Specific type of user identification.

value - Gets or sets the content value of the <AuthSystem> element

Since:

1.5r1

getSystem

public AuthSystem getSystem()

Gets the value of the <System> element.

The SIF specification defines the meaning of this element as: "An identifying string for the system that supports this authentication information."

Returns:

An AuthSystem object

Since:

1.5r1

removeSystem

public void removeSystem()

Removes the System child element previously created by calling setSystem

Since:

1.5r1

getUsername

public java.lang.String getUsername()

Gets the value of the <Username> element.

The SIF specification defines the meaning of this element as: "The identification string for this user."

Returns:

The Username element of this object.

Since:

1.5r1

setUsername

public void setUsername(java.lang.String value)

Sets the value of the <Username> element.

The SIF specification defines the meaning of this element as: "The identification string for this user."

Parameters:

value - A String object

Since:

1.5r1

getDistinguishedName

public java.lang.String getDistinguishedName()

Gets the value of the <DistinguishedName> element.

The SIF specification defines the meaning of this element as: "This is the distinguished name of the user in a network directory system."

Returns:

The DistinguishedName element of this object.

Since:

1.5r1

setDistinguishedName

public void setDistinguishedName(java.lang.String value)

Sets the value of the <DistinguishedName> element.

The SIF specification defines the meaning of this element as: "This is the distinguished name of the user in a network directory system."

Parameters:

value - A String object

Since:

1.5r1

setPasswordList

public void setPasswordList(PasswordList value)

Sets the value of the <PasswordList> element.

Parameters:

value - A PasswordList object

Since:

1.5r1

getPasswordList

public PasswordList getPasswordList()

Gets the value of the <PasswordList> element.

Returns:

A PasswordList object

Since:

1.5r1

removePasswordList

public void removePasswordList()

Removes the PasswordList child element previously created by calling setPasswordList

Since:

1.5r1