com.soa.message.script

Class Headers

java.lang.Object

com.soa.message.script.Headers

public class Headers
extends java.lang.Object

Holds transport headers for a message. This object is returned from Message.getTransportHeaders() as follows:

    headers = message.getTransportHeaders();
 

The headers in this collection are represented by the Header object. The following retrieves a header:

    header = headers.get("Authentication");
 

This collection of headers can be changed. It supports the addition, changing, and removing of headers. The following will add or change a header:

    headers.add("Content-Type", "application/xml");
 

The following will remove a header:

    headers.remove("Authentication");
 

Method Summary

Modifier and Type	Method and Description
void	add(java.lang.String name, java.util.Date value) Adds a date header.
void	add(java.lang.String name, java.lang.String value) Adds a header.
boolean	contains(java.lang.String name) Returns whether or not a header with the given name exists.
Header	get(java.lang.String name) Returns the Header object for the given header name, null if no header with the given name is present.
Header[]	getArray() Returns the headers as an array of Header.
Header	getDate(java.lang.String name) Returns the Header object for the given header name as a date, null if no header with the given name is present.
void	remove(java.lang.String name) Removes the headaer with the given name.

Methods inherited from class java.lang.Object

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

Method Detail

getArray

public Header[] getArray()

Returns the headers as an array of Header. Changes to the returned array are not reflected in this object.

Returns:

Header array.

get

public Header get(java.lang.String name)

Returns the Header object for the given header name, null if no header with the given name is present.

Parameters:

name - Name of the header to return. Name lookup is case-insensitive.

Returns:

Header, or null.

getDate

public Header getDate(java.lang.String name)

Returns the Header object for the given header name as a date, null if no header with the given name is present.

Parameters:

name - Name of the header to return. Name lookup is case-insensitive.

Returns:

Header, or null.

add

public void add(java.lang.String name,
                java.lang.String value)
         throws GException

Adds a header. This will override any existing header with the specified name.

Parameters:

name - The header name. Name lookup is case-insensitive.

value - The header value. This may include any parameters, and may be multi-valued with each value separated by a comma.

Throws:

GException - Thrown if the header could not be parsed.

add

public void add(java.lang.String name,
                java.util.Date value)
         throws GException

Adds a date header. This will override any existing header with the specified name.

Parameters:

name - The header name. Name lookup is case-insensitive.

value - The header value as a Date.

Throws:

GException - Thrown if the header could not be parsed.

remove

public void remove(java.lang.String name)

Removes the headaer with the given name.

Parameters:

name - The header name. Name lookup is case-insensitive.

contains

public boolean contains(java.lang.String name)

Returns whether or not a header with the given name exists.

Parameters:

name - The header name. Name lookup is case-insensitive.

Returns:

true if the header exists, false if not.