com.ebay.sdk.ApiLogging Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ebaysdkcore939 Show documentation
Repack of the eBay SDK version 939 for repository use
There is a newer version: 939.0.0
/*
Copyright (c) 2013 eBay, Inc.
This program is licensed under the terms of the eBay Common Development and
Distribution License (CDDL) Version 1.0 (the "License") and any subsequent  version 
thereof released by eBay.  The then-current version of the License can be found 
at http://www.opensource.org/licenses/cddl1.php and in the eBaySDKLicense file that 
is under the eBay SDK ../docs directory.
*/

package com.ebay.sdk;

/**
 * Contains properties to control SDK logging.
 * 
 * 

 * Title: 
 * Description: 
 * Copyright: Copyright (c) 2004
 * Company: eBay Inc.
 * @author Weijun Li
 * @version 1.0
 */
public class ApiLogging {

  private boolean logExceptions = true;
  private boolean logSOAPMessages = true;
  private boolean logHTTPHeaders = false;
  private ExceptionFilter messageLoggingFilter = null;

  /**
   * Constructor.
   */
  public ApiLogging() {
  }

  /**
   * Set to true to enable logging of all exceptions if logging is enabled
   * (setEnableLogging(true)).
   *
   * @param logExceptions boolean
   */
  public void setLogExceptions(boolean logExceptions) {
    this.logExceptions = logExceptions;
  }

  /**
   * Get LogExceptions property.
   * @return true means logging of exception is turned on.
   */
  public boolean isLogExceptions() {
    return this.logExceptions;
  }

  /**
   * Set to true to enable logging of SOAP request and response messages if
   * logging is enabled (setEnableLogging(true)).
   * @param logSOAPMessages boolean
   */
  public void setLogSOAPMessages(boolean logSOAPMessages) {
    this.logSOAPMessages = logSOAPMessages;
  }

  /**
   * Get LogSOAPMessages property.
   * @return true means logging of SOAP messages is turned on.
   */
  public boolean isLogSOAPMessages() {
    return this.logSOAPMessages;
  }

  /**
   * Get the message logging filter.
   * @return the message logging filter object.
   */
  public ExceptionFilter getMessageLoggingFilter() {
    return this.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.
   * @param messageLoggingFilter
   */
  public void setMessageLoggingFilter(ExceptionFilter messageLoggingFilter) {
    this.messageLoggingFilter = messageLoggingFilter;
  }

  /**
   * Get LogHTTPHeaders property.
   * @return true means logging of HTTP headers is turned on.
   */
  public boolean isLogHTTPHeaders() {
	return logHTTPHeaders;
  }

	
  /**
   * Set to true to enable logging of all HTTP request/response headers 
   * if logging is enabled(setEnableLogging(true)).
   *
   * @param logHTTPHeaders
   */	
  public void setLogHTTPHeaders(boolean logHTTPHeaders) {
	this.logHTTPHeaders = logHTTPHeaders;
  }
}