Skip navigation links

com.oracle.sft.xcap.client
Interface XcapRequest

public interface XcapRequest

Represents an XCAP request. Responsibilities include:

• relate an XCAP resource to an XCAP operation.
• provide access to the headers of the XCAP request.

Nested Class Summary

static class

XcapRequest.Operation The XCAP method to be performed.

Method Summary

void	addHeader(String aHeaderName, List<String> aHeaderValues) Add one header with a list of values.
void	addHeader(String aHeaderName, String aHeaderValue) Add one header with only one value.
void	addHeaders(Map<String,List<String>> aHeaders) Add a set of headers.
Map<String,List<String>>	getHeaders() Returns an unmodifiable Map of headers for this request.
XcapRequest.Operation	getOperation() Get operation of this request.
XcapResource	getResource() Get XCAP resource of this request.
void	removeHeader(String aHeaderName) Remove a header whose name is the given name.

Method Detail

getResource

XcapResource getResource()

Get XCAP resource of this request.

Returns:

The component on which the operation is requested.

getOperation

XcapRequest.Operation getOperation()

Get operation of this request.

Returns:

The requested operation.

getHeaders

Map<String,List<String>> getHeaders()

Returns an unmodifiable Map of headers for this request. The Map keys are Strings that represent the request-header field names. Each Map value is a unmodifiable List of Strings that represents the corresponding header field values.

Returns:

a map, the key of the map is name of a header, and the value is a list of values of the header.

addHeaders

void addHeaders(Map<String,List<String>> aHeaders)

Add a set of headers.

Parameters:

aHeaders - a map whose key is name of a header and value is a list of values of the header.

addHeader

void addHeader(String aHeaderName,
               List<String> aHeaderValues)

Add one header with a list of values.

Parameters:

aHeaderName - name of the header

aHeaderValues - a list of values of the header

addHeader

void addHeader(String aHeaderName,
               String aHeaderValue)

Add one header with only one value.

Parameters:

aHeaderName - name of the header

aHeaderValue - value of the header

removeHeader

void removeHeader(String aHeaderName)

Remove a header whose name is the given name.

Parameters:

aHeaderName - name of the header to be removed

Skip navigation links