@ComponentProfile(summary="Log the message to the log file; useful for debugging", tag="service,logging,debug") public class LogMessageService extends LoggingServiceImpl
Service which logs the AdaptrisMessage
to the configured logger for debugging purposes.
In the adapter configuration file this class is aliased as log-message-service which is the preferred alternative to the fully qualified classname when building your configuration.
LoggingServiceImpl.LoggingLevel
log
CONFIRMATION_ID_KEY
Constructor and Description |
---|
LogMessageService() |
LogMessageService(LoggingServiceImpl.LoggingLevel level) |
LogMessageService(LoggingServiceImpl.LoggingLevel level,
java.lang.String loggingPrefix) |
LogMessageService(java.lang.String uniqueId) |
Modifier and Type | Method and Description |
---|---|
void |
doService(AdaptrisMessage msg)
Apply the service to the message.
|
java.lang.Boolean |
getIncludeEvents()
Deprecated.
|
java.lang.Boolean |
getIncludePayload()
Deprecated.
|
MessageLogger |
getLoggingFormat() |
java.lang.String |
getLogPrefix() |
MessageLogger |
loggingFormat() |
void |
setIncludeEvents(java.lang.Boolean b)
Deprecated.
since 3.8.4 use
setLoggingFormat(MessageLogger) instead. |
void |
setIncludePayload(java.lang.Boolean b)
Deprecated.
since 3.8.4 use
setLoggingFormat(MessageLogger) instead. |
void |
setLoggingFormat(MessageLogger ml) |
void |
setLogPrefix(java.lang.String s)
Set the logging prefix to the output
|
closeService, getLogCategory, getLogger, getLogLevel, initService, prepare, setLogCategory, setLogLevel, slf4jLogger, withLogCategory
changeState, close, continueOnFailure, createName, createQualifier, getContinueOnFail, getIsTrackingEndpoint, getLookupName, getUniqueId, init, isBranching, isTrackingEndpoint, requestClose, requestInit, requestStart, requestStop, retrieveComponentState, setContinueOnFail, setIsTrackingEndpoint, setLookupName, setUniqueId, start, stop
public LogMessageService()
public LogMessageService(LoggingServiceImpl.LoggingLevel level)
public LogMessageService(LoggingServiceImpl.LoggingLevel level, java.lang.String loggingPrefix)
public LogMessageService(java.lang.String uniqueId)
public void doService(AdaptrisMessage msg) throws ServiceException
Service
Apply the service to the message.
msg
- the AdaptrisMessage
to processServiceException
- wrapping any underlying Exception
s#doService(com.adaptris.core.AdaptrisMessage)
public java.lang.String getLogPrefix()
public void setLogPrefix(java.lang.String s)
s
- the logging prefix, default ''@Deprecated @Removal(version="3.11.0", message="Use a logging-format instead") public java.lang.Boolean getIncludePayload()
@Deprecated @Removal(version="3.11.0", message="Use a logging-format instead") public void setIncludePayload(java.lang.Boolean b)
setLoggingFormat(MessageLogger)
instead.b
- true to include the payload, default is true.@Deprecated @Removal(version="3.11.0", message="Use a logging-format instead") public java.lang.Boolean getIncludeEvents()
@Deprecated @Removal(version="3.11.0", message="Use a logging-format instead") public void setIncludeEvents(java.lang.Boolean b)
setLoggingFormat(MessageLogger)
instead.b
- true to include events, default is false.public MessageLogger getLoggingFormat()
public void setLoggingFormat(MessageLogger ml)
public MessageLogger loggingFormat()