com.bea.wli.sb.sources

Interface Headers

public interface Headers

This class is used for managing headers (specifically RFC822-style headers). It is used by various Sources such as MimeSource and MessageContextSource. The class is modeled very closely after the InternetHeaders and MimeHeaders classes (from JavaMail and SAAJ APIs respectively), as all three are essentially used for managing RFC822/MIME headers. All three classes are nearly identical in function and even API signatures. However, the JavaMail and SAAJ implementations are somewhat dated, relying on such features as Enumeration and the always-synchronized Vector class. Also, there are some bugs in MimeHeaders' matching iterator when non-standard iterating or removal patterns are used. These bugs can result in headers being retrieved by the iterator twice or the wrong headers being deleted. Lastly, by designing this Headers class as an interface, it makes it possible to create thin wrappers around both MimeHeaders and InternetHeaders, allowing them to be used more interchangeably and without having to copy data between Headers and the other two representations.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Headers.Header Represents an RFC822 header.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONTENT_DESCRIPTION
static java.lang.String	CONTENT_DISPOSITION
static java.lang.String	CONTENT_ID
static java.lang.String	CONTENT_LENGTH
static java.lang.String	CONTENT_LOCATION
static java.lang.String	CONTENT_TRANSFER_ENCODING
static java.lang.String	CONTENT_TYPE
static java.lang.String	CONTENT_TYPE_PARAMETER_ACTION
static java.lang.String	CONTENT_TYPE_PARAMETER_BOUNDARY
static java.lang.String	CONTENT_TYPE_PARAMETER_CHARSET
static java.lang.String	CONTENT_TYPE_PARAMETER_START
static java.lang.String	CONTENT_TYPE_PARAMETER_START_INFO
static java.lang.String	CONTENT_TYPE_PARAMETER_TYPE
static java.lang.String	DEFAULT_MIME_CHARSET
static java.lang.String	MIME_MULTIPART
static java.lang.String	MIME_MULTIPART_ALTERNATIVE
static java.lang.String	MIME_MULTIPART_FORMDATA
static java.lang.String	MIME_MULTIPART_MIXED
static java.lang.String	MIME_MULTIPART_RELATED
static java.lang.String	MIME_VERSION
static java.lang.String	RFC822_HEADER_CHARSET
static java.lang.String	TRANSFER_ENCODING

Method Summary

Methods

Modifier and Type	Method and Description
void	addHeader(java.lang.String name, java.lang.String value)
java.util.Iterator<Headers.Header>	getAllHeaders()
java.lang.String[]	getHeader(java.lang.String name)
java.lang.String	getHeader(java.lang.String name, java.lang.String delim)
java.util.Iterator<Headers.Header>	getMatchingHeaders(java.lang.String[] strings)
java.util.Iterator<Headers.Header>	getNonMatchingHeaders(java.lang.String[] strings)
void	removeAllHeaders()
void	removeHeader(java.lang.String s)
void	setHeader(java.lang.String name, java.lang.String value)

Field Detail

DEFAULT_MIME_CHARSET

static final java.lang.String DEFAULT_MIME_CHARSET

See Also:

Constant Field Values

RFC822_HEADER_CHARSET

static final java.lang.String RFC822_HEADER_CHARSET

See Also:

Constant Field Values

CONTENT_ID

static final java.lang.String CONTENT_ID

See Also:

Constant Field Values

CONTENT_DESCRIPTION

static final java.lang.String CONTENT_DESCRIPTION

See Also:

Constant Field Values

CONTENT_DISPOSITION

static final java.lang.String CONTENT_DISPOSITION

See Also:

Constant Field Values

CONTENT_LENGTH

static final java.lang.String CONTENT_LENGTH

See Also:

Constant Field Values

CONTENT_LOCATION

static final java.lang.String CONTENT_LOCATION

See Also:

Constant Field Values

CONTENT_TRANSFER_ENCODING

static final java.lang.String CONTENT_TRANSFER_ENCODING

See Also:

Constant Field Values

CONTENT_TYPE

static final java.lang.String CONTENT_TYPE

See Also:

Constant Field Values

TRANSFER_ENCODING

static final java.lang.String TRANSFER_ENCODING

See Also:

Constant Field Values

CONTENT_TYPE_PARAMETER_CHARSET

static final java.lang.String CONTENT_TYPE_PARAMETER_CHARSET

See Also:

Constant Field Values

CONTENT_TYPE_PARAMETER_BOUNDARY

static final java.lang.String CONTENT_TYPE_PARAMETER_BOUNDARY

See Also:

Constant Field Values

CONTENT_TYPE_PARAMETER_START

static final java.lang.String CONTENT_TYPE_PARAMETER_START

See Also:

Constant Field Values

CONTENT_TYPE_PARAMETER_START_INFO

static final java.lang.String CONTENT_TYPE_PARAMETER_START_INFO

See Also:

Constant Field Values

CONTENT_TYPE_PARAMETER_TYPE

static final java.lang.String CONTENT_TYPE_PARAMETER_TYPE

See Also:

Constant Field Values

CONTENT_TYPE_PARAMETER_ACTION

static final java.lang.String CONTENT_TYPE_PARAMETER_ACTION

See Also:

Constant Field Values

MIME_VERSION

static final java.lang.String MIME_VERSION

See Also:

Constant Field Values

MIME_MULTIPART

static final java.lang.String MIME_MULTIPART

See Also:

Constant Field Values

MIME_MULTIPART_RELATED

static final java.lang.String MIME_MULTIPART_RELATED

See Also:

Constant Field Values

MIME_MULTIPART_FORMDATA

static final java.lang.String MIME_MULTIPART_FORMDATA

See Also:

Constant Field Values

MIME_MULTIPART_MIXED

static final java.lang.String MIME_MULTIPART_MIXED

See Also:

Constant Field Values

MIME_MULTIPART_ALTERNATIVE

static final java.lang.String MIME_MULTIPART_ALTERNATIVE

See Also:

Constant Field Values

Method Detail

setHeader

void setHeader(java.lang.String name,
             java.lang.String value)

addHeader

void addHeader(java.lang.String name,
             java.lang.String value)

removeHeader

void removeHeader(java.lang.String s)

removeAllHeaders

void removeAllHeaders()

getHeader

java.lang.String getHeader(java.lang.String name,
                         java.lang.String delim)

getHeader

java.lang.String[] getHeader(java.lang.String name)

getAllHeaders

java.util.Iterator<Headers.Header> getAllHeaders()

getMatchingHeaders

java.util.Iterator<Headers.Header> getMatchingHeaders(java.lang.String[] strings)

getNonMatchingHeaders

java.util.Iterator<Headers.Header> getNonMatchingHeaders(java.lang.String[] strings)