|
Oracle Fusion Middleware extensions for Applications Core API Reference 11g Release 1 (11.1.1.6) E22562-05 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object oracle.apps.fnd.applcore.log.AppsLogger
public abstract class AppsLogger
Fusion Application Developers can use the static methods in this class to perform logging operations from applications.
Field Summary | |
---|---|
static java.util.logging.Level |
CONFIG
Configuration Properties and Env Settings. |
static java.util.logging.Level |
FINE
High level logging messages. |
static java.util.logging.Level |
FINER
Logging messages called upon entry and/or exit from a routine. |
static java.util.logging.Level |
FINEST
Low level logging messages giving maximum detail. |
static java.util.logging.Level |
INFO
Key flow steps. |
static java.lang.String |
RCS_ID
|
static java.util.logging.Level |
SEVERE
Highest level of severity - catch-all for any errors that were not expected (by the developer) to have occurred during normal execution. |
static java.util.logging.Level |
WARNING
Used for internal errors that may have been raised and exceptions that were thrown, which the user may not have been notified directly of. |
Method Summary | |
---|---|
static AppsIncidentInfo |
createIncident(java.lang.Object pThis,
MessageVORow pMessage,
java.util.Map<java.lang.String,java.lang.Object> pMap,
java.lang.Throwable pException)
Creates an incident in ADR system for the specified seeded pMessage . |
static AppsIncidentInfo |
createIncident(java.lang.Object pThis,
java.lang.String pAppShortName,
java.lang.String pMessageName,
java.util.Map<java.lang.String,java.lang.Object> pMap,
java.lang.Throwable pException)
Creates an incident in ADR system for the specified combination of Application short name and message name. |
static AppsIncidentInfo |
createIncident(java.lang.Object pThis,
java.lang.String pErrorMessage,
java.lang.Throwable pException)
This should only be called by the ApplSession framework when the incident needs to be created and db is not accessible. |
static java.util.Map<java.lang.String,java.lang.String> |
getEssAdrEnvironmentVars()
Return the environment variables to be set by ESS before launching a batch process. |
static boolean |
isEnabled(java.util.logging.Level pLevel)
Returns whether logging or tracing is enabled for the given severity. |
static boolean |
isEnabled(MessageVORow pMessage)
Returns whether logging is enabled for the given seeded message. |
static boolean |
isIncidentEnabled()
Returns whether incident creation is enabled for the Applications system. |
static void |
releaseAppsLogger()
Deprecated. |
static void |
releaseAppsLogger(java.lang.String sessionId)
Release the resources for the AppsLogger instances associated with the current session. |
static AppsIncidentInfo |
write(java.lang.Object pThis,
MessageVORow pMessage,
java.util.Map<java.lang.String,java.lang.Object> pMap,
java.lang.Throwable pException)
Writes the specified seeded pMessage , and optionally an
pException to the log. |
static void |
write(java.lang.Object pThis,
java.lang.String pString,
java.util.logging.Level pLevel)
Writes pString to the log at the given level. |
static void |
write(java.lang.Object pThis,
java.lang.String pString,
java.util.Map<java.lang.String,java.lang.Object> pMap,
java.util.logging.Level pLevel)
Writes pString to the log at the given level. |
static void |
write(java.lang.Object pThis,
java.lang.String pAppShortName,
java.lang.String pMessageName,
java.lang.String pTokenSubstedMsgTxt,
java.lang.Throwable pException)
Writes the specified seeded pMessage , and optionally an
pException to the log. |
static void |
write(java.lang.Object pThis,
java.lang.Throwable pException)
Write pException to the log. |
static void |
write(java.lang.Object pThis,
java.lang.Throwable pException,
java.util.logging.Level pLevel)
Write pException to the log at a given level. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String RCS_ID
public static final java.util.logging.Level SEVERE
public static final java.util.logging.Level WARNING
public static final java.util.logging.Level INFO
public static final java.util.logging.Level CONFIG
public static final java.util.logging.Level FINE
public static final java.util.logging.Level FINER
public static final java.util.logging.Level FINEST
Method Detail |
---|
public static boolean isEnabled(java.util.logging.Level pLevel)
For performance standards compliance, this API must be called before you
construct any parameter Objects to pass to any of the write*(..)
APIs.
pLevel
- severity of the message.
true
if logging is enabled for the severity,
false
otherwisepublic static boolean isIncidentEnabled()
For performance standards compliance, this API must be called before you
construct any parameter Objects to pass to
createIncident(Object, MessageVORow, Map, Throwable)
API.
true
if incident creation is enabled for Applications
system, false
otherwise.public static boolean isEnabled(MessageVORow pMessage)
The API first checks for loggable_alertable attribute of message. If attribute
is not 'Y' then message is not loggable and API returns false. If the
loggable_alertable attribute for message is set to 'Y' then the level
corrosponding to the message type is compared against AppsLogger configured
logging level. If the message type has higher logging level than the
AppsLogger configured logging value, true
is returned otherwise
the API returns false
.
pMessage
- The Message to be written to the log file
true
if logging is enabled for the message,
false
otherwisepublic static AppsIncidentInfo write(java.lang.Object pThis, MessageVORow pMessage, java.util.Map<java.lang.String,java.lang.Object> pMap, java.lang.Throwable pException)
pMessage
, and optionally an
pException
to the log. This API also supports AutoIncident
creation functionality when called by Message Service.
For performance standards compliance, you must call
isEnabled(Level)
before
constructing any parameter Objects to pass to this API.
The message will only be logged if the message type of pMessage
and the module identified by pThis
are loggable.
Message qualifies for auto incident creation based on following condition.
loggable_alertable = 'Y'
type = 'ERROR'
message_severity = 'HIGH'
message_category != null
pThis
- Object writing the message to the log;
for example, this
, MyClass.class
.
If null, module name will default to
AppsLoggerHelper.MODULE_UNKNOWN
.pMessage
- Message to be translated and written to the log file. If null, no log
is recorded.pMap
- Map of tokens associated with the message. This parameter is optional.
These are the tokens that can be passed to the Message Service to get
the formated message text.pException
- Throwable
, which will be converted to string and written
to the log. This parameter is optional.
AppsIncidentInfo
object if an incident
was created in ADR as result of this call. If no incident
was created then API returns null.public static void write(java.lang.Object pThis, java.lang.String pAppShortName, java.lang.String pMessageName, java.lang.String pTokenSubstedMsgTxt, java.lang.Throwable pException)
pMessage
, and optionally an
pException
to the log. This API also supports AutoIncident
creation functionality when called by Message Service.
For performance standards compliance, you must call
isEnabled(Level)
before
constructing any parameter Objects to pass to this API.
The message will only be logged if the message type of pMessage
and the module identified by pThis
are loggable.
Message qualifies for auto incident creation based on following condition.
loggable_alertable = 'Y'
type = 'ERROR'
message_severity = 'HIGH'
message_category != null
pThis
- Object writing the message to the log;
for example, this
, MyClass.class
.
If null, module name will default to
AppsLoggerHelper.MODULE_UNKNOWN
.pAppShortName
- The short name of the application this message belongs to.pMessageName
- The message name identifier.pTokenSubstedMsgTxt
- A message string to be logged as is, instead of the string in the
message. Normally, this parameter is in fact the message
string determined by the pException
- Throwable
, which will be converted to string and written
to the log. This parameter is optional.public static void write(java.lang.Object pThis, java.lang.Throwable pException, java.util.logging.Level pLevel)
pException
to the log at a given level.
For performance standards compliance, you must call
isEnabled(Level)
before
constructing any parameter Objects to pass to this API.
The message will be logged only if the given pLevel
and the module identified by pThis
are loggable.
pThis
- Object writing the message to the log;
for example, this
, MyClass.class
.
If null, module name will default to
AppsLoggerHelper.MODULE_UNKNOWN
.pException
- Throwable
, which will be converted to string and written
to the log file. If null, no log is recorded.pLevel
- Severity of the exception message. The message will be logged
only if its severity is greater than or equal to the
lesser of the configured runtime log-level (AFLOG_LEVEL) and the
configured OJDL log level through logging.xml.
If null, no log is recorded.public static void write(java.lang.Object pThis, java.lang.Throwable pException)
pException
to the log.
For performance standards compliance, you must call
isEnabled(Level)
before
constructing any parameter Objects to pass to this API. The
Level
passed to isEnabled()
API in this case
should always be AppsLogger.SEVERE
.
The message will be logged only if the module identified by
pThis
is loggable. The exception is logged in log file at
SEVERE
level.
pThis
- Object writing the message to the log;
for example, this
, MyClass.class
.
If null, module name will default to
AppsLoggerHelper.MODULE_UNKNOWN
.pException
- Throwable
, which will be converted to string and written
to the log file. If null, no log is recorded.public static void write(java.lang.Object pThis, java.lang.String pString, java.util.logging.Level pLevel)
pString
to the log at the given level.
For performance standards compliance, you must call
isEnabled(Level)
before
constructing any parameter Objects to pass to this API.
The message will be logged only if the given pLevel
and the module identified by pThis
are loggable.
pThis
- Object writing the message to the log;
for example, this
, MyClass.class
.
If null, module name will default to
AppsLoggerHelper.MODULE_UNKNOWN
.pString
- String to be written to the log file. If null, no log is recorded.pLevel
- Severity of the message. The message will be logged
only if its severity is greater than or equal to the
lesser of the configured runtime log-level (AFLOG_LEVEL) and the
configured OJDL log level through logging.xml. If null, no log is
recorded.public static void write(java.lang.Object pThis, java.lang.String pString, java.util.Map<java.lang.String,java.lang.Object> pMap, java.util.logging.Level pLevel)
pString
to the log at the given level.
pThis
- Object writing the message to the log;
for example, this
, MyClass.class
.
If null, module name will default to
AppsLoggerHelper.MODULE_UNKNOWN
.pString
- String to be written to the log file. If null, no log is recorded.pLevel
- Severity of the message. The message will be logged
only if its severity is greater than or equal to the
lesser of the configured runtime log-level (AFLOG_LEVEL) and the
configured OJDL log level through logging.xml. If null, no log is
recorded.public static AppsIncidentInfo createIncident(java.lang.Object pThis, MessageVORow pMessage, java.util.Map<java.lang.String,java.lang.Object> pMap, java.lang.Throwable pException)
pMessage
. It also writes the message, and
optionally an pException
to the log.
For performance standards compliance, you must call
isIncidentEnabled()
before
constructing any parameter Objects to pass to this API.
This API is for Fusion application developers to manually create incidents from within their application code. If the last incident created was due to the same message parameter as is passed to the API then no new incident will be created. This is done to avoid double incident creation.
pThis
- Object creating the incident in ADR system;
for example, this
, MyClass.class
.
If null, module name will default to
AppsLoggerHelper.MODULE_UNKNOWN
.pMessage
- Message resulting in incident creation. This is also the message that
will be translated and written to the log as part of incident creation
process. If null, no incident is created and recorded.pMap
- Map of tokens associated with the message. This parameter is optional.
These are the tokens that can be passed to the Message Service to get
the formated message text.pException
- Throwable
, which will be converted to string and written
to the log. This parameter is optional.
AppsIncidentInfo
object if an incident
is created in ADR as result of this call. If no incident
is created then returns null.public static AppsIncidentInfo createIncident(java.lang.Object pThis, java.lang.String pAppShortName, java.lang.String pMessageName, java.util.Map<java.lang.String,java.lang.Object> pMap, java.lang.Throwable pException)
pException
to the log.
This API is for Fusion application developers to manually create incidents from within their application code. If the last incident created was due to the same message as specified by short application name and message name to the API then no new incident will be created. This is done to avoid double incident creation.
pThis
- Object creating the incident in ADR system;
for example, this
, MyClass.class
.
If null, module name will default to
AppsLoggerHelper.MODULE_UNKNOWN
.pAppShortname
- Short name of application requesting to create incident.pMessageName
- The name of message resulting in incident creation.pMap
- Map of tokens associated with the message. This parameter is optional.
These are the tokens that can be passed to the Message Service to get
the formated message text.pException
- Throwable
, which will be converted to string and written
to the log. This parameter is optional.
AppsIncidentInfo
object if an incident
is created in ADR as result of this call. If no incident
is created then returns null.public static AppsIncidentInfo createIncident(java.lang.Object pThis, java.lang.String pErrorMessage, java.lang.Throwable pException)
This should only be called by the ApplSession framework when the incident needs to be created and db is not accessible.
Creates an incident in ADR system for the specified ErrorMessage. This API
should be used only when database is downa nd messages can't be retrived
from message dictionary tables. It also writes the message and optionally an
pException
to the log.
This API is for Fusion application developers to manually create incidents from within their application code when they don't have access to Database. If the last incident created was due to the same message as specified erro message to the API then no new incident will be created. This is done to avoid double incident creation.
pThis
- Object creating the incident in ADR system;
for example, this
, MyClass.class
.
If null, module name will default to
AppsLoggerHelper.MODULE_UNKNOWN
.pErrorMessage
- The error message as a string resulting in incident creation. The string
should be in AppShortname-MessageNum format.pException
- Throwable
, which will be converted to string and written
to the log. This parameter is optional.
AppsIncidentInfo
object if an incident
is created in ADR as result of this call. If no incident
is created then returns null.public static void releaseAppsLogger()
This should only be called by the ApplSession framework when the session is about to be terminated.
releaseAppsLogger(String sessionId)
public static void releaseAppsLogger(java.lang.String sessionId)
This should only be called by the ApplSession framework when the session is about to be cleaned up.
public static java.util.Map<java.lang.String,java.lang.String> getEssAdrEnvironmentVars()
This should only be called by ESS.
|
Oracle Fusion Middleware extensions for Applications Core API Reference 11g Release 1 (11.1.1.6) E22562-05 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |