atg.nucleus.logging
Class ApplicationLoggingImpl

java.lang.Object
  extended by atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      extended by atg.nucleus.logging.ApplicationLoggingImpl
All Implemented Interfaces:
ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging
Direct Known Subclasses:
BandedDiscountCalculatorHelper, DetailedItemPriceTools, EventSender, LoadProperties, NavHistory, OrderHolder, PageFragment, PriceOrderTotal, ProcAddApprovalSystemMessagesToOrder, ProcAddApproverIdsToOrder, ProcAddApproverIdToOrder, ProcAddApproverMessagesToOrder, ProcAddMessageMapperErrorToOrder, ProcAddOrderToRepository, ProcAuthorizePayment, ProcChangeOrderState, ProcCheckForDiscontinuedProducts, ProcCheckForErrors, ProcCheckForExpiredPromotions, ProcCheckOrderState, ProcCreateImplicitRelationships, ProcCreditCardModCheck, ProcExecuteChain, ProcMoveUsedPromotions, ProcPurchaseConfigurableItem, ProcRemoveEmptyPaymentGroups, ProcRemoveEmptyShippingGroups, ProcRemoveExpiredCommerceItems, ProcSetCatalogRefs, ProcSetCostCenterAmount, ProcSetLastModifiedTime, ProcSetPaymentGroupAmount, ProcSetProductRefs, ProcUpdateGiftRepository, ProcValidateCostCenter, ProcValidateCostCentersForCheckout, ProcValidateCreditCard, ProcValidateCurrencyCodes, ProcValidateElectronicShippingGroup, ProcValidateGiftCertificate, ProcValidateHandlingInstructionsForCheckout, ProcValidateHardgoodShippingGroup, ProcValidateInvoiceRequest, ProcValidateOrderCostsForCheckout, ProcValidateOrderForCheckout, ProcValidatePaymentGroupsForCheckout, ProcValidateShippingCostsForCheckout, ProcValidateShippingGroupsForCheckout, ProcValidateStoreCredit, ProcVerifyApproval, ProcVerifyOrderAddresses, PropertyManager, SavedProperties

public class ApplicationLoggingImpl
extends VariableArgumentApplicationLoggingImpl
implements atg.nucleus.logging.ApplicationLoggingSender

This is a straightforward implementation of ApplicationLogging that sends events to LogListeners.


Field Summary
static java.lang.String CLASS_VERSION
          Class version string
 
Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging
DEFAULT_LOG_TRACE_STATUS
 
Fields inherited from interface atg.nucleus.logging.ApplicationLogging
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS
 
Constructor Summary
ApplicationLoggingImpl()
          Creates a new ApplicationLoggingImpl
ApplicationLoggingImpl(java.lang.String pLoggingIdentifier)
          Creates a new ApplicationLoggingImpl with the specified originator that will be applied to all logging messages.
ApplicationLoggingImpl(java.lang.String pLoggingIdentifier, boolean pAutoInitListeners)
          Creates a new ApplicationLoggingImpl with the specified originator that will be applied to all logging messages.
 
Method Summary
protected  void addGlobalLogListeners()
           
 void addLogListener(LogListener pListener)
          Adds a listener to the list of log listeners
 ApplicationLogging getLoggingForVlogging()
          Return the application logging to use for variable argument logging.
 java.lang.String getLoggingIdentifer()
          Deprecated. Use the correctly spelled loggingIdentifier property
 java.lang.String getLoggingIdentifier()
          Returns property LoggingIdentifier
 int getLogListenerCount()
          Returns the number of log listeners
 LogListener[] getLogListeners()
          Return an array representing the list of LogListeners.
 void initializeFromServiceEvent(ServiceEvent pEvent)
          Initialize this component from a service event.
 boolean isAutoInitListeners()
          Whether to automatically initialize the log listeners with the list from the Global Nucleus.
 boolean isLoggingDebug()
          This method returns whether or not an debug log event should be broadcast.
 boolean isLoggingError()
          This method returns whether or not an error log event should be broadcast.
 boolean isLoggingInfo()
          This method returns whether or not an info log event should be broadcast.
 boolean isLoggingTrace()
          This method returns whether or not an trace log event should be broadcast.
 boolean isLoggingWarning()
          This method returns whether or not an warning log event should be broadcast.
 void logDebug(java.lang.String pMessage)
          Logs an debug event with the specified message
 void logDebug(java.lang.String pMessage, java.lang.Throwable pThrowable)
          Logs an debug event with the specified message and Throwable
 void logDebug(java.lang.Throwable pThrowable)
          Logs an debug event with the specified Throwable
 void logError(java.lang.String pMessage)
          Logs an error event with the specified message
 void logError(java.lang.String pMessage, java.lang.Throwable pThrowable)
          Logs an error event with the specified message and Throwable
 void logError(java.lang.Throwable pThrowable)
          Logs an error event with the specified Throwable
 void logInfo(java.lang.String pMessage)
          Logs an info event with the specified message
 void logInfo(java.lang.String pMessage, java.lang.Throwable pThrowable)
          Logs an info event with the specified message and Throwable
 void logInfo(java.lang.Throwable pThrowable)
          Logs an info event with the specified Throwable
 void logTrace(java.lang.String pMessage)
          Logs an trace event with the specified message
 void logTrace(java.lang.String pMessage, java.lang.Throwable pThrowable)
          Logs an trace event with the specified message and Throwable
 void logTrace(java.lang.Throwable pThrowable)
          Logs an trace event with the specified Throwable
 void logWarning(java.lang.String pMessage)
          Logs an warning event with the specified message
 void logWarning(java.lang.String pMessage, java.lang.Throwable pThrowable)
          Logs an warning event with the specified message and Throwable
 void logWarning(java.lang.Throwable pThrowable)
          Logs an warning event with the specified Throwable
 void removeLogListener(LogListener pListener)
          Removes a listener from the list of log listeners
 void sendLogEvent(LogEvent pLogEvent)
          Sends a LogEvent to all of the listeners
 void setAutoInitListeners(boolean pAutoInitListeners)
          Whether to automatically initialize the log listeners with the list from the Global Nucleus.
 void setLoggingDebug(boolean pLogging)
          Sets whether or not debug log events should be logged.
 void setLoggingError(boolean pLogging)
          Sets whether or not error log events should be logged.
 void setLoggingIdentifier(java.lang.String pLoggingIdentifier)
          Set the property LoggingIdentifier
 void setLoggingInfo(boolean pLogging)
          Sets whether or not info log events should be logged.
 void setLoggingTrace(boolean pLogging)
          Sets whether or not trace log events should be logged.
 void setLoggingWarning(boolean pLogging)
          Sets whether or not warning log events should be logged.
 
Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION
Class version string

Constructor Detail

ApplicationLoggingImpl

public ApplicationLoggingImpl()
Creates a new ApplicationLoggingImpl


ApplicationLoggingImpl

public ApplicationLoggingImpl(java.lang.String pLoggingIdentifier)
Creates a new ApplicationLoggingImpl with the specified originator that will be applied to all logging messages.


ApplicationLoggingImpl

public ApplicationLoggingImpl(java.lang.String pLoggingIdentifier,
                              boolean pAutoInitListeners)
Creates a new ApplicationLoggingImpl with the specified originator that will be applied to all logging messages.

Method Detail

getLoggingIdentifier

public java.lang.String getLoggingIdentifier()
Returns property LoggingIdentifier


setLoggingIdentifier

public void setLoggingIdentifier(java.lang.String pLoggingIdentifier)
Set the property LoggingIdentifier


getLoggingIdentifer

public java.lang.String getLoggingIdentifer()
Deprecated. Use the correctly spelled loggingIdentifier property

Returns misspelled property LoggingIdentifer (should be loggingIdentifier)


setAutoInitListeners

public void setAutoInitListeners(boolean pAutoInitListeners)
Whether to automatically initialize the log listeners with the list from the Global Nucleus.


isAutoInitListeners

public boolean isAutoInitListeners()
Whether to automatically initialize the log listeners with the list from the Global Nucleus.


initializeFromServiceEvent

public void initializeFromServiceEvent(ServiceEvent pEvent)
Initialize this component from a service event.


addGlobalLogListeners

protected void addGlobalLogListeners()

addLogListener

public void addLogListener(LogListener pListener)
Adds a listener to the list of log listeners

Specified by:
addLogListener in interface atg.nucleus.logging.ApplicationLoggingSender

removeLogListener

public void removeLogListener(LogListener pListener)
Removes a listener from the list of log listeners

Specified by:
removeLogListener in interface atg.nucleus.logging.ApplicationLoggingSender

getLogListenerCount

public int getLogListenerCount()
Returns the number of log listeners

Specified by:
getLogListenerCount in interface atg.nucleus.logging.ApplicationLoggingSender

sendLogEvent

public void sendLogEvent(LogEvent pLogEvent)
Sends a LogEvent to all of the listeners


isLoggingInfo

public boolean isLoggingInfo()
This method returns whether or not an info log event should be broadcast.

Specified by:
isLoggingInfo in interface ApplicationLogging
Returns:
boolean true if info log events should be logged
false if info log events should not be logged

setLoggingInfo

public void setLoggingInfo(boolean pLogging)
Sets whether or not info log events should be logged.

Specified by:
setLoggingInfo in interface ApplicationLogging

isLoggingWarning

public boolean isLoggingWarning()
This method returns whether or not an warning log event should be broadcast.

Specified by:
isLoggingWarning in interface ApplicationLogging
Returns:
boolean true if warning log events should be logged
false if warning log events should not be logged

setLoggingWarning

public void setLoggingWarning(boolean pLogging)
Sets whether or not warning log events should be logged.

Specified by:
setLoggingWarning in interface ApplicationLogging

isLoggingError

public boolean isLoggingError()
This method returns whether or not an error log event should be broadcast.

Specified by:
isLoggingError in interface ApplicationLogging
Returns:
boolean true if error log events should be logged
false if error log events should not be logged

setLoggingError

public void setLoggingError(boolean pLogging)
Sets whether or not error log events should be logged.

Specified by:
setLoggingError in interface ApplicationLogging

isLoggingDebug

public boolean isLoggingDebug()
This method returns whether or not an debug log event should be broadcast.

Specified by:
isLoggingDebug in interface ApplicationLogging
Returns:
boolean true if debug log events should be logged
false if debug log events should not be logged

setLoggingDebug

public void setLoggingDebug(boolean pLogging)
Sets whether or not debug log events should be logged.

Specified by:
setLoggingDebug in interface ApplicationLogging

isLoggingTrace

public boolean isLoggingTrace()
This method returns whether or not an trace log event should be broadcast.

Specified by:
isLoggingTrace in interface atg.nucleus.logging.TraceApplicationLogging
Overrides:
isLoggingTrace in class VariableArgumentApplicationLoggingImpl
Returns:
boolean true if trace log events should be logged
false if trace log events should not be logged

setLoggingTrace

public void setLoggingTrace(boolean pLogging)
Sets whether or not trace log events should be logged.

Specified by:
setLoggingTrace in interface atg.nucleus.logging.TraceApplicationLogging

logInfo

public void logInfo(java.lang.String pMessage)
Logs an info event with the specified message

Specified by:
logInfo in interface ApplicationLogging

logInfo

public void logInfo(java.lang.Throwable pThrowable)
Logs an info event with the specified Throwable

Specified by:
logInfo in interface ApplicationLogging

logInfo

public void logInfo(java.lang.String pMessage,
                    java.lang.Throwable pThrowable)
Logs an info event with the specified message and Throwable

Specified by:
logInfo in interface ApplicationLogging

logWarning

public void logWarning(java.lang.String pMessage)
Logs an warning event with the specified message

Specified by:
logWarning in interface ApplicationLogging

logWarning

public void logWarning(java.lang.Throwable pThrowable)
Logs an warning event with the specified Throwable

Specified by:
logWarning in interface ApplicationLogging

logWarning

public void logWarning(java.lang.String pMessage,
                       java.lang.Throwable pThrowable)
Logs an warning event with the specified message and Throwable

Specified by:
logWarning in interface ApplicationLogging

logError

public void logError(java.lang.String pMessage)
Logs an error event with the specified message

Specified by:
logError in interface ApplicationLogging

logError

public void logError(java.lang.Throwable pThrowable)
Logs an error event with the specified Throwable

Specified by:
logError in interface ApplicationLogging

logError

public void logError(java.lang.String pMessage,
                     java.lang.Throwable pThrowable)
Logs an error event with the specified message and Throwable

Specified by:
logError in interface ApplicationLogging

logDebug

public void logDebug(java.lang.String pMessage)
Logs an debug event with the specified message

Specified by:
logDebug in interface ApplicationLogging

logDebug

public void logDebug(java.lang.Throwable pThrowable)
Logs an debug event with the specified Throwable

Specified by:
logDebug in interface ApplicationLogging

logDebug

public void logDebug(java.lang.String pMessage,
                     java.lang.Throwable pThrowable)
Logs an debug event with the specified message and Throwable

Specified by:
logDebug in interface ApplicationLogging

logTrace

public void logTrace(java.lang.String pMessage)
Logs an trace event with the specified message

Specified by:
logTrace in interface atg.nucleus.logging.TraceApplicationLogging

logTrace

public void logTrace(java.lang.Throwable pThrowable)
Logs an trace event with the specified Throwable

Specified by:
logTrace in interface atg.nucleus.logging.TraceApplicationLogging

logTrace

public void logTrace(java.lang.String pMessage,
                     java.lang.Throwable pThrowable)
Logs an trace event with the specified message and Throwable

Specified by:
logTrace in interface atg.nucleus.logging.TraceApplicationLogging

getLogListeners

public LogListener[] getLogListeners()
Return an array representing the list of LogListeners. This method returns a new array each time invoked.

Specified by:
getLogListeners in interface atg.nucleus.logging.ApplicationLoggingSender

getLoggingForVlogging

public ApplicationLogging getLoggingForVlogging()
Description copied from class: VariableArgumentApplicationLoggingImpl
Return the application logging to use for variable argument logging.

Specified by:
getLoggingForVlogging in class VariableArgumentApplicationLoggingImpl