|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AuditEventManager
The AuditEventManager is the interface for the Lightweight Audit Framework. It gives various APIs to log successful and failure audit messages.
It provides getDetails()
and search()
APIs as well to find specific audit events
Method Summary | |
---|---|
AuditEventManagerResult |
create(AuditEvent auditEvent) Creates the audit event in the backend. |
AuditEventManagerBulkResult |
createBulkAuditEvents(java.util.List auditEvents) Bulk API to create the audit events in the backend. |
AuditEventManagerBulkResult |
deleteBulkAuditEvents(SearchCriteria filter, java.util.Map options) |
AuditEvent |
getDetails(java.lang.String eventId, java.util.Set retAttrs) Given an audit event ID, you can use this API to get the details of the audit event |
void |
log(AuditEvent event) This method logs the given event as is. |
void |
logFailure(java.lang.String entityId, java.lang.String entityName, java.lang.String entityType, java.lang.String action, java.util.Map addValues, java.util.Map removeValues, java.lang.String reason) This API accepts the entity details as parameters and creates a failure audit event internally This will internally invoke log(AuditEvent event) API |
void |
logFailure(java.lang.String entityId, java.lang.String entityName, java.lang.String entityType, java.lang.String action, java.util.Map addValues, java.util.Map removeValues, java.lang.String toEntityId, java.lang.String toEntityName, java.lang.String toEntityType, java.lang.String reason) This API accepts the entity details as parameters and creates a failure audit event internally This should be invoked for relationship entities (like RoleRole or RoleUser ) This will internally invoke log(AuditEvent event) API |
void |
logFailure(java.lang.String entityId, java.lang.String entityName, java.lang.String entityType, java.lang.String action, java.lang.String reason) This API accepts the entity details as parameters and creates a failure audit event internally This will internally invoke log(AuditEvent event) API |
void |
logSuccess(java.lang.String entityId, java.lang.String entityName, java.lang.String entityType, java.lang.String action) This API accepts the entity details as parameters and creates an audit event internally This will internally invoke log(AuditEvent event) API |
void |
logSuccess(java.lang.String entityId, java.lang.String entityName, java.lang.String entityType, java.lang.String action, java.util.Map addValues, java.util.Map removeValues) This API accepts the entity details as parameters and creates an audit event internally This will internally invoke log(AuditEvent event) API |
void |
logSuccess(java.lang.String entityId, java.lang.String entityName, java.lang.String entityType, java.lang.String action, java.util.Map addValues, java.util.Map removeValues, java.lang.String toEntityId, java.lang.String toEntityName, java.lang.String toEntityType) This API accepts the entity details as parameters and creates an audit event internally This should be invoked for relationship entities (like RoleRole or RoleUser This will internally invoke log(AuditEvent event) API |
void |
logSuccess(java.lang.String entityId, java.lang.String entityName, java.lang.String entityType, java.lang.String action, java.lang.String toEntityId, java.lang.String toEntityName, java.lang.String toEntityType) This API accepts the entity details as parameters and creates an audit event internally This should be invoked for relationship entities (like RoleRole or RoleUser This will internally invoke log(AuditEvent event) API |
java.util.List |
search(SearchCriteria sc, java.util.Set retAttrs, java.util.Map config) This API lets you query for audit events by most fields of audit event. |
Method Detail |
---|
void log(AuditEvent event) throws AuditEventCreateException, AccessDeniedException
create(AuditEvent entity) API
event
- The audit event to be loggedAuditEventCreateException
- In case there's any exception while auditing the eventAccessDeniedException
- In case user doesn't have authorization to auditvoid logSuccess(java.lang.String entityId, java.lang.String entityName, java.lang.String entityType, java.lang.String action) throws AuditEventCreateException, AccessDeniedException
log(AuditEvent event) API
entityId
- The entityId (key) of the entity being audited (can NOT be null)entityName
- The entity name of the entity being audited (can NOT be null)entityType
- The entity type of the entity being audited (can NOT be null)action
- The type of operation AuditConstants.AuditEventActions
AuditEventCreateException
- In case there's any exception while auditing the eventAccessDeniedException
- In case user doesn't have authorization to auditvoid logSuccess(java.lang.String entityId, java.lang.String entityName, java.lang.String entityType, java.lang.String action, java.util.Map addValues, java.util.Map removeValues) throws AuditEventCreateException, AccessDeniedException
log(AuditEvent event) API
entityId
- The entityId (key) of the entity being audited (can NOT be null)entityName
- The entity name of the entity being audited (can NOT be null)entityType
- The entity type of the entity being audited (can NOT be null)action
- The type of operation AuditConstants.AuditEventActions
addValues
- the values being added in this operation on the entityIdremoveValues
- the values being replaced/removed (if any) during the operationAuditEventCreateException
- In case there's any exception while auditing the eventAccessDeniedException
- In case user doesn't have authorization to auditvoid logSuccess(java.lang.String entityId, java.lang.String entityName, java.lang.String entityType, java.lang.String action, java.lang.String toEntityId, java.lang.String toEntityName, java.lang.String toEntityType) throws AuditEventCreateException, AccessDeniedException
RoleRole
or RoleUser
This will internally invoke log(AuditEvent event) API
entityId
- The entityId (key) of the entity being audited (can NOT be null)entityName
- The entity name of the entity being audited (can NOT be null)entityType
- The entity type of the entity being audited (can NOT be null)action
- The type of operation AuditConstants.AuditEventActions
toEntityId
- The other entityId in a relation - e.g. if entityId is for a role, then toEntityId can be a user idtoEntityName
- The name of the other entitytoEntityType
- The type of the other entityAuditEventCreateException
- In case there's any exception while auditing the eventAccessDeniedException
- In case user doesn't have authorization to auditvoid logSuccess(java.lang.String entityId, java.lang.String entityName, java.lang.String entityType, java.lang.String action, java.util.Map addValues, java.util.Map removeValues, java.lang.String toEntityId, java.lang.String toEntityName, java.lang.String toEntityType) throws AuditEventCreateException, AccessDeniedException
RoleRole
or RoleUser
This will internally invoke log(AuditEvent event) API
entityId
- The entityId (key) of the entity being audited (can NOT be null)entityName
- The entity name of the entity being audited (can NOT be null)entityType
- The entity type of the entity being audited (can NOT be null)action
- The type of operation AuditConstants.AuditEventActions
addValues
- the values being added in this operation on the entityIdremoveValues
- the values being replaced/removed (if any) during the operationtoEntityId
- The other entityId in a relation - e.g. if entityId is for a role, then toEntityId can be a user idtoEntityName
- The name of the other entitytoEntityType
- The type of the other entityAuditEventCreateException
- In case there's any exception while auditing the eventAccessDeniedException
- In case user doesn't have authorization to auditvoid logFailure(java.lang.String entityId, java.lang.String entityName, java.lang.String entityType, java.lang.String action, java.lang.String reason) throws AuditEventCreateException, AccessDeniedException
log(AuditEvent event) API
entityId
- The entityId (key) of the entity being audited (can NOT be null)entityName
- The entity name of the entity being audited (can NOT be null)entityType
- The entity type of the entity being audited (can NOT be null)action
- The type of operation AuditConstants.AuditEventActions
reason
- The reason for the failure - the error messageAuditEventCreateException
- In case there's any exception while auditing the eventAccessDeniedException
- In case user doesn't have authorization to auditvoid logFailure(java.lang.String entityId, java.lang.String entityName, java.lang.String entityType, java.lang.String action, java.util.Map addValues, java.util.Map removeValues, java.lang.String reason) throws AuditEventCreateException, AccessDeniedException
log(AuditEvent event) API
entityId
- The entityId (key) of the entity being audited (can NOT be null)entityName
- The entity name of the entity being audited (can NOT be null)entityType
- The entity type of the entity being audited (can NOT be null)action
- The type of operation AuditConstants.AuditEventActions
addValues
- the values being added in this operation on the entityIdremoveValues
- the values being replaced/removed (if any) during the operationreason
- The reason for the failure - the error messageAuditEventCreateException
- In case there's any exception while auditing the eventAccessDeniedException
- In case user doesn't have authorization to auditvoid logFailure(java.lang.String entityId, java.lang.String entityName, java.lang.String entityType, java.lang.String action, java.util.Map addValues, java.util.Map removeValues, java.lang.String toEntityId, java.lang.String toEntityName, java.lang.String toEntityType, java.lang.String reason) throws AuditEventCreateException, AccessDeniedException
RoleRole
or RoleUser
) This will internally invoke log(AuditEvent event) API
entityId
- The entityId (key) of the entity being audited (can NOT be null)entityName
- The entity name of the entity being audited (can NOT be null)entityType
- The entity type of the entity being audited (can NOT be null)action
- The type of operation AuditConstants.AuditEventActions
addValues
- the values being added in this operation on the entityIdremoveValues
- the values being replaced/removed (if any) during the operationtoEntityId
- The other entityId in a relation - e.g. if entityId is for a role, then toEntityId can be a user idtoEntityName
- The name of the other entitytoEntityType
- The type of the other entityreason
- The reason for the failure - the error messageAuditEventCreateException
- In case there's any exception while auditing the eventAccessDeniedException
- In case user doesn't have authorization to auditAuditEventManagerResult create(AuditEvent auditEvent) throws ValidationFailedException, EntityAlreadyExistsException, EntityLockedException, EntityCreateException, AccessDeniedException
auditEvent
- The audit event being createdValidationFailedException
- In case there any validation failureEntityAlreadyExistsException
- Not applicable to AuditEventEntityLockedException
- Not applicable to AuditEventEntityCreateException
- In case there's any exception while creating the audit eventAccessDeniedException
- In case user doesn't have authorization to auditAuditEventManagerBulkResult createBulkAuditEvents(java.util.List auditEvents) throws ValidationFailedException, EntityAlreadyExistsException, EntityLockedException, EntityCreateException, AccessDeniedException
auditEvents
- The list of audit event being created in bulkValidationFailedException
- In case there any validation failureEntityAlreadyExistsException
- Not applicable to AuditEventEntityLockedException
- Not applicable to AuditEventEntityCreateException
- In case there's any exception while creating the audit eventAccessDeniedException
- In case user doesn't have authorization to auditAuditEvent getDetails(java.lang.String eventId, java.util.Set retAttrs) throws oracle.iam.platform.entitymgr.NoSuchEntityException, EntitySearchException, ValidationFailedException, AccessDeniedException
eventId
- The audit event ID which would identify an audit event entryretAttrs
- The values to be retrieved for the audit event.oracle.iam.platform.entitymgr.NoSuchEntityException
- If this event id doesn't existEntitySearchException
- If an error occurred while finding the audit eventValidationFailedException
- Not applicable to AuditEventAccessDeniedException
- In case user doesn't have authorization to find an audit eventjava.util.List search(SearchCriteria sc, java.util.Set retAttrs, java.util.Map config) throws EntitySearchException, oracle.iam.platform.entitymgr.NoSuchEntityException, ValidationFailedException, AccessDeniedException
sc
- The search criteria for finding audit events for specific entitiesretAttrs
- The values to be retrieved for the audit eventsconfig
- Parameters to further configure the search operation. There are four configuration parameters. STARTROW, ENDROW, SORTEDBY and SORTORDER.
The STARTROW and ENDROW search configuration parameters indicates which subset of the complete search result is to be fetched.
The SORTEDBY search configuration parameter indicates the attribute on which search result is to be sorted. This parameter is optional and is set to Role Name
by default.
The SORTORDER search configuration parameter indicates the order of sorting. There are two possible values for this parameter. To sort the result in ascending order use SortOrder.ASCENDING and to sort the result in descending order use SortOrder.DESCENDING. This parameter is optional and is set to SortOrder.ASCENDING by default.
oracle.iam.platform.entitymgr.NoSuchEntityException
- Not applicable to AuditEventEntitySearchException
- If an error occurred while searching by the criteriaValidationFailedException
- Not applicable to AuditEventAccessDeniedException
- In case user doesn't have authorization to search for audit eventsAuditEventManagerBulkResult deleteBulkAuditEvents(SearchCriteria filter, java.util.Map options) throws oracle.iam.platform.entitymgr.NoSuchEntityException, java.lang.UnsupportedOperationException, oracle.iam.platform.entitymgr.ProviderException, EntityLockedException, EntityDeleteException
filter
- The search criteria for finding Audit Events to delete.options
- The operation parameters, e.g. batch size.oracle.iam.platform.entitymgr.NoSuchEntityException
- Not applicable to AuditEventEntityDeleteException
- If an error occurred while deleting the audit events.EntityLockedException
oracle.iam.platform.entitymgr.ProviderException
- If the provider throws an exception.java.lang.UnsupportedOperationException
- If the provider does not support the remove operation.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |