openconnector

Class LoggerUtil

java.lang.Object

openconnector.LoggerUtil

public class LoggerUtil
extends java.lang.Object

This LoggerUtil class is created for adding the extra information with each log in MDC(Mapped diagnostic context). Once the information is added in MDC that can be seen in identityiq after writing following lines in log4j2.properties file. appender.file.layout.pattern = %-4r [%t] %5p %c %x - %m - %X{Application}%n %X{AppType}%n..

See source code for more details.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LoggerUtil.LoggerOperation

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	conApiResponseMSecs
static java.lang.String	configOptionsKey
static java.lang.String	opAuthenticate
static java.lang.String	opChangePassword
static java.lang.String	opCreate
static java.lang.String	opDelete
static java.lang.String	opDisable
static java.lang.String	opEnable
static java.lang.String	opGetIteratorPartitions
static java.lang.String	opGetObject
static java.lang.String	opIterateObjects
static java.lang.String	opIterateWithPartition
static java.lang.String	opModify
static java.lang.String	opTestConfiguration
static java.lang.String	opUnlock
static java.lang.String	replaceWith
static java.lang.String	toReplace

Constructor Summary

Constructors

Constructor and Description
LoggerUtil()

Method Summary

Modifier and Type	Method and Description
static void	clearData(java.lang.String key) Function is called to clear once single entry from MDC.
static void	clearMDCData() ClearMDCData is used to clear the entry keys like nativeIdentity, application, objectType and operation from MDC.
static void	setApplication(java.lang.String application) Function which sets the name of application for which logging is enabled.
static void	setAppType(java.lang.String appType) Function which sets the type of application for which logging is enabled.
static void	setMDC(java.lang.String key, java.lang.String value) Function to add value in MDC
static void	setNativeIdentity(java.lang.String nativeIdentity) This sets the native identity of account or group.
static void	setObjectType(java.lang.String objectType) This sets the object type like account , or group etc.
static void	setOperation(java.lang.String operation) Function which sets the operation which is happening for the application.
static void	unsetNativeIdentity() Function to remove native identity from MDC.

Methods inherited from class java.lang.Object

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

Field Detail

configOptionsKey

public static java.lang.String configOptionsKey

conApiResponseMSecs

public static final java.lang.String conApiResponseMSecs

See Also:

Constant Field Values

opTestConfiguration

public static final java.lang.String opTestConfiguration

opGetObject

public static final java.lang.String opGetObject

opIterateObjects

public static final java.lang.String opIterateObjects

opIterateWithPartition

public static final java.lang.String opIterateWithPartition

opAuthenticate

public static final java.lang.String opAuthenticate

opCreate

public static final java.lang.String opCreate

opModify

public static final java.lang.String opModify

opDelete

public static final java.lang.String opDelete

opEnable

public static final java.lang.String opEnable

opDisable

public static final java.lang.String opDisable

opUnlock

public static final java.lang.String opUnlock

opChangePassword

public static final java.lang.String opChangePassword

opGetIteratorPartitions

public static final java.lang.String opGetIteratorPartitions

toReplace

public static final java.lang.String toReplace

See Also:

Constant Field Values

replaceWith

public static final java.lang.String replaceWith

See Also:

Constant Field Values

Constructor Detail

LoggerUtil

public LoggerUtil()

Method Detail

setMDC

public static void setMDC(java.lang.String key,
                          java.lang.String value)

Function to add value in MDC

Parameters:

key - - Name of the key against which value will be inserted into MDC.

value - - Value against the key mentioned above.

setApplication

public static void setApplication(java.lang.String application)

Function which sets the name of application for which logging is enabled.

Parameters:

application - - Name of application for which logging is running.

setAppType

public static void setAppType(java.lang.String appType)

Function which sets the type of application for which logging is enabled.

Parameters:

appType - - Type of application for which values are populated in MDC.

setOperation

public static void setOperation(java.lang.String operation)

Function which sets the operation which is happening for the application. Example Iterate, Create etc.

Parameters:

operation - - Opearation like Create, Update, read etc. whatever is going on.

setObjectType

public static void setObjectType(java.lang.String objectType)

This sets the object type like account , or group etc.

Parameters:

objectType - - parameter to accept object type like account or group.

setNativeIdentity

public static void setNativeIdentity(java.lang.String nativeIdentity)

This sets the native identity of account or group.

Parameters:

nativeIdentity - - Identity id of the account which is under process.

unsetNativeIdentity

public static void unsetNativeIdentity()

Function to remove native identity from MDC.

clearMDCData

public static void clearMDCData()

ClearMDCData is used to clear the entry keys like nativeIdentity, application, objectType and operation from MDC.

clearData

public static void clearData(java.lang.String key)

Function is called to clear once single entry from MDC.

Parameters:

key -