LoggingFeature (Jersey 3.0.10 API)

java.lang.Object
- org.glassfish.jersey.logging.LoggingFeature

All Implemented Interfaces:

jakarta.ws.rs.core.Feature
```
public class LoggingFeature
extends Object
implements jakarta.ws.rs.core.Feature
```
This feature enables logging request and/or response on client-side and/or server-side depending on the context's RuntimeType.
The feature may be register programmatically like other features by calling any of Configurable register(...) method, i.e. Configurable.register(Class) or by setting any of the configuration property listed bellow.
Common configurable properties applies for both client and server and are following:
If any of the configuration value is not set, following default values are applied:
- logger name: org.glassfish.jersey.logging.LoggingFeature
- logger level: Level.FINE
- verbosity: LoggingFeature.Verbosity.PAYLOAD_TEXT
- maximum entity size: 8192
- line separator: DEFAULT_SEPARATOR
- redact headers: "Authorization"
Server configurable properties:
Client configurable properties:
Since:

2.23

Author:

Ondrej Kosatka

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`LoggingFeature.LoggingFeatureBuilder` Builder class for logging feature configuration.
`static class`	`LoggingFeature.Verbosity` `Verbosity` determines how detailed message will be logged.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_LOGGER_LEVEL` Default logger level which will be used for logging request and response messages.
`static String`	`DEFAULT_LOGGER_NAME` Default logger name to log request and response messages.
`static int`	`DEFAULT_MAX_ENTITY_SIZE` Default maximum entity bytes to be logged.
`static String`	`DEFAULT_REDACT_HEADERS` Default headers to be redacted.
`static String`	`DEFAULT_SEPARATOR` Default separator for entity logging.
`static LoggingFeature.Verbosity`	`DEFAULT_VERBOSITY` Default verbosity for entity logging.
`static String`	`LOGGING_FEATURE_LOGGER_LEVEL` Common logger level property.
`static String`	`LOGGING_FEATURE_LOGGER_LEVEL_CLIENT` Client logger level property.
`static String`	`LOGGING_FEATURE_LOGGER_LEVEL_SERVER` Server logger level property.
`static String`	`LOGGING_FEATURE_LOGGER_NAME` Common logger name property.
`static String`	`LOGGING_FEATURE_LOGGER_NAME_CLIENT` Client logger name property.
`static String`	`LOGGING_FEATURE_LOGGER_NAME_SERVER` Server logger name property.
`static String`	`LOGGING_FEATURE_MAX_ENTITY_SIZE` Common property for configuring a maximum number of bytes of entity to be logged.
`static String`	`LOGGING_FEATURE_MAX_ENTITY_SIZE_CLIENT` Client property for configuring a maximum number of bytes of entity to be logged.
`static String`	`LOGGING_FEATURE_MAX_ENTITY_SIZE_SERVER` Server property for configuring a maximum number of bytes of entity to be logged.
`static String`	`LOGGING_FEATURE_REDACT_HEADERS` Common property for configuring headers to be redacted.
`static String`	`LOGGING_FEATURE_REDACT_HEADERS_CLIENT` Client property for configuring headers to be redacted.
`static String`	`LOGGING_FEATURE_REDACT_HEADERS_SERVER` Server property for configuring headers to be redacted.
`static String`	`LOGGING_FEATURE_SEPARATOR` Common property for configuring logging separator.
`static String`	`LOGGING_FEATURE_SEPARATOR_CLIENT` Client property for logging separator.
`static String`	`LOGGING_FEATURE_SEPARATOR_SERVER` Server property for configuring separator.
`static String`	`LOGGING_FEATURE_VERBOSITY` Common property for configuring a verbosity of entity.
`static String`	`LOGGING_FEATURE_VERBOSITY_CLIENT` Client property for configuring a verbosity of entity.
`static String`	`LOGGING_FEATURE_VERBOSITY_SERVER` Server property for configuring a verbosity of entity.

Constructor Summary

Constructors
Constructor and Description
`LoggingFeature()` Creates the feature with default values.
`LoggingFeature(Logger logger)` Creates the feature with custom logger.
`LoggingFeature(Logger logger, Integer maxEntitySize)` Creates the feature with custom logger and maximum number of bytes of entity to log.
`LoggingFeature(Logger logger, Level level, LoggingFeature.Verbosity verbosity, Integer maxEntitySize)` Creates the feature with custom logger, it's level, message verbosity and maximum number of bytes of entity to log.
`LoggingFeature(Logger logger, LoggingFeature.Verbosity verbosity)` Creates the feature with custom logger and verbosity.
`LoggingFeature(LoggingFeature.LoggingFeatureBuilder builder)` Constructor based on logging feature builder.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static LoggingFeature.LoggingFeatureBuilder`	`builder()` builder method to create LoggingFeature with required settings
`boolean`	`configure(jakarta.ws.rs.core.FeatureContext context)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_LOGGER_NAME
```
public static final String DEFAULT_LOGGER_NAME
```
    Default logger name to log request and response messages.
  - DEFAULT_LOGGER_LEVEL
```
public static final String DEFAULT_LOGGER_LEVEL
```
    Default logger level which will be used for logging request and response messages.
  - DEFAULT_MAX_ENTITY_SIZE
```
public static final int DEFAULT_MAX_ENTITY_SIZE
```
    Default maximum entity bytes to be logged.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_VERBOSITY
```
public static final LoggingFeature.Verbosity DEFAULT_VERBOSITY
```
    Default verbosity for entity logging. See LoggingFeature.Verbosity.
  - DEFAULT_SEPARATOR
```
public static final String DEFAULT_SEPARATOR
```
    Default separator for entity logging.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_REDACT_HEADERS
```
public static final String DEFAULT_REDACT_HEADERS
```
    Default headers to be redacted. If multiple, separate each header with a semicolon.
    
    See Also:
    
    Constant Field Values
  - LOGGING_FEATURE_LOGGER_NAME
```
public static final String LOGGING_FEATURE_LOGGER_NAME
```
    Common logger name property.
    
    See Also:
    
    Constant Field Values
  - LOGGING_FEATURE_LOGGER_LEVEL
```
public static final String LOGGING_FEATURE_LOGGER_LEVEL
```
    Common logger level property.
    
    See Also:
    
    Constant Field Values
  - LOGGING_FEATURE_VERBOSITY
```
public static final String LOGGING_FEATURE_VERBOSITY
```
    Common property for configuring a verbosity of entity.
    
    See Also:
    
    Constant Field Values
  - LOGGING_FEATURE_MAX_ENTITY_SIZE
```
public static final String LOGGING_FEATURE_MAX_ENTITY_SIZE
```
    Common property for configuring a maximum number of bytes of entity to be logged.
    
    See Also:
    
    Constant Field Values
  - LOGGING_FEATURE_SEPARATOR
```
public static final String LOGGING_FEATURE_SEPARATOR
```
    Common property for configuring logging separator.
    
    See Also:
    
    Constant Field Values
  - LOGGING_FEATURE_REDACT_HEADERS
```
public static final String LOGGING_FEATURE_REDACT_HEADERS
```
    Common property for configuring headers to be redacted. The headers are semicolon-separated.
    
    See Also:
    
    Constant Field Values
  - LOGGING_FEATURE_LOGGER_NAME_SERVER
```
public static final String LOGGING_FEATURE_LOGGER_NAME_SERVER
```
    Server logger name property.
    
    See Also:
    
    Constant Field Values
  - LOGGING_FEATURE_LOGGER_LEVEL_SERVER
```
public static final String LOGGING_FEATURE_LOGGER_LEVEL_SERVER
```
    Server logger level property.
    
    See Also:
    
    Constant Field Values
  - LOGGING_FEATURE_VERBOSITY_SERVER
```
public static final String LOGGING_FEATURE_VERBOSITY_SERVER
```
    Server property for configuring a verbosity of entity.
    
    See Also:
    
    Constant Field Values
  - LOGGING_FEATURE_MAX_ENTITY_SIZE_SERVER
```
public static final String LOGGING_FEATURE_MAX_ENTITY_SIZE_SERVER
```
    Server property for configuring a maximum number of bytes of entity to be logged.
    
    See Also:
    
    Constant Field Values
  - LOGGING_FEATURE_SEPARATOR_SERVER
```
public static final String LOGGING_FEATURE_SEPARATOR_SERVER
```
    Server property for configuring separator.
    
    See Also:
    
    Constant Field Values
  - LOGGING_FEATURE_REDACT_HEADERS_SERVER
```
public static final String LOGGING_FEATURE_REDACT_HEADERS_SERVER
```
    Server property for configuring headers to be redacted. The headers are semicolon-separated.
    
    See Also:
    
    Constant Field Values
  - LOGGING_FEATURE_LOGGER_NAME_CLIENT
```
public static final String LOGGING_FEATURE_LOGGER_NAME_CLIENT
```
    Client logger name property.
    
    See Also:
    
    Constant Field Values
  - LOGGING_FEATURE_LOGGER_LEVEL_CLIENT
```
public static final String LOGGING_FEATURE_LOGGER_LEVEL_CLIENT
```
    Client logger level property.
    
    See Also:
    
    Constant Field Values
  - LOGGING_FEATURE_VERBOSITY_CLIENT
```
public static final String LOGGING_FEATURE_VERBOSITY_CLIENT
```
    Client property for configuring a verbosity of entity.
    
    See Also:
    
    Constant Field Values
  - LOGGING_FEATURE_MAX_ENTITY_SIZE_CLIENT
```
public static final String LOGGING_FEATURE_MAX_ENTITY_SIZE_CLIENT
```
    Client property for configuring a maximum number of bytes of entity to be logged.
    
    See Also:
    
    Constant Field Values
  - LOGGING_FEATURE_SEPARATOR_CLIENT
```
public static final String LOGGING_FEATURE_SEPARATOR_CLIENT
```
    Client property for logging separator.
    
    See Also:
    
    Constant Field Values
  - LOGGING_FEATURE_REDACT_HEADERS_CLIENT
```
public static final String LOGGING_FEATURE_REDACT_HEADERS_CLIENT
```
    Client property for configuring headers to be redacted. The headers are semicolon-separated.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - LoggingFeature
```
public LoggingFeature()
```
    Creates the feature with default values.
  - LoggingFeature
```
public LoggingFeature(Logger logger)
```
    Creates the feature with custom logger.
    
    Parameters:
    
    logger - the logger to log requests and responses.
  - LoggingFeature
```
public LoggingFeature(Logger logger,
                      LoggingFeature.Verbosity verbosity)
```
    Creates the feature with custom logger and verbosity.
    
    Parameters:
    
    logger - the logger to log requests and responses.
    
    verbosity - verbosity of logged messages. See LoggingFeature.Verbosity.
  - LoggingFeature
```
public LoggingFeature(Logger logger,
                      Integer maxEntitySize)
```
    Creates the feature with custom logger and maximum number of bytes of entity to log.
    
    Parameters:
    
    logger - the logger to log requests and responses.
    
    maxEntitySize - maximum number of entity bytes to be logged (and buffered) - if the entity is larger, logging filter will print (and buffer in memory) only the specified number of bytes and print "...more..." string at the end. Negative values are interpreted as zero.
  - LoggingFeature
```
public LoggingFeature(Logger logger,
                      Level level,
                      LoggingFeature.Verbosity verbosity,
                      Integer maxEntitySize)
```
    Creates the feature with custom logger, it's level, message verbosity and maximum number of bytes of entity to log.
    
    Parameters:
    
    logger - the logger to log requests and responses.
    
    level - level on which the messages will be logged.
    
    verbosity - verbosity of logged messages. See LoggingFeature.Verbosity.
    
    maxEntitySize - maximum number of entity bytes to be logged (and buffered) - if the entity is larger, logging filter will print (and buffer in memory) only the specified number of bytes and print "...more..." string at the end. Negative values are interpreted as zero.
  - LoggingFeature
```
public LoggingFeature(LoggingFeature.LoggingFeatureBuilder builder)
```
    Constructor based on logging feature builder. All parameters are passed through a builder instance.
    
    Parameters:
    
    builder - instance of a builder with required logging feature parameters
- Method Detail
  - configure
```
public boolean configure(jakarta.ws.rs.core.FeatureContext context)
```
    Specified by:
    
    configure in interface jakarta.ws.rs.core.Feature
  - builder
```
public static LoggingFeature.LoggingFeatureBuilder builder()
```
    builder method to create LoggingFeature with required settings
    
    Returns:
    
    Builder for LoggingFeature

Class LoggingFeature

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_LOGGER_NAME

DEFAULT_LOGGER_LEVEL

DEFAULT_MAX_ENTITY_SIZE

DEFAULT_VERBOSITY

DEFAULT_SEPARATOR

DEFAULT_REDACT_HEADERS

LOGGING_FEATURE_LOGGER_NAME

LOGGING_FEATURE_LOGGER_LEVEL

LOGGING_FEATURE_VERBOSITY

LOGGING_FEATURE_MAX_ENTITY_SIZE

LOGGING_FEATURE_SEPARATOR

LOGGING_FEATURE_REDACT_HEADERS

LOGGING_FEATURE_LOGGER_NAME_SERVER

LOGGING_FEATURE_LOGGER_LEVEL_SERVER

LOGGING_FEATURE_VERBOSITY_SERVER

LOGGING_FEATURE_MAX_ENTITY_SIZE_SERVER

LOGGING_FEATURE_SEPARATOR_SERVER

LOGGING_FEATURE_REDACT_HEADERS_SERVER

LOGGING_FEATURE_LOGGER_NAME_CLIENT

LOGGING_FEATURE_LOGGER_LEVEL_CLIENT

LOGGING_FEATURE_VERBOSITY_CLIENT

LOGGING_FEATURE_MAX_ENTITY_SIZE_CLIENT

LOGGING_FEATURE_SEPARATOR_CLIENT

LOGGING_FEATURE_REDACT_HEADERS_CLIENT

Constructor Detail

LoggingFeature

LoggingFeature

LoggingFeature

LoggingFeature

LoggingFeature

LoggingFeature

Method Detail

configure

builder