Skip navigation links

com.oracle.sft.xcap.client
Interface XCAPClient

public interface XCAPClient

Launch point for XCAP APIs. com.oracle.sft.api.CommunicationService.getXcapClient() can get an instance of XCAPClient.

Method Summary

XcapConnection	createConnection(XcapRoot xcapRoot) Creates a new XcapConnection.
<X extends XcapDocument> X	createDocument(XcapDocumentSelector selector, String contentType) Create an instance of XcapDocument which denote an XML document.
XcapDocumentSelector	createDocumentSelector(String auid, String xui, String documentName) Create a XcapDocumentSelector instance which denotes document selector.
XcapRequest	createRequest(XcapResource component, XcapRequest.Operation operation) Creates an XCAP request.
XcapRoot	createXcapRoot(String anXcapRoot) Provides an encapsulation of the XCAP Root part of the request URI.

Method Detail

createConnection

XcapConnection createConnection(XcapRoot xcapRoot)

Creates a new XcapConnection.

Parameters:

xcapRoot - The URI in which all XCAP resources exist.

Returns:

A XcapClient.

createRequest

XcapRequest createRequest(XcapResource component,
                          XcapRequest.Operation operation)

Creates an XCAP request.

Parameters:

component - component related to the request.

operation - operation to perform on the component

Returns:

request that can be send by an XcapClient.

createXcapRoot

XcapRoot createXcapRoot(String anXcapRoot)

Provides an encapsulation of the XCAP Root part of the request URI.

Parameters:

anXcapRoot - the XCAP Root part of the request URI. An example: https://www.zero-xdm.com:8080/services. The generic form is <protocol>://<host>:<port>[/<path>].

Returns:

encapsulation of the XCAP Root as provided by anXcapRoot argument.

createDocumentSelector

XcapDocumentSelector createDocumentSelector(String auid,
                                            String xui,
                                            String documentName)

Create a XcapDocumentSelector instance which denotes document selector. Document selector is a sequence of path segments, with each segment being separated by a "/", that identify the XML document within an XCAP root that is being selected.

Parameters:

auid - Application Unique ID

xui - XCAP User Identifier

documentName - Name of the XML document

Returns:

an XcapDocumentSelector instance of the auid, xui and documentName.

createDocument

<X extends XcapDocument> X createDocument(XcapDocumentSelector selector,
                                          String contentType)

Create an instance of XcapDocument which denote an XML document.

Parameters:

selector - an XCAP document selector

contentType - the content type of the XCAP document

Returns:

an instance of XcapDocument.

Skip navigation links