net.java.sip.communicator.impl.protocol.sip.xcap
Interface ResourceListsClient

All Known Subinterfaces:

XCapClient

All Known Implementing Classes:

XCapClientImpl

public interface ResourceListsClient

XCAP resource-lists client interface.

Compliant with rfc4825, rfc4826

Author:

Grigorii Balutsel

Field Summary

static String	DOCUMENT_FORMAT Resource-lists uri format.
static String	ELEMENT_CONTENT_TYPE Resource-lists content type.
static String	NAMESPACE Resource-lists namespace.
static String	RESOURCE_LISTS_CONTENT_TYPE Resource-lists content type.

Method Summary

void	deleteResourceLists() Deletes the resource-lists from the server.
ListType	getList(String anchor) Gets the resource-lists from the server.
ResourceListsType	getResourceLists() Gets the resource-lists from the server.
void	putResourceLists(ResourceListsType resourceLists) Puts the resource-lists to the server.

Field Detail

DOCUMENT_FORMAT

static final String DOCUMENT_FORMAT

Resource-lists uri format.

See Also:

Constant Field Values

RESOURCE_LISTS_CONTENT_TYPE

static final String RESOURCE_LISTS_CONTENT_TYPE

Resource-lists content type.

See Also:

Constant Field Values

ELEMENT_CONTENT_TYPE

static final String ELEMENT_CONTENT_TYPE

Resource-lists content type.

See Also:

Constant Field Values

NAMESPACE

static final String NAMESPACE

Resource-lists namespace.

See Also:

Constant Field Values

Method Detail

putResourceLists

void putResourceLists(ResourceListsType resourceLists)
                      throws XCapException

Puts the resource-lists to the server.

Parameters:

resourceLists - the resource-lists to be saved on the server.

Throws:

IllegalStateException - if the user has not been connected.

XCapException - if there is some error during operation.

getResourceLists

ResourceListsType getResourceLists()
                                   throws XCapException

Gets the resource-lists from the server.

Returns:

the resource-lists.

Throws:

IllegalStateException - if the user has not been connected.

XCapException - if there is some error during operation.

deleteResourceLists

void deleteResourceLists()
                         throws XCapException

Deletes the resource-lists from the server.

Throws:

IllegalStateException - if the user has not been connected.

XCapException - if there is some error during operation.

getList

ListType getList(String anchor)
                 throws XCapException

Gets the resource-lists from the server.

Parameters:

anchor - reference to the list.

Returns:

the list.

Throws:

IllegalStateException - if the user has not been connected.

XCapException - if there is some error during operation.