Grizzly NIO 5.0.2 · org.glassfish.grizzly.http.GZipContentEncoding

Modifier and Type	Field and Description
private static final String[]	ALIASES
private final GZipDecoder	decoder
public static final int	DEFAULT_IN_BUFFER_SIZE
public static final int	DEFAULT_OUT_BUFFER_SIZE
private final GZipEncoder	encoder
private final EncodingFilter	encoderFilter
public static final String	NAME

Access	Constructor and Description
public	GZipContentEncoding() Construct `GZipContentEncoding` using default buffer sizes.
public	GZipContentEncoding(int input buffer size inBufferSize, int output buffer size outBufferSize) Construct `GZipContentEncoding` using specific buffer sizes.
public	GZipContentEncoding(int input buffer size inBufferSize, int output buffer size outBufferSize, EncodingFilter `EncodingFilter`, which will decide if `GZipContentEncoding` should be applied to encode specific `HttpHeader` packet. encoderFilter) Construct `GZipContentEncoding` using specific buffer sizes, with default compression level and strategy.
public	GZipContentEncoding(int input buffer size inBufferSize, int output buffer size outBufferSize, int the compression level used by the GZipEncoder compressionLevel, int the compression strategy used by the GZipEncoder compressionStrategy, EncodingFilter `EncodingFilter`, which will decide if `GZipContentEncoding` should be applied to encode specific `HttpHeader` packet. encoderFilter) Construct `GZipContentEncoding` using specific buffer sizes, compression level and strategy.

Method Summary

Modifier and Type	Method and Description
public ParsingResult	decode(final Connection<L> connection, final HttpContent httpContent) Implements org.glassfish.grizzly.http.ContentEncoding.decode. Decode HTTP packet content represented by `HttpContent`.
public HttpContent	encode(Connection<L> connection, HttpContent httpContent) Implements org.glassfish.grizzly.http.ContentEncoding.encode. Encode HTTP packet content represented by `HttpContent`.
public boolean	equals(Object obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public String[]	getAliases() Implements org.glassfish.grizzly.http.ContentEncoding.getAliases. Get the `ContentEncoding` aliases.
public static String[]	getGzipAliases()
public String	getName() Implements org.glassfish.grizzly.http.ContentEncoding.getName. Get the `ContentEncoding` name.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public final boolean	wantDecode(final HttpHeader header) Implements org.glassfish.grizzly.http.ContentEncoding.wantDecode. Method should implement the logic, which decides if HTTP packet with the specific `HttpHeader` should be decoded using this `ContentEncoding`.
public final boolean	wantEncode(final HttpHeader header) Implements org.glassfish.grizzly.http.ContentEncoding.wantEncode. Method should implement the logic, which decides if HTTP packet with the specific `HttpHeader` should be encoded using this `ContentEncoding`.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll toString wait wait wait

Field Detail

ALIASES	back to summary
private static final String[] ALIASES

decoder	back to summary
private final GZipDecoder decoder

DEFAULT_IN_BUFFER_SIZE	back to summary
public static final int DEFAULT_IN_BUFFER_SIZE

DEFAULT_OUT_BUFFER_SIZE	back to summary
public static final int DEFAULT_OUT_BUFFER_SIZE

encoder	back to summary
private final GZipEncoder encoder

encoderFilter	back to summary
private final EncodingFilter encoderFilter

NAME	back to summary
public static final String NAME

Constructor Detail

GZipContentEncoding	back to summary
public GZipContentEncoding() Construct `GZipContentEncoding` using default buffer sizes.

GZipContentEncoding back to summary

GZipContentEncoding	back to summary
public GZipContentEncoding(int inBufferSize, int outBufferSize) Construct `GZipContentEncoding` using specific buffer sizes. Parameters inBufferSize:int input buffer size outBufferSize:int output buffer size

public GZipContentEncoding(int inBufferSize, int outBufferSize)

Construct GZipContentEncoding using specific buffer sizes.

Parameters

inBufferSize:int: input buffer size
outBufferSize:int: output buffer size

GZipContentEncoding back to summary

GZipContentEncoding	back to summary
public GZipContentEncoding(int inBufferSize, int outBufferSize, EncodingFilter encoderFilter) Construct `GZipContentEncoding` using specific buffer sizes, with default compression level and strategy. Parameters inBufferSize:int input buffer size outBufferSize:int output buffer size encoderFilter:EncodingFilter `EncodingFilter`, which will decide if `GZipContentEncoding` should be applied to encode specific `HttpHeader` packet.

public GZipContentEncoding(int inBufferSize, int outBufferSize, EncodingFilter encoderFilter)

Construct GZipContentEncoding using specific buffer sizes, with default compression level and strategy.

Parameters

inBufferSize:int: input buffer size
outBufferSize:int: output buffer size
encoderFilter:EncodingFilter: EncodingFilter, which will decide if GZipContentEncoding should be applied to encode specific HttpHeader packet.

GZipContentEncoding back to summary

GZipContentEncoding	back to summary
public GZipContentEncoding(int inBufferSize, int outBufferSize, int compressionLevel, int compressionStrategy, EncodingFilter encoderFilter) Construct `GZipContentEncoding` using specific buffer sizes, compression level and strategy. Parameters inBufferSize:int input buffer size outBufferSize:int output buffer size compressionLevel:int the compression level used by the GZipEncoder compressionStrategy:int the compression strategy used by the GZipEncoder encoderFilter:EncodingFilter `EncodingFilter`, which will decide if `GZipContentEncoding` should be applied to encode specific `HttpHeader` packet.

public GZipContentEncoding(int inBufferSize, int outBufferSize, int compressionLevel, int compressionStrategy, EncodingFilter encoderFilter)

Construct GZipContentEncoding using specific buffer sizes, compression level and strategy.

Parameters

inBufferSize:int: input buffer size
outBufferSize:int: output buffer size
compressionLevel:int: the compression level used by the GZipEncoder
compressionStrategy:int: the compression strategy used by the GZipEncoder
encoderFilter:EncodingFilter: EncodingFilter, which will decide if GZipContentEncoding should be applied to encode specific HttpHeader packet.

Method Detail

decode back to summary

decode	back to summary
public ParsingResult decode(final Connection<L> connection, final HttpContent httpContent) Implements org.glassfish.grizzly.http.ContentEncoding.decode. Doc from org.glassfish.grizzly.http.ContentEncoding.decode. Decode HTTP packet content represented by `HttpContent`. Annotations @Override

public ParsingResult decode(final Connection<L> connection, final HttpContent httpContent)

Implements org.glassfish.grizzly.http.ContentEncoding.decode.

Doc from org.glassfish.grizzly.http.ContentEncoding.decode.

Decode HTTP packet content represented by HttpContent.

Annotations

@Override

encode back to summary

encode	back to summary
public HttpContent encode(Connection<L> connection, HttpContent httpContent) Implements org.glassfish.grizzly.http.ContentEncoding.encode. Doc from org.glassfish.grizzly.http.ContentEncoding.encode. Encode HTTP packet content represented by `HttpContent`. Annotations @Override

public HttpContent encode(Connection<L> connection, HttpContent httpContent)

Implements org.glassfish.grizzly.http.ContentEncoding.encode.

Doc from org.glassfish.grizzly.http.ContentEncoding.encode.

Encode HTTP packet content represented by HttpContent.

Annotations

@Override

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Annotations @Override

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Annotations

@Override

getAliases back to summary

getAliases	back to summary
public String[] getAliases() Implements org.glassfish.grizzly.http.ContentEncoding.getAliases. Doc from org.glassfish.grizzly.http.ContentEncoding.getAliases. Get the `ContentEncoding` aliases. Annotations @Override

public String[] getAliases()

Implements org.glassfish.grizzly.http.ContentEncoding.getAliases.

Doc from org.glassfish.grizzly.http.ContentEncoding.getAliases.

Get the ContentEncoding aliases.

Annotations

@Override

getGzipAliases	back to summary
public static String[] getGzipAliases()

getName back to summary

getName	back to summary
public String getName() Implements org.glassfish.grizzly.http.ContentEncoding.getName. Doc from org.glassfish.grizzly.http.ContentEncoding.getName. Get the `ContentEncoding` name. Annotations @Override

public String getName()

Implements org.glassfish.grizzly.http.ContentEncoding.getName.

Doc from org.glassfish.grizzly.http.ContentEncoding.getName.

Get the ContentEncoding name.

Annotations

@Override

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Annotations

@Override

wantDecode back to summary

wantDecode	back to summary
public final boolean wantDecode(final HttpHeader header) Implements org.glassfish.grizzly.http.ContentEncoding.wantDecode. Doc from org.glassfish.grizzly.http.ContentEncoding.wantDecode. Method should implement the logic, which decides if HTTP packet with the specific `HttpHeader` should be decoded using this `ContentEncoding`. Annotations @Override

public final boolean wantDecode(final HttpHeader header)

Implements org.glassfish.grizzly.http.ContentEncoding.wantDecode.

Doc from org.glassfish.grizzly.http.ContentEncoding.wantDecode.

Method should implement the logic, which decides if HTTP packet with the specific HttpHeader should be decoded using this ContentEncoding.

Annotations

@Override

wantEncode back to summary

wantEncode	back to summary
public final boolean wantEncode(final HttpHeader header) Implements org.glassfish.grizzly.http.ContentEncoding.wantEncode. Doc from org.glassfish.grizzly.http.ContentEncoding.wantEncode. Method should implement the logic, which decides if HTTP packet with the specific `HttpHeader` should be encoded using this `ContentEncoding`. Annotations @Override

public final boolean wantEncode(final HttpHeader header)

Implements org.glassfish.grizzly.http.ContentEncoding.wantEncode.

Doc from org.glassfish.grizzly.http.ContentEncoding.wantEncode.

Method should implement the logic, which decides if HTTP packet with the specific HttpHeader should be encoded using this ContentEncoding.

Annotations

@Override

public Class GZipContentEncoding

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail