public class PermObj extends FortEntity implements Serializable
User
, Role
, Permission
,
PwPolicy
SDSet
etc...) are used to carry data between three Fortress
layers.starting with the (1) Manager layer down thru middle (2) Process layer and it's processing rules into
(3) DAO layer where persistence with the OpenLDAP server occurs.
AdminMgrImpl
, AccessMgrImpl
, ReviewMgrImpl
,...UserP
, RoleP
, PermP
,...UserDAO
, RoleDAO
, PermDAO
,...objName
and ou
attributes set before passing into AdminMgrImpl
or ReviewMgrImpl
APIs.
Create methods usually require more attributes (than Read) due to constraints enforced between entities.
setObjName(java.lang.String)
and setOu(java.lang.String)
attributes set before calling AdminMgrImpl.addPermObj(PermObj)
.
addProperty(java.lang.String, java.lang.String)
may be set before calling AdminMgrImpl.addPermObj(PermObj)
.
getProperty(java.lang.String)
may be set after calling ReviewMgrImpl.findPermObjs(PermObj)
.
PermObj
entity is not used for authorization checks, rather contains Permission
which are themselves authorization targets.OrgUnit.Type.PERM
that is contained within the ou=OS-P,ou=ARBAC,dc=example,dc=com
location in ldap.
PermObj
1<->* Operations Permission
PermObj#objName
.
Permission
javadoc.
1. ftObject STRUCTURAL Object Class is used to store object name, id and type variables on target entity.
Fortress Permission Structural Object Class objectclass ( 1.3.6.1.4.1.38088.2.2 NAME 'ftObject' DESC 'Fortress Permission Object Class' SUP organizationalunit STRUCTURAL MUST ( ftId $ ftObjNm ) MAY ( ftType ) )2. ftProperties AUXILIARY Object Class is used to store client specific name/value pairs on target entity. This aux object class can be used to store custom attributes
------------------------------------------ AC2: Fortress Properties Auxiliary Object Class objectclass ( 1.3.6.1.4.1.38088.3.2 NAME 'ftProperties' DESC 'Fortress Properties AUX Object Class' AUXILIARY MAY ( ftProps ) ) ------------------------------------------
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 ) ) ------------------------------------------
adminSession, contextId, modCode, modId, sequenceId
Constructor and Description |
---|
PermObj()
Default Constructor used internal to Fortress.
|
PermObj(String objName)
Construct an Fortress PermObj entity given an object name.
|
PermObj(String objName,
String ou)
Construct an Fortress PermObj entity given an object and perm ou name.
|
Modifier and Type | Method and Description |
---|---|
void |
addProperties(Properties props)
Add new collection of name/value pairs to attributes associated with PermObj.
|
void |
addProperty(String key,
String value)
Add name/value pair to list of properties associated with PermObj.
|
boolean |
equals(Object thatObj)
Matches the objName from two PermObj entities.
|
String |
getDescription()
Returns optional description that is associated with PermObj.
|
String |
getDn()
Returns distinguished name associated with PermObj.
|
String |
getInternalId()
Return the internal id that is associated with PermObj.
|
String |
getObjName()
Get the authorization target's object name.
|
String |
getOu()
Return orgUnit name for PermObj.
|
Properties |
getProperties()
Return the collection of name/value pairs to attributes associated with PermObj.
|
String |
getProperty(String key)
Get a name/value pair attribute from list of properties associated with PermObj.
|
Props |
getProps()
Gets the value of the Props property.
|
String |
getType()
Get the type attribute of the Perm object.
|
int |
hashCode() |
boolean |
isAdmin()
If set to true, this entity will be loaded into the Admin Permission data set.
|
void |
setAdmin(boolean admin)
If set to true, this entity will be loaded into the Admin Permission data set.
|
void |
setDescription(String description)
Sets the optional description that is associated with PermObj.
|
void |
setDn(String dn)
Set distinguished name associated with PermObj.
|
void |
setInternalId()
This attribute is required but is set automatically by Fortress DAO class before object is persisted to ldap.
|
void |
setInternalId(String internalId)
Set the internal id that is associated with PermObj.
|
void |
setObjName(String objName)
This attribute is required and sets the authorization target object name.
|
void |
setOu(String ou)
Set the orgUnit name associated with PermObj.
|
void |
setProps(Props value)
Sets the value of the Props property.
|
void |
setType(String type)
Sets the type attribute of the Perm object.
|
String |
toString() |
getAdminSession, getContextId, getModCode, getModId, getSequenceId, setAdminSession, setContextId, setModCode, setSequenceId
public PermObj()
public PermObj(String objName)
objName
- maps to 'ftObjNm' attribute in 'ftObject' object class.public String getObjName()
public void setObjName(String objName)
public void setInternalId()
public void setInternalId(String internalId)
internalId
- maps to 'ftId' in 'ftObject' object class.public String getInternalId()
public boolean isAdmin()
public void setAdmin(boolean admin)
admin
- boolean variable indicates if entity is an RBAC or ARBAC Permission Object.public void setDescription(String description)
description
- that is mapped to same name in 'organizationalUnit' object class.public String getDescription()
public Props getProps()
Props
public void setProps(Props value)
value
- allowed object is
Props
public void addProperty(String key, String value)
key
- contains property name and maps to 'ftProps' attribute in 'ftProperties' aux object class.value
- public String getProperty(String key)
key
- contains property name and maps to 'ftProps' attribute in 'ftProperties' aux object class.public void addProperties(Properties props)
props
- contains collection of name/value pairs and maps to 'ftProps' attribute in 'ftProperties' aux object class.public Properties getProperties()
public void setOu(String ou)
ou
- mapped to same name in 'ftObject' object class.public String getOu()
public void setType(String type)
type
- maps to attribute name 'ftType' in 'ftObject' object class.public String getType()
public void setDn(String dn)
dn
- that is mapped to same name in 'organizationalUnit' object class.public String getDn()
public boolean equals(Object thatObj)
Copyright © 2003-2016, The Apache Software Foundation. All Rights Reserved. Generated 20160718-1621