com.laserfiche.api.client.httphandlers

Interface Headers

All Known Implementing Classes:

HeadersImpl

public interface Headers

Represents a collection of HTTP headers.

Method Summary

Modifier and Type	Method and Description
void	append(String name, String value) Append the value of the header.
void	delete(String name) Remove the header under this name.
Collection<HeaderKeyValue>	entries() Returns a collection of header key value pairs.
String	get(String name) Returns the header value.
boolean	has(String name) Check if the header is set.
Set<String>	keys() Return all header names (that are set).
void	set(String name, String value) Set the header.
Collection<String>	values() Returns a collection of header values.

Method Detail

append

void append(String name,
            String value)

Append the value of the header. If there's existing header under the same name, both values are retained.

Parameters:

name - Name of the header.

value - Value of the header.

delete

void delete(String name)

Remove the header under this name.

Parameters:

name - Name of the header.

entries

Collection<HeaderKeyValue> entries()

Returns a collection of header key value pairs. If a header has multiple values, they are concatenated by a comma.

get

String get(String name)

Returns the header value. If a header has multiple values, they are concatenated by a comma.

Parameters:

name - Name of the header.

has

boolean has(String name)

Check if the header is set.

Parameters:

name - Name of the header.

Returns:

A boolean indicating whether the specified header has been set.

keys

Set<String> keys()

Return all header names (that are set).

set

void set(String name,
         String value)

Set the header.

Parameters:

name - Name of the header.

value - Value of the header.

values

Collection<String> values()

Returns a collection of header values. If a header has multiple values, they are concatenated by a comma.