Skip navigation links

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

public class ServiceLog<TConfig extends IdcClientConfig>

extends Object

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

Nested Class Summary

class

ServiceLog.Timer

Constructor Summary

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

Method Summary

String	getLogId()
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	logJaxWSAuthenticateUserRequest(String stackName, Map<String,Object> requestContext) if enabled, write information about the jaxws authenticate user request to the log
void	logJaxWSAuthenticateUserResponse(String stackName, Map responseContext) if enabled, write information about the jaxws authenticate user response to the log
void	logJaxWSRequest(String stackName, Map<String,Object> requestContext) if enabled, write information about the jaxws request to the log
void	logJaxWSResponse(String stackName, Map<String,Object> responseContext) if enabled, write information about the jaxws response to the log
void	logMultipartRequest(String header, DataBinder binder) if enabled, write information about the multipartRequest to the log
void	logResponseBinder(DataBinder binder)
void	logResponseHeaders(Map<String,String> headers)
void	logStandardRequest(String header, String body) if enabled, write information about to the log
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
static boolean	useAdfTimer()

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

logStandardRequest

public void logStandardRequest(String header,
                               String body)

if enabled, write information about to the log

Parameters:

header -

body -

logMultipartRequest

public void logMultipartRequest(String header,
                                DataBinder binder)

if enabled, write information about the multipartRequest to the log

Parameters:

header -

binder -

logJaxWSRequest

public void logJaxWSRequest(String stackName,
                            Map<String,Object> requestContext)

if enabled, write information about the jaxws request to the log

Parameters:

requestContext -

logJaxWSResponse

public void logJaxWSResponse(String stackName,
                             Map<String,Object> responseContext)

if enabled, write information about the jaxws response to the log

Parameters:

responseContext -

logResponseHeaders

public void logResponseHeaders(Map<String,String> headers)

logResponseBinder

public void logResponseBinder(DataBinder binder)

logJaxWSAuthenticateUserRequest

public void logJaxWSAuthenticateUserRequest(String stackName,
                                            Map<String,Object> requestContext)

if enabled, write information about the jaxws authenticate user request to the log

Parameters:

requestContext -

logJaxWSAuthenticateUserResponse

public void logJaxWSAuthenticateUserResponse(String stackName,
                                             Map responseContext)

if enabled, write information about the jaxws authenticate user response to the log

Parameters:

-

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

useAdfTimer

public static boolean useAdfTimer()

Skip navigation links