LogUtils (OpenAM Project 15.1.7-SNAPSHOT API)

java.lang.Object
- com.sun.identity.saml.common.LogUtils

```
public class LogUtils
extends Object
```
The LogUtils class defines methods which are used by SAML compoment to write logs.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ACCESS_GRANTED` Constants for log message ACCESS_GRANTED.
`static String`	`ARTIFACT_TO_SEND` Constants for log message ARTIFACT_TO_SEND.
`static String`	`ASSERTION_ARTIFACT_CREATED` Constants for log message ASSERTION_ARTIFACT_CREATED.
`static String`	`ASSERTION_ARTIFACT_REMOVED` Constants for log message ASSERTION_ARTIFACT_REMOVED.
`static String`	`ASSERTION_ARTIFACT_VERIFIED` Constants for log message ASSERTION_ARTIFACT_VERIFIED.
`static String`	`ASSERTION_CREATED` Constants for log message ASSERTION_CREATED.
`static String`	`ASSERTION_REMOVED` Constants for log message ASSERTION_REMOVED.
`static String`	`AUTH_PROTOCOL_MISMATCH` Constants for log message AUTH_PROTOCOL_MISMATCH.
`static String`	`BUILD_RESPONSE_ERROR` Constants for log message BUILD_RESPONSE_ERROR.
`static String`	`ERROR_RESPONSE_STATUS` Constants for log message ERROR_RESPONSE_STATUS.
`static String`	`FAILED_TO_CREATE_SSO_TOKEN` Constants for log message FAILED_TO_CREATE_SSO_TOKEN.
`static String`	`INVALID_AUTH_TYPE` Constants for log message INVALID_AUTH_TYPE.
`static String`	`INVALID_REQUEST` Constants for log message INVALID_REQUEST.
`static String`	`INVALID_RESPONSE` Constants for log message INVALID_RESPONSE.
`static String`	`INVALID_RESPONSE_SIGNATURE` Constants for log message INVALID_RESPONSE_SIGNATURE.
`static String`	`MISMATCHED_ASSERTION_AND_ARTIFACT` Constants for log message MISMATCHED_ASSERTION_AND_ARTIFACT.
`static String`	`MISSING_RESPONSE` Constants for log message MISSING_RESPONSE.
`static String`	`MISSING_TARGET` Constants for log message MISSING_TARGET.
`static String`	`NO_ASSERTION_IN_RESPONSE` Constants for log message NO_ASSERTION_IN_RESPONSE.
`static String`	`NO_REPLY_FROM_SOAP_RECEIVER` Constants for log message NO_REPLY_FROM_SOAP_RECEIVER.
`static String`	`NULL_PARAMETER` Constants for log message NULL_PARAMETER.
`static String`	`NULL_SAML_RESPONSE` Constants for log message NULL_SAML_RESPONSE.
`static String`	`REDIRECT_TO_URL` Constants for log message REDIRECT_TO_URL.
`static String`	`REPLIED_SOAP_MESSAGE` Constants for log message REPLIED_SOAP_MESSAGE.
`static String`	`RESPONSE_MESSAGE_ERROR` Constants for log message RESPONSE_MESSAGE_ERROR.
`static String`	`SAML_ARTIFACT_QUERY` Constants for log message SAML_ARTIFACT_QUERY.
`static String`	`SENDING_RESPONSE` Constants for log message SENDING_RESPONSE.
`static String`	`SOAP_FAULT_ERROR` Constants for log message SOAP_FAULT_ERROR.
`static String`	`SOAP_MESSAGE_FACTORY_ERROR` Constants for log message SOAP_MESSAGE_FACTORY_ERROR.
`static String`	`SOAP_RECEIVER_URL` Constants for log message SOAP_RECEIVER_URL.
`static String`	`SOAP_REQUEST_MESSAGE` Constants for log message SOAP_REQUEST_MESSAGE.
`static String`	`TARGET_FORBIDDEN` Constants for log message TARGET_FORBIDDEN.
`static String`	`UNTRUSTED_SITE` Constants for log message UNTRUSTED_SITE.
`static String`	`WRONG_SOAP_URL` Constants for log message WRONG_SOAP_URL.

Constructor Summary

Constructors
Constructor and Description

LogUtils()

Constructors
Constructor and Description
`LogUtils()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`access(Level level, String msgId, String[] data)` Logs SAML specific access conditions to the SAML access log (amSAML.access).
`static void`	`access(Level level, String msgId, String[] data, Object session)` Logs SAML specific access conditions to the SAML access log (amSAML.access).
`static void`	`error(Level level, String msgId, String[] data)` Logs SAML specific errror conditions to the SAML error log (amSAML.error).
`static void`	`error(Level level, String msgId, String[] data, Object session)` Logs SAML specific errror conditions to the SAML error log (amSAML.error).
`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.
`boolean`	`isLogEnabled()` Checks if logging is enabled.

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

- Field Detail
  - ASSERTION_CREATED
```
public static final String ASSERTION_CREATED
```
    Constants for log message ASSERTION_CREATED.
    
    See Also:
    
    Constant Field Values
  - ASSERTION_ARTIFACT_CREATED
```
public static final String ASSERTION_ARTIFACT_CREATED
```
    Constants for log message ASSERTION_ARTIFACT_CREATED.
    
    See Also:
    
    Constant Field Values
  - ASSERTION_ARTIFACT_REMOVED
```
public static final String ASSERTION_ARTIFACT_REMOVED
```
    Constants for log message ASSERTION_ARTIFACT_REMOVED.
    
    See Also:
    
    Constant Field Values
  - ASSERTION_REMOVED
```
public static final String ASSERTION_REMOVED
```
    Constants for log message ASSERTION_REMOVED.
    
    See Also:
    
    Constant Field Values
  - ASSERTION_ARTIFACT_VERIFIED
```
public static final String ASSERTION_ARTIFACT_VERIFIED
```
    Constants for log message ASSERTION_ARTIFACT_VERIFIED.
    
    See Also:
    
    Constant Field Values
  - AUTH_PROTOCOL_MISMATCH
```
public static final String AUTH_PROTOCOL_MISMATCH
```
    Constants for log message AUTH_PROTOCOL_MISMATCH.
    
    See Also:
    
    Constant Field Values
  - INVALID_AUTH_TYPE
```
public static final String INVALID_AUTH_TYPE
```
    Constants for log message INVALID_AUTH_TYPE.
    
    See Also:
    
    Constant Field Values
  - SOAP_RECEIVER_URL
```
public static final String SOAP_RECEIVER_URL
```
    Constants for log message SOAP_RECEIVER_URL.
    
    See Also:
    
    Constant Field Values
  - NO_ASSERTION_IN_RESPONSE
```
public static final String NO_ASSERTION_IN_RESPONSE
```
    Constants for log message NO_ASSERTION_IN_RESPONSE.
    
    See Also:
    
    Constant Field Values
  - MISMATCHED_ASSERTION_AND_ARTIFACT
```
public static final String MISMATCHED_ASSERTION_AND_ARTIFACT
```
    Constants for log message MISMATCHED_ASSERTION_AND_ARTIFACT.
    
    See Also:
    
    Constant Field Values
  - ARTIFACT_TO_SEND
```
public static final String ARTIFACT_TO_SEND
```
    Constants for log message ARTIFACT_TO_SEND.
    
    See Also:
    
    Constant Field Values
  - WRONG_SOAP_URL
```
public static final String WRONG_SOAP_URL
```
    Constants for log message WRONG_SOAP_URL.
    
    See Also:
    
    Constant Field Values
  - SAML_ARTIFACT_QUERY
```
public static final String SAML_ARTIFACT_QUERY
```
    Constants for log message SAML_ARTIFACT_QUERY.
    
    See Also:
    
    Constant Field Values
  - NO_REPLY_FROM_SOAP_RECEIVER
```
public static final String NO_REPLY_FROM_SOAP_RECEIVER
```
    Constants for log message NO_REPLY_FROM_SOAP_RECEIVER.
    
    See Also:
    
    Constant Field Values
  - REPLIED_SOAP_MESSAGE
```
public static final String REPLIED_SOAP_MESSAGE
```
    Constants for log message REPLIED_SOAP_MESSAGE.
    
    See Also:
    
    Constant Field Values
  - NULL_SAML_RESPONSE
```
public static final String NULL_SAML_RESPONSE
```
    Constants for log message NULL_SAML_RESPONSE.
    
    See Also:
    
    Constant Field Values
  - INVALID_RESPONSE_SIGNATURE
```
public static final String INVALID_RESPONSE_SIGNATURE
```
    Constants for log message INVALID_RESPONSE_SIGNATURE.
    
    See Also:
    
    Constant Field Values
  - ERROR_RESPONSE_STATUS
```
public static final String ERROR_RESPONSE_STATUS
```
    Constants for log message ERROR_RESPONSE_STATUS.
    
    See Also:
    
    Constant Field Values
  - NULL_PARAMETER
```
public static final String NULL_PARAMETER
```
    Constants for log message NULL_PARAMETER.
    
    See Also:
    
    Constant Field Values
  - MISSING_TARGET
```
public static final String MISSING_TARGET
```
    Constants for log message MISSING_TARGET.
    
    See Also:
    
    Constant Field Values
  - REDIRECT_TO_URL
```
public static final String REDIRECT_TO_URL
```
    Constants for log message REDIRECT_TO_URL.
    
    See Also:
    
    Constant Field Values
  - TARGET_FORBIDDEN
```
public static final String TARGET_FORBIDDEN
```
    Constants for log message TARGET_FORBIDDEN.
    
    See Also:
    
    Constant Field Values
  - FAILED_TO_CREATE_SSO_TOKEN
```
public static final String FAILED_TO_CREATE_SSO_TOKEN
```
    Constants for log message FAILED_TO_CREATE_SSO_TOKEN.
    
    See Also:
    
    Constant Field Values
  - ACCESS_GRANTED
```
public static final String ACCESS_GRANTED
```
    Constants for log message ACCESS_GRANTED.
    
    See Also:
    
    Constant Field Values
  - MISSING_RESPONSE
```
public static final String MISSING_RESPONSE
```
    Constants for log message MISSING_RESPONSE.
    
    See Also:
    
    Constant Field Values
  - RESPONSE_MESSAGE_ERROR
```
public static final String RESPONSE_MESSAGE_ERROR
```
    Constants for log message RESPONSE_MESSAGE_ERROR.
    
    See Also:
    
    Constant Field Values
  - INVALID_RESPONSE
```
public static final String INVALID_RESPONSE
```
    Constants for log message INVALID_RESPONSE.
    
    See Also:
    
    Constant Field Values
  - SOAP_MESSAGE_FACTORY_ERROR
```
public static final String SOAP_MESSAGE_FACTORY_ERROR
```
    Constants for log message SOAP_MESSAGE_FACTORY_ERROR.
    
    See Also:
    
    Constant Field Values
  - UNTRUSTED_SITE
```
public static final String UNTRUSTED_SITE
```
    Constants for log message UNTRUSTED_SITE.
    
    See Also:
    
    Constant Field Values
  - INVALID_REQUEST
```
public static final String INVALID_REQUEST
```
    Constants for log message INVALID_REQUEST.
    
    See Also:
    
    Constant Field Values
  - SOAP_REQUEST_MESSAGE
```
public static final String SOAP_REQUEST_MESSAGE
```
    Constants for log message SOAP_REQUEST_MESSAGE.
    
    See Also:
    
    Constant Field Values
  - BUILD_RESPONSE_ERROR
```
public static final String BUILD_RESPONSE_ERROR
```
    Constants for log message BUILD_RESPONSE_ERROR.
    
    See Also:
    
    Constant Field Values
  - SENDING_RESPONSE
```
public static final String SENDING_RESPONSE
```
    Constants for log message SENDING_RESPONSE.
    
    See Also:
    
    Constant Field Values
  - SOAP_FAULT_ERROR
```
public static final String SOAP_FAULT_ERROR
```
    Constants for log message SOAP_FAULT_ERROR.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - LogUtils
```
public LogUtils()
```
- Method Detail
  - access
```
public static void access(Level level,
                          String msgId,
                          String[] data)
```
    Logs SAML specific access conditions to the SAML access log (amSAML.access).
    
    Parameters:
    
    level - java.util.logging.Level indicating log level
    
    msgId - message ID for the log entry.
    
    data - string array of access messages to be logged.
  - access
```
public static void access(Level level,
                          String msgId,
                          String[] data,
                          Object session)
```
    Logs SAML specific access conditions to the SAML access log (amSAML.access).
    
    Parameters:
    
    level - java.util.logging.Level indicating log level
    
    msgId - message ID for the log entry.
    
    data - string array of access messages to be logged.
    
    session - the user's session object.
  - error
```
public static void error(Level level,
                         String msgId,
                         String[] data)
```
    Logs SAML specific errror conditions to the SAML error log (amSAML.error).
    
    Parameters:
    
    level - java.util.logging.Level indicating log level
    
    msgId - message ID for the log entry.
    
    data - string array of error messages to be logged.
  - error
```
public static void error(Level level,
                         String msgId,
                         String[] data,
                         Object session)
```
    Logs SAML specific errror conditions to the SAML error log (amSAML.error).
    
    Parameters:
    
    level - java.util.logging.Level indicating log level
    
    msgId - message ID for the log entry.
    
    data - string array of error messages to be logged.
    
    session - the user's session object.
  - isLogEnabled
```
public boolean isLogEnabled()
```
    Checks if 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 LogUtils

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ASSERTION_CREATED

ASSERTION_ARTIFACT_CREATED

ASSERTION_ARTIFACT_REMOVED

ASSERTION_REMOVED

ASSERTION_ARTIFACT_VERIFIED

AUTH_PROTOCOL_MISMATCH

INVALID_AUTH_TYPE

SOAP_RECEIVER_URL

NO_ASSERTION_IN_RESPONSE

MISMATCHED_ASSERTION_AND_ARTIFACT

ARTIFACT_TO_SEND

WRONG_SOAP_URL

SAML_ARTIFACT_QUERY

NO_REPLY_FROM_SOAP_RECEIVER

REPLIED_SOAP_MESSAGE

NULL_SAML_RESPONSE

INVALID_RESPONSE_SIGNATURE

ERROR_RESPONSE_STATUS

NULL_PARAMETER

MISSING_TARGET

REDIRECT_TO_URL

TARGET_FORBIDDEN

FAILED_TO_CREATE_SSO_TOKEN

ACCESS_GRANTED

MISSING_RESPONSE

RESPONSE_MESSAGE_ERROR

INVALID_RESPONSE

SOAP_MESSAGE_FACTORY_ERROR

UNTRUSTED_SITE

INVALID_REQUEST

SOAP_REQUEST_MESSAGE

BUILD_RESPONSE_ERROR

SENDING_RESPONSE

SOAP_FAULT_ERROR

Constructor Detail

LogUtils

Method Detail

access

access

error

error

isLogEnabled

isAccessLoggable

isErrorLoggable