com.edustructures.sifworks.infra
Class Password

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class Password
extends SIFKeyedElement

The password in this system for this user. Value must be base64 encoded to facilitate transfer of possibly invalid XML characters that can result from the encryption algorithm applied, and to deter casual snooping of unencrypted passwords. An Algorithm attribute value of "base64" therefore signifies clear text.

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

Password()
Constructor

Password(PasswordAlgorithm algorithm, java.lang.String keyName, java.lang.String value)
Constructor that accepts values for all mandatory fields

Method Summary

java.lang.String	getAlgorithm() Gets the value of the Algorithm attribute.
java.lang.String	getKey() Gets the key of this object
ElementDef[]	getKeyFields() Gets the metadata fields that make up the key of this object
java.lang.String	getKeyName() Gets the value of the KeyName attribute.
java.lang.String	getValue() Gets the value of the <Value> element.
void	setAlgorithm(PasswordAlgorithm value) Sets the value of the Algorithm attribute.
void	setAlgorithm(java.lang.String value) Sets the value of the Algorithm attribute as a String.
void	setKeyName(java.lang.String value) Sets the value of the KeyName attribute.
void	setValue(java.lang.String value) Sets the value of the <Value> 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

Password

public Password()

Constructor

Password

public Password(PasswordAlgorithm algorithm,
                java.lang.String keyName,
                java.lang.String value)

Constructor that accepts values for all mandatory fields

Parameters:

algorithm - The method used to encrypt the user's password. See the implementation details below.

keyName - The name of the key to be used for decryption of the password. Left blank for plain, encoded text (Algorithm attribute value of "base64") and hash algorithms.

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

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

getValue

public java.lang.String getValue()

Gets the value of the <Value> element.

The SIF specification defines the meaning of this element as: "Gets or sets the content value of the <Password> element"

Returns:

The Value element of this object.

Since:

1.5r1

setValue

public void setValue(java.lang.String value)

Sets the value of the <Value> element.

The SIF specification defines the meaning of this element as: "Gets or sets the content value of the <Password> element"

Parameters:

value - A String object

Since:

1.5r1

getAlgorithm

public java.lang.String getAlgorithm()

Gets the value of the Algorithm attribute.

The SIF specification defines the meaning of this attribute as: "The method used to encrypt the user's password. See the implementation details below."

Returns:

The Algorithm attribute of this object.

Since:

1.5r1

setAlgorithm

public void setAlgorithm(PasswordAlgorithm value)

Sets the value of the Algorithm attribute.

The SIF specification defines the meaning of this attribute as: "The method used to encrypt the user's password. See the implementation details below."

Parameters:

value - A constant defined by the PasswordAlgorithm class

Since:

1.5r1

setAlgorithm

public void setAlgorithm(java.lang.String value)

Sets the value of the Algorithm attribute as a String.

The SIF specification defines the meaning of this attribute as: "The method used to encrypt the user's password. See the implementation details below."

Parameters:

value - The value as a String

Since:

1.5r1

getKeyName

public java.lang.String getKeyName()

Gets the value of the KeyName attribute.

The SIF specification defines the meaning of this attribute as: "The name of the key to be used for decryption of the password. Left blank for plain, encoded text (Algorithm attribute value of "base64") and hash algorithms."

Returns:

The KeyName attribute of this object.

Since:

1.5r1

setKeyName

public void setKeyName(java.lang.String value)

Sets the value of the KeyName attribute.

The SIF specification defines the meaning of this attribute as: "The name of the key to be used for decryption of the password. Left blank for plain, encoded text (Algorithm attribute value of "base64") and hash algorithms."

Parameters:

value - A String object

Since:

1.5r1