com.waveset.object
Class Administrator

java.lang.Object
  extended bycom.waveset.object.PersistentObject
      extended bycom.waveset.object.Principal
          extended bycom.waveset.object.Administrator
All Implemented Interfaces:
java.lang.Comparable, javax.naming.Referenceable, java.io.Serializable, XmlObject

public class Administrator
extends Principal

An Administrator object is created to define a user who will be allowed to configure or administer portions of the Waveset Provisioning System.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class com.waveset.object.PersistentObject
PersistentObject.Comparator, PersistentObject.InitialInstance
 
Field Summary
static java.lang.String code_id
           
 
Fields inherited from class com.waveset.object.Principal
_adminGroupRefs, _adminGroups, _adminGroupsRuleRef, _adminRoleRefs, _controlledObjectGroupRefs, _controlledObjectGroups, _controlledObjectGroupsRuleRef, _permissions, _userFormRef, _viewUserFormRef, LAST_LOGIN_LOCALE_PROP, LOCALE_PROP
 
Fields inherited from class com.waveset.object.PersistentObject
_trace, trace
 
Constructor Summary
Administrator()
           
Administrator(org.w3c.dom.Element e)
           
Administrator(java.lang.String name)
           
 
Method Summary
protected  void addSubclassAttributes(java.lang.StringBuffer b)
          Each concrete subclass may append to the buffer an XML representation of any fields it adds to PersistentObject (if those field values must persist).
protected  void addSubclassElements(java.lang.StringBuffer b)
          Each concrete subclass may append to the buffer an XML representation of any fields it adds to PersistentObject (if those field values must persist).
protected  WSAttribute getAttributeValues(java.lang.String attrName)
           
 java.lang.String getEmail()
           
 Administrator getForwardAdmin()
           
 ObjectRef getForwardAdminRef()
           
 EncryptedData getPassword()
           
 java.util.ArrayList getReferences()
          Return the list of references within this object.
 WSAttributes getSummaryAttributes()
           
 Type getType()
          Return the type of this object.
 java.util.List listQueryableAttributes()
           
 java.util.List listSummaryAttributes()
          Returns the complete list of defined attributes that this type of persistent object exposes as summary attributes (regardless of whether this particular object has a value for each).
protected  void parseSubclassAttributes(org.w3c.dom.Element e)
          Each concrete subclass should parse from the XML buffer any persisted subclass-specific fields (generally, the same ones that it writes into the buffer).
protected  void parseSubclassElements(org.w3c.dom.Element e)
          Each concrete subclass should parse from the XML buffer any persisted subclass-specific elements (generally, the same ones that it writes into the buffer).
static void resolveSummaryAttributes(ObjectCache cache, WSAttributes attrs)
          Walk the summary attributes, translating the embedded IDs to names.
 
Methods inherited from class com.waveset.object.Principal
addAdminGroup, addAdminGroupRef, addCommonPrincipalElements, addControlledObjectGroup, addPermission, clearAdminGroups, getAdminGroupRefs, getAdminGroups, getAdminGroupsRuleRef, getAdminRoleRefs, getAdminRoles, getControlledObjectGroupRefs, getControlledObjectGroups, getControlledObjectGroupsRuleRef, getEncryptedValues, getPermissions, getUserForm, getUserFormId, getUserFormRef, getViewUserForm, getViewUserFormId, getViewUserFormRef, hasCapabilities, listQueryableReferenceAttributes, parseCommonPrincipalElements, parsePermissions, removeAdminGroup, removeControlledObjectGroup, removePermission, setAdminGroupRefs, setAdminGroups, setAdminGroupsRuleRef, setAdminRoleRefs, setAdminRoles, setControlledObjectGroupRefs, setControlledObjectGroups, setControlledObjectGroupsRuleRef, setPermissions, setUserForm, setUserFormRef, setViewUserForm, setViewUserFormRef
 
Methods inherited from class com.waveset.object.PersistentObject
addCommonElements, addEndTag, addMemberObjectGroup, addMemberObjectGroup, addPersistentAttributes, addStartTag, addSummaryAttributes, addXmlHeader, attributesMatch, attributesMatch, attributesMatch, checkReference, checkReferences, clearId, cloneAs, cloneObject, compareTo, create, create, create, create, createLastModItem, createLastModItem, createLastModItemList, directObjectGroupMember, dump, dumpFile, equals, fakeId, getAttribute, getAttributeValues, getAuthReferences, getAuthType, getBasicAttributes, getBasicAttributes, getBasicAttributes, getCache, getCounterValue, getCreateDate, getCreator, getDisplayableName, getDisplayName, getElementName, getId, getIdOrName, getInitialInstances, getLastMod, getLastModDate, getLastModifier, getLastModItemId, getLockInfo, getMemberObjectGroupRefs, getMemberObjectGroupRefsUpTo, getMemberObjectGroups, getName, getNameOrId, getProperties, getProperty, getPropertyAsString, getPropertyList, getQueryableAttributes, getReference, getRuleDrivenMemberObjectGroupRefs, getRuleDrivenMemberObjectGroupRefsUpTo, getRuleDrivenMemberObjectGroups, getSubtype, getSummaryString, hasEncryptedData, hashCode, identityEquals, isAlias, isHidden, isId, isProtected, isProtectedFromDelete, isReferencedIn, listOperationalAttributes, objectGroupMember, objectGroupMemberRef, parseCommonElement, parseCommonElements, parsePersistentAttributes, parseXml, parseXml, prepareForSerialization, prepareToSerialize, println, reEncrypt, reEncryptSubclassAttributes, removeMemberObjectGroup, removeProperty, resolve, resolve, resolve, resolveArray, resolveArrayByFetching, resolveObjectReference, resolveObjectReferences, resolveReference, resolveSummaryAttributes, ruleDrivenObjectGroupMemberRef, setAuthType, setAuthType, setCache, setCreateDate, setCreator, setDisplayName, setDisplayName, setHidden, setIsAlias, setLastMod, setLastMod, setLastModDate, setLastModifier, setMemberObjectGroupRef, setMemberObjectGroupRefs, setMemberObjectGroups, setName, setProperties, setProperty, setPropertyList, setProtected, setProtectedFromDelete, setRuleDrivenMembersCache, setSubtype, setTrace, toString, toXml, toXml, toXml, toXmlFile, visit
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

code_id

public static final java.lang.String code_id
See Also:
Constant Field Values
Constructor Detail

Administrator

public Administrator()

Administrator

public Administrator(org.w3c.dom.Element e)
              throws WavesetException

Administrator

public Administrator(java.lang.String name)
Method Detail

getType

public Type getType()
Description copied from class: PersistentObject
Return the type of this object. This must be implemented by each subclass.

Specified by:
getType in class PersistentObject

getReferences

public java.util.ArrayList getReferences()
Description copied from class: Principal
Return the list of references within this object.

Overrides:
getReferences in class Principal

getPassword

public EncryptedData getPassword()

getEmail

public java.lang.String getEmail()

getForwardAdminRef

public ObjectRef getForwardAdminRef()

getForwardAdmin

public Administrator getForwardAdmin()
                              throws WavesetException
Throws:
WavesetException

listSummaryAttributes

public java.util.List listSummaryAttributes()
Description copied from class: PersistentObject
Returns the complete list of defined attributes that this type of persistent object exposes as summary attributes (regardless of whether this particular object has a value for each).

Any subclass of PersistentObject that overrides this method should first invoke super.listSummaryAttributes() to ensure that the subclass includes summary attributes that are common to all PersistentObjects.

Any subclass that overrides this implementation must also consider the length of the summary string that will be generated from these attributes.

Overrides:
listSummaryAttributes in class Principal
Returns:
the complete list of defined attributes that this type of persistent object exposes as summary attributes (regardless of whether this particular object has a value for each).

Any subclass of PersistentObject that overrides this method should first invoke super.listSummaryAttributes() to ensure that the subclass includes summary attributes common to all PersistentObjects.


resolveSummaryAttributes

public static void resolveSummaryAttributes(ObjectCache cache,
                                            WSAttributes attrs)
                                     throws WavesetException
Description copied from class: PersistentObject
Walk the summary attributes, translating the embedded IDs to names. For this object, they are just name and ID which do not need translating.

Throws:
WavesetException

listQueryableAttributes

public java.util.List listQueryableAttributes()
Overrides:
listQueryableAttributes in class Principal
Returns:
the complete list of defined attributes that this type of persistent object exposes as queryable attributes (regardless of whether this particular object has a value for each).

Any subclass of PersistentObject that overrides this method must first invoke super.getQueryableAttributes() to ensure that the list of queryable attribute for PersistentObjects are included in the subclasses list.


getSummaryAttributes

public WSAttributes getSummaryAttributes()
Overrides:
getSummaryAttributes in class PersistentObject
Returns:
attribute values to be displayed when this object appears in a list. The WSAttributes contains a WSAttribute for each summary attribute. Each WSAttribute may contain multiple values.

Any subclass of PersistentObject that overrides this method should first invoke super.getSummaryAttributes() to ensure that the subclass includes summary attributes that are common to all PersistentObjects.

See Also:

If a subclass wants to expose a different set of summary attributes, that subclass should override {@link #listSummaryAttributes}. In order to supply values for summary attributes that may not be available in PersistentObject (e.g., from a field specified to that subclass), such a subclass may also override {@link #getAttributeValues(Attribute)}.

A subclass should not need to override this method (except to limit the number of values for a summary attribute).


getAttributeValues

protected WSAttribute getAttributeValues(java.lang.String attrName)
Overrides:
getAttributeValues in class Principal
Parameters:
attrName - - the name of the attribute for which to return values.
Returns:
a WSAttribute that represents the value (or values) that this object contains for the specified attribute.


addSubclassAttributes

protected void addSubclassAttributes(java.lang.StringBuffer b)
Description copied from class: PersistentObject
Each concrete subclass may append to the buffer an XML representation of any fields it adds to PersistentObject (if those field values must persist). PersistentObject's default implementation is a no-op.

NOTE: Any subclass that overrides this method must similarly override parseSubclassAttributes() so that the subclass attributes are restored.

Overrides:
addSubclassAttributes in class PersistentObject
See Also:


addSubclassElements

protected void addSubclassElements(java.lang.StringBuffer b)
Description copied from class: PersistentObject
Each concrete subclass may append to the buffer an XML representation of any fields it adds to PersistentObject (if those field values must persist). PersistentObject's default implementation is a no-op.

NOTE: Any subclass that overrides this method must similarly override parseSubclassElements() so that the subclass elements are restored.

Overrides:
addSubclassElements in class PersistentObject
See Also:


parseSubclassAttributes

protected void parseSubclassAttributes(org.w3c.dom.Element e)
                                throws WavesetException
Description copied from class: PersistentObject
Each concrete subclass should parse from the XML buffer any persisted subclass-specific fields (generally, the same ones that it writes into the buffer).

Overrides:
parseSubclassAttributes in class PersistentObject
Throws:
WavesetException
See Also:

PersistentObject's default implementation is a no-op.

, PersistentObject.parseXml(Element)

parseSubclassElements

protected void parseSubclassElements(org.w3c.dom.Element e)
                              throws WavesetException
Description copied from class: PersistentObject
Each concrete subclass should parse from the XML buffer any persisted subclass-specific elements (generally, the same ones that it writes into the buffer).

Overrides:
parseSubclassElements in class PersistentObject
Throws:
WavesetException
See Also:

PersistentObject's default implementation is a no-op.

, PersistentObject.parseXml(Element)