Package org.openiam.idm.srvc.audit.dto

Class AuditLogBuilder

java.lang.Object

org.openiam.idm.srvc.audit.dto.AuditLogBuilder

All Implemented Interfaces:

Serializable

public abstract class AuditLogBuilder
extends Object
implements Serializable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	contentProviderId
protected String	languageId
protected String	parentId	This is the reference to the parent
protected String	principal
protected String	userId

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AuditLogBuilder()

Method Summary

Modifier and Type	Method	Description
AuditLogBuilder	addChild(AuditLogBuilder child)
AuditLogBuilder	addInfo(String value)
AuditLogBuilder	addManagedSystem(String managedSysId, String managedSysName)
AuditLogBuilder	addPathVariable(String key, String value)
AuditLogBuilder	addTargetAttribute(String id, String name)
AuditLogBuilder	addTargetGroup(String id)
AuditLogBuilder	addTargetGroup(String id, String name)
AuditLogBuilder	addTargetOrganization(String id)
AuditLogBuilder	addTargetOrganization(String id, String name)
AuditLogBuilder	addTargetResource(String id)
AuditLogBuilder	addTargetResource(String id, String name)
AuditLogBuilder	addTargetRole(String id)
AuditLogBuilder	addTargetRole(String id, String name)
AuditLogBuilder	addURLParameter(String key, String value)
AuditLogBuilder	addWarning(String value)
AuditLogBuilder	apply(Audit audit)
AuditLogBuilder	apply(BaseObject request)
AuditLogBuilder	apply(BaseServiceRequest request)
List<IdmAuditLogDoc>	build(String correlationId)
AuditLogBuilder	fail()	Signals that this event failed
String	getId()
String	getParentId()
Tuple<String,String>	getRequestor()
boolean	hasResult()
boolean	isValid()
AuditLogBuilder	put(String key, String value)
AuditLogBuilder	put(AuditAttributeName key, Integer value)
AuditLogBuilder	put(AuditAttributeName key, Long value)
AuditLogBuilder	put(AuditAttributeName key, Object value, com.fasterxml.jackson.databind.ObjectMapper mapper)
AuditLogBuilder	put(AuditAttributeName key, String value)
AuditLogBuilder	setAction(ActivitiRequestType action)
AuditLogBuilder	setAction(AuditAction action)
AuditLogBuilder	setActivitiTaskName(String value)
AuditLogBuilder	setAuditDescription(String value)	Sets the description of this event
AuditLogBuilder	setAuthProviderId(String value)
AuditLogBuilder	setClientIP(String value)
AuditLogBuilder	setContentProviderId(String value)
AuditLogBuilder	setDeviceInfo(String value)
AuditLogBuilder	setEventName(String value)
AuditLogBuilder	setException(Throwable e)	Sets an Exception for this event
AuditLogBuilder	setFailCount(Integer value)
AuditLogBuilder	setFailureReason(String failureReason)
AuditLogBuilder	setGroovyScript(String value)
AuditLogBuilder	setMethod(String value)
AuditLogBuilder	setParentId(String value)
AuditLogBuilder	setRequestBody(String value)
AuditLogBuilder	setRequestor(String userId, String principal)
AuditLogBuilder	setResponseBody(String value)
AuditLogBuilder	setResponseCode(ResponseCode code)
AuditLogBuilder	setSessionID(String value)
AuditLogBuilder	setSource(AuditSource source)
AuditLogBuilder	setSuccessReason(String value)	Sets the reason for success
AuditLogBuilder	setTargetClass(Class<?> clazz)
AuditLogBuilder	setTargetTask(String id, String name)
AuditLogBuilder	setTargetUser(String userId)
AuditLogBuilder	setTargetUser(String userId, String login)
AuditLogBuilder	setTargetUser(String userId, Login login)
AuditLogBuilder	setTaskClass(Class<?> clazz)
AuditLogBuilder	setTaskDescription(String value)
AuditLogBuilder	setTaskName(String value)
AuditLogBuilder	setTaskOwner(String value)
AuditLogBuilder	setURI(String value)
AuditLogBuilder	setURIPatternId(String value)
AuditLogBuilder	setURL(String value)
AuditLogBuilder	setURLParameters(Map<String,String> urlParameters)
AuditLogBuilder	succeed()	Signals that this event succeeded

Methods inherited from class java.lang.Object

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

Field Detail

userId

protected String userId

principal

protected String principal

contentProviderId

protected String contentProviderId

languageId

protected String languageId

parentId

protected String parentId

This is the reference to the parent

"null" EXPLICITLY means "no parent", becuase of Spring Data ElasticSearch's limitation of not being able to do an "Exists" query (or it's possible, that due to their sh*tty documentation, I wasn't able to find a way to do it).

Constructor Detail

AuditLogBuilder

protected AuditLogBuilder()

Method Detail

getParentId

public String getParentId()

setRequestor

public AuditLogBuilder setRequestor(String userId,
                                    String principal)

setParentId

public final AuditLogBuilder setParentId(String value)

setContentProviderId

public final AuditLogBuilder setContentProviderId(String value)

setTaskOwner

public AuditLogBuilder setTaskOwner(String value)

setTaskClass

public AuditLogBuilder setTaskClass(Class<?> clazz)

setTargetClass

public AuditLogBuilder setTargetClass(Class<?> clazz)

setTaskDescription

public AuditLogBuilder setTaskDescription(String value)

setTaskName

public AuditLogBuilder setTaskName(String value)

setSource

public AuditLogBuilder setSource(AuditSource source)

setAuditDescription

public AuditLogBuilder setAuditDescription(String value)

Sets the description of this event

Parameters:

value -

Returns:

this

apply

public AuditLogBuilder apply(BaseServiceRequest request)

apply

public AuditLogBuilder apply(Audit audit)

apply

public AuditLogBuilder apply(BaseObject request)

setActivitiTaskName

public AuditLogBuilder setActivitiTaskName(String value)

setEventName

public AuditLogBuilder setEventName(String value)

addWarning

public AuditLogBuilder addWarning(String value)

addInfo

public AuditLogBuilder addInfo(String value)

setFailCount

public AuditLogBuilder setFailCount(Integer value)

setException

public AuditLogBuilder setException(Throwable e)

Sets an Exception for this event

Parameters:

e -

Returns:

this

setSuccessReason

public AuditLogBuilder setSuccessReason(String value)

Sets the reason for success

Parameters:

reason -

Returns:

setURI

public AuditLogBuilder setURI(String value)

setURL

public AuditLogBuilder setURL(String value)

setGroovyScript

public AuditLogBuilder setGroovyScript(String value)

setFailureReason

public AuditLogBuilder setFailureReason(String failureReason)

setResponseCode

public AuditLogBuilder setResponseCode(ResponseCode code)

put

public AuditLogBuilder put(AuditAttributeName key,
                           Integer value)

put

public AuditLogBuilder put(AuditAttributeName key,
                           Long value)

put

public AuditLogBuilder put(AuditAttributeName key,
                           String value)

setAction

public AuditLogBuilder setAction(AuditAction action)

setAction

public AuditLogBuilder setAction(ActivitiRequestType action)

setTargetUser

public AuditLogBuilder setTargetUser(String userId)

setTargetUser

public AuditLogBuilder setTargetUser(String userId,
                                     Login login)

setTargetUser

public AuditLogBuilder setTargetUser(String userId,
                                     String login)

addTargetRole

public AuditLogBuilder addTargetRole(String id)

addTargetAttribute

public AuditLogBuilder addTargetAttribute(String id,
                                          String name)

addTargetRole

public AuditLogBuilder addTargetRole(String id,
                                     String name)

addTargetGroup

public AuditLogBuilder addTargetGroup(String id)

addTargetGroup

public AuditLogBuilder addTargetGroup(String id,
                                      String name)

addTargetOrganization

public AuditLogBuilder addTargetOrganization(String id)

addTargetOrganization

public AuditLogBuilder addTargetOrganization(String id,
                                             String name)

addTargetResource

public AuditLogBuilder addTargetResource(String id)

addTargetResource

public AuditLogBuilder addTargetResource(String id,
                                         String name)

put

public AuditLogBuilder put(AuditAttributeName key,
                           Object value,
                           com.fasterxml.jackson.databind.ObjectMapper mapper)

put

public AuditLogBuilder put(String key,
                           String value)

setMethod

public AuditLogBuilder setMethod(String value)

addURLParameter

public AuditLogBuilder addURLParameter(String key,
                                       String value)

addPathVariable

public AuditLogBuilder addPathVariable(String key,
                                       String value)

setURLParameters

public AuditLogBuilder setURLParameters(Map<String,String> urlParameters)

setRequestBody

public AuditLogBuilder setRequestBody(String value)

setResponseBody

public AuditLogBuilder setResponseBody(String value)

hasResult

public boolean hasResult()

fail

public AuditLogBuilder fail()

Signals that this event failed

Returns:

this

succeed

public AuditLogBuilder succeed()

Signals that this event succeeded

Returns:

this

getId

public final String getId()

getRequestor

public final Tuple<String,String> getRequestor()

addManagedSystem

public AuditLogBuilder addManagedSystem(String managedSysId,
                                        String managedSysName)

setSessionID

public AuditLogBuilder setSessionID(String value)

setAuthProviderId

public AuditLogBuilder setAuthProviderId(String value)

addChild

public AuditLogBuilder addChild(AuditLogBuilder child)

setTargetTask

public AuditLogBuilder setTargetTask(String id,
                                     String name)

setClientIP

public AuditLogBuilder setClientIP(String value)

setURIPatternId

public AuditLogBuilder setURIPatternId(String value)

isValid

public final boolean isValid()

build

public final List<IdmAuditLogDoc> build(String correlationId)

setDeviceInfo

public AuditLogBuilder setDeviceInfo(String value)