org.eclipse.jetty.http

Class HttpFields

java.lang.Object

org.eclipse.jetty.http.HttpFields

All Implemented Interfaces:

Iterable<HttpField>

Direct Known Subclasses:

HttpTester.Message

public class HttpFields
extends Object
implements Iterable<HttpField>

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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	__separators

Constructor Summary

Constructors

Constructor and Description
HttpFields() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(HttpField field)
void	add(HttpFields fields) Add fields from another HttpFields instance.
void	add(HttpHeader header, HttpHeaderValue value)
void	add(HttpHeader header, String value) Add to or set a field.
void	add(String name, String value) Add to or set a field.
void	addDateField(String name, long date) Sets the value of a date field.
void	clear() Clear the header.
boolean	contains(HttpHeader header)
boolean	contains(HttpHeader header, String value)
boolean	contains(String name, String value)
boolean	containsKey(String name)
String	get(HttpHeader header)
String	get(String header)
long	getDateField(String name) Get a header as a date value.
HttpField	getField(HttpHeader header)
HttpField	getField(int i) Get a Field by index.
HttpField	getField(String name)
Enumeration<String>	getFieldNames() Get enumeration of header _names.
Collection<String>	getFieldNamesCollection() Get Collection of header names.
long	getLongField(String name) Get a header as an long value.
static Float	getQuality(String value)
String	getStringField(HttpHeader header)
String	getStringField(String name)
Enumeration<String>	getValues(String name) Get multi headers
Enumeration<String>	getValues(String name, String separators) Get multi field values with separator.
List<String>	getValuesList(String name) Get multi headers
Iterator<HttpField>	iterator()
void	put(HttpField field)
void	put(HttpHeader header, HttpHeaderValue value)
void	put(HttpHeader header, String value) Set a field.
void	put(String name, List<String> list) Set a field.
void	put(String name, String value) Set a field.
void	putDateField(HttpHeader name, long date) Sets the value of a date field.
void	putDateField(String name, long date) Sets the value of a date field.
void	putLongField(HttpHeader name, long value) Sets the value of an long field.
void	putLongField(String name, long value) Sets the value of an long field.
static List<String>	qualityList(Enumeration<String> e) List values in quality order.
HttpField	remove(HttpHeader name) Remove a field.
HttpField	remove(String name) Remove a field.
int	size()
String	toString()
static String	valueParameters(String value, Map<String,String> parameters) Get field value parameters.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

__separators

public static final String __separators

See Also:

Constant Field Values

Constructor Detail

HttpFields

public HttpFields()

Constructor.

Method Detail

getFieldNamesCollection

public Collection<String> getFieldNamesCollection()

Get Collection of header names.

getFieldNames

public Enumeration<String> getFieldNames()

Get enumeration of header _names. Returns an enumeration of strings representing the header _names for this request.

size

public int size()

getField

public HttpField getField(int i)

Get a Field by index.

Returns:

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

iterator

public Iterator<HttpField> iterator()

Specified by:

iterator in interface Iterable<HttpField>

getField

public HttpField getField(HttpHeader header)

getField

public HttpField getField(String name)

contains

public boolean contains(HttpHeader header,
               String value)

contains

public boolean contains(String name,
               String value)

contains

public boolean contains(HttpHeader header)

containsKey

public boolean containsKey(String name)

getStringField

public String getStringField(HttpHeader header)

get

public String get(HttpHeader header)

get

public String get(String header)

getStringField

public String getStringField(String name)

Parameters:

name - the case-insensitive field name

Returns:

the value of a field, or null if not found. For multiple fields of the same name, only the first is returned.

getValuesList

public List<String> getValuesList(String name)

Get multi headers

Parameters:

name - the case-insensitive field name

Returns:

List the values

getValues

public Enumeration<String> getValues(String name)

Get multi headers

Parameters:

name - the case-insensitive field name

Returns:

Enumeration of the values

getValues

public Enumeration<String> getValues(String name,
                            String separators)

Get multi field values with separator. The multiple values can be represented as separate headers of the same name, or by a single header using the separator(s), or a combination of both. Separators may be quoted.

Parameters:

name - the case-insensitive field name

separators - String of separators.

Returns:

Enumeration of the values, or null if no such header.

put

public void put(HttpField field)

put

public void put(String name,
       String value)

Set a field.

Parameters:

name - the name of the field

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

put

public void put(HttpHeader header,
       HttpHeaderValue value)

put

public void put(HttpHeader header,
       String value)

Set a field.

Parameters:

header - the header name of the field

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

put

public void put(String name,
       List<String> list)

Set a field.

Parameters:

name - the name of the field

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

add

public void add(String name,
       String value)
         throws IllegalArgumentException

Add to or set a field. If the field is allowed to have multiple values, add will add multiple headers of the same name.

Parameters:

name - the name of the field

value - the value of the field.

Throws:

IllegalArgumentException - If the name is a single valued field and already has a value.

add

public void add(HttpHeader header,
       HttpHeaderValue value)
         throws IllegalArgumentException

Throws:

IllegalArgumentException

add

public void add(HttpHeader header,
       String value)
         throws IllegalArgumentException

Add to or set a field. If the field is allowed to have multiple values, add will add multiple headers of the same name.

Parameters:

header - the header

value - the value of the field.

Throws:

IllegalArgumentException

remove

public HttpField remove(HttpHeader name)

Remove a field.

Parameters:

name - the field to remove

remove

public HttpField remove(String name)

Remove a field.

Parameters:

name - the field to remove

getLongField

public long getLongField(String name)
                  throws NumberFormatException

Get a header as an long value. Returns the value of an integer field or -1 if not found. The case of the field name is ignored.

Parameters:

name - the case-insensitive field name

Throws:

NumberFormatException - If bad long found

getDateField

public long getDateField(String name)

Get a header as a date value. Returns the value of a date field, or -1 if not found. The case of the field name is ignored.

Parameters:

name - the case-insensitive field name

putLongField

public void putLongField(HttpHeader name,
                long value)

Sets the value of an long field.

Parameters:

name - the field name

value - the field long value

putLongField

public void putLongField(String name,
                long value)

Sets the value of an long field.

Parameters:

name - the field name

value - the field long value

putDateField

public void putDateField(HttpHeader name,
                long date)

Sets the value of a date field.

Parameters:

name - the field name

date - the field date value

putDateField

public void putDateField(String name,
                long date)

Sets the value of a date field.

Parameters:

name - the field name

date - the field date value

addDateField

public void addDateField(String name,
                long date)

Sets the value of a date field.

Parameters:

name - the field name

date - the field date value

toString

public String toString()

Overrides:

toString in class Object

clear

public void clear()

Clear the header.

add

public void add(HttpField field)

add

public void add(HttpFields fields)

Add fields from another HttpFields instance. Single valued fields are replaced, while all others are added.

Parameters:

fields - the fields to add

valueParameters

public static String valueParameters(String value,
                     Map<String,String> parameters)

Get field value parameters. Some field values can have parameters. This method separates the value from the parameters and optionally populates a map with the parameters. For example:

 FieldName : Value ; param1=val1 ; param2=val2

 

Parameters:

value - The Field value, possibly with parameteres.

parameters - A map to populate with the parameters, or null

Returns:

The value.

getQuality

public static Float getQuality(String value)

qualityList

public static List<String> qualityList(Enumeration<String> e)

List values in quality order.

Parameters:

e - Enumeration of values with quality parameters

Returns:

values in quality order.