com.ebay.sdk
Class ApiLogging

java.lang.Object
  com.ebay.sdk.ApiLogging

public class ApiLogging
extends Object

Contains properties to control SDK logging.

View UML diagram of the class.

Title:

Description:

Copyright: Copyright (c) 2004

Company: eBay Inc.

Constructor Summary

ApiLogging()
Constructor.

Method Summary

boolean	getEnableLogging() Indicates if logging should be enabled.
boolean	getLogExceptions() Get LogExceptions property.
boolean	getLogSOAPMessages() Get LogSOAPMessages property.
ExceptionFilter	getMessageLoggingFilter() Get the message logging filter.
org.apache.commons.logging.Log	getOverrideLog() Get the logger.
void	setEnableLogging(boolean enableLogging) Specifies if logging should be enabled.
void	setLogExceptions(boolean logExceptions) Set to true to enable logging of all exceptions if logging is enabled (setEnableLogging(true)).
void	setLogSOAPMessages(boolean logSOAPMessages) Set to true to enable logging of SOAP request and response messages if logging is enabled (setEnableLogging(true)).
void	setMessageLoggingFilter(ExceptionFilter messageLoggingFilter) Set the message logging filter.
void	setOverrideLog(org.apache.commons.logging.Log overrideLog) Set the logger.

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiLogging

public ApiLogging()

Constructor.

Method Detail

setLogExceptions

public void setLogExceptions(boolean logExceptions)

Set to true to enable logging of all exceptions if logging is enabled (setEnableLogging(true)).

Parameters:

logExceptions - boolean

getLogExceptions

public boolean getLogExceptions()

Get LogExceptions property.

Returns:

true means logging of exception is turned on.

setLogSOAPMessages

public void setLogSOAPMessages(boolean logSOAPMessages)

Set to true to enable logging of SOAP request and response messages if logging is enabled (setEnableLogging(true)).

Parameters:

logSOAPMessages - boolean

getLogSOAPMessages

public boolean getLogSOAPMessages()

Get LogSOAPMessages property.

Returns:

true means logging of SOAP messages is turned on.

getEnableLogging

public boolean getEnableLogging()

Indicates if logging should be enabled.

Returns:

true means the logging is enabled.

setEnableLogging

public void setEnableLogging(boolean enableLogging)

Specifies if logging should be enabled. After you enabled logging, if you specified override logger setOverrideLog()), it will be used. Otherwise it will use the logger of Axis client.

Parameters:

enableLogging - true means to enable logging. false to display it.

getOverrideLog

public org.apache.commons.logging.Log getOverrideLog()

Get the logger.

Returns:

the logger object.

setOverrideLog

public void setOverrideLog(org.apache.commons.logging.Log overrideLog)

Set the logger. You need to enable logging first (setEnableLogging) before you set the logger. After you enabled logging, if you specified override logger setOverrideLog()), it will be used. Otherwise it will use the logger of Axis client.

Parameters:

overrideLog - the logger to be set to.

getMessageLoggingFilter

public ExceptionFilter getMessageLoggingFilter()

Get the message logging filter.

Returns:

the message logging filter object.

setMessageLoggingFilter

public void setMessageLoggingFilter(ExceptionFilter messageLoggingFilter)

Set the message logging filter. This will only have an effect if logging in general, and logging of SOAP messages (payload), are already enabled. The message logging filter allows constrained logging of payload messages for specific exceptions that match the filter.

Parameters:

the - message logging filter object.