org.openliberty.xmltooling.ps

Class PSObject

java.lang.Object

org.opensaml.core.xml.AbstractXMLObject

org.openliberty.xmltooling.ps.PSObject

All Implemented Interfaces:

org.opensaml.core.xml.ElementExtensibleXMLObject, org.opensaml.core.xml.XMLObject

Direct Known Subclasses:

ItemData

public class PSObject
extends org.opensaml.core.xml.AbstractXMLObject
implements org.opensaml.core.xml.ElementExtensibleXMLObject

PSObject is the basic data object in the People Service representing both Collections and Entities

From section 2.1 of the ID-WSF People Service Specification v1.0:

Both individual users and the groups to which they may belong are represented as <Object> elements - whether an <Object> refers to a group or a user (or perhaps some other individual entity) is distinguished by a NodeType attribute with values of urn:liberty:ps:collection or urn:liberty:ps:entity respectively (see Section 2.1.1 for exact definition).

The <Object> element has DisplayName elements to carry a human-readable name for the <Object> (see Section 2.1.5).

The <ObjectID> element uniquely labels each <Object> (see Section 2.1.4). The optional CreatedDateTime and ModifiedDateTime attributes express the time at which an Object was created and last modified respectively (see Section 2.1.2).

To account for nested Objects, an <Object> element can have multiple <Object> and/or <ObjectRef> elements to refer to other Objects.

 <xs:element name="Object" type="ObjectType" />
 
 <xs:complexType name="ObjectType">
  <xs:sequence>
      <xs:element ref="ObjectID" minOccurs="0" />
      <xs:element name="DisplayName" type="LocalizedDisplayNameType" minOccurs="1" maxOccurs="unbounded" />
      <xs:element name="Tag" type="TagType" minOccurs="0" maxOccurs="unbounded" />
      <xs:element ref="Object" minOccurs="0" maxOccurs="unbounded" />
      <xs:element name="ObjectRef" type="ObjectIDType" minOccurs="0" maxOccurs="unbounded" />
  </xs:sequence>
  <xs:attribute name="NodeType" type="xs:anyURI" use="required" />
  <xs:attribute name="CreatedDateTime" type="xs:dateTime" use="optional" />
  <xs:attribute name="ModifiedDateTime" type="xs:dateTime" use="optional" />
 </xs:complexType>
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PSObject.Builder Static Builder for PSObject
static class	PSObject.Marshaller Static Marshaller for PSObject
static class	PSObject.NodeType
static class	PSObject.Unmarshaller Ststic Unmarshaller for PSObject

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATT_CREATED_DATE_TIME
static String	ATT_MODIFIED_DATE_TIME
static String	ATT_NODE_TYPE
private DateTime	createdDateTime
private org.opensaml.core.xml.util.XMLObjectChildrenList<DisplayName>	displayNames
static String	LOCAL_NAME
private DateTime	modifiedDateTime
private PSObject.NodeType	nodeType
private ObjectID	objectID
private org.opensaml.core.xml.util.XMLObjectChildrenList<ObjectRef>	objectRefs
private org.opensaml.core.xml.util.XMLObjectChildrenList<PSObject>	objects
private org.opensaml.core.xml.util.XMLObjectChildrenList<Tag>	tags
private org.opensaml.core.xml.util.IndexedXMLObjectChildrenList<org.opensaml.core.xml.XMLObject>	unknownXMLObjects

Constructor Summary

Constructors

Modifier	Constructor and Description
	PSObject()
	PSObject(String displayName)
protected	PSObject(String namespaceURI, String elementLocalName, String namespacePrefix)

Method Summary

Methods

Modifier and Type	Method and Description
static PSObject	createCollection(String displayName)
static PSObject	createEntity(String displayName)
ObjectRef	createObjectRef() This method returns a PSObjectRef only if there is a PSObjectID present in the PSObject
TargetObjectID	createTargetObjectID() This method returns a TargetObjectID only if there is a PSObjectID present in the PSObject
DateTime	getCreatedDateTime()
org.opensaml.core.xml.util.XMLObjectChildrenList<DisplayName>	getDisplayNames()
DateTime	getModifiedDateTime()
String	getName()
PSObject.NodeType	getNodeType()
ObjectID	getObjectID()
org.opensaml.core.xml.util.XMLObjectChildrenList<ObjectRef>	getObjectRefs()
org.opensaml.core.xml.util.XMLObjectChildrenList<PSObject>	getObjects()
List<org.opensaml.core.xml.XMLObject>	getOrderedChildren()
org.opensaml.core.xml.util.XMLObjectChildrenList<Tag>	getTags()
List<org.opensaml.core.xml.XMLObject>	getUnknownXMLObjects()
List<org.opensaml.core.xml.XMLObject>	getUnknownXMLObjects(QName typeOrName)
boolean	isCollection()
boolean	isEntity()
void	print()
static void	printPSObject(PSObject object)
private static void	printPSObject(PSObject object, int depth)
void	setCreatedDateTime(DateTime createdDateTime)
void	setModifiedDateTime(DateTime modifiedDateTime)
void	setName(String displayNameValue) Sets the value of the first DisplayName, or creates one if it does not exist
void	setNodeType(PSObject.NodeType nodeType)
void	setObjectID(ObjectID objectID)

Methods inherited from class org.opensaml.core.xml.AbstractXMLObject

detach, getDOM, getElementQName, getIDIndex, getNamespaceManager, getNamespaces, getNoNamespaceSchemaLocation, getObjectMetadata, getParent, getSchemaLocation, getSchemaType, hasChildren, hasParent, isNil, isNilXSBoolean, manageQualifiedAttributeNamespace, prepareAttributeValueForAssignment, prepareElementContentForAssignment, prepareForAssignment, prepareForAssignment, prepareForAssignment, registerOwnID, releaseChildrenDOM, releaseDOM, releaseParentDOM, releaseThisAndChildrenDOM, releaseThisandParentDOM, resolveID, resolveIDFromRoot, setDOM, setElementNamespacePrefix, setElementQName, setNil, setNil, setNoNamespaceSchemaLocation, setParent, setSchemaLocation, setSchemaType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensaml.core.xml.XMLObject

detach, getDOM, getElementQName, getIDIndex, getNamespaceManager, getNamespaces, getNoNamespaceSchemaLocation, getObjectMetadata, getParent, getSchemaLocation, getSchemaType, hasChildren, hasParent, isNil, isNilXSBoolean, releaseChildrenDOM, releaseDOM, releaseParentDOM, resolveID, resolveIDFromRoot, setDOM, setNil, setNil, setNoNamespaceSchemaLocation, setParent, setSchemaLocation

Field Detail

LOCAL_NAME

public static String LOCAL_NAME

ATT_NODE_TYPE

public static String ATT_NODE_TYPE

ATT_CREATED_DATE_TIME

public static String ATT_CREATED_DATE_TIME

ATT_MODIFIED_DATE_TIME

public static String ATT_MODIFIED_DATE_TIME

nodeType

private PSObject.NodeType nodeType

createdDateTime

private DateTime createdDateTime

modifiedDateTime

private DateTime modifiedDateTime

objectID

private ObjectID objectID

displayNames

private org.opensaml.core.xml.util.XMLObjectChildrenList<DisplayName> displayNames

tags

private org.opensaml.core.xml.util.XMLObjectChildrenList<Tag> tags

objects

private org.opensaml.core.xml.util.XMLObjectChildrenList<PSObject> objects

objectRefs

private org.opensaml.core.xml.util.XMLObjectChildrenList<ObjectRef> objectRefs

unknownXMLObjects

private org.opensaml.core.xml.util.IndexedXMLObjectChildrenList<org.opensaml.core.xml.XMLObject> unknownXMLObjects

Constructor Detail

PSObject

public PSObject()

PSObject

public PSObject(String displayName)

PSObject

protected PSObject(String namespaceURI,
        String elementLocalName,
        String namespacePrefix)

Method Detail

createEntity

public static PSObject createEntity(String displayName)

createCollection

public static PSObject createCollection(String displayName)

isCollection

public boolean isCollection()

isEntity

public boolean isEntity()

print

public void print()

printPSObject

public static void printPSObject(PSObject object)

printPSObject

private static void printPSObject(PSObject object,
                 int depth)

createObjectRef

public ObjectRef createObjectRef()

This method returns a PSObjectRef only if there is a PSObjectID present in the PSObject

Returns:

a reference to the object or null if one cannot be created

createTargetObjectID

public TargetObjectID createTargetObjectID()

This method returns a TargetObjectID only if there is a PSObjectID present in the PSObject

Returns:

a TargetObjectID referring to the object or null if one cannot be created

getName

public String getName()

Returns:

the value of the first DisplayName

setName

public void setName(String displayNameValue)

Sets the value of the first DisplayName, or creates one if it does not exist

getNodeType

public PSObject.NodeType getNodeType()

setNodeType

public void setNodeType(PSObject.NodeType nodeType)

setCreatedDateTime

public void setCreatedDateTime(DateTime createdDateTime)

getCreatedDateTime

public DateTime getCreatedDateTime()

setModifiedDateTime

public void setModifiedDateTime(DateTime modifiedDateTime)

getModifiedDateTime

public DateTime getModifiedDateTime()

setObjectID

public void setObjectID(ObjectID objectID)

getObjectID

public ObjectID getObjectID()

getDisplayNames

public org.opensaml.core.xml.util.XMLObjectChildrenList<DisplayName> getDisplayNames()

getTags

public org.opensaml.core.xml.util.XMLObjectChildrenList<Tag> getTags()

getObjects

public org.opensaml.core.xml.util.XMLObjectChildrenList<PSObject> getObjects()

getObjectRefs

public org.opensaml.core.xml.util.XMLObjectChildrenList<ObjectRef> getObjectRefs()

getUnknownXMLObjects

public List<org.opensaml.core.xml.XMLObject> getUnknownXMLObjects()

Specified by:

getUnknownXMLObjects in interface org.opensaml.core.xml.ElementExtensibleXMLObject

getUnknownXMLObjects

public List<org.opensaml.core.xml.XMLObject> getUnknownXMLObjects(QName typeOrName)

Specified by:

getUnknownXMLObjects in interface org.opensaml.core.xml.ElementExtensibleXMLObject

getOrderedChildren

public List<org.opensaml.core.xml.XMLObject> getOrderedChildren()

Specified by:

getOrderedChildren in interface org.opensaml.core.xml.XMLObject