org.glassfish.jersey.client.filter

Class EncodingFeature

java.lang.Object

org.glassfish.jersey.client.filter.EncodingFeature

All Implemented Interfaces:

javax.ws.rs.core.Feature

public class EncodingFeature
extends java.lang.Object
implements javax.ws.rs.core.Feature

Feature that configures support for content encodings on the client side. This feature registers EncodingFilter and the specified set of encoding providers to the client configuration. It also allows setting the value of ClientProperties.USE_ENCODING property.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.Class<?>[]	encodingProviders
private java.lang.String	useEncoding

Constructor Summary

Constructors

Constructor and Description
EncodingFeature(java.lang.Class<?>... encodingProviders) Create a new instance of the feature.
EncodingFeature(java.lang.String useEncoding, java.lang.Class<?>... encoders) Create a new instance of the feature specifying the default value for the ClientProperties.USE_ENCODING property.

Method Summary

Modifier and Type	Method and Description
boolean	configure(javax.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

useEncoding

private final java.lang.String useEncoding

encodingProviders

private final java.lang.Class<?>[] encodingProviders

Constructor Detail

EncodingFeature

public EncodingFeature(java.lang.Class<?>... encodingProviders)

Create a new instance of the feature.

Parameters:

encodingProviders - Encoding providers to be registered in the client configuration.

EncodingFeature

public EncodingFeature(java.lang.String useEncoding,
                       java.lang.Class<?>... encoders)

Create a new instance of the feature specifying the default value for the ClientProperties.USE_ENCODING property. Unless the value is set in the client configuration properties at the time when this feature gets enabled, the provided value will be used.

Parameters:

useEncoding - Default value of ClientProperties.USE_ENCODING property.

encoders - Encoders to be registered in the client configuration.

Method Detail

configure

public boolean configure(javax.ws.rs.core.FeatureContext context)

Specified by:

configure in interface javax.ws.rs.core.Feature