org.apache.cxf.ext.logging

Class LoggingFeature

java.lang.Object

javax.xml.ws.WebServiceFeature

org.apache.cxf.feature.AbstractFeature

org.apache.cxf.feature.DelegatingFeature<LoggingFeature.Portable>

org.apache.cxf.ext.logging.LoggingFeature

All Implemented Interfaces:

AbstractPortableFeature, Feature

public class LoggingFeature
extends DelegatingFeature<LoggingFeature.Portable>

This class is used to control message-on-the-wire logging. By attaching this feature to an endpoint, you can specify logging. If this feature is present, an endpoint will log input and output of ordinary and log messages.

 
      
       
      
    
  ]]>
  

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LoggingFeature.Portable

Field Summary

Fields inherited from class org.apache.cxf.feature.DelegatingFeature

delegate

Fields inherited from class javax.xml.ws.WebServiceFeature

enabled

Constructor Summary

Constructors

Constructor and Description
LoggingFeature()

Method Summary

Modifier and Type	Method and Description
void	addBinaryContentMediaTypes(String mediaTypes) Add additional binary media types to the default values for both logging interceptors Content for these types will not be logged.
void	addInBinaryContentMediaTypes(String mediaTypes) Add additional binary media types to the default values in the LoggingInInterceptor.
void	addOutBinaryContentMediaTypes(String mediaTypes) Add additional binary media types to the default values in the LoggingOutInterceptor.
void	addSensitiveElementNames(Set<String> sensitiveElementNames) Sets list of XML or JSON elements containing sensitive information to be masked.
void	addSensitiveProtocolHeaderNames(Set<String> sensitiveProtocolHeaderNames) Sets list of protocol headers containing sensitive information to be masked.
void	setInMemThreshold(long inMemThreshold)
void	setInSender(LogEventSender s)
void	setLimit(int limit)
void	setLogBinary(boolean logBinary)
void	setLogMultipart(boolean logMultipart)
void	setOutSender(LogEventSender s)
void	setPrettyLogging(boolean prettyLogging)
void	setSender(LogEventSender sender)
void	setVerbose(boolean verbose)

Methods inherited from class org.apache.cxf.feature.DelegatingFeature

getDelegate, initialize, initialize, initialize, initialize, initializeProvider, setDelegate

Methods inherited from class org.apache.cxf.feature.AbstractFeature

doInitializeProvider, getActive, getID, isEnabled

Methods inherited from class java.lang.Object

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

Constructor Detail

LoggingFeature

public LoggingFeature()

Method Detail

setLimit

public void setLimit(int limit)

setInMemThreshold

public void setInMemThreshold(long inMemThreshold)

setSender

public void setSender(LogEventSender sender)

setInSender

public void setInSender(LogEventSender s)

setOutSender

public void setOutSender(LogEventSender s)

setPrettyLogging

public void setPrettyLogging(boolean prettyLogging)

setLogBinary

public void setLogBinary(boolean logBinary)

setLogMultipart

public void setLogMultipart(boolean logMultipart)

setVerbose

public void setVerbose(boolean verbose)

addInBinaryContentMediaTypes

public void addInBinaryContentMediaTypes(String mediaTypes)

Add additional binary media types to the default values in the LoggingInInterceptor. Content for these types will not be logged. For example:

 <bean id="loggingFeature" class="org.apache.cxf.ext.logging.LoggingFeature">
   <property name="addInBinaryContentMediaTypes" value="audio/mpeg;application/zip"/>
 </bean>
 

Parameters:

mediaTypes - list of mediaTypes. symbol ; - delimeter

addOutBinaryContentMediaTypes

public void addOutBinaryContentMediaTypes(String mediaTypes)

Add additional binary media types to the default values in the LoggingOutInterceptor. Content for these types will not be logged. For example:

 <bean id="loggingFeature" class="org.apache.cxf.ext.logging.LoggingFeature">
   <property name="addOutBinaryContentMediaTypes" value="audio/mpeg;application/zip"/>
 </bean>
 

Parameters:

mediaTypes - list of mediaTypes. symbol ; - delimeter

addBinaryContentMediaTypes

public void addBinaryContentMediaTypes(String mediaTypes)

Add additional binary media types to the default values for both logging interceptors Content for these types will not be logged. For example:

 <bean id="loggingFeature" class="org.apache.cxf.ext.logging.LoggingFeature">
   <property name="addBinaryContentMediaTypes" value="audio/mpeg;application/zip"/>
 </bean>
 

Parameters:

mediaTypes - list of mediaTypes. symbol ; - delimeter

addSensitiveElementNames

public void addSensitiveElementNames(Set<String> sensitiveElementNames)

Sets list of XML or JSON elements containing sensitive information to be masked. Corresponded data will be replaced with configured mask For example:

 sensitiveElementNames: {password}

 Initial logging statement: my usermy secret password
 Result logging statement: my userXXXX
 

Parameters:

sensitiveElementNames - set of sensitive element names to be replaced

addSensitiveProtocolHeaderNames

public void addSensitiveProtocolHeaderNames(Set<String> sensitiveProtocolHeaderNames)

Sets list of protocol headers containing sensitive information to be masked. Corresponded data will be replaced with configured mask For example:

 sensitiveHeaders: {Authorization}

 Initial logging statement: {Authorization=Basic QWxhZGRpbjpPcGVuU2VzYW1l}
 Result logging statement: {Authorization=XXX}
 

Parameters:

sensitiveProtocolHeaderNames - set of sensitive element names to be replaced