com.edustructures.sifworks.infra
Class Authentication

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFDataObject
              com.edustructures.sifworks.infra.Authentication

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class Authentication
extends SIFDataObject

Passwords in the Authentication object can be stored in one of three ways, all base64 encoded: as clear text, as one-way hashes, or as encrypted text resulting from the application of a symmetric or asymmetric cipher. Clear text passwords are not retrievable from values stored as one-way hashes-these hashed values can only be used to verify passwords input by a user. Clear text passwords can be retrieved from encrypted text, if the receiving system has the appropriate key to decrypt the encrypted text. This specification does not define the exchange of keys for symmetric and asymmetric cryptographic algorithms, but provides the KeyName attribute to associate a key with an encrypted password. It is envisioned that when systems exchange keys in a manner outside this specification, a key name is sufficient to retrieve a key for input to the appropriate decryption algorithm.

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

Authentication()
Constructor

Authentication(java.lang.String refId, java.lang.String sifRefId, AuthSifRefIdType sifRefObject)
Constructor that accepts values for all mandatory fields

Method Summary

AuthenticationInfo	getAuthenticationInfo() Gets the value of the <AuthenticationInfo> 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
java.lang.String	getRefId() Gets the value of the RefId attribute.
java.lang.String	getSIF_RefId() Gets the value of the SIF_RefId attribute.
java.lang.String	getSIF_RefObject() Gets the value of the SIF_RefObject attribute.
void	removeAuthenticationInfo() Removes the AuthenticationInfo child element previously created by calling setAuthenticationInfo
void	setAuthenticationInfo(AuthenticationInfo value) Sets the value of the <AuthenticationInfo> element.
void	setAuthenticationInfo(AuthSystem system) Sets the value of the <AuthenticationInfo> child element.
void	setRefId(java.lang.String value) Sets the value of the RefId attribute.
void	setSIF_RefId(java.lang.String value) Sets the value of the SIF_RefId attribute.
void	setSIF_RefObject(AuthSifRefIdType value) Sets the value of the SIF_RefObject attribute.
void	setSIF_RefObject(java.lang.String value) Sets the value of the SIF_RefObject attribute as a String.

Methods inherited from class com.edustructures.sifworks.SIFDataObject

addSIFExtendedElement, clone, getElementOrAttribute, getObjectTag, getObjectType, getSIFExtendedElement, getSIFExtendedElements, getSIFExtendedElementsContainer, getSIFMetadata, getSIFVersion, setElementOrAttribute, setElementOrAttribute, setElementOrAttribute, setSIFExtendedElements, setSIFExtendedElementsContainer, setSIFMetadata, setSIFVersion, toXML

Methods inherited from class com.edustructures.sifworks.SIFElement

addChild, addChild, compareGraphTo, create, effectiveSIFVersion, getChild, getChild, getChild, getChild, getChild, getChildCount, getChildList, getChildList, getChildList, getChildren, getChildren, getContent, getContent, getField, getField, getFieldCount, getFields, getFieldValue, getSIFValue, getTextValue, getXmlId, hasTextValue, removeChild, removeChild, removeChild, removeChild, restoreImplementationDef, setChanged, setChildren, setEmpty, setField, setField, setField, setField, setSIFValue, 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

Authentication

public Authentication()

Constructor

Authentication

public Authentication(java.lang.String refId,
                      java.lang.String sifRefId,
                      AuthSifRefIdType sifRefObject)

Constructor that accepts values for all mandatory fields

Parameters:

refId - The SIF RefId that uniquely identifies this authentication object.

sifRefId - The SIF RefId of a student or staff member

sifRefObject - The type of SIF object that the SIF_RefId attribute identifies.

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

getRefId

public java.lang.String getRefId()

Gets the value of the RefId attribute.

The SIF specification defines the meaning of this attribute as: "The SIF RefId that uniquely identifies this authentication object."

Overrides:

getRefId in class SIFDataObject

Returns:

The RefId attribute of this object.

Since:

1.5r1

setRefId

public void setRefId(java.lang.String value)

Sets the value of the RefId attribute.

The SIF specification defines the meaning of this attribute as: "The SIF RefId that uniquely identifies this authentication object."

Parameters:

value - A String object

Since:

1.5r1

getSIF_RefId

public java.lang.String getSIF_RefId()

Gets the value of the SIF_RefId attribute.

The SIF specification defines the meaning of this attribute as: "The SIF RefId of a student or staff member"

This attribute is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering attributes of this kind.

Version	Tag
1.5r1	"SifRefId"
SIF2.0	"SIF_RefId"

Returns:

The SIF_RefId attribute of this object.

Since:

1.5r1

setSIF_RefId

public void setSIF_RefId(java.lang.String value)

Sets the value of the SIF_RefId attribute.

The SIF specification defines the meaning of this attribute as: "The SIF RefId of a student or staff member"

This attribute is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering attributes of this kind.

Version	Tag
1.5r1	"SifRefId"
SIF2.0	"SIF_RefId"

Parameters:

value - A String object

Since:

1.5r1

getSIF_RefObject

public java.lang.String getSIF_RefObject()

Gets the value of the SIF_RefObject attribute.

The SIF specification defines the meaning of this attribute as: "The type of SIF object that the SIF_RefId attribute identifies."

This attribute is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering attributes of this kind.

Version	Tag
1.5r1	"SifRefIdType"
SIF2.0	"SIF_RefObject"

Returns:

The SIF_RefObject attribute of this object.

Since:

1.5r1

setSIF_RefObject

public void setSIF_RefObject(AuthSifRefIdType value)

Sets the value of the SIF_RefObject attribute.

The SIF specification defines the meaning of this attribute as: "The type of SIF object that the SIF_RefId attribute identifies."

This attribute is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering attributes of this kind.

Version	Tag
1.5r1	"SifRefIdType"
SIF2.0	"SIF_RefObject"

Parameters:

value - A constant defined by the AuthSifRefIdType class

Since:

1.5r1

setSIF_RefObject

public void setSIF_RefObject(java.lang.String value)

Sets the value of the SIF_RefObject attribute as a String.

The SIF specification defines the meaning of this attribute as: "The type of SIF object that the SIF_RefId attribute identifies."

This attribute is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering attributes of this kind.

Version	Tag
1.5r1	"SifRefIdType"
SIF2.0	"SIF_RefObject"

Parameters:

value - The value as a String

Since:

1.5r1

setAuthenticationInfo

public void setAuthenticationInfo(AuthenticationInfo value)

Sets the value of the <AuthenticationInfo> element.

The SIF specification defines the meaning of this element as: "The authentication information for one system."

Parameters:

value - A AuthenticationInfo object

Since:

1.5r1

setAuthenticationInfo

public void setAuthenticationInfo(AuthSystem system)

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

Parameters:

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

Since:

1.5r1

getAuthenticationInfo

public AuthenticationInfo getAuthenticationInfo()

Gets the value of the <AuthenticationInfo> element.

The SIF specification defines the meaning of this element as: "The authentication information for one system."

Returns:

An AuthenticationInfo object

Since:

1.5r1

removeAuthenticationInfo

public void removeAuthenticationInfo()

Removes the AuthenticationInfo child element previously created by calling setAuthenticationInfo

Since:

1.5r1