Skip navigation links

Package com.oracle.sft.api

The SFT base communication API.

See:
Description

Interface Summary

ActivityParticipant	Represents the activity of a Participant in a communication.
Capability	Represents the RCS-e capability of an endpoint in capability query/update.
CapabilityMessage	Represents CapabilityMessage in a QueryInteraction for the capability query and update exchange between participants.
CommonPresenceInstantMessage	Represents the Common Presence and Instant Messaging (CPIM) message in an IMConversation or IMConference.
Communication	Represents a communication session.
CommunicationContext<C extends Communication,P extends Participant,M extends Message>	Represents the context of a given Communication event.
CommunicationService	This interface represents the Service Foundation Toolkit (SFT) runtime for a particular application.
CommunicationSession	Instance of a CommunicationSession object.
Conference	Represents a Conference.
ConferenceParticipantExtension	Represents an extension applicable for Participant that joined in Conference or MSRPConference.
ContextElement	This is an element of the Context.
Conversation	Represents a two party call.
ConversationParticipantExtension	ConversationParticipantExtension is an interface to define some abilities which are applicable for Participant instance within a Conversation only.
DispositionContext	Represents the data that is carried in a CommonPresenceInstantMessage for instant messaging disposition request or disposition notification.
DispositionNotification	Represents the data that carried in a instant messaging disposition notification message
DtmfSignal	Represents DTMF Signal.
EndUserConfirmationData	Represents the Data Structure for End User Confirmation Request, End User Confirmation Response, End User Confirmation Acknowledgement in End User Confirmation exchange ,
EndUserConfirmationDisplay	Represent the displayed Subject and Text on an end user client during End User Confirmation exchange
EndUserConfirmationMessage	Represents End User Confirmation Message in an IMConversation between participants.
Focus	Focus is a special Participant in a Conference, application can use it to initialize the media server mixer setting using JSR309 API.
IMConference	Represents a multi-party pager-mode instant messaging.
IMConversation	Represents a two party IM conversation.
Interaction	A communication where more than one Participant interact with each other.
MediaParticipant	Represents a MediaParticipant.
MediaPartner	Represents a MediaPartner.
Message	Message represents the actual information passed between parties involved in the communication.
MessageIndication	Represents the Message Indication (like typing) in a chat between participants.
MessageObservation	This interface encapsulates Message Observation UserActivity.
MessageSummary	This interface encapsulates the NOTIFY Bodies for MWI notification.
MessageSummaryExtensionHeader	This interface encapsulates the Message Summary Extension Header for MWI Event Package.
MessageSummaryLine	This interface encapsulates the Message Summary Line for MWI Event Package .
MSRPConference	A interaction object that can represents 2 different type of MSRP session:
MSRPConversation	An interaction object that represents the session-mode instant messaging or chat session among two participants.
MSRPPlayer	A participant that is used to send large files from container to the other participants in a MSRP communication.
MSRPRecorder	A participant that is used to save the large file and/or to record the message history in a MSRP communication.
Participant	Represents a participant in the conversation.
ParticipantExtension	ParticipantExtension is an parent interface to define participant's ability in some scenarios.
PhoneNumber	This interface provides an easy way to access the telephone number information of the user.
Player	Represents a Player object.
ProtocolMessage	Represents the ProtocolMessage (actual SIP Message).
QueryInteraction	Represents a QueryInteraction for some message exchange between two user agents via AS , such as SIP OPTIONS It extends a Interaction.
Recorder	Represents a Recorder object.
ResourceListsMessage	Represents the ProtocolMessage (actual SIP Message).
RestAuthorizationAdapter	When provide a customized security policy Java class to REST API module, the Java class must implement this interface.
RestAuthorizeData	Data used to authorize the operation calling a REST API.
TextMessage	Represents the TextMessage in an IMConversation between participants.
UserActivity	This interface encapsulates the User Activity.
UserParticipant	Represents a user participant in the communication.

Class Summary

Agent<T>	Agent objects encapsulate application logic related to Communication artifacts such as Communication and Participant.
AuthenticationCallback	An instance of AuthenticationCallback will be passed to the CallbackHandler that is set by the application in the CommunicationService when an authentication challenge response is sent to SFT.
ContextListener	The SFT context listener, application need configure it in sip.xml and web.xml (only needed if application contains web application and require use SFT in it.) as following:
MessageRecipient	Represents MessageRecipient specified in the resource-list of a message.
ServiceLocator	Class to lookup CommunicationSession and CommunicationService from any Java EE Module.
Servlet	The SFT sip servlet, application need configure it in sip.xml as following:

Enum Summary

AuthenticationCallback.ChallengeType	Type of Challenge for which the CallbackHandler is invoked.
Capability.Feature	Types of 3GPP and RCS-e features that are negotiated during the capability query-and-update process.
CommonPresenceInstantMessage.Headers	Common CPIM Headers
Communication.State	Different Communication States.
DispositionContext.RequestType	Disposition Request Type
DispositionNotification.Status	disposition status
DispositionNotification.Type	disposition notification type
EndUserConfirmationData.Behaviour	to determine the behaviour the receiving handset in End User Confirmation Request
EndUserConfirmationData.UserAction	The action of the ender user in End User Confirmation Response
EndUserConfirmationData.UserStatus	The statue of the ender user in End User Confirmation Acknowledgement
MediaPartner.MediaOperation
MessageContextClass	The coding of the message types in the message-context-class values which
MessageIndication.State	The State in the MessageIndication.
MessageRecipient.CopyControl	Represents various CopyControl options for a MessageRecipient.
MSRPSessionType	The session type for MSRP communication.
Reason	Reason for rejecting a participant.
RestAuthorizationAdapter.HTTPMethod	The HTTP method used by REST APIs.
RuleSetType	Indicates the type of rule set.
Warning	Warn-text recommended by RFC3261 for Warning header.

Exception Summary

CommunicationException

Base exception class for handling failures in the communication.

Annotation Types Summary

Context

Context annotation.

Package com.oracle.sft.api Description

The SFT base communication API.

Skip navigation links