Package org.eclipse.jetty.http

Class HttpFields.MutableHttpFields

java.lang.Object

org.eclipse.jetty.http.HttpFields.MutableHttpFields

All Implemented Interfaces:

Iterable<HttpField>, Supplier<HttpFields>, HttpFields, HttpFields.Mutable

Enclosing interface:

HttpFields

@Deprecated(forRemoval=true)
public static class HttpFields.MutableHttpFields
extends Object

Deprecated, for removal: This API element is subject to removal in a future version.

Nested Class Summary

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

HttpFields.ImmutableHttpFields, HttpFields.Mutable, HttpFields.MutableHttpFields

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

HttpFields.Mutable.Wrapper

Field Summary

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

CONNECTION_CLOSE, CONNECTION_KEEPALIVE, CONTENT_LENGTH_0, EMPTY, EXPIRES_01JAN1970

Constructor Summary

Constructors

Constructor	Description
MutableHttpFields()	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
HttpFields.Mutable	add(HttpField field)	Adds the given HttpField to this instance.
HttpFields.Mutable	add(HttpFields fields)	Adds all the HttpFields of the given HttpFields to this instance.
HttpFields	asImmutable()	Returns an immutable copy of this HttpFields instance.
HttpFields.Mutable	clear()	Removes all the fields from this instance.
HttpFields.Mutable	computeField(String name, BiFunction<String,List<HttpField>,HttpField> computeFn)	Computes a single field for the given HTTP field name and for existing fields with the same name.
HttpFields.Mutable	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> HttpFields.Mutable	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.
HttpField	getField(String name)	Returns the first HttpField with the given field name, or null if no such field is present.
HttpField	getField(HttpHeader header)	Returns the first HttpField with the given field name, or null if no such field is present.
int	hashCode()
Iterator<HttpField>	iterator()
ListIterator<HttpField>	listIterator()
ListIterator<HttpField>	listIterator(int index)
HttpFields.Mutable	put(String name, String value)	This method behaves like HttpFields.Mutable.remove(String) when the given value is null, otherwise behaves like HttpFields.Mutable.put(HttpField).
HttpFields.Mutable	put(HttpField field)	Puts the given HttpField into this instance.
HttpFields.Mutable	put(HttpHeader header, String value)	This method behaves like HttpFields.Mutable.remove(HttpHeader) when the given value is null, otherwise behaves like HttpFields.Mutable.put(HttpField).
HttpFields.Mutable	put(HttpHeader header, HttpHeaderValue value)	This method behaves like HttpFields.Mutable.remove(HttpHeader) when the given value is null, otherwise behaves like HttpFields.Mutable.put(HttpField).
HttpFields.Mutable	remove(String name)	Removes all the fields with the given name.
HttpFields.Mutable	remove(EnumSet<HttpHeader> headers)	Removes all the fields with the given names.
HttpFields.Mutable	remove(HttpHeader name)	Removes all the fields with the given name.
int	size()
Stream<HttpField>	stream()
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, containsLast, get, get, get, getCSV, getCSV, getDateField, getDateField, getFieldNames, getFieldNamesCollection, getFields, getFields, getLast, getLongField, getLongField, getQualityCSV, getQualityCSV, getQualityCSV, getValues, getValuesList, getValuesList, isEqualTo

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

add, add, add, add, add, add, addCSV, addCSV, addDateField, ensureField, put, put, put, putDate, putDate

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

MutableHttpFields

public MutableHttpFields()

Deprecated, for removal: This API element is subject to removal in a future version.

Method Details

add

public HttpFields.Mutable add(HttpField field)

Description copied from interface: HttpFields.Mutable

Adds the given HttpField to this instance.

Specified by:

add in interface HttpFields.Mutable

Parameters:

field - the HttpField to add

Returns:

this instance

add

public HttpFields.Mutable add(HttpFields fields)

Description copied from interface: HttpFields.Mutable

Adds all the HttpFields of the given HttpFields to this instance.

Specified by:

add in interface HttpFields.Mutable

Parameters:

fields - the fields to add

Returns:

this instance

asImmutable

public HttpFields asImmutable()

Description copied from interface: HttpFields

Returns an immutable copy of this HttpFields instance.

Specified by:

asImmutable in interface HttpFields

Returns:

a new immutable copy of this HttpFields instance

clear

public HttpFields.Mutable clear()

Description copied from interface: HttpFields.Mutable

Removes all the fields from this instance.

Specified by:

clear in interface HttpFields.Mutable

Returns:

this instance

hashCode

public int hashCode()

Overrides:

hashCode in class Object

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

getField

public HttpField getField(HttpHeader header)

Description copied from interface: HttpFields

Returns the first HttpField with the given field name, or null if no such field is present.

Specified by:

getField in interface HttpFields

Parameters:

header - the field name to search for

Returns:

the first HttpField with the given field name, or null if no such field is present

getField

public HttpField getField(String name)

Description copied from interface: HttpFields

Returns the first HttpField with the given field name, or null if no such field is present.

The comparison of field name is case-insensitive via HttpField.is(String).

Specified by:

getField in interface HttpFields

Parameters:

name - the case-insensitive field name to search for

Returns:

the first HttpField with the given field name, or null if no such field is present

iterator

public Iterator<HttpField> iterator()

Specified by:

iterator in interface HttpFields

Specified by:

iterator in interface Iterable<HttpField>

listIterator

public ListIterator<HttpField> listIterator()

Specified by:

listIterator in interface HttpFields

Returns:

an iterator over the HttpFields in this HttpFields.

See Also:

• HttpFields.listIterator(int)

listIterator

public ListIterator<HttpField> listIterator(int index)

Specified by:

listIterator in interface HttpFields

Returns:

an iterator over the HttpFields in this HttpFields starting at the given index.

See Also:

• HttpFields.listIterator()

put

public HttpFields.Mutable put(HttpField field)

Description copied from interface: HttpFields.Mutable

Puts the given HttpField into this instance.

If a fields with the same name is present, the given field replaces it, and other existing fields with the same name are removed, so that only the given field will be present.

If a field with the same name is not present, the given field will be added.

Specified by:

put in interface HttpFields.Mutable

Parameters:

field - the field to put

Returns:

this instance

put

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

Description copied from interface: HttpFields.Mutable

This method behaves like HttpFields.Mutable.remove(String) when the given value is null, otherwise behaves like HttpFields.Mutable.put(HttpField).

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 removed

Returns:

this instance

put

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

Description copied from interface: HttpFields.Mutable

This method behaves like HttpFields.Mutable.remove(HttpHeader) when the given value is null, otherwise behaves like HttpFields.Mutable.put(HttpField).

Specified by:

put in interface HttpFields.Mutable

Parameters:

header - the name of the field

value - the value of the field; if null the field is removed

Returns:

this instance

put

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

Description copied from interface: HttpFields.Mutable

This method behaves like HttpFields.Mutable.remove(HttpHeader) when the given value is null, otherwise behaves like HttpFields.Mutable.put(HttpField).

Specified by:

put in interface HttpFields.Mutable

Parameters:

header - the name of the field

value - the value of the field; if null the field is removed

Returns:

this instance

computeField

public HttpFields.Mutable 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 parameter. 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 field name

computeFn - the compute function

Returns:

this instance

computeField

public HttpFields.Mutable computeField(String name,
 BiFunction<String,List<HttpField>,HttpField> computeFn)

Description copied from interface: HttpFields.Mutable

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

Specified by:

computeField in interface HttpFields.Mutable

Parameters:

name - the field name

computeFn - the compute function

Returns:

this instance

See Also:

• HttpFields.Mutable.computeField(HttpHeader, BiFunction)

computeField

public <T> HttpFields.Mutable 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

Removes all the fields with the given name.

Specified by:

remove in interface HttpFields.Mutable

Parameters:

name - the name of the fields to remove

Returns:

this instance

remove

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

Description copied from interface: HttpFields.Mutable

Removes all the fields with the given names.

Specified by:

remove in interface HttpFields.Mutable

Parameters:

headers - the names of the fields to remove

Returns:

this instance

remove

public HttpFields.Mutable remove(String name)

Description copied from interface: HttpFields.Mutable

Removes all the fields with the given name.

Specified by:

remove in interface HttpFields.Mutable

Parameters:

name - the name of the fields to remove

Returns:

this instance

size

public int size()

Specified by:

size in interface HttpFields

Returns:

the number of HttpFields in this instance

stream

public Stream<HttpField> stream()

Specified by:

stream in interface HttpFields

Returns:

a sequential stream of the HttpFields in this instance

toString

public String toString()

Overrides:

toString in class Object