Skip navigation links

com.oracle.sft.api
Interface CommunicationService

public interface CommunicationService

This interface represents the Service Foundation Toolkit (SFT) runtime for a particular application. An instance of this type is injected into a CommunicationBean for each event. It can also be accessed by web applications from the HTTP session. Applications may use this interface to modify the runtime behavior of the SFT. It also serves as an application level service provider to the java classes.

See Also:

CommunicationBean, Communication

Field Summary

static String

NAME Name of the HTTP session attribute to retrieve an instance of CommunicationService.

Method Summary

Capability	createCapability() Create an instance of Capability
EndUserConfirmationData	createEndUserConfirmationData() create an instance of EndUserConfirmationData
ResourceListsFactory	createResourceListsFactory() Create an instance of ResourceListsFactory.
<C extends Communication> Collection<C>	findByInitiator(Class<C> type, String initiator) Search for all communication initiated by a particular user.
<C extends Communication> C	findByName(Class<C> type, String name) Search API for communication by name.
<C extends Communication> Collection<C>	findByParticipant(Class<C> type, String participantName) Search for all communication where a particular user is present.
<C extends Communication> Collection<C>	findCommunications(Class<C> type) Method that returns all the communications for that application depending on the type of communication,
CallbackHandler	getCallbackHandler() Retrieve the CallbackHandler instance set in this CommunicationService.
XCAPClient	getXcapClient() create an instance of XCAPClient
void	setAuthenticationCallbackHandler(CallbackHandler handler) Application would set the CallbackHandler using this method.
void	setDefaultDomainName(String domainName) Set the default domain name used by SFT.
void	setDomainProxy(String domainProxy) Set the domain proxy or S-CSCF used by SFT.
void	setXcapRoot(String xcapRoot) Set the XCAP Root used by SFT.

Field Detail

NAME

static final String NAME

Name of the HTTP session attribute to retrieve an instance of CommunicationService.

See Also:

Constant Field Values

Method Detail

findCommunications

<C extends Communication> Collection<C> findCommunications(Class<C> type)

Method that returns all the communications for that application depending on the type of communication,

Type Parameters:

C - Communication. Can be conversation, conference..

Parameters:

type - Type of the Communication class.

Returns:

list of communications.

findByName

<C extends Communication> C findByName(Class<C> type,
                                       String name)

Search API for communication by name.

Type Parameters:

C - communication

Parameters:

type - type of communication

name - name of the communication

Returns:

communication if found.

findByInitiator

<C extends Communication> Collection<C> findByInitiator(Class<C> type,
                                                        String initiator)

Search for all communication initiated by a particular user.

Type Parameters:

C - type of communication

Parameters:

type - communication class

initiator - Caller of the communication.

Returns:

collection of communicationm that matches the criteria.

findByParticipant

<C extends Communication> Collection<C> findByParticipant(Class<C> type,
                                                          String participantName)

Search for all communication where a particular user is present.

Type Parameters:

C - Communication

Parameters:

type - type of communication

participantName - name of the participant

Returns:

all communications that contain this participant.

setDefaultDomainName

void setDefaultDomainName(String domainName)

Set the default domain name used by SFT. Applications are expected to use this method to set the domain name, early enough to avoid unexpected behavior. This is equivalent to specifying the domain name using ServiceAttributes annotation.

Parameters:

domainName - Domain Name, eg: "example.com"

See Also:

ServiceAttributes

setDomainProxy

void setDomainProxy(String domainProxy)

Set the domain proxy or S-CSCF used by SFT. Applications are expected to use this method to set the proxy , early enough to avoid unexpected behavior. This is equivalent to specifying the domain proxy using ServiceAttributes annotation.

Parameters:

domainProxy - URI representing the proxy or S-CSCF, eg: <sip:example.cscf.net:5060>

See Also:

ServiceAttributes

setXcapRoot

void setXcapRoot(String xcapRoot)

Set the XCAP Root used by SFT. Applications are expected to use this method to set the XCAP Root, early enough to avoid unexpected behavior. This is equivalent to specifying the XCAP Root using ServiceAttributes annotation.

Parameters:

xcapRoot - XCAP Root that SFT uses, eg: http://example.xdms.net:8080/xcaproot

See Also:

ServiceAttributes

createResourceListsFactory

ResourceListsFactory createResourceListsFactory()

Create an instance of ResourceListsFactory.

Returns:

object factory instance.

getXcapClient

XCAPClient getXcapClient()

create an instance of XCAPClient

Returns:

An XCAPClient instance.

createCapability

Capability createCapability()

Create an instance of Capability

Returns:

Capability

createEndUserConfirmationData

EndUserConfirmationData createEndUserConfirmationData()

create an instance of EndUserConfirmationData

Returns:

An instance of EndUserConfirmationData

setAuthenticationCallbackHandler

void setAuthenticationCallbackHandler(CallbackHandler handler)

Application would set the CallbackHandler using this method. Whenever there is a challenge from the the user agent, that need to be handled (eg: from proxy), container would invoke this callback handler to receive the authentication information.

Parameters:

handler - An instance of the An instance of the CallbackHandler

See Also:

CallbackHandler

getCallbackHandler

CallbackHandler getCallbackHandler()

Retrieve the CallbackHandler instance set in this CommunicationService.

Returns:

CallbackHandler instance.

Skip navigation links