oracle.stellent.ridc.common.util

Class ServiceLog<TConfig extends IdcClientConfig>

java.lang.Object

oracle.stellent.ridc.common.util.ServiceLog<TConfig>

Type Parameters:

TConfig - IdcClientConfig for the specific client

@Concealed
public final class ServiceLog<TConfig extends IdcClientConfig>
extends Object

ALL LOG MESSAGES IN THIS CLASS ARE ASSUMED TO BE DEBUG OR FINER AND NEED NO I18N

Constructor Summary

Constructors

Constructor and Description
ServiceLog(TConfig clientConfig, ServiceRequest serviceRequest, DataBinder requestBinder) Create service log.

Method Summary

Modifier and Type	Method and Description
String	getLogId()
static TimerProvider	getTimerProvider()
void	logCleanup() Stop the log and do a cleanup, This method should always be in the finally block
void	logExceptionResponse(String message) Logs an Exception Response to a Service Request
void	logResponseBinder(DataBinder binder)
void	logStart() Start the log of this service request processing This method should be in a try block with the logCleanup() called in the finally clause
void	logStop() Stop the log of this service request processing This method should be in a try block with the logCleanup() called in the finally clause
static String	toId(long i) Just a way to make a very long number a bit shorter for human consumption

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceLog

public ServiceLog(TConfig clientConfig,
                  ServiceRequest serviceRequest,
                  DataBinder requestBinder)

Create service log. Creation will start the timer, and optionally log a message. Method logStop() will stop the timer and optionally log a message. Static methods are available for use in other locations but want to keep the same log message formats.

Parameters:

clientConfig -

serviceRequest -

requestBinder -

Method Detail

logStart

public void logStart()

Start the log of this service request processing This method should be in a try block with the logCleanup() called in the finally clause

logStop

public void logStop()

Stop the log of this service request processing This method should be in a try block with the logCleanup() called in the finally clause

logCleanup

public void logCleanup()

Stop the log and do a cleanup, This method should always be in the finally block

logResponseBinder

public void logResponseBinder(DataBinder binder)

logExceptionResponse

public void logExceptionResponse(String message)

Logs an Exception Response to a Service Request

Parameters:

message -

getLogId

public String getLogId()

Returns:

the id of this servicelog. Since a ServiceRequest holds this object, it can also serve a an ID for the Service Request

toId

public static String toId(long i)

Just a way to make a very long number a bit shorter for human consumption

getTimerProvider

public static TimerProvider getTimerProvider()