Class LogOutput

java.lang.Object

org.chenile.core.interceptors.BaseChenileInterceptor

org.chenile.core.interceptors.LogOutput

All Implemented Interfaces:

Command<ChenileExchange>

public class LogOutput
extends BaseChenileInterceptor

Logs the output from the response object. This is required if the service is asynchronous i.e. its response is not emitted back but needs to be used to keep track of success and failure by logging the response into some medium (such as files, queues, topics etc.)
The original entry point (that constructed the ChenileExchange) can give us a callback to invoke or can ask us to log into a file. That can then be used to transmit the status to the original caller or displayed in a UI.

Field Summary

Fields

Modifier and Type	Field	Description
private ExternalApiLogSupport	externalApiLogSupport
private ExternalApiProperties	externalApiProperties
private ExternalApiPublisher	externalApiPublisher
private static final String	LOG_START_TIME
private static final org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor	Description
LogOutput()

Method Summary

Modifier and Type	Method	Description
protected boolean	bypassInterception(ChenileExchange exchange)	Over-ride this to bypass interception in special circumstances
private void	copyParamHeaders(LogRecord record, ChenileExchange exchange)
protected void	doPostProcessing(ChenileExchange chenileExchange)	Override this to do post processing.
protected void	doPreProcessing(ChenileExchange exchange)	Override this to do pre-processing.
private Long	durationMillis(ChenileExchange exchange)
private LogRecord	makeLogRecord(ChenileExchange exchange)
private void	publishExternalApiRecord(ChenileExchange exchange, LogRecord record)

Methods inherited from class BaseChenileInterceptor

doContinue, execute, getExtensionByAnnotation, getExtensionByAnnotation, resumeFromSavedPoint, savePoint

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

logger

private static final org.slf4j.Logger logger

LOG_START_TIME

private static final String LOG_START_TIME

See Also:

• Constant Field Values

externalApiPublisher

@Autowired(required=false)
private ExternalApiPublisher externalApiPublisher

externalApiLogSupport

@Autowired(required=false)
private ExternalApiLogSupport externalApiLogSupport

externalApiProperties

@Autowired(required=false)
private ExternalApiProperties externalApiProperties

Constructor Details

LogOutput

public LogOutput()

Method Details

doPreProcessing

protected void doPreProcessing(ChenileExchange exchange)

Description copied from class: BaseChenileInterceptor

Override this to do pre-processing. This will be called before the service is invoked. Don't expect to see exception or response being set in ChenileExchange. However you can check for ChenileExchange.getBody() to manipulate the body if this interceptor is a Chenile post processor or a service specific or operation specific interceptor.
If this interceptor is a Chenile pre-processor, then ChenileExchange.getBody() will return null. Then you need to look at headers only.

Overrides:

doPreProcessing in class BaseChenileInterceptor

Parameters:

exchange -

doPostProcessing

protected void doPostProcessing(ChenileExchange chenileExchange)

Description copied from class: BaseChenileInterceptor

Override this to do post processing. This will be called even if there is an exception downstream. So make sure that if you don't want to do any processing in case of exception, check if ChenileExchange.getException() returns null value. If you happen to throw an exception in this method, it will get added to the set of errors that would ultimately be returned. See also ChenileExchange.setException(Throwable)

Overrides:

doPostProcessing in class BaseChenileInterceptor

Parameters:

chenileExchange - Chenile Exchange

makeLogRecord

private LogRecord makeLogRecord(ChenileExchange exchange)

publishExternalApiRecord

private void publishExternalApiRecord(ChenileExchange exchange,
 LogRecord record)

copyParamHeaders

private void copyParamHeaders(LogRecord record,
 ChenileExchange exchange)

bypassInterception

protected boolean bypassInterception(ChenileExchange exchange)

Description copied from class: BaseChenileInterceptor

Over-ride this to bypass interception in special circumstances

Overrides:

bypassInterception in class BaseChenileInterceptor

Parameters:

exchange -

Returns:

durationMillis

private Long durationMillis(ChenileExchange exchange)