Skip navigation links

com.oracle.sft.api
Interface CapabilityMessage

All Superinterfaces:

Message

public interface CapabilityMessage

extends Message

Represents CapabilityMessage in a QueryInteraction for the capability query and update exchange between participants.

IMConversation is created by the SFT internally for the incoming OPTIONS request/response

Upon receiving the incoming OPTIONS request, the CommunicationEvent.Type.QUERYING event is invoked on the CommunicationBean.

Upon receiving a response to an OPTIONS request, the CommunicationEvent.Type.QUERIED is invoked on the CommunicationBean. CommunicationBean can get an instance of CapabilityMessage via CommunicationContext.getMessage()

See Also:

QueryInteraction

Method Summary

void	consume(Capability capability) Consume this CapabilityMessage in the server and send the Capability back to the participant.
Capability	getAvailableCapabilities() Retrieve an instance of Capability that encapsulates the available capability of an endpoint.
Capability	getCapabilities() Retrieve an instance of Capability that encapsulates the capability of an endpoint.
String	getCapabilityOwner() Retrieve the owner of the capability.
String	getCommunication() Retrieve the name of communication in which capability query happens

Methods inherited from interface com.oracle.sft.api.Message

consume, getContent, getContentType, reject, send, send, send

Method Detail

getCapabilities

Capability getCapabilities()

Retrieve an instance of Capability that encapsulates the capability of an endpoint.

Returns:

An instance of Capability.

getAvailableCapabilities

Capability getAvailableCapabilities()

Retrieve an instance of Capability that encapsulates the available capability of an endpoint.

Returns:

An instance of Capability.

getCapabilityOwner

String getCapabilityOwner()

Retrieve the owner of the capability.

Returns:

A string denoting the capability owner.

consume

void consume(Capability capability)

Consume this CapabilityMessage in the server and send the Capability back to the participant.

Parameters:

capability - An instance of Capability

getCommunication

String getCommunication()

Retrieve the name of communication in which capability query happens

Returns:

Name of communication.

Skip navigation links