Package org.apache.directory.fortress.core.model

Class FortEntity

java.lang.Object

org.apache.directory.fortress.core.model.FortEntity

Direct Known Subclasses:

AdminRoleRelationship, AuthZ, Bind, Configuration, Group, Hier, Mod, OrgUnit, OrgUnitRelationship, PermGrant, Permission, PermissionAttribute, PermissionAttributeSet, PermObj, Props, PwPolicy, Role, RoleConstraint, RolePerm, RoleRelationship, SDSet, Session, User, UserAudit, UserRole

public abstract class FortEntity
extends Object

This abstract class is extended by other Fortress entities. It is used to store contextual data that can be used for administrative RBAC checking in addition to associating an audit context with every LDAP operation.

Audit Context Schema

The FortEntity Class is used to tag all Fortress LDAP records with variables contained within this auxiliary object class:

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
  )
 )
 ------------------------------------------
 

This class is not thread safe.

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field	Description
protected Session	adminSession
protected String	contextId
protected String	modCode
protected String	modId
protected long	sequenceId

Constructor Summary

Constructors

Constructor	Description
FortEntity()	Default constructor will call the setter to load a new internal ID into entity.
FortEntity(Session adminSession)	Use this constructor to load administrative RBAC session into this entity.

Method Summary

Modifier and Type	Method	Description
Session	getAdminSession()	Return the ARBAC Session object that was loaded into this entity.
String	getContextId()	Return the contextId for this record.
String	getModCode()	Contains the Fortress modification code to be associated with an audit record.
String	getModId()	Get the unique ID that is to be associated with a particular audit record in directory.
long	getSequenceId()	Sequence id is used internal to Fortress.
void	setAdminSession(Session adminSession)	Load an ARBAC Session object into this entity.
void	setContextId(String contextId)	Set the contextId associated with this record.
void	setModCode(String modCode)	Set the Fortress modification code to be associated with an audit record.
void	setSequenceId(long sequenceId)	Sequence id is used internal to Fortress

Methods inherited from class java.lang.Object

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

Field Detail

modCode

protected String modCode

modId

protected String modId

adminSession

protected Session adminSession

sequenceId

protected long sequenceId

contextId

protected String contextId

Constructor Detail

FortEntity

public FortEntity()

Default constructor will call the setter to load a new internal ID into entity.

FortEntity

public FortEntity(Session adminSession)

Use this constructor to load administrative RBAC session into this entity.

Parameters:

adminSession - contains ARBAC Session object.

Method Detail

getAdminSession

public Session getAdminSession()

Return the ARBAC Session object that was loaded into this entity.

Returns:

ARBAC Session object.

setAdminSession

public void setAdminSession(Session adminSession)

Load an ARBAC Session object into this entity. Once loaded, all Fortress Manager's will perform administrative permission checks against the User who is contained within the Session.

Parameters:

adminSession - The ARBAC admin session

getModCode

public String getModCode()

Contains the Fortress modification code to be associated with an audit record. This is the ObjectName.methodName for the Manager API that was called.

Returns:

String contains the modification code maps to 'ftModCode' attribute in 'FortEntity' object class.

setModCode

public void setModCode(String modCode)

Set the Fortress modification code to be associated with an audit record. Contains the Fortress modification code which is ObjectName.methodName for the Manager API that was called.

Parameters:

modCode - contains the modification code maps to 'ftModCode' attribute in 'FortEntity' object class.

getModId

public String getModId()

Get the unique ID that is to be associated with a particular audit record in directory.

Returns:

attribute that maps to 'ftModId' attribute in 'FortEntity' object class.

getContextId

public String getContextId()

Return the contextId for this record. The contextId is used for multi-tenancy to isolate data sets within a particular sub-tree within DIT

Returns:

value maps to sub-tree in DIT, e.g. ou=contextId, dc=example, dc=com.

setContextId

public void setContextId(String contextId)

Set the contextId associated with this record. The contextId is used for multi-tenancy to isolate data sets within a particular sub-tree within DIT. Package private to prevent outside classes from setting.

Parameters:

contextId - maps to sub-tree in DIT, e.g. ou=contextId, dc=example, dc=com.

getSequenceId

public long getSequenceId()

Sequence id is used internal to Fortress.

Returns:

long value contains sequence id.

setSequenceId

public void setSequenceId(long sequenceId)

Sequence id is used internal to Fortress

Parameters:

sequenceId - contains sequence to use.