Class UserAudit
- java.lang.Object
-
- org.apache.directory.fortress.core.model.FortEntity
-
- org.apache.directory.fortress.core.model.UserAudit
-
- All Implemented Interfaces:
Serializable
public class UserAudit extends FortEntity implements Serializable
This entity is used to pass search criteria into theAuditMgr
APIs, down through the org.apache.directory.fortress.core.impl.AuditP process layer and finally into the org.apache.directory.fortress.core.impl.AuditDAO data access layer. Once the data has been retrieved from the directory it will be passed back to the caller using one of audit output entities.All audit data is returned to user using one of the following:
- 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, sequenceId
-
-
Constructor Summary
Constructors Constructor Description UserAudit()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Date
getBeginDate()
Get the Date for search to begin.String
getDn()
Get the optional dn attribute can be used to constraintAuditMgrImpl.searchUserSessions(UserAudit)
.Date
getEndDate()
String
getInternalUserId()
Get the optional internalUserId attribute which limits set by org.apache.directory.fortress.core.model.User#internalId.String
getObjId()
String
getObjName()
Get the optional objName attribute which limits set by org.apache.directory.fortress.core.model.Permission#objName.String
getOpName()
Get the optional opName attribute which limitsAuditMgrImpl.searchAdminMods(UserAudit)
by org.apache.directory.fortress.core.impl.AuditDAO#REQMOD.String
getUserId()
Get the optional userId attribute which limits set by org.apache.directory.fortress.core.model.User#userId.boolean
isAdmin()
boolean
isFailedOnly()
The failedOnly flag will limit result set to include only authN or authZ events that have failed.void
setAdmin(boolean admin)
void
setBeginDate(Date beginDate)
Set the Date for search to begin.void
setDn(String dn)
Set the optional dn attribute can be used to constraintAuditMgrImpl.searchUserSessions(UserAudit)
.void
setEndDate(Date endDate)
void
setFailedOnly(boolean failedOnly)
The failedOnly flag will limit result set to include only authN or authZ events that have failed.void
setInternalUserId(String internalUserId)
Set the optional internalUserId attribute which limits set by org.apache.directory.fortress.core.model.User#internalId.void
setObjId(String objId)
void
setObjName(String objName)
Set the optional objName attribute which limits set by org.apache.directory.fortress.core.model.Permission#objName.void
setOpName(String opName)
Set the optional opName attribute which limitsAuditMgrImpl.searchAdminMods(UserAudit)
by org.apache.directory.fortress.core.impl.AuditDAO#REQMOD}.void
setUserId(String userId)
Set the optional userId attribute which limits set by org.apache.directory.fortress.core.model.User#userId.-
Methods inherited from class org.apache.directory.fortress.core.model.FortEntity
getAdminSession, getContextId, getModCode, getModId, getSequenceId, setAdminSession, setContextId, setModCode, setSequenceId
-
-
-
-
Method Detail
-
getObjName
public String getObjName()
Get the optional objName attribute which limits set by org.apache.directory.fortress.core.model.Permission#objName. For modification search, this attr maps to org.apache.directory.fortress.core.impl.AuditDAO#REQMOD. For authorization search, it will map to org.apache.directory.fortress.core.impl.AuditDAO#REQDN. The object name is derived from another class name which represents targets for Fortress authorizations. For exampleAdminMgrImpl
or 'CustomerCheckOutPage'.- Returns:
- the name of the object which maps to 'reqDn' for 'auditSearch' target, or 'reqMod' for 'auditMod' search.
-
setObjName
public void setObjName(String objName)
Set the optional objName attribute which limits set by org.apache.directory.fortress.core.model.Permission#objName. For modification search, this attr maps to org.apache.directory.fortress.core.impl.AuditDAO#REQMOD. For authorization search, it will map to org.apache.directory.fortress.core.impl.AuditDAO#REQDN. The object name is derived from another class name which represents targets for Fortress authorizations. For exampleAdminMgrImpl
or 'CustomerCheckOutPage'.- Parameters:
objName
- maps to 'reqDn' for 'auditSearch' target, or 'reqMod' for 'auditMod' search.
-
isFailedOnly
public boolean isFailedOnly()
The failedOnly flag will limit result set to include only authN or authZ events that have failed.AuditMgrImpl.searchInvalidUsers(UserAudit)
maps to (org.apache.directory.fortress.core.impl.AuditDAO#REQENTRIES} == 0)AuditMgrImpl.searchAuthZs(UserAudit)
maps to (org.apache.directory.fortress.core.impl.AuditDAO#REQENTRIES == 0)AuditMgrImpl.searchBinds(UserAudit)
maps to (org.apache.directory.fortress.core.impl.AuditDAO#REQRESULT gtr than 1)
- Returns:
- boolean if true will limit search to failed events.
-
setFailedOnly
public void setFailedOnly(boolean failedOnly)
The failedOnly flag will limit result set to include only authN or authZ events that have failed.AuditMgrImpl.searchInvalidUsers(UserAudit)
maps to (org.apache.directory.fortress.core.impl.AuditDAO#REQENTRIES == 0)AuditMgrImpl.searchAuthZs(UserAudit)
maps to (org.apache.directory.fortress.core.impl.AuditDAO#REQENTRIES == 0)AuditMgrImpl.searchBinds(UserAudit)
maps to (org.apache.directory.fortress.core.impl.AuditDAO#REQRESULT gtr than or equal 1)
- Parameters:
failedOnly
- if boolean true search will limit to failed only.
-
getOpName
public String getOpName()
Get the optional opName attribute which limitsAuditMgrImpl.searchAdminMods(UserAudit)
by org.apache.directory.fortress.core.impl.AuditDAO#REQMOD. The operation name is derived from a method name of a class which represents targets for Fortress authorizations. For example 'read', 'search' or 'add'.- Returns:
- value that maps to 'reqMod' on 'auditMod' object class.
-
setOpName
public void setOpName(String opName)
Set the optional opName attribute which limitsAuditMgrImpl.searchAdminMods(UserAudit)
by org.apache.directory.fortress.core.impl.AuditDAO#REQMOD}. The operation name is derived from a method name of a class which represents targets for Fortress authorizations. For example 'read', 'search' or 'add'.- Parameters:
opName
- attribute maps to 'reqMod' on 'auditMod' object class.
-
getUserId
public String getUserId()
Get the optional userId attribute which limits set by org.apache.directory.fortress.core.model.User#userId. For authentication searchs, this attr maps to org.apache.directory.fortress.core.impl.AuditDAO#REQDN. For authorization search, it will map to org.apache.directory.fortress.core.impl.AuditDAO#REQUAUTHZID. The userId for this search represents the end user.- Returns:
- the userId which maps to 'reqDn' for authentications or 'reqAuthzID' for authorization events.
-
setUserId
public void setUserId(String userId)
Set the optional userId attribute which limits set by org.apache.directory.fortress.core.model.User#userId. For authentication searchs, this attr maps to org.apache.directory.fortress.core.impl.AuditDAO#REQDN. For authorization search, it will map to org.apache.directory.fortress.core.impl.AuditDAO#REQUAUTHZID. The userId for this search represents the end user.- Parameters:
userId
- maps to 'reqDn' for authentications or 'reqAuthzID' for authorization events.
-
getInternalUserId
public String getInternalUserId()
Get the optional internalUserId attribute which limits set by org.apache.directory.fortress.core.model.User#internalId. ForAuditMgrImpl.searchUserSessions(UserAudit)
this attr maps to org.apache.directory.fortress.core.impl.AuditDAO#REQMOD. The internalUserId for this search represents the end user but is stored as its internal id.- Returns:
- the internalUserId which maps to 'reqMod' for 'auditModify' object class searches.
-
setInternalUserId
public void setInternalUserId(String internalUserId)
Set the optional internalUserId attribute which limits set by org.apache.directory.fortress.core.model.User#internalId. ForAuditMgrImpl.searchUserSessions(UserAudit)
this attr maps to org.apache.directory.fortress.core.impl.AuditDAO#REQMOD. The internalUserId for this search represents the end user but is stored as its internal id.- Parameters:
internalUserId
- maps to 'reqMod' for 'auditModify' object class searches.
-
getBeginDate
public Date getBeginDate()
Get the Date for search to begin. The earlier the date, the more records will be returned. This attribute is mapped to 'reqStart' on slapd audit records which provides the start time of the operation which is also the rDn for the node.- Returns:
- attribute that maps to 'reqStart' in audit object classes.
-
setBeginDate
public void setBeginDate(Date beginDate)
Set the Date for search to begin. The earlier the date, the more records will be returned. This attribute is mapped to 'reqStart' on slapd audit records which provides the start time of the operation which is also the rDn for the node.- Parameters:
beginDate
- attribute that maps to 'reqStart' in audit object classes.
-
getEndDate
public Date getEndDate()
-
setEndDate
public void setEndDate(Date endDate)
- Parameters:
endDate
-
-
getDn
public String getDn()
Get the optional dn attribute can be used to constraintAuditMgrImpl.searchUserSessions(UserAudit)
. The dn for this search may represent any target entry in DIT that has been recently modified or deleted.- Returns:
- the dn which maps to 'reqDn' for 'auditModify' object class searches.
-
setDn
public void setDn(String dn)
Set the optional dn attribute can be used to constraintAuditMgrImpl.searchUserSessions(UserAudit)
. The dn for this search may represent any target entry in DIT that has been recently modified or deleted.- Parameters:
dn
- maps to 'reqDn' for 'auditModify' object class searches.
-
getObjId
public String getObjId()
-
setObjId
public void setObjId(String objId)
-
isAdmin
public boolean isAdmin()
-
setAdmin
public void setAdmin(boolean admin)
-
-