Module org.eclipse.jetty.http

Package org.eclipse.jetty.http

Class HttpFields.MutableHttpFields

java.lang.Object

org.eclipse.jetty.http.HttpFields.MutableHttpFields

All Implemented Interfaces:

Iterable<HttpField>, HttpFields, HttpFields.Mutable

Direct Known Subclasses:

HttpTester.Message

Enclosing interface:

HttpFields

public static class HttpFields.MutableHttpFields
extends Object
implements HttpFields.Mutable

HTTP Fields. A collection of HTTP header and or Trailer fields.

This class is not synchronized as it is expected that modifications will only be performed by a single thread.

The cookie handling provided by this class is guided by the Servlet specification and RFC6265.

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.jetty.http.HttpFields

HttpFields.ImmutableHttpFields, HttpFields.Mutable, HttpFields.MutableHttpFields

Field Summary

Fields inherited from interface org.eclipse.jetty.http.HttpFields

CONNECTION_CLOSE, CONNECTION_KEEPALIVE, EMPTY, EXPIRES_01JAN1970

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MutableHttpFields()	Initialize an empty HttpFields.
protected	MutableHttpFields(int capacity)	Initialize an empty HttpFields.
protected	MutableHttpFields(HttpFields fields)	Initialize HttpFields from another.
protected	MutableHttpFields(HttpFields fields, EnumSet<HttpHeader> removeFields)	Initialize HttpFields from another and remove fields
protected	MutableHttpFields(HttpFields fields, HttpField replaceField)	Initialize HttpFields from another and replace a field

Method Summary

Modifier and Type	Method	Description
HttpFields.Mutable	add(HttpField field)
HttpFields.Mutable	add(HttpFields fields)
HttpFields	asImmutable()
HttpFields.Mutable	clear()
void	computeField(String name, BiFunction<String,List<HttpField>,HttpField> computeFn)	Computes a single field for the given HTTP header name and for existing fields with the same name.
void	computeField(HttpHeader header, BiFunction<HttpHeader,List<HttpField>,HttpField> computeFn)	Computes a single field for the given HttpHeader and for existing fields with the same header.
<T> void	computeField(T header, BiFunction<T,List<HttpField>,HttpField> computeFn, BiPredicate<HttpField,T> matcher)
boolean	equals(Object o)
HttpField	getField(int index)	Get a Field by index.
int	hashCode()
Iterator<HttpField>	iterator()
ListIterator<HttpField>	listIterator()
HttpFields.Mutable	put(String name, String value)	Set a field.
HttpFields.Mutable	put(String name, List<String> list)	Set a field.
HttpFields.Mutable	put(HttpField field)
HttpFields.Mutable	put(HttpHeader header, String value)	Set a field.
HttpFields.Mutable	put(HttpHeader header, HttpHeaderValue value)
HttpFields.Mutable	remove(String name)	Remove a field.
HttpFields.Mutable	remove(EnumSet<HttpHeader> fields)
HttpFields.Mutable	remove(HttpHeader name)	Remove a field.
int	size()
Stream<HttpField>	stream()
HttpFields	takeAsImmutable()	Efficiently take the fields as an Immutable that cannot be changed by any further mutations to this instance.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.jetty.http.HttpFields

asString, contains, contains, contains, contains, contains, contains, get, get, getCSV, getCSV, getDateField, getDateField, getField, getField, getFieldNames, getFieldNamesCollection, getFields, getFields, getLongField, getLongField, getQualityCSV, getQualityCSV, getQualityCSV, getValues, getValuesList, getValuesList, isEqualTo

Methods inherited from interface org.eclipse.jetty.http.HttpFields.Mutable

add, add, add, addCSV, addCSV, addDateField, ensureField, putDateField, putDateField, putLongField, putLongField

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

MutableHttpFields

protected MutableHttpFields()

Initialize an empty HttpFields.

MutableHttpFields

protected MutableHttpFields(int capacity)

Initialize an empty HttpFields.

Parameters:

capacity - the capacity of the http fields

MutableHttpFields

protected MutableHttpFields(HttpFields fields)

Initialize HttpFields from another.

Parameters:

fields - the fields to copy data from

MutableHttpFields

protected MutableHttpFields(HttpFields fields,
 HttpField replaceField)

Initialize HttpFields from another and replace a field

Parameters:

fields - the fields to copy data from

replaceField - the replacement field

MutableHttpFields

protected MutableHttpFields(HttpFields fields,
 EnumSet<HttpHeader> removeFields)

Initialize HttpFields from another and remove fields

Parameters:

fields - the fields to copy data from

removeFields - the the fields to remove

Method Details

add

public HttpFields.Mutable add(HttpField field)

Specified by:

add in interface HttpFields.Mutable

add

public HttpFields.Mutable add(HttpFields fields)

Specified by:

add in interface HttpFields.Mutable

asImmutable

public HttpFields asImmutable()

Specified by:

asImmutable in interface HttpFields

takeAsImmutable

public HttpFields takeAsImmutable()

Description copied from interface: HttpFields

Efficiently take the fields as an Immutable that cannot be changed by any further mutations to this instance.

Specified by:

takeAsImmutable in interface HttpFields

Returns:

An immutable version of the fields.

clear

public HttpFields.Mutable clear()

Specified by:

clear in interface HttpFields.Mutable

equals

public boolean equals(Object o)

Overrides:

equals in class Object

getField

public HttpField getField(int index)

Get a Field by index.

Specified by:

getField in interface HttpFields

Parameters:

index - the field index

Returns:

A Field value or null if the Field value has not been set

hashCode

public int hashCode()

Overrides:

hashCode in class Object

iterator

public Iterator<HttpField> iterator()

Specified by:

iterator in interface HttpFields.Mutable

Specified by:

iterator in interface Iterable<HttpField>

listIterator

public ListIterator<HttpField> listIterator()

Specified by:

listIterator in interface HttpFields.Mutable

put

public HttpFields.Mutable put(HttpField field)

Specified by:

put in interface HttpFields.Mutable

put

public HttpFields.Mutable put(String name,
 String value)

Description copied from interface: HttpFields.Mutable

Set a field.

Specified by:

put in interface HttpFields.Mutable

Parameters:

name - the name of the field

value - the value of the field. If null the field is cleared.

Returns:

this builder

put

public HttpFields.Mutable put(HttpHeader header,
 HttpHeaderValue value)

Specified by:

put in interface HttpFields.Mutable

put

public HttpFields.Mutable put(HttpHeader header,
 String value)

Description copied from interface: HttpFields.Mutable

Set a field.

Specified by:

put in interface HttpFields.Mutable

Parameters:

header - the header name of the field

value - the value of the field. If null the field is cleared.

Returns:

this builder

put

public HttpFields.Mutable put(String name,
 List<String> list)

Description copied from interface: HttpFields.Mutable

Set a field.

Specified by:

put in interface HttpFields.Mutable

Parameters:

name - the name of the field

list - the List value of the field. If null the field is cleared.

Returns:

this builder

computeField

public void computeField(HttpHeader header,
 BiFunction<HttpHeader,List<HttpField>,HttpField> computeFn)

Description copied from interface: HttpFields.Mutable

Computes a single field for the given HttpHeader and for existing fields with the same header.

The compute function receives the field name and a list of fields with the same name so that their values can be used to compute the value of the field that is returned by the compute function. If the compute function returns null, the fields with the given name are removed.

This method comes handy when you want to add an HTTP header if it does not exist, or add a value if the HTTP header already exists, similarly to Map.compute(Object, BiFunction).

This method can be used to put a new field (or blindly replace its value):

 httpFields.computeField("X-New-Header",
     (name, fields) -> new HttpField(name, "NewValue"));
 

This method can be used to coalesce many fields into one:

 // Input:
 GET / HTTP/1.1
 Host: localhost
 Cookie: foo=1
 Cookie: bar=2,baz=3
 User-Agent: Jetty

 // Computation:
 httpFields.computeField("Cookie", (name, fields) ->
 {
     // No cookies, nothing to do.
     if (fields == null)
         return null;

     // Coalesces all cookies.
     String coalesced = fields.stream()
         .flatMap(field -> Stream.of(field.getValues()))
         .collect(Collectors.joining(", "));

     // Returns a single Cookie header with all cookies.
     return new HttpField(name, coalesced);
 }

 // Output:
 GET / HTTP/1.1
 Host: localhost
 Cookie: foo=1, bar=2, baz=3
 User-Agent: Jetty
 

This method can be used to replace a field:

 httpFields.computeField("X-Length", (name, fields) ->
 {
     if (fields == null)
         return null;

     // Get any value among the X-Length headers.
     String length = fields.stream()
         .map(HttpField::getValue)
         .findAny()
         .orElse("0");

     // Replace X-Length headers with X-Capacity header.
     return new HttpField("X-Capacity", length);
 });
 

This method can be used to remove a field:

 httpFields.computeField("Connection", (name, fields) -> null);
 

Specified by:

computeField in interface HttpFields.Mutable

Parameters:

header - the HTTP header

computeFn - the compute function

computeField

public void computeField(String name,
 BiFunction<String,List<HttpField>,HttpField> computeFn)

Description copied from interface: HttpFields.Mutable

Computes a single field for the given HTTP header name and for existing fields with the same name.

Specified by:

computeField in interface HttpFields.Mutable

Parameters:

name - the HTTP header name

computeFn - the compute function

See Also:

• HttpFields.Mutable.computeField(HttpHeader, BiFunction)

computeField

public <T> void computeField(T header,
 BiFunction<T,List<HttpField>,HttpField> computeFn,
 BiPredicate<HttpField,T> matcher)

remove

public HttpFields.Mutable remove(HttpHeader name)

Description copied from interface: HttpFields.Mutable

Remove a field.

Specified by:

remove in interface HttpFields.Mutable

Parameters:

name - the field to remove

Returns:

this builder

remove

public HttpFields.Mutable remove(EnumSet<HttpHeader> fields)

Specified by:

remove in interface HttpFields.Mutable

remove

public HttpFields.Mutable remove(String name)

Description copied from interface: HttpFields.Mutable

Remove a field.

Specified by:

remove in interface HttpFields.Mutable

Parameters:

name - the field to remove

Returns:

this builder

size

public int size()

Specified by:

size in interface HttpFields

stream

public Stream<HttpField> stream()

Specified by:

stream in interface HttpFields

toString

public String toString()

Overrides:

toString in class Object