public class Hier extends FortEntity implements Serializable
The Fortress ftHier Entity Class is used internal to Fortress and usually does not require manipulation by external program. The entity is a composite of 3 different LDAP Schema object classes:
1. organizationalRole Structural Object Class is used to store basic attributes like cn and description.
------------------------------------------ objectclass ( 2.5.6.8 NAME 'organizationalRole' DESC 'RFC2256: an organizational role' SUP top STRUCTURAL MUST cn MAY ( x121Address $ registeredAddress $ destinationIndicator $ preferredDeliveryMethod $ telexNumber $ teletexTerminalIdentifier $ telephoneNumber $ internationaliSDNNumber $ facsimileTelephoneNumber $ seeAlso $ roleOccupant $ preferredDeliveryMethod $ street $ postOfficeBox $ postalCode $ postalAddress $ physicalDeliveryOfficeName $ ou $ st $ l $ description ) ) ------------------------------------------
2. ftHier AUXILIARY Object Class is used to store parent to child relationships on target entity.
------------------------------------------ Fortress Hierarchies Structural Object Class objectclass ( 1.3.6.1.4.1.38088.2.7 NAME 'ftHier' DESC 'Fortress Hierarchy Structural Object Class' SUP organizationalrole STRUCTURAL MUST ( cn ) MAY ( ftRels $ description ) )3. ftMods AUXILIARY Object Class is used to store Fortress audit variables on target entity.
------------------------------------------ Fortress Audit Modification Auxiliary Object Class objectclass ( 1.3.6.1.4.1.38088.3.4 NAME 'ftMods' DESC 'Fortress Modifiers AUX Object Class' AUXILIARY MAY ( ftModifier $ ftModCode $ ftModId ) ) ------------------------------------------
Modifier and Type | Class and Description |
---|---|
static class |
Hier.Op
Operation type specifies if Add, Update or Deletion of relationship is being targeted.
|
static class |
Hier.Type
Enumeration is used to specify which hierarchy node this entity is bound to.
|
Modifier and Type | Field and Description |
---|---|
Hier.Op |
op
The operation
|
Hier.Type |
type
The hierarchy type - ROLE, AROLE, USER, PERM
|
adminSession, contextId, modCode, modId, sequenceId
Constructor and Description |
---|
Hier()
default constructor is used by internal components.
|
Hier(Hier.Type type)
Construct entity given a hierarchy type - ROLE, AROLE, USER, PERM.
|
Hier(Hier.Type type,
String child,
String parent)
Construct entity given a parent, child and a hierarchy type.
|
Hier(List<Relationship> relationships)
construct hierarchy given a list of parent-child relationships.
|
Hier(String child,
String parent)
Construct entity given a parent and child.
|
Modifier and Type | Method and Description |
---|---|
Hier.Op |
getOp()
Return the operation to execute on behalf of this entity.
|
List<Relationship> |
getRelationships()
Return the list of relationships that are set in collection on this entity.
|
Hier.Type |
getType()
Return required the type of node this entity is bound to.
|
boolean |
isRelationship(String role,
String parent)
Return true if child and parent represent a valid relationship that is contained within the collection of
relationships.
|
void |
removeRelationship(String role,
String parent)
Remove the specified relationship from the collection of valid relationships stored in this entity.
|
void |
setOp(Hier.Op op)
The the operation for which this entity is bound for.
|
void |
setRelationship(Relationship rel)
Set the relationship object into the collection of valid relationships stored in this entity.
|
void |
setRelationship(String role,
String parent)
Set the child and parent into the collection of valid relationships stored in this entity.
|
void |
setRelationships(List<Relationship> relationships)
Set the list of relationships that are set in collection on this entity.
|
void |
setType(Hier.Type type)
Set the required type which determines which directory node this entity is bound to.
|
String |
toString() |
getAdminSession, getContextId, getModCode, getModId, getSequenceId, setAdminSession, setContextId, setModCode, setSequenceId
public Hier.Op op
public Hier.Type type
public Hier()
public Hier(List<Relationship> relationships)
relationships
- maps to 'ftRels' attribute on 'ftHier' object class.public Hier(Hier.Type type)
type
- determines where the target node resides. For example the 'ROLE' type will specify the RBAC Role container as target.public Hier(Hier.Type type, String child, String parent)
type
- determines where the target node resides. For example the 'ROLE' type will specify the RBAC Role container as target.child
- maps to the 'ftRels' attribute in 'ftHier' object class.parent
- maps to the 'ftRels' attribute in 'ftHier' object class.public Hier.Op getOp()
public void setOp(Hier.Op op)
op
- type contains 'ADD', 'MOD', or 'REM'.public Hier.Type getType()
public void setType(Hier.Type type)
type
- variable specifies which directory node the hierarchy entity is bound to.public boolean isRelationship(String role, String parent)
role
- attribute maps to the 'ftRels' attribute on 'ftHier' object class.parent
- attribute maps to the 'ftRels' attribute on 'ftHier' object class.public void setRelationship(String role, String parent)
role
- attribute maps to the 'ftRels' attribute on 'ftHier' object class.parent
- attribute maps to the 'ftRels' attribute on 'ftHier' object class.public void setRelationship(Relationship rel)
rel
- attribute maps to the 'ftRels' attribute on 'ftHier' object class.public void removeRelationship(String role, String parent)
role
- attribute maps to the 'ftRels' attribute on 'ftHier' object class.parent
- attribute maps to the 'ftRels' attribute on 'ftHier' object class.public List<Relationship> getRelationships()
public void setRelationships(List<Relationship> relationships)
relationships
- that map to the 'ftRels' attribute on the 'ftHier' object class.public String toString()
toString
in class Object
Object.toString()
Copyright © 2003-2016, The Apache Software Foundation. All Rights Reserved. Generated 20160718-1621