com.edustructures.sifworks.infra
Class PasswordList

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFList<T>
              com.edustructures.sifworks.SIFKeyedList<Password>
                  com.edustructures.sifworks.infra.PasswordList

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<Password>, java.util.Collection<Password>

public class PasswordList
extends SIFKeyedList<Password>

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

PasswordList()
Constructor

PasswordList(Password password)
Constructor that accepts values for all mandatory fields

Method Summary

void	addPassword(PasswordAlgorithm algorithm, java.lang.String keyName, java.lang.String value) Adds a new <Password> repeatable element.
Password	getPassword(PasswordAlgorithm algorithm) Gets a Password object instance.
Password[]	getPasswords() Gets all Password object instances.
void	removePassword(PasswordAlgorithm algorithm) Removes a Password object instance.
void	setPasswords(Password[] passwords) Sets an array of Password objects.

Methods inherited from class com.edustructures.sifworks.SIFKeyedList

getChild, getChild

Methods inherited from class com.edustructures.sifworks.SIFList

add, addAll, clear, contains, containsAll, get, iterator, remove, remove, removeAll, retainAll, size, toArray, toArray

Methods inherited from class com.edustructures.sifworks.SIFElement

addChild, addChild, clone, compareGraphTo, create, effectiveSIFVersion, getChild, getChild, getChild, getChildCount, getChildList, getChildList, getChildList, getChildren, getChildren, getContent, getContent, getField, getField, getFieldCount, getFields, getFieldValue, getKey, 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

Methods inherited from interface java.util.Collection

equals, hashCode, isEmpty

Constructor Detail

PasswordList

public PasswordList()

Constructor

PasswordList

public PasswordList(Password password)

Constructor that accepts values for all mandatory fields

Parameters:

password - A representation of the user's password using the given algorithm.

Method Detail

addPassword

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

Adds a new <Password> repeatable element. This form of setPassword is provided as a convenience method that is functionally equivalent to the version of setPassword that accepts a single Password object.

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

Since:

1.5r1

removePassword

public void removePassword(PasswordAlgorithm algorithm)

Removes a Password object instance. More than one instance can be defined for this object because it is a repeatable field element.

Parameters:

algorithm - Identifies the Password object to remove by its Algorithm value

Since:

1.5r1

getPassword

public Password getPassword(PasswordAlgorithm algorithm)

Gets a Password object instance. More than one instance can be defined for this object because it is a repeatable field element.

Parameters:

algorithm - Identifies the Password object to return by its "Algorithm" attribute value

Returns:

A Password object

Since:

1.5r1

getPasswords

public Password[] getPasswords()

Gets all Password object instances. More than one instance can be defined for this object because it is a repeatable field element.

Returns:

An array of Password objects

Since:

1.5r1

setPasswords

public void setPasswords(Password[] passwords)

Sets an array of Password objects. All existing Password instances are removed and replaced with this list. Calling this method with the parameter value set to null removes all Passwords.

Since:

1.5r1