Class Mod
- java.lang.Object
-
- org.apache.directory.fortress.core.model.FortEntity
-
- org.apache.directory.fortress.core.model.Mod
-
- All Implemented Interfaces:
Serializable
public class Mod extends FortEntity implements Serializable
This entity class contains OpenLDAP slapd access log records that correspond to modifications made to the directory.The auditModify Structural object class is used to store Fortress update and delete events that can later be queried via ldap API.
The deletions can be recorded in this manner and associated with Fortress context because deletions will perform a modification first if audit is enabled.The Modify operation contains a description of modifications in the
reqMod attribute, which was already described above in the Add
operation. It may optionally contain the previous contents of any
modified attributes in the reqOld attribute, using the same format as
described above for the Delete operation. The reqOld attribute is only
populated if the entry being modified matches the configured logold
filter.
- ------------------------------------------
-
objectclass ( 1.3.6.1.4.1.4203.666.11.5.2.9
-
NAME 'auditModify'
-
DESC 'Modify operation'
-
SUP auditWriteObject STRUCTURAL
-
MAY reqOld MUST reqMod )
- ------------------------------------------
Note this class uses descriptions pulled from man pages on slapd access log.
- Author:
- Apache Directory Project
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class org.apache.directory.fortress.core.model.FortEntity
adminSession, contextId, modCode, modId
-
-
Constructor Summary
Constructors Constructor Description Mod()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getObjectClass()
Get the object class name of the audit record.String
getReqAuthzID()
The reqAuthzID attribute is the distinguishedName of the user that performed the operation.String
getReqDN()
The reqDN attribute is the distinguishedName of the target of the operation.String
getReqEnd()
reqEnd provide the end time of the operation.List<String>
getReqMod()
The reqMod attribute carries all of the attributes of the original entry being added.String
getReqResult()
The reqResult attribute is the numeric LDAP result code of the operation, indicating either success or a particular LDAP error code.String
getReqSession()
The reqSession attribute is an implementation-specific identifier that is common to all the operations associated with the same LDAP session.String
getReqStart()
reqStart provide the start of the operation, They use generalizedTime syntax.String
getReqType()
The reqType attribute is a simple string containing the type of operation being logged, e.g.long
getSequenceId()
Sequence id is used internal to Fortress.void
setObjectClass(String objectClass)
Set the object class name of the audit record.void
setReqAuthzID(String reqAuthzID)
The reqAuthzID attribute is the distinguishedName of the user that performed the operation.void
setReqDN(String reqDN)
The reqDN attribute is the distinguishedName of the target of the operation.void
setReqEnd(String reqEnd)
reqEnd provide the end time of the operation.void
setReqMod(List<String> reqMod)
The reqMod attribute carries all of the attributes of the original entry being added.void
setReqResult(String reqResult)
The reqResult attribute is the numeric LDAP result code of the operation, indicating either success or a particular LDAP error code.void
setReqSession(String reqSession)
The reqSession attribute is an implementation-specific identifier that is common to all the operations associated with the same LDAP session.void
setReqStart(String reqStart)
reqStart provide the start of the operation, They use generalizedTime syntax.void
setReqType(String reqType)
The reqType attribute is a simple string containing the type of operation being logged, e.g.void
setSequenceId(long sequenceId)
Sequence id is used internal to Fortress-
Methods inherited from class org.apache.directory.fortress.core.model.FortEntity
getAdminSession, getContextId, getModCode, getModId, setAdminSession, setContextId, setModCode
-
-
-
-
Method Detail
-
getReqMod
public List<String> getReqMod()
The reqMod attribute carries all of the attributes of the original entry being added. (Or in the case of a Modify operation, all of the modifications being performed.) The values are formatted as attribute:<+|-|=|#> [ value] Where '+' indicates an Add of a value, '-' for Delete, '=' for Replace, and '#' for Increment. In an Add operation, all of the reqMod values will have the '+' designator.- Returns:
- collection of Strings that map to 'reqMod' attribute on 'auditModify' object class.
-
setReqMod
public void setReqMod(List<String> reqMod)
The reqMod attribute carries all of the attributes of the original entry being added. (Or in the case of a Modify operation, all of the modifications being performed.) The values are formatted as attribute:<+|-|=|#> [ value] Where '+' indicates an Add of a value, '-' for Delete, '=' for Replace, and '#' for Increment. In an Add operation, all of the reqMod values will have the '+' designator.- Parameters:
reqMod
- contains collection of Strings that map to 'reqMod' attribute on 'auditModify' object class.
-
getReqEnd
public String getReqEnd()
reqEnd provide the end time of the operation. It uses generalizedTime syntax.- Returns:
- value that maps to 'reqEnd' attribute on 'auditModify' object class.
-
setReqEnd
public void setReqEnd(String reqEnd)
reqEnd provide the end time of the operation. It uses generalizedTime syntax.- Parameters:
reqEnd
- value that maps to same name on 'auditModify' object class.
-
getReqSession
public String getReqSession()
The reqSession attribute is an implementation-specific identifier that is common to all the operations associated with the same LDAP session. Currently this is slapd's internal connection ID, stored in decimal.- Returns:
- value that maps to 'reqSession' attribute on 'auditModify' object class.
-
setReqSession
public void setReqSession(String reqSession)
The reqSession attribute is an implementation-specific identifier that is common to all the operations associated with the same LDAP session. Currently this is slapd's internal connection ID, stored in decimal.- Parameters:
reqSession
- maps to same name on 'auditModify' object class.
-
getObjectClass
public String getObjectClass()
Get the object class name of the audit record. For this entity, this value will always be 'auditModify'.- Returns:
- value that maps to 'objectClass' attribute on 'auditModify' obejct class.
-
setObjectClass
public void setObjectClass(String objectClass)
Set the object class name of the audit record. For this entity, this value will always be 'auditModify'.- Parameters:
objectClass
- value that maps to same name on 'auditModify' obejct class.
-
getReqAuthzID
public String getReqAuthzID()
The reqAuthzID attribute is the distinguishedName of the user that performed the operation. This will usually be the same name as was established at the start of a session by a Bind request (if any) but may be altered in various circumstances. For Fortress bind operations this will map toUser.userId
- Returns:
- value that maps to 'reqAuthzID' on 'auditModify' object class.
-
setReqAuthzID
public void setReqAuthzID(String reqAuthzID)
The reqAuthzID attribute is the distinguishedName of the user that performed the operation. This will usually be the same name as was established at the start of a session by a Bind request (if any) but may be altered in various circumstances. For Fortress bind operations this will map toUser.userId
-
getReqDN
public String getReqDN()
The reqDN attribute is the distinguishedName of the target of the operation. E.g.,for a Bind request, this is the Bind DN. For an Add request, this is the DN of the entry being added. For a Search request, this is the base DN of the search.- Returns:
- value that map to 'reqDN' attribute on 'auditModify' object class.
-
setReqDN
public void setReqDN(String reqDN)
The reqDN attribute is the distinguishedName of the target of the operation. E.g., for a Bind request, this is the Bind DN. For an Add request, this is the DN of the entry being added. For a Search request, this is the base DN of the search.- Parameters:
reqDN
- maps to 'reqDN' attribute on 'auditModify' object class.
-
getReqResult
public String getReqResult()
The reqResult attribute is the numeric LDAP result code of the operation, indicating either success or a particular LDAP error code. An error code may be accompanied by a text error message which will be recorded in the reqMessage attribute.- Returns:
- value that maps to 'reqResult' attribute on 'auditModify' object class.
-
setReqResult
public void setReqResult(String reqResult)
The reqResult attribute is the numeric LDAP result code of the operation, indicating either success or a particular LDAP error code. An error code may be accompanied by a text error message which will be recorded in the reqMessage attribute.- Parameters:
reqResult
- maps to same name on 'auditModify' object class.
-
getReqStart
public String getReqStart()
reqStart provide the start of the operation, They use generalizedTime syntax. The reqStart attribute is also used as the RDN for each log entry.- Returns:
- value that maps to 'reqStart' attribute on 'auditModify' object class.
-
setReqStart
public void setReqStart(String reqStart)
reqStart provide the start of the operation, They use generalizedTime syntax. The reqStart attribute is also used as the RDN for each log entry.- Parameters:
reqStart
- maps to same name on 'auditModify' object class.
-
getReqType
public String getReqType()
The reqType attribute is a simple string containing the type of operation being logged, e.g. add, delete, search, etc. For extended operations, the type also includes the OID of the extended operation, e.g. extended(1.1.1.1)- Returns:
- value that maps to 'reqType' attribute on 'auditModify' object class.
-
setReqType
public void setReqType(String reqType)
The reqType attribute is a simple string containing the type of operation being logged, e.g. add, delete, search, etc. For extended operations, the type also includes the OID of the extended operation, e.g.extended(1.1.1.1)- Parameters:
reqType
- maps to same name on 'auditModify' object class.
-
getSequenceId
public long getSequenceId()
Sequence id is used internal to Fortress.- Overrides:
getSequenceId
in classFortEntity
- Returns:
- long value contains sequence id.
-
setSequenceId
public void setSequenceId(long sequenceId)
Sequence id is used internal to Fortress- Overrides:
setSequenceId
in classFortEntity
- Parameters:
sequenceId
- contains sequence to use.
-
-