LogUtil (OpenAM Project 15.1.7-SNAPSHOT API)

java.lang.Object
- com.sun.identity.wss.logging.LogUtil

```
public class LogUtil
extends Object
```
The LogUtil class defines methods which are used by Web Services Security (STS and WSS) compoment to write logs.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ATTR_MAP_FOR_SP`
`static String`	`AUTHENTICATION_FAILED`
`static String`	`CREATED_SAML11_ASSERTION`
`static String`	`CREATED_SAML20_ASSERTION`
`static String`	`DOMAIN` The Domain field.
`static String`	`ERROR_ADDING_SECURITY_HEADER`
`static String`	`ERROR_CREATING_SAML11_ASSERTION`
`static String`	`ERROR_CREATING_SAML20_ASSERTION`
`static String`	`ERROR_PARSING_SOAP_HEADERS`
`static String`	`ERROR_RETRIEVING_TOKEN_FROM_STS`
`static String`	`ERROR_SIGNING_SAML_ASSERTION`
`static String`	`IDENTITY_SUBJECT_NAME`
`static String`	`IP_ADDR` The IPAddr field.
`static String`	`LOGIN_ID` The LoginID field.
`static String`	`MODULE_NAME` The ModuleName field.
`static String`	`REQUEST_TO_BE_SECURED`
`static String`	`REQUEST_TO_BE_VALIDATED`
`static String`	`RESPONSE_TO_BE_SECURED`
`static String`	`RESPONSE_TO_BE_VALIDATED`
`static String`	`SIGNATURE_VALIDATION_FAILED`
`static String`	`SUCCESS_RETRIEVING_TOKEN_FROM_STS`
`static String`	`SUCCESS_SECURE_REQUEST`
`static String`	`SUCCESS_SECURE_RESPONSE`
`static String`	`SUCCESS_VALIDATE_REQUEST`
`static String`	`SUCCESS_VALIDATE_RESPONSE`
`static String`	`UNABLE_TO_DECRYPT`
`static String`	`UNABLE_TO_ENCRYPT`
`static String`	`UNABLE_TO_SIGN`
`static String`	`UNSUPPORTED_TOKEN_TYPE`

Constructor Summary

Constructors
Constructor and Description

LogUtil()

Constructors
Constructor and Description
`LogUtil()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`access(Level level, String msgid, String[] data)` Logs message to Web Services access logs.
`static void`	`access(Level level, String msgid, String[] data, Object session)` Logs message to Web Services access logs.
`static void`	`access(Level level, String msgid, String[] data, Object session, Map props)` Logs message to Web Services access logs.
`static void`	`error(Level level, String msgid, String[] data)` Logs error messages to Web Services error log.
`static void`	`error(Level level, String msgid, String[] data, Object session)` Logs error messages to Web Services error log.
`static void`	`error(Level level, String msgid, String[] data, Object session, Map props)` Logs error messages to Web Services error log.
`static boolean`	`isAccessLoggable(Level level)` Checks if an access message of the given level would actually be logged by this logger.
`static boolean`	`isErrorLoggable(Level level)` Checks if an error message of the given level would actually be logged by this logger.
`static boolean`	`isLogEnabled()` Checks if the logging is enabled.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - UNSUPPORTED_TOKEN_TYPE
```
public static final String UNSUPPORTED_TOKEN_TYPE
```
    See Also:
    
    Constant Field Values
  - CREATED_SAML11_ASSERTION
```
public static final String CREATED_SAML11_ASSERTION
```
    See Also:
    
    Constant Field Values
  - CREATED_SAML20_ASSERTION
```
public static final String CREATED_SAML20_ASSERTION
```
    See Also:
    
    Constant Field Values
  - ERROR_SIGNING_SAML_ASSERTION
```
public static final String ERROR_SIGNING_SAML_ASSERTION
```
    See Also:
    
    Constant Field Values
  - ERROR_CREATING_SAML11_ASSERTION
```
public static final String ERROR_CREATING_SAML11_ASSERTION
```
    See Also:
    
    Constant Field Values
  - ERROR_CREATING_SAML20_ASSERTION
```
public static final String ERROR_CREATING_SAML20_ASSERTION
```
    See Also:
    
    Constant Field Values
  - IDENTITY_SUBJECT_NAME
```
public static final String IDENTITY_SUBJECT_NAME
```
    See Also:
    
    Constant Field Values
  - ATTR_MAP_FOR_SP
```
public static final String ATTR_MAP_FOR_SP
```
    See Also:
    
    Constant Field Values
  - SUCCESS_RETRIEVING_TOKEN_FROM_STS
```
public static final String SUCCESS_RETRIEVING_TOKEN_FROM_STS
```
    See Also:
    
    Constant Field Values
  - ERROR_RETRIEVING_TOKEN_FROM_STS
```
public static final String ERROR_RETRIEVING_TOKEN_FROM_STS
```
    See Also:
    
    Constant Field Values
  - SUCCESS_VALIDATE_REQUEST
```
public static final String SUCCESS_VALIDATE_REQUEST
```
    See Also:
    
    Constant Field Values
  - REQUEST_TO_BE_VALIDATED
```
public static final String REQUEST_TO_BE_VALIDATED
```
    See Also:
    
    Constant Field Values
  - RESPONSE_TO_BE_SECURED
```
public static final String RESPONSE_TO_BE_SECURED
```
    See Also:
    
    Constant Field Values
  - SUCCESS_SECURE_RESPONSE
```
public static final String SUCCESS_SECURE_RESPONSE
```
    See Also:
    
    Constant Field Values
  - REQUEST_TO_BE_SECURED
```
public static final String REQUEST_TO_BE_SECURED
```
    See Also:
    
    Constant Field Values
  - SUCCESS_SECURE_REQUEST
```
public static final String SUCCESS_SECURE_REQUEST
```
    See Also:
    
    Constant Field Values
  - RESPONSE_TO_BE_VALIDATED
```
public static final String RESPONSE_TO_BE_VALIDATED
```
    See Also:
    
    Constant Field Values
  - SUCCESS_VALIDATE_RESPONSE
```
public static final String SUCCESS_VALIDATE_RESPONSE
```
    See Also:
    
    Constant Field Values
  - AUTHENTICATION_FAILED
```
public static final String AUTHENTICATION_FAILED
```
    See Also:
    
    Constant Field Values
  - ERROR_PARSING_SOAP_HEADERS
```
public static final String ERROR_PARSING_SOAP_HEADERS
```
    See Also:
    
    Constant Field Values
  - ERROR_ADDING_SECURITY_HEADER
```
public static final String ERROR_ADDING_SECURITY_HEADER
```
    See Also:
    
    Constant Field Values
  - SIGNATURE_VALIDATION_FAILED
```
public static final String SIGNATURE_VALIDATION_FAILED
```
    See Also:
    
    Constant Field Values
  - UNABLE_TO_SIGN
```
public static final String UNABLE_TO_SIGN
```
    See Also:
    
    Constant Field Values
  - UNABLE_TO_ENCRYPT
```
public static final String UNABLE_TO_ENCRYPT
```
    See Also:
    
    Constant Field Values
  - UNABLE_TO_DECRYPT
```
public static final String UNABLE_TO_DECRYPT
```
    See Also:
    
    Constant Field Values
  - DOMAIN
```
public static final String DOMAIN
```
    The Domain field. The Domain pertaining to the log record's Data field.
    
    See Also:
    
    Constant Field Values
  - LOGIN_ID
```
public static final String LOGIN_ID
```
    The LoginID field. The Login ID pertaining to the log record's Data field.
    
    See Also:
    
    Constant Field Values
  - IP_ADDR
```
public static final String IP_ADDR
```
    The IPAddr field. The IP Address pertaining to the log record's Data field.
    
    See Also:
    
    Constant Field Values
  - MODULE_NAME
```
public static final String MODULE_NAME
```
    The ModuleName field. The Module pertaining to the log record's Data field.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - LogUtil
```
public LogUtil()
```
- Method Detail
  - access
```
public static void access(Level level,
                          String msgid,
                          String[] data)
```
    Logs message to Web Services access logs.
    Parameters:
    level - the log level , these are based on those defined in java.util.logging.Level, the values for level can be any one of the following :
    
    SEVERE (highest value)
    
    WARNING
    
    INFO
    
    CONFIG
    
    FINE
    
    FINER
    
    FINEST (lowest value)
    msgid - the message or a message identifier.
    
    data - string array of dynamic data to be replaced in the message.
  - access
```
public static void access(Level level,
                          String msgid,
                          String[] data,
                          Object session)
```
    Logs message to Web Services access logs.
    Parameters:
    level - the log level , these are based on those defined in java.util.logging.Level, the values for level can be any one of the following :
    
    SEVERE (highest value)
    
    WARNING
    
    INFO
    
    CONFIG
    
    FINE
    
    FINER
    
    FINEST (lowest value)
    msgid - the message or a message identifier.
    
    data - string array of dynamic data to be replaced in the message.
    
    session - the User's session object
  - access
```
public static void access(Level level,
                          String msgid,
                          String[] data,
                          Object session,
                          Map props)
```
    Logs message to Web Services access logs.
    Parameters:
    level - the log level , these are based on those defined in java.util.logging.Level, the values for level can be any one of the following :
    
    SEVERE (highest value)
    
    WARNING
    
    INFO
    
    CONFIG
    
    FINE
    
    FINER
    
    FINEST (lowest value)
    msgid - the message or a message identifier.
    
    data - string array of dynamic data to be replaced in the message.
    
    session - the User's session object
    
    props - extra log fields
  - error
```
public static void error(Level level,
                         String msgid,
                         String[] data)
```
    Logs error messages to Web Services error log.
    Parameters:
    level - the log level , these are based on those defined in java.util.logging.Level, the values for level can be any one of the following :
    
    SEVERE (highest value)
    
    WARNING
    
    INFO
    
    CONFIG
    
    FINE
    
    FINER
    
    FINEST (lowest value)
    msgid - the message or a message identifier.
    
    data - string array of dynamic data to be replaced in the message.
  - error
```
public static void error(Level level,
                         String msgid,
                         String[] data,
                         Object session)
```
    Logs error messages to Web Services error log.
    Parameters:
    level - the log level , these are based on those defined in java.util.logging.Level, the values for level can be any one of the following :
    
    SEVERE (highest value)
    
    WARNING
    
    INFO
    
    CONFIG
    
    FINE
    
    FINER
    
    FINEST (lowest value)
    msgid - the message or a message identifier.
    
    data - string array of dynamic data to be replaced in the message.
    
    session - the User's Session object.
  - error
```
public static void error(Level level,
                         String msgid,
                         String[] data,
                         Object session,
                         Map props)
```
    Logs error messages to Web Services error log.
    Parameters:
    level - the log level , these are based on those defined in java.util.logging.Level, the values for level can be any one of the following :
    
    SEVERE (highest value)
    
    WARNING
    
    INFO
    
    CONFIG
    
    FINE
    
    FINER
    
    FINEST (lowest value)
    msgid - the message or a message identifier.
    
    data - string array of dynamic data to be replaced in the message.
    
    session - the User's Session object.
    
    props - extra log fields
  - isLogEnabled
```
public static boolean isLogEnabled()
```
    Checks if the logging is enabled.
    
    Returns:
    
    true if logging is enabled.
  - isAccessLoggable
```
public static boolean isAccessLoggable(Level level)
```
    Checks if an access message of the given level would actually be logged by this logger. This check is based on the Loggers effective level.
    
    Parameters:
    
    level - a message logging level.
    
    Returns:
    
    true if the given message level is currently being logged.
  - isErrorLoggable
```
public static boolean isErrorLoggable(Level level)
```
    Checks if an error message of the given level would actually be logged by this logger. This check is based on the Loggers effective level.
    
    Parameters:
    
    level - a message logging level.
    
    Returns:
    
    true if the given message level is currently being logged.

Class LogUtil

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

UNSUPPORTED_TOKEN_TYPE

CREATED_SAML11_ASSERTION

CREATED_SAML20_ASSERTION

ERROR_SIGNING_SAML_ASSERTION

ERROR_CREATING_SAML11_ASSERTION

ERROR_CREATING_SAML20_ASSERTION

IDENTITY_SUBJECT_NAME

ATTR_MAP_FOR_SP

SUCCESS_RETRIEVING_TOKEN_FROM_STS

ERROR_RETRIEVING_TOKEN_FROM_STS

SUCCESS_VALIDATE_REQUEST

REQUEST_TO_BE_VALIDATED

RESPONSE_TO_BE_SECURED

SUCCESS_SECURE_RESPONSE

REQUEST_TO_BE_SECURED

SUCCESS_SECURE_REQUEST

RESPONSE_TO_BE_VALIDATED

SUCCESS_VALIDATE_RESPONSE

AUTHENTICATION_FAILED

ERROR_PARSING_SOAP_HEADERS

ERROR_ADDING_SECURITY_HEADER

SIGNATURE_VALIDATION_FAILED

UNABLE_TO_SIGN

UNABLE_TO_ENCRYPT

UNABLE_TO_DECRYPT

DOMAIN

LOGIN_ID

IP_ADDR

MODULE_NAME

Constructor Detail

LogUtil

Method Detail

access

access

access

error

error

error

isLogEnabled

isAccessLoggable

isErrorLoggable