Package com.sun.identity.plugin.log

Interface Logger

@SupportedAll @Deprecated(since="8.0.0", forRemoval=true) public interface Logger
Deprecated, for removal: This API element is subject to removal in a future version.
This interface defines methods which will be invoked by the the Federation Framework to write federation related events and errors to the access and error log files.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    access(Level level, String messageID, String[] data, Object session)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Logs message to the access logs.
    void
    access(Level level, String msgid, String[] data, Object session, Map props)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Writes access to a component into a log.
    void
    error(Level level, String messageId, String[] data, Object session)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Logs error messages to the error logs.
    void
    error(Level level, String msgid, String[] data, Object session, Map props)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Writes error occurred in a component into a log.
    void
    init(String componentName)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Initializes the logging for the component.
    boolean
    isAccessLoggable(Level level)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Checks if an access message of the given level would actually be logged by this logger.
    boolean
    isErrorLoggable(Level level)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Checks if an error message of the given level would actually be logged by this logger.
    boolean
    isLogEnabled()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Checks if the logging is enabled.

  • Method Details

    • init

      void init(String componentName) throws LogException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Initializes the logging for the component.
      Parameters:
      componentName - the component name.
      Throws:
      LogException - if there is an error during initialization.

    • access

      void access(Level level, String messageID, String[] data, Object session) throws LogException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Logs message to the 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)
      messageID - the message or a message identifier.
      data - string array of dynamic data to be replaced in the message.
      session - the User's session object
      Throws:
      LogException - if there is an error.

    • access

      void access(Level level, String msgid, String[] data, Object session, Map props) throws LogException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Writes access to a component into a log.
      Parameters:
      level - indicating log level
      msgid - Message id
      data - string array of dynamic data only known during run time
      session - Session object (it could be null)
      props - representing log record columns
      Throws:
      LogException - if there is an error.

    • error

      void error(Level level, String messageId, String[] data, Object session) throws LogException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Logs error messages to the error 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)
      messageId - the message or a message identifier.
      data - string array of dynamic data to be replaced in the message.
      session - the User's Session object.
      Throws:
      LogException - if there is an error.

    • error

      void error(Level level, String msgid, String[] data, Object session, Map props) throws LogException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Writes error occurred in a component into a log.
      Parameters:
      level - indicating log level
      msgid - Message id
      data - string array of dynamic data only known during run time
      session - Session object (it could be null)
      props - log record columns
      Throws:
      LogException - if there is an error.

    • isLogEnabled

      boolean isLogEnabled()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Checks if the logging is enabled.
      Returns:
      true if logging is enabled.

    • isAccessLoggable

      boolean isAccessLoggable(Level level)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Checks if an access message of the given level would actually be logged by this logger. This check is based on the Logger's effective level.
      Parameters:
      level - a message logging level defined in java.util.logging.Level.
      Returns:
      true if the given message level is currently being logged.

    • isErrorLoggable

      boolean isErrorLoggable(Level level)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Checks if an error message of the given level would actually be logged by this logger. This check is based on the Logger's effective level.
      Parameters:
      level - a message logging level defined in java.util.logging.Level.
      Returns:
      true if the given message level is currently being logged.