A B C D E F G H I L M N O P R S T U V W

A

addActivities(String[]) - Method in interface org.glassfish.cafe.api.presence.PersonInformation

Adds a number of new activities.

addActivity(String) - Method in interface org.glassfish.cafe.api.presence.PersonInformation

Adds a new activity.

addAgent(String, Agent<T>) - Method in interface org.glassfish.cafe.api.Communication

Set an agent instance in the communication.

addAgent(String, Agent<T>) - Method in interface org.glassfish.cafe.api.Participant

Set an agent instance in the communication.

addAgent(String, Agent<T>) - Method in interface org.glassfish.cafe.api.UserProcedure

Set an agent instance in the communication.

addCivicAddress(String, String) - Method in interface org.glassfish.cafe.api.presence.CivicLocationInfo

Adds a civic address element.

addElement(Element) - Method in interface org.glassfish.cafe.api.presence.PresenceDocument

Adds Element to your Presence Document.

addElement(Element) - Method in interface org.glassfish.cafe.api.presence.PresenceInformation

Adds an Element to your Presence Information.

addElement(Element) - Method in interface org.glassfish.cafe.api.presence.PresenceWatcherFilterSet

Adds Element to your filter

addElement(Element) - Method in interface org.glassfish.cafe.api.presence.WatcherInfoSubscriberFilter

Adds Element to your filter

ADDITIONAL_LOCATION_INFO - Static variable in interface org.glassfish.cafe.api.presence.CivicLocationInfo

addMood(String) - Method in interface org.glassfish.cafe.api.presence.PersonInformation

Adds a new mood.

addMoods(String[]) - Method in interface org.glassfish.cafe.api.presence.PersonInformation

Adds a number of new moods.

addParticipant(String) - Method in interface org.glassfish.cafe.api.Communication

Add a UserParticipant to the communication.

addParticipant(Participant) - Method in interface org.glassfish.cafe.api.Communication

Add a participant to the communication.

addParticipant(Class<P>, String) - Method in interface org.glassfish.cafe.api.Communication

Add a participant to the Communication.

addParticipant(Class<P>, String, Joinable) - Method in interface org.glassfish.cafe.api.Communication

Add a participant that can be added to the communication with a specific Joinable.

addRecipient(MessageRecipient) - Method in interface org.glassfish.cafe.api.TextMessage

Add Recipient to the Message resource-list

addUserToBlackList() - Method in interface org.glassfish.cafe.api.presence.WatcherInfo

Arranges the watcher to be added, by administrative means, to the white list of the WatcherInfoSubscriber.

addUserToWhiteList() - Method in interface org.glassfish.cafe.api.presence.WatcherInfo

Arranges the watcher to be added, by administrative means, to the white list of the WatcherInfoSubscriber.

Agent<T> - Class in org.glassfish.cafe.api

Agent objects encapsulate application logic related to a Communication artifact like Communication, Participant etc.

Agent() - Constructor for class org.glassfish.cafe.api.Agent

ASSERTION_MODE_REQUIRED - Static variable in annotation type org.glassfish.cafe.api.security.LoginConfig

ASSERTION_MODE_SUPPORTED - Static variable in annotation type org.glassfish.cafe.api.security.LoginConfig

AssertionScheme - Enum in org.glassfish.cafe.api.security

Enumerated values for Asserted authentication as per RFC 3325,4474

B

buildCommunication(String, Communication, Object...) - Method in interface org.glassfish.cafe.spi.CafeObjectBuilder

Build a Communication object from an already existing Communication.

buildCommunication(String, Participant, Object...) - Method in interface org.glassfish.cafe.spi.CafeObjectBuilder

Build a Communication object using the specified initiator.

buildCommunication(String, ProtocolMessage) - Method in interface org.glassfish.cafe.spi.CafeObjectBuilder

Build a Communication object from an incoming ProtocolMessage.

buildParticipant(String, Joinable) - Method in interface org.glassfish.cafe.spi.CafeObjectBuilder

Build a Participant object with the specified name.

buildProtocolMessageHandler() - Method in interface org.glassfish.cafe.spi.CafeObjectBuilder

Return a ProtocolMessageHandler object that encapsulate the Communication or UserProcedure.

buildUserProcedure(String, Object...) - Method in interface org.glassfish.cafe.spi.CafeObjectBuilder

Build a UserProcedure object with the specified id.

C

CafeModule - Interface in org.glassfish.cafe.spi

Represents a module in CAFE framework.

CafeModuleRuntime - Interface in org.glassfish.cafe.spi

Represents CAFE framework runtime object for a particular Java EE application.

CafeObjectBuilder<O> - Interface in org.glassfish.cafe.spi

CAFE framework uses an instance of this class returned by CafeModule for creating the objects like Communications,UserProcedures or Participants.

CITY - Static variable in interface org.glassfish.cafe.api.presence.CivicLocationInfo

CITY_DIVISION - Static variable in interface org.glassfish.cafe.api.presence.CivicLocationInfo

CivicLocationInfo - Interface in org.glassfish.cafe.api.presence

The CivicLocationInfo component models the civic location for a person or a device.

cleanup() - Method in interface org.glassfish.cafe.spi.CafeModule

Framework executes this method, so that any internal housekeeping of the cafeModule can be released.

clearActivities() - Method in interface org.glassfish.cafe.api.presence.PersonInformation

Removes the set of activities.

clearMoods() - Method in interface org.glassfish.cafe.api.presence.PersonInformation

Removes the set of activities.

clone() - Method in interface org.glassfish.cafe.api.CommunicationContext

Return a copy of the communication context that is thread safe.

Communication - Interface in org.glassfish.cafe.api

Represents a communication.

Communication.State - Enum in org.glassfish.cafe.api

Different Communication States.

CommunicationBean - Annotation Type in org.glassfish.cafe.api.bean

Indicate that the annotated class is a POJO listening to Communication Events or Participant Events.

CommunicationContext<C extends Communication,P extends Participant,M extends Message> - Interface in org.glassfish.cafe.api

Represents the context related to a particular Communication Event.

CommunicationEvent - Annotation Type in org.glassfish.cafe.api.bean

Specifies Events pertaining to a Communication.

CommunicationEvent.Type - Enum in org.glassfish.cafe.api.bean

Type or classification of a CommunicationEvent.

CommunicationException - Exception in org.glassfish.cafe.api

Base exception class for handling failures in the communication.

CommunicationException(String) - Constructor for exception org.glassfish.cafe.api.CommunicationException

Creates a CommunicationException with the specified message.

CommunicationException(Throwable) - Constructor for exception org.glassfish.cafe.api.CommunicationException

Creates a CommunicationException wrapping another Throwable.

CommunicationException(String, Throwable) - Constructor for exception org.glassfish.cafe.api.CommunicationException

Creates a CommunicationException wrapping another Throwable, but with a specific message.

CommunicationService - Interface in org.glassfish.cafe.api

An utility class to create objects that are not related to a CommunicationSession, for example groups.

CommunicationSession - Interface in org.glassfish.cafe.api

Instance of a CommunicationSession object.

Conference - Interface in org.glassfish.cafe.api

Represents a Conference.

consume() - Method in interface org.glassfish.cafe.api.Message

Stop processing the message further and consume the message.

Context - Annotation Type in org.glassfish.cafe.api

Context annotation.

Conversation - Interface in org.glassfish.cafe.api

Represents a two party call.

COUNTRY_CODE - Static variable in interface org.glassfish.cafe.api.presence.CivicLocationInfo

COUNTY - Static variable in interface org.glassfish.cafe.api.presence.CivicLocationInfo

createBuilder(Class<O>, CommunicationSession) - Method in interface org.glassfish.cafe.spi.CafeModule

Creates an Object builder for a specified type for a particular CommunicationSession.

createCivicLocationInfo() - Method in interface org.glassfish.cafe.api.presence.GeographicalLocation

Creates a CivicLocationInfo and adds it to the ImsGeographicalLocationInfo.

createCommunication(Class<C>, String, Participant, Object...) - Method in interface org.glassfish.cafe.api.CommunicationSession

A generic method to create any type of communication.

createCommunication(Class<C>, String, Communication, Object...) - Method in interface org.glassfish.cafe.api.CommunicationSession

A generic method to create any type of communication from another communication.

createConference() - Method in interface org.glassfish.cafe.api.CommunicationSession

Create a conference with a specified name.

createConference(String) - Method in interface org.glassfish.cafe.api.CommunicationSession

Create a conference with a specified name.

createConference(String, Conversation) - Method in interface org.glassfish.cafe.api.CommunicationSession

Create a conference from the Conversation.

createConversation(String, String) - Method in interface org.glassfish.cafe.api.CommunicationSession

Create a Conversation between the initiator and another party.

createConversation(String) - Method in interface org.glassfish.cafe.api.CommunicationSession

Create a Conversation between the initiator and another party.

createConversation(Participant, String) - Method in interface org.glassfish.cafe.api.CommunicationSession

Create a Conversation between the initiator and another party.

createConversation(Participant) - Method in interface org.glassfish.cafe.api.CommunicationSession

Create a Conversation between the initiator and another party.

createDocument(String) - Method in interface org.glassfish.cafe.api.PresenceSource

Overwrites the associated presence document with a presence document based on the content of an existing presence document.

createDomainFilter(String) - Method in interface org.glassfish.cafe.api.presence.PresenceWatcherFilterSet

Creates an instance of an PresenceWatcherFilter and associate it immediately to this current set.

createEmptyDocument() - Method in interface org.glassfish.cafe.api.PresenceSource

Overwrites the associated presence document with an empty one based on the user ID of this Presence Source.

createFilter() - Method in interface org.glassfish.cafe.api.presence.PresenceWatcherFilterSet

Creates an instance of an PresenceWatcherFilter and associate it immediately to this current set.

createFilter(String) - Method in interface org.glassfish.cafe.api.presence.PresenceWatcherFilterSet

Creates an instance of an PresenceWatcherFilter and associate it immediately to this current set.

createFilter() - Method in interface org.glassfish.cafe.api.WatcherInfoSubscriber

Creates a filter for this WatcherInfoSubscriber.

createFilterSet() - Method in interface org.glassfish.cafe.api.PresenceWatcher

Creates a Filter Set instance associated with this watcher.

createGeographicalLocation() - Method in interface org.glassfish.cafe.api.presence.PersonInformation

Creates a GeographicalLocation and adds it to this PersonInformation.

createGeographicalLocation() - Method in interface org.glassfish.cafe.api.presence.ServiceInformation

Creates a GeographicalLocation and adds it to this ServiceInformation.

createGroup(String, String, Map<String, String>) - Method in interface org.glassfish.cafe.api.CommunicationService

Creates a group for a user with a number of buddies.

createGroup(String, String) - Method in interface org.glassfish.cafe.api.CommunicationService

Creates an empty group for a user.

createIMConference() - Method in interface org.glassfish.cafe.api.CommunicationSession

Create an IMConference.

createIMConference(String) - Method in interface org.glassfish.cafe.api.CommunicationSession

Create an IMConference with a specified name.

createIMConference(String, IMConversation) - Method in interface org.glassfish.cafe.api.CommunicationSession

Create an IMConference from the IMConversation.

createIMConversation(String, String) - Method in interface org.glassfish.cafe.api.CommunicationSession

Create an IMConversation between the initiator and another party.

createIMConversation(String) - Method in interface org.glassfish.cafe.api.CommunicationSession

Create an IMConversation between the initiator and another party.

createMessageIndication() - Method in interface org.glassfish.cafe.api.IMConference

Creates a message indication object.

createMessageIndication(MessageIndication.State) - Method in interface org.glassfish.cafe.api.IMConference

Creates a message indication object.

createMessageIndication() - Method in interface org.glassfish.cafe.api.IMConversation

Creates a message indication object.

createMessageIndication(MessageIndication.State) - Method in interface org.glassfish.cafe.api.IMConversation

Creates a message indication object.

createMSRPConference(String, MSRPConversation) - Method in interface org.glassfish.cafe.api.CommunicationSession

Create a MSRPConference from a MSRPConversation.

createMSRPConference(String) - Method in interface org.glassfish.cafe.api.CommunicationSession

Create a MSRPConference with a specified name.

createOrModifyBuddy(String, String) - Method in interface org.glassfish.cafe.api.Group

Adds a buddy to the group with the specified user ID and display name, or, if a buddy with the specified user ID already exists, modifies the display name.

createParticipant(Class<P>, String) - Method in interface org.glassfish.cafe.api.CommunicationSession

Create a participant, that can be added to the Communication.

createParticipant(Class<P>, String, Joinable) - Method in interface org.glassfish.cafe.api.CommunicationSession

Create a participant that can be added to the communication with a specific Joinable.

createPersonOnline() - Method in interface org.glassfish.cafe.api.PresenceSource

Overwrites the associated presence document with a new one with status open and, in the person information, willingness set to open and the note set to online The presence document is based on the user ID of the Presence Source.

createPersonOnlineActivity(String) - Method in interface org.glassfish.cafe.api.PresenceSource

Overwrites the associated presence document with a new one with status open and an activity in the person information.

createPresenceSource(String) - Method in interface org.glassfish.cafe.api.CommunicationSession

Creates a Presence Source using the provided user ID as its IMS entity.

createPresenceWatcher(Group) - Method in interface org.glassfish.cafe.api.CommunicationSession

Creates a presence watcher.

createPresenceWatcher(String, String) - Method in interface org.glassfish.cafe.api.CommunicationSession

Creates a presence watcher.

createProxyAuthentication(String, String, String) - Method in interface org.glassfish.cafe.api.CommunicationService

Creates a proxy authentication for a registration.

createRegistration(String) - Method in interface org.glassfish.cafe.api.CommunicationSession

Creates a Registration with fromUserId as the user identity to register on the network.

createRegistration(String, ProxyAuthentication) - Method in interface org.glassfish.cafe.api.CommunicationSession

Creates a Registration with fromUserId as the user identity to register on the network, with one set of credentials.

createRegistration(String, List<ProxyAuthentication>) - Method in interface org.glassfish.cafe.api.CommunicationSession

Creates a Registration with fromUserId as the user identity to register on the network, with a list of credentials.

createRuleSetFromTemplate(String, RuleSetType) - Method in interface org.glassfish.cafe.api.CommunicationService

Create a rules set and shared list according to the specified template.

createTextMessage() - Method in interface org.glassfish.cafe.api.IMConference

Creats an empty text message object.

createTextMessage(String) - Method in interface org.glassfish.cafe.api.IMConference

Creates the text message with the supplied text.

createTextMessage() - Method in interface org.glassfish.cafe.api.IMConversation

Creats an empty text message object.

createTextMessage(String) - Method in interface org.glassfish.cafe.api.IMConversation

Creates the text message with the supplied text.

createTextMessage(String) - Method in interface org.glassfish.cafe.api.MSRPConference

Creates the text message with the supplied text.

createWatcherInfoSubscriber(String) - Method in interface org.glassfish.cafe.api.CommunicationSession

Creates a WatcherInfoSubscriber object for the given user ID.

D

delete() - Method in interface org.glassfish.cafe.api.Group

Deletes the complete group.

deleteRuleSetFromTemplate(String) - Method in interface org.glassfish.cafe.api.CommunicationService

Deletes all the rules from the rule set.

DeviceInformation - Interface in org.glassfish.cafe.api.presence

The �device� components model the physical piece of equipment in which services execute.

DtmfSignal - Interface in org.glassfish.cafe.api

Represents the a DTMF Signal.

E

end() - Method in interface org.glassfish.cafe.api.Communication

End the conversation.

end() - Method in interface org.glassfish.cafe.api.UserProcedure

Ends the procedure.

equals(Object) - Method in class org.glassfish.cafe.api.MessageRecipient

excludeCustomElement(String) - Method in interface org.glassfish.cafe.api.presence.PresenceWatcherFilter

Excludes a custom element from the filter.

excludeCustomElement(String, String, String) - Method in interface org.glassfish.cafe.api.presence.PresenceWatcherFilter

Excludes a custom element in the filter.

excludeCustomElement(String, Map<String, String>) - Method in interface org.glassfish.cafe.api.presence.PresenceWatcherFilter

Excludes a custom element in the filter.

F

findByInitiator(Class<C>, String) - Method in interface org.glassfish.cafe.api.CommunicationService

Search for all communication initiated by a particular user.

findByName(Class<C>, String) - Method in interface org.glassfish.cafe.api.CommunicationService

Search API for communication by name.

findByParticipant(Class<C>, String) - Method in interface org.glassfish.cafe.api.CommunicationService

Search for all communication where a particular user is present.

findCommunications(Class<C>) - Method in interface org.glassfish.cafe.api.CommunicationService

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

FLOOR - Static variable in interface org.glassfish.cafe.api.presence.CivicLocationInfo

G

GeographicalLocation - Interface in org.glassfish.cafe.api.presence

The GeographicalLocationInfo components model the person�s or the device�s geographical location.

get() - Method in class org.glassfish.cafe.api.Agent

Return the application specific data.

get() - Method in interface org.glassfish.cafe.api.ProtocolMessage

Method to retrieve the actual SIP Message.

getActivities() - Method in interface org.glassfish.cafe.api.presence.PersonInformation

Returns the set of activities.

getAgent(String) - Method in interface org.glassfish.cafe.api.Communication

Gets the agent from its name.

getAgent(String) - Method in interface org.glassfish.cafe.api.Participant

Gets the agent from its name.

getAgent(String) - Method in interface org.glassfish.cafe.api.UserProcedure

Gets the agent from its name.

getAgents() - Method in interface org.glassfish.cafe.api.Communication

Retrieve the agent instance pertaining to the communication.

getAgents() - Method in interface org.glassfish.cafe.api.Participant

Retrieve the agent instance pertaining to the communication.

getAgents() - Method in interface org.glassfish.cafe.api.UserProcedure

Retrieve the agent instance pertaining to the communication.

getAllActivities() - Method in interface org.glassfish.cafe.api.presence.PresenceDocument

Convenience method to get all activities of all the person information elements.

getAllAttributes() - Method in interface org.glassfish.cafe.api.CommunicationSession

Retrieve all attributes set in this session.

getAllDeviceInformation() - Method in interface org.glassfish.cafe.api.presence.PresenceDocument

Returns the collection of device information ID's defined on this document

getAllMediaParticipants(Class<P>) - Method in interface org.glassfish.cafe.api.Conference

Get a collection of particular type of Participants in the conference.

getAllParticipants() - Method in interface org.glassfish.cafe.api.Conference

Return all the participants in the conference.

getAllParticipants() - Method in interface org.glassfish.cafe.api.IMConference

Return all the participants in the conference.

getAllServiceInformation() - Method in interface org.glassfish.cafe.api.presence.PresenceDocument

Returns the collection of Service Information elements defined on this document.

getAttribute(String) - Method in interface org.glassfish.cafe.api.CommunicationSession

Retrieve the attribute from the session.

getBuddyDisplayName(String) - Method in interface org.glassfish.cafe.api.Group

Returns the display name of the buddy with the specified user ID.

getBuddyNames() - Method in interface org.glassfish.cafe.api.Group

Returns the list of user IDs of the buddies in the group.

getCallee() - Method in interface org.glassfish.cafe.api.Conversation

Return the callee in the call.

getCaller() - Method in interface org.glassfish.cafe.api.Conversation

Return the caller who initiated the call..

getCard() - Method in interface org.glassfish.cafe.api.presence.PersonInformation

Gets the CIPID card for this person.

getCivicAddress(String) - Method in interface org.glassfish.cafe.api.presence.CivicLocationInfo

Returns the value of the civic address identifier.

getCivicLocationInfo() - Method in interface org.glassfish.cafe.api.presence.GeographicalLocation

Returns the CivicLocationInfo of the ImsGeographicalLocationInfo.

getCommunication() - Method in interface org.glassfish.cafe.api.CommunicationContext

Return the communication associated with the context.

getCommunicationContext() - Method in class org.glassfish.cafe.api.Agent

Retrieve the CommunicationContext object in the Application Link.

getConfirmedPresenceDocument() - Method in interface org.glassfish.cafe.api.PresenceSource

Returns the last presence document that has been acknowledged.

getContact() - Method in interface org.glassfish.cafe.api.presence.ServiceInformation

Returns the contact information.

getContactPriority() - Method in interface org.glassfish.cafe.api.presence.ServiceInformation

Gets contact information priority.

getContent() - Method in interface org.glassfish.cafe.api.Message

return the actual content of the message.

getContentType() - Method in interface org.glassfish.cafe.api.Message

Return the content type of the message.

getCoordinates() - Method in interface org.glassfish.cafe.api.presence.GeographicalLocation

Returns the coordinates of the current GeographicalLocationInfo.

getCopyControl() - Method in class org.glassfish.cafe.api.MessageRecipient

Return the copycontrol settings of the recipient

getCount() - Method in class org.glassfish.cafe.api.MessageRecipient

Return the count of Anonymous recipients.

getDescription() - Method in interface org.glassfish.cafe.api.Conference

Return the description of the conference.

getDescription() - Method in interface org.glassfish.cafe.api.IMConference

Return the description of the conference.

getDeviceId() - Method in interface org.glassfish.cafe.api.presence.DeviceInformation

Returns the device identifier as in RFC 4479.

getDeviceID() - Method in interface org.glassfish.cafe.api.presence.ServiceInformation

Gets Per service device identifier..

getDeviceInformation(String) - Method in interface org.glassfish.cafe.api.presence.PresenceDocument

Returns the DeviceInformation connected to the presence document and with the specified device ID.

getDeviceInformationAnyway(String) - Method in interface org.glassfish.cafe.api.presence.PresenceDocument

Returns the DeviceInformation if an instance with this device ID exists, creates an instance of DeviceInformation with this device ID if it does not exist and returns it.

getDisplayName() - Method in interface org.glassfish.cafe.api.Group

Returns the display name of the group.

getDisplayName() - Method in interface org.glassfish.cafe.api.presence.PersonInformation

Gets the CIPID display name for this person.

getDisplayName() - Method in interface org.glassfish.cafe.api.presence.WatcherInfo

Returns the display name of the watcher.

getDomain() - Method in interface org.glassfish.cafe.api.ProxyAuthentication

Returns the authentication domain name.

getDomainName() - Method in interface org.glassfish.cafe.spi.CafeModuleRuntime

Return the Domain name configuration on the Java EE application.

getDomainProxy() - Method in interface org.glassfish.cafe.spi.CafeModuleRuntime

Return the Domain Proxy configuration on the Java EE application.

getDuration() - Method in interface org.glassfish.cafe.api.DtmfSignal

Returns the duration of the DTMF signal in milliseconds.

getElementNS(String, String) - Method in interface org.glassfish.cafe.api.presence.PresenceDocument

Returns an Element object belonging to this Presence Document.

getElementNS(String, String) - Method in interface org.glassfish.cafe.api.presence.PresenceInformation

Returns an Element object belonging to this Presence Information.

getElementNS(String, String) - Method in interface org.glassfish.cafe.api.presence.PresenceWatcherFilterSet

Returns an Element object belonging to this filter Document

getElementNS(String, String) - Method in interface org.glassfish.cafe.api.presence.WatcherInfoSubscriberFilter

Returns an Element object belonging to this filter Document

getElementsNS(String, String) - Method in interface org.glassfish.cafe.api.presence.PresenceDocument

Returns an Element object belonging to this Presence Document.

getElementsNS(String, String) - Method in interface org.glassfish.cafe.api.presence.PresenceInformation

Returns an Element object belonging to this Presence Information.

getElementsNS(String, String) - Method in interface org.glassfish.cafe.api.presence.PresenceWatcherFilterSet

Returns an Element object belonging to this filter Document

getElementsNS(String, String) - Method in interface org.glassfish.cafe.api.presence.WatcherInfoSubscriberFilter

Returns an Element object belonging to this filter Document

getEvent() - Method in interface org.glassfish.cafe.api.presence.WatcherInfo

Returns the event that caused the subscription to change status.

getEvent() - Method in interface org.glassfish.cafe.api.PresenceWatcher

Returns the event package corresponding to this Subscription.

getExpirationTime() - Method in interface org.glassfish.cafe.api.UserProcedure

Returns the expiration time.

getFilter() - Method in interface org.glassfish.cafe.api.WatcherInfoSubscriber

Returns the filter for this WatcherInfoSubscriber.

getFilterSet() - Method in interface org.glassfish.cafe.api.PresenceWatcher

Gets the Filter Set instance associated with this watcher.

getGeographicalLocationInfo() - Method in interface org.glassfish.cafe.api.presence.PersonInformation

Returns a GeographicalLocationInfo interface representing the geographical location of this person.

getGeographicalLocationInfo() - Method in interface org.glassfish.cafe.api.presence.ServiceInformation

Returns a GeographicalLocationInfo interface representing the geographical location of this service.

getGMLId() - Method in interface org.glassfish.cafe.api.presence.GeographicalLocation

Returns the Geography Markup Language (GML) identifier for the current point of the GeographicalLocationInfo.

getGroup(String, String) - Method in interface org.glassfish.cafe.api.CommunicationService

Returns the group for the specified user and group name.

getGroup() - Method in interface org.glassfish.cafe.api.PresenceWatcher

Returns the group that this presence watcher is subscribed to.

getGroups(String) - Method in interface org.glassfish.cafe.api.CommunicationService

returns the list of groups for the specified user.

getHomepage() - Method in interface org.glassfish.cafe.api.presence.PersonInformation

Gets the CIPID homepage for this person.

getIcon() - Method in interface org.glassfish.cafe.api.presence.PersonInformation

Gets the CIPID icon for this person.

getId() - Method in interface org.glassfish.cafe.api.presence.DeviceInformation

Returns the device element identifier.

getId() - Method in interface org.glassfish.cafe.api.presence.PersonInformation

Returns the person identifier.

getId() - Method in interface org.glassfish.cafe.api.presence.ServiceInformation

Returns the service id.

getIdentity() - Method in class org.glassfish.cafe.api.MessageRecipient

Return the uri string of the recipient

getIdentity() - Method in interface org.glassfish.cafe.api.presence.PeerPresentity

Returns the identity associated to this Peer Presentity

getIdentity() - Method in interface org.glassfish.cafe.api.presence.PresenceDocument

Returns the identity associated to this presence document

getIdleTime() - Method in interface org.glassfish.cafe.api.IMConversation

Return the current value of the idle time.

getInitiator() - Method in interface org.glassfish.cafe.api.Communication

Retrieves the participant who initiated the communication.

getJoinable() - Method in interface org.glassfish.cafe.api.Participant

Return the Joinable object represents this Participant.

getLastActive() - Method in interface org.glassfish.cafe.api.MessageIndication

Return the time when the participant was active previously in the chat.

getMap() - Method in interface org.glassfish.cafe.api.presence.PersonInformation

Gets the CIPID map name for this person.

getMediaEvent(Class<M>) - Method in interface org.glassfish.cafe.api.CommunicationContext

Return the JSR 309 MediaEvent associated with the current context.

getMessage() - Method in interface org.glassfish.cafe.api.CommunicationContext

Get the current Message from the ongoing conversation.

getMessage() - Method in interface org.glassfish.cafe.api.UserProcedure

Returns the message in the user procedure.

getMoods() - Method in interface org.glassfish.cafe.api.presence.PersonInformation

Returns the set of moods.

getName() - Method in interface org.glassfish.cafe.api.Communication

Return the name of the communication.

getName() - Method in interface org.glassfish.cafe.api.Group

Returns the name of the group.

getName() - Method in interface org.glassfish.cafe.api.Participant

Return the user name of the participant.

getName() - Method in interface org.glassfish.cafe.api.ProxyAuthentication

Returns the authentication user ID.

getNextMessageType() - Method in interface org.glassfish.cafe.api.MessageIndication

Returns the content type of the next message participant is planning to send.

getNickName() - Method in interface org.glassfish.cafe.api.Participant

Return the nick name of the participant.

getNote() - Method in interface org.glassfish.cafe.api.presence.PresenceInformation

Returns the first available note

getNotes() - Method in interface org.glassfish.cafe.api.presence.PresenceInformation

Returns all available notes

getOverridingWillingness() - Method in interface org.glassfish.cafe.api.presence.PersonInformation

Gets the willingness status.

getOwner() - Method in interface org.glassfish.cafe.api.Group

Returns the owner of the group.

getParticipant(String) - Method in interface org.glassfish.cafe.api.Communication

Retrieve a Participant from the Communication.

getParticipant(Class<P>, String) - Method in interface org.glassfish.cafe.api.Communication

Retrieve a Participant from the Communication.

getParticipant() - Method in interface org.glassfish.cafe.api.CommunicationContext

Return the current participant.

getParticipant() - Method in interface org.glassfish.cafe.api.IMConversation

Retrieve the participant which receives the messages from the initiator.

getParticipant() - Method in interface org.glassfish.cafe.api.MSRPConversation

Return the Callee of this conversation

getPassword() - Method in interface org.glassfish.cafe.api.ProxyAuthentication

Returns the authentication password.

getPeerPresentities() - Method in interface org.glassfish.cafe.api.PresenceMessage

Returns the presence information associated with remote presentities that were in the last subscription that was previously made.

getPeerPresentities() - Method in interface org.glassfish.cafe.api.PresenceWatcher

Provides the accumulated presence information for all the presentities this watcher has subscribed to.

getPeerPresentity(String) - Method in interface org.glassfish.cafe.api.PresenceWatcher

Provides the presence information for a certain presentity the watcher has subscribed to.

getPersonInformation() - Method in interface org.glassfish.cafe.api.presence.PresenceDocument

Returns the Person Information associated to this presence document, if any.

getPersonInformationAnyway() - Method in interface org.glassfish.cafe.api.presence.PresenceDocument

Returns the Person Information associated to this presence document, or a newly created one if there was none before.

getPersonInformations() - Method in interface org.glassfish.cafe.api.presence.PresenceDocument

Get all the person information elements in the document.

getPresenceDocument() - Method in interface org.glassfish.cafe.api.presence.PeerPresentity

Returns the associated presence container

getPresenceDocument() - Method in interface org.glassfish.cafe.api.PresenceSource

Returns the actual version of the associated presence document.

getProtocolObjectFactory() - Method in interface org.glassfish.cafe.spi.CafeModuleRuntime

Return protocol specific factory object.

getRecipients() - Method in interface org.glassfish.cafe.api.TextMessage

return MessageRecipients for this message.

getRefreshInterval() - Method in interface org.glassfish.cafe.api.MessageIndication

Return the refresh interval time.

getRegistrar() - Method in interface org.glassfish.cafe.spi.CafeModuleRuntime

Return the Registrar configuration on the Java EE application.

getRpidClass() - Method in interface org.glassfish.cafe.api.presence.PresenceInformation

Returns the class value.

getRuleSetType(String) - Method in interface org.glassfish.cafe.api.CommunicationService

Attempts to determine the ruleset type.

getServiceDescriptionText() - Method in interface org.glassfish.cafe.api.presence.ServiceInformation

Gets the ServiceDescriptionText.

getServiceID() - Method in interface org.glassfish.cafe.api.presence.ServiceInformation

Gets the service ID.

getServiceInformation(String, String) - Method in interface org.glassfish.cafe.api.presence.PresenceDocument

Returns the Service Information with the specified service ID and version.

getServiceInformation(String) - Method in interface org.glassfish.cafe.api.presence.PresenceDocument

Returns the Service Information with the specified service ID.

getServiceInformationAnyway(String, String) - Method in interface org.glassfish.cafe.api.presence.PresenceDocument

Returns the ServiceInformation if an instance with this service ID and version exists, creates an instance of ServiceInformation with this service ID and version if it did not exist and returns it.

getSignal() - Method in interface org.glassfish.cafe.api.DtmfSignal

Return the DTMF signal as a string.

getSound() - Method in interface org.glassfish.cafe.api.presence.PersonInformation

Gets the CIPID sound name for this person.

getSRSName() - Method in interface org.glassfish.cafe.api.presence.GeographicalLocation

Returns the Spatial Reference System (SRS) name of the current point of the GeographicalLocationInfo.

getState() - Method in interface org.glassfish.cafe.api.Communication

Return the current state of communication.

getState() - Method in interface org.glassfish.cafe.api.MessageIndication

Return the state in the message indication.

getState() - Method in interface org.glassfish.cafe.api.UserProcedure

Returns the current state of the procedure.

getStatus() - Method in interface org.glassfish.cafe.api.presence.ServiceInformation

Gets service status: OPEN or CLOSE.

getStatus() - Method in interface org.glassfish.cafe.api.presence.WatcherInfo

Returns the status of the watcher subscription.

getStatusIcon() - Method in interface org.glassfish.cafe.api.presence.PersonInformation

Gets the status icon for this person.

getStatusIcon() - Method in interface org.glassfish.cafe.api.presence.ServiceInformation

Gets the status icon.

getStream() - Method in interface org.glassfish.cafe.api.Recorder

A method to retrieve the stream currently being recorded by the recorder.

getStreams() - Method in interface org.glassfish.cafe.api.Player

A method to retrieve the streams currently being played by the player.

getSubscriptionState() - Method in interface org.glassfish.cafe.api.presence.PeerPresentity

Returns the subscription state of the peer presentity.

getSupportedType(ProtocolMessage) - Method in interface org.glassfish.cafe.spi.CafeModule

Get the type of Communication or UserProcedure supported for the incoming ProtocolMessage.

getTerminationReason() - Method in interface org.glassfish.cafe.api.presence.PeerPresentity

Returns the reason why the subscription state is TERMINATED.

getText() - Method in interface org.glassfish.cafe.api.TextMessage

Return the text of the message.

getTimeStamp() - Method in interface org.glassfish.cafe.api.presence.PresenceInformation

Returns time stamp.

getType() - Method in interface org.glassfish.cafe.spi.CafeObjectBuilder

Return the type of the object built.

getUserId() - Method in interface org.glassfish.cafe.api.presence.WatcherInfo

Returns the URI of the watcher that is subscribing to the resource.

getUserId() - Method in interface org.glassfish.cafe.api.UserProcedure

Returns the user who initiated the procedure.

getUserId() - Method in interface org.glassfish.cafe.api.WatcherInfoSubscriber

Returns the user ID of the user that initiated this subscription and whose watchers' state changes are reported.

getUserPrincipal() - Method in interface org.glassfish.cafe.api.CommunicationContext

Returns a java.security.Principal object containing the name of the current authenticated user.

getUserProcedure() - Method in interface org.glassfish.cafe.api.CommunicationContext

Return the current user procedure, if applicable.

getVersion() - Method in interface org.glassfish.cafe.api.presence.ServiceInformation

Gets the version.

getWatchersInfo() - Method in interface org.glassfish.cafe.api.WatcherInfoMessage

Returns the watcher information associated with the watcher(s) for which a subscription has been previously made.

getWillingness() - Method in interface org.glassfish.cafe.api.presence.ServiceInformation

The element is an extension to PIDF that is used to describe the �Application-specific willingness�

getXcapRoot() - Method in interface org.glassfish.cafe.spi.CafeModuleRuntime

Return the XCAP root configuration on the Java EE application.

getXML() - Method in interface org.glassfish.cafe.api.presence.PresenceDocument

Returns the raw XML content of this presence container.

getXML() - Method in interface org.glassfish.cafe.api.presence.PresenceWatcherFilterSet

Returns the raw XML content of this filter

getXML() - Method in interface org.glassfish.cafe.api.presence.WatcherInfoSubscriberFilter

Returns the raw XML content of this filter

Group - Interface in org.glassfish.cafe.api

This entity is responsible for actions on a user specific group that is stored on a RLS server.

H

handleRequest(ProtocolMessage) - Method in interface org.glassfish.cafe.spi.ProtocolMessageHandler

CAFE framework will execute this method to handle incoming SIP request.

handleResponse(ProtocolMessage) - Method in interface org.glassfish.cafe.spi.ProtocolMessageHandler

CAFE framework will execute this method to handle incoming SIP response.

handles(Class<?>) - Method in interface org.glassfish.cafe.spi.CafeModule

Checks whether the module can create an instance of specified CAFE artifact type.

handleTimeout(ProtocolMessage) - Method in interface org.glassfish.cafe.spi.ProtocolMessageHandler

CAFE framework will execute this method to handle ServletTimer timeouts.

hashCode() - Method in class org.glassfish.cafe.api.MessageRecipient

HOUSE_NUMBER - Static variable in interface org.glassfish.cafe.api.presence.CivicLocationInfo

HOUSE_NUMBER_SUFFIX - Static variable in interface org.glassfish.cafe.api.presence.CivicLocationInfo

I

IMConference - Interface in org.glassfish.cafe.api

IMConversation - Interface in org.glassfish.cafe.api

Represents a two party IM conversation.

includeActiveWatchers() - Method in interface org.glassfish.cafe.api.presence.WatcherInfoSubscriberFilter

Includes a filter for active watchers

includeCustomElement(String) - Method in interface org.glassfish.cafe.api.presence.PresenceWatcherFilter

Includes a custom element in the filter.

includeCustomElement(String, String, String) - Method in interface org.glassfish.cafe.api.presence.PresenceWatcherFilter

Includes a custom element in the filter.

includeCustomElement(String, Map<String, String>) - Method in interface org.glassfish.cafe.api.presence.PresenceWatcherFilter

Includes a custom element in the filter.

includePendingWatchers() - Method in interface org.glassfish.cafe.api.presence.WatcherInfoSubscriberFilter

Includes a filter for pending watchers.

includeTerminatedWatchers() - Method in interface org.glassfish.cafe.api.presence.WatcherInfoSubscriberFilter

Includes a filter for terminated watchers.

includeWaitingWatchers() - Method in interface org.glassfish.cafe.api.presence.WatcherInfoSubscriberFilter

Includes a filter for waiting watchers.

initialize(CafeModuleRuntime) - Method in interface org.glassfish.cafe.spi.CafeModule

Initialize the CafeModule with an instance of the CafeModuleRuntime.

invoke() - Method in class org.glassfish.cafe.api.Agent

Invoke the the agent to perform application specific tasks.

invoke(CommunicationEvent.Type) - Method in class org.glassfish.cafe.api.Agent

Invoke the the agent to perform application specific tasks.

invoke(ParticipantEvent.Type) - Method in class org.glassfish.cafe.api.Agent

Invoke the the agent to perform application specific tasks.

invokeBean(CommunicationContext, Enum, CommunicationSession) - Method in interface org.glassfish.cafe.spi.CafeModuleRuntime

This method can be used by a CafeModule to execute any event on CommunicationBean.

isAnonymous() - Method in class org.glassfish.cafe.api.MessageRecipient

Return the anonymity status of the recipient

isCallbackEnabled() - Method in class org.glassfish.cafe.api.Agent

Gets the callback enabled flag.

isInband() - Method in interface org.glassfish.cafe.api.DtmfSignal

Return whether the DTMF signal is inband or not.

isUserInRole(String) - Method in interface org.glassfish.cafe.api.CommunicationContext

Returns a boolean indicating whether the authenticated user is included in the specified logical "role".

L

LANDMARK - Static variable in interface org.glassfish.cafe.api.presence.CivicLocationInfo

LEADING_STREET_DIRECTION - Static variable in interface org.glassfish.cafe.api.presence.CivicLocationInfo

LINK - Static variable in interface org.glassfish.cafe.spi.ProtocolMessageHandler

Name of the SipApplicationSession attribute using which CAFE framework will retrieve the linked SipApplicationSession which holds the ProtocolMessageHandler

LoginConfig - Annotation Type in org.glassfish.cafe.api.security

Login configuration to configure authentication mechanism and realm.

M

MediaParticipant - Interface in org.glassfish.cafe.api

Represents a MediaParticipant.

mergeAccordingToOMA() - Method in interface org.glassfish.cafe.api.presence.PresenceDocument

Modify the document according to OMA by merging all the person information element into one person information element.

mergeAccordingToRCS() - Method in interface org.glassfish.cafe.api.presence.PresenceDocument

Modify the document according to RCS by merging all the person information element into one person information element.

Message - Interface in org.glassfish.cafe.api

Message represents the actual information passed between parties involved in the communication.

MessageIndication - Interface in org.glassfish.cafe.api

Represents the Message Indication (like typing) in a chat between participants.

MessageIndication.State - Enum in org.glassfish.cafe.api

The State in the MessageIndication.

MessageRecipient - Class in org.glassfish.cafe.api

Represents MessageRecipient specified in the resource-list of a message.

MessageRecipient() - Constructor for class org.glassfish.cafe.api.MessageRecipient

MessageRecipient(String, MessageRecipient.CopyControl) - Constructor for class org.glassfish.cafe.api.MessageRecipient

MessageRecipient.CopyControl - Enum in org.glassfish.cafe.api

Represents various CopyControl options for a MessageRecipient.

MSRPConference - Interface in org.glassfish.cafe.api

A communication object that represents a session-mode instant messaging or chat session among multiple participants.

MSRPConversation - Interface in org.glassfish.cafe.api

A communication object that represents the session-mode instant messaging or chat session among two participants.

MSRPPlayer - Interface in org.glassfish.cafe.api

A participant that is used to send large files from CAFE to the other participants in a MSRP communication.

MSRPRecorder - Interface in org.glassfish.cafe.api

A participant that is used to save the large file and/or to record the message history in a MSRP communication.

N

NAME - Static variable in interface org.glassfish.cafe.api.CommunicationService

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

NAME - Static variable in interface org.glassfish.cafe.api.CommunicationSession

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

NAME - Static variable in interface org.glassfish.cafe.spi.ProtocolMessageHandler

Name of the SipApplicationSession attribute using which CAFE framework will retrieve the ProtocolMessageHandler

NATIONAL_SUBDIVISION - Static variable in interface org.glassfish.cafe.api.presence.CivicLocationInfo

NEIGHBORHOOD - Static variable in interface org.glassfish.cafe.api.presence.CivicLocationInfo

NS_CIPID - Static variable in interface org.glassfish.cafe.api.presence.PresenceDocument

CIPID Namespace definition

NS_CIVICLOC - Static variable in interface org.glassfish.cafe.api.presence.PresenceDocument

GEOPRIV CIVICLOC Namespace definition

NS_GEOPRIV10 - Static variable in interface org.glassfish.cafe.api.presence.PresenceDocument

GEOPRIV Namespace definition

NS_OMAPRES - Static variable in interface org.glassfish.cafe.api.presence.PresenceDocument

OMA-PRES Namespace definition

NS_PDM - Static variable in interface org.glassfish.cafe.api.presence.PresenceDocument

Presence Document Model (PDM) Namespace definintion

NS_PIDF - Static variable in interface org.glassfish.cafe.api.presence.PresenceDocument

PIDF Namespace definition

NS_RPID - Static variable in interface org.glassfish.cafe.api.presence.PresenceDocument

RPID Namespace definition

O

org.glassfish.cafe.api - package org.glassfish.cafe.api

org.glassfish.cafe.api.bean - package org.glassfish.cafe.api.bean

org.glassfish.cafe.api.presence - package org.glassfish.cafe.api.presence

org.glassfish.cafe.api.security - package org.glassfish.cafe.api.security

org.glassfish.cafe.spi - package org.glassfish.cafe.spi

P

Participant - Interface in org.glassfish.cafe.api

Represents a participant in the conversation.

ParticipantEvent - Annotation Type in org.glassfish.cafe.api.bean

Specifies events pertaining to a Participant in the Communication.

ParticipantEvent.Type - Enum in org.glassfish.cafe.api.bean

Type or classification of a ParticipantEvent.

PeerPresentity - Interface in org.glassfish.cafe.api.presence

A logical entity that has Presence Information (see definition below) associated with it.

PeerPresentity.SubscriptionState - Enum in org.glassfish.cafe.api.presence

The subscription state according to RFC3265.

PersonInformation - Interface in org.glassfish.cafe.api.presence

Specifies a set of methods and attributes used for storing, modifying and retrieving presence information.

play(InputStream, String, long) - Method in interface org.glassfish.cafe.api.MSRPPlayer

Send the contents of the stream to the participants using MSRP protocol.

play(URI...) - Method in interface org.glassfish.cafe.api.MSRPPlayer

Start sending the media from the specified location(s) using MSRP protocol.

play(String...) - Method in interface org.glassfish.cafe.api.MSRPPlayer

Start sending the media from the specified location(s) using the MSRP protocol.

Player - Interface in org.glassfish.cafe.api

Represents a Player object.

POSTAL_CODE - Static variable in interface org.glassfish.cafe.api.presence.CivicLocationInfo

PresenceDocument - Interface in org.glassfish.cafe.api.presence

Represents presence information which is either associated with a PresenceSource, or received in a Notification as part of a PresenceWatcherprocedure.

PresenceInformation - Interface in org.glassfish.cafe.api.presence

The generalisation of a category of presence information.

PresenceInformation.Status - Enum in org.glassfish.cafe.api.presence

Available Basic Status

PresenceMessage - Interface in org.glassfish.cafe.api

The SubscriptionNotifyMessage represents the actual information received as result of initiating a PresenceWatcher.

PresenceSource - Interface in org.glassfish.cafe.api

This entity is responsible for publishing presence information on behalf of a presentity.

PresenceWatcher - Interface in org.glassfish.cafe.api

The Presence Watcher is an entity that requests presence information about a list of presentities (i.e.

PresenceWatcherFilter - Interface in org.glassfish.cafe.api.presence

This entity models on highlevel the element as defined by [RFC4661].

PresenceWatcherFilter.Type - Enum in org.glassfish.cafe.api.presence

Filter Type

PresenceWatcherFilterSet - Interface in org.glassfish.cafe.api.presence

The Filter Set encapsulates a set of filters which can be used for the ImsPresenceWatcher in order to subscribe to the presence server.

ProtocolEvent - Annotation Type in org.glassfish.cafe.api.bean

Evens on receiving and sending of SIP Messages.

ProtocolEvent.Type - Enum in org.glassfish.cafe.api.bean

Type or classification of a CommunicationEvent.

ProtocolMessage - Interface in org.glassfish.cafe.api

Represents the ProtocolMessage (actual SIP Message).

ProtocolMessageHandler - Interface in org.glassfish.cafe.spi

A ProtocolMessageHandler object encapsulates the Communication or UserProcedure.

ProxyAuthentication - Interface in org.glassfish.cafe.api

ProxyAuthentication is used in authentication and authorization procedures that take place between the application and the network.

R

Reason - Enum in org.glassfish.cafe.api

Reason for rejecting a participant.

record(URI) - Method in interface org.glassfish.cafe.api.MSRPRecorder

Start recording to the specified URI.

record(String) - Method in interface org.glassfish.cafe.api.MSRPRecorder

Start recording to the specified location.

record(OutputStream) - Method in interface org.glassfish.cafe.api.MSRPRecorder

Start recording to the specified output stream.

Recorder - Interface in org.glassfish.cafe.api

Represents a Recorder object.

redirect(String) - Method in interface org.glassfish.cafe.api.UserParticipant

Redirect the communication to use a different participant instead of this participant.

Registration - Interface in org.glassfish.cafe.api

This entity is responsible for registering a user to a remote endpoint.

reject(Reason) - Method in interface org.glassfish.cafe.api.Message

Reject the message sent by a party in the communication.

reject() - Method in interface org.glassfish.cafe.api.UserParticipant

Reject the participant from entering into the conversation.

reject(Reason) - Method in interface org.glassfish.cafe.api.UserParticipant

Reject the participant from entering into the conversation.

removeActivity(String) - Method in interface org.glassfish.cafe.api.presence.PersonInformation

Removes an activity.

removeAgent(String) - Method in interface org.glassfish.cafe.api.Communication

Method to remove an agent from the communication.

removeAgent(String) - Method in interface org.glassfish.cafe.api.Participant

Method to remove an agent from the participant..

removeAgent(String) - Method in interface org.glassfish.cafe.api.UserProcedure

Method to remove an agent from the communication.

removeAttribute(String) - Method in interface org.glassfish.cafe.api.CommunicationSession

Remove the attribute from the session.

removeBuddy(String) - Method in interface org.glassfish.cafe.api.Group

Removes the buddy with the specified user ID from the group.

removeCivicAddress(String) - Method in interface org.glassfish.cafe.api.presence.CivicLocationInfo

Removes the civic address element with the given identifier.

removeCivicLocationInfo() - Method in interface org.glassfish.cafe.api.presence.GeographicalLocation

Removes any existing CivicLocationInfo from the GeographicalLocationInfo.

removeDeviceInformation(String) - Method in interface org.glassfish.cafe.api.presence.PresenceDocument

removeFilter() - Method in interface org.glassfish.cafe.api.WatcherInfoSubscriber

Removes the filter for this WatcherInfoSubscriber.

removeFilterSet() - Method in interface org.glassfish.cafe.api.PresenceWatcher

Removes the Filter Set instance associated with this watcher.

removeMood(String) - Method in interface org.glassfish.cafe.api.presence.PersonInformation

Removes a mood.

removeParticipant(String) - Method in interface org.glassfish.cafe.api.Communication

Remove any type of participant from the communication.

removeParticipant(Participant) - Method in interface org.glassfish.cafe.api.Communication

Remove a participant from the communication.

removePersonInformation() - Method in interface org.glassfish.cafe.api.presence.PresenceDocument

Removes the person information from the Presence Document.

removePersonInformation(String) - Method in interface org.glassfish.cafe.api.presence.PresenceDocument

Remove the specified person information element from the document.

removePoint() - Method in interface org.glassfish.cafe.api.presence.GeographicalLocation

Removes any existing point from the GeographicalLocation.

removeServiceInformation(String) - Method in interface org.glassfish.cafe.api.presence.PresenceDocument

Removes the Service Information indicated by the service ID.

replaceParticipant(Participant, Participant) - Method in interface org.glassfish.cafe.api.Communication

Replace a participant with another Participant.

RESIDENCE - Static variable in interface org.glassfish.cafe.api.presence.CivicLocationInfo

RuleSetType - Enum in org.glassfish.cafe.api

Indicates the type of rule set.

S

send() - Method in interface org.glassfish.cafe.api.Message

send the message.

send(String) - Method in interface org.glassfish.cafe.api.Message

send the message on behalf of a user

send(Participant) - Method in interface org.glassfish.cafe.api.Message

send the message on behalf of a participant

sendAnonymous() - Method in interface org.glassfish.cafe.api.TextMessage

Send the Message as Anonymous User.

sendAnonymous(String) - Method in interface org.glassfish.cafe.api.TextMessage

Send Message with the sender as anonymous

ServiceAttributes - Annotation Type in org.glassfish.cafe.api.bean

A ServiceAttributes annotation can be placed on top a CommunicationBean annotation.

ServiceInformation - Interface in org.glassfish.cafe.api.presence

Specifies a set of presence information elements that are typically used as presence information for a service.

set(T) - Method in class org.glassfish.cafe.api.Agent

Set application specific data.

setAnonymize(boolean) - Method in class org.glassfish.cafe.api.MessageRecipient

Set the anonymity settings

setAttribute(String, Object) - Method in interface org.glassfish.cafe.api.CommunicationSession

Set an attribute in the session.

setCallbackEnabled(boolean) - Method in class org.glassfish.cafe.api.Agent

Sets the callback enabled flag.

setCard(String) - Method in interface org.glassfish.cafe.api.presence.PersonInformation

Sets the CIPID card for this person.

setCommunication(O) - Method in interface org.glassfish.cafe.spi.CafeObjectBuilder

If the CAFE framework might have found an object that matches the name of the object being built in its cache.

setCommunicationContext(CommunicationContext<?, ?, ?>) - Method in class org.glassfish.cafe.api.Agent

Set the CommunicationContext object.

setContact(String) - Method in interface org.glassfish.cafe.api.presence.ServiceInformation

Sets contacts value.

setContactPriority(String) - Method in interface org.glassfish.cafe.api.presence.ServiceInformation

Sets contact priority information.

setCopyControl(MessageRecipient.CopyControl) - Method in class org.glassfish.cafe.api.MessageRecipient

Set the copycontrol of the recipient

setCount(int) - Method in class org.glassfish.cafe.api.MessageRecipient

Set the recipient count.

setDescription(String) - Method in interface org.glassfish.cafe.api.Conference

Set the description of the conference.

setDescription(String) - Method in interface org.glassfish.cafe.api.IMConference

Set the description of the conference.

setDeviceID(String) - Method in interface org.glassfish.cafe.api.presence.ServiceInformation

Sets Per service device identifier.

setDisplayName(String) - Method in interface org.glassfish.cafe.api.Group

Returns the name of the group.

setDisplayName(String) - Method in interface org.glassfish.cafe.api.presence.PersonInformation

Sets the CIPID display name for this person.

setDuration(long) - Method in interface org.glassfish.cafe.api.DtmfSignal

Set the duration of the DTMF signal in milliseconds.

setExpirationTime(Date) - Method in interface org.glassfish.cafe.api.UserProcedure

Sets the expiration time.

setHomepage(String) - Method in interface org.glassfish.cafe.api.presence.PersonInformation

Sets the CIPID home page for this person.

setIcon(String) - Method in interface org.glassfish.cafe.api.presence.PersonInformation

Sets the CIPID icon for this person.

setIdentity(String) - Method in class org.glassfish.cafe.api.MessageRecipient

Set the uri string for the recipient

setIdleTime(int) - Method in interface org.glassfish.cafe.api.IMConversation

An IM conversation by default gets destroyed as soon as the message is received successfully or sent successfully.

setLastActive(Date) - Method in interface org.glassfish.cafe.api.MessageIndication

Set the time participant was active previously in the chat.

setMap(String) - Method in interface org.glassfish.cafe.api.presence.PersonInformation

Sets the CIPID map name for this person.

setName(String) - Method in interface org.glassfish.cafe.api.Participant

Set the user name of the participant.

setNextMessageType(String) - Method in interface org.glassfish.cafe.api.MessageIndication

Set the content type of the next message.

setNickName(String) - Method in interface org.glassfish.cafe.api.Participant

Set the nick name of the participant.

setNote(String) - Method in interface org.glassfish.cafe.api.presence.PersonInformation

Sets a note.

setNote(String) - Method in interface org.glassfish.cafe.api.presence.ServiceInformation

Sets note.

setOverridingWillingness(PresenceInformation.Status) - Method in interface org.glassfish.cafe.api.presence.PersonInformation

Sets the willingness status.

setPoint(String, String, String) - Method in interface org.glassfish.cafe.api.presence.GeographicalLocation

Sets the point of the current GeographicalLocationInfo, including the Geography Markup Language (GML) identifier, the Spartial Reference System (SRS) name and the coordinates.

setRefreshInterval(int) - Method in interface org.glassfish.cafe.api.MessageIndication

Set the refresh interval time.

setRpidClass(String) - Method in interface org.glassfish.cafe.api.presence.PresenceInformation

Sets a class value.

setServiceDescriptionText(String) - Method in interface org.glassfish.cafe.api.presence.ServiceInformation

The element is an extension to PIDF that is used to describe OMA-specific services.

setSignal(String) - Method in interface org.glassfish.cafe.api.DtmfSignal

Set the DTMF signal.

setSound(String) - Method in interface org.glassfish.cafe.api.presence.PersonInformation

Sets the CIPID sound name for this person.

setState(MessageIndication.State) - Method in interface org.glassfish.cafe.api.MessageIndication

Set the state in the message indication.

setStatus(PresenceInformation.Status) - Method in interface org.glassfish.cafe.api.presence.ServiceInformation

Sets service status: OPEN or CLOSE.

setStatusIcon(String) - Method in interface org.glassfish.cafe.api.presence.PersonInformation

Sets a new status icon.

setStatusIcon(String) - Method in interface org.glassfish.cafe.api.presence.ServiceInformation

Sets a new status icon.

setText(String) - Method in interface org.glassfish.cafe.api.TextMessage

Set the text of the message.

setWillingness(PresenceInformation.Status) - Method in interface org.glassfish.cafe.api.presence.ServiceInformation

Sets the willingness status.

start(URI...) - Method in interface org.glassfish.cafe.api.Player

Start playing using the specified URI list.

start(String...) - Method in interface org.glassfish.cafe.api.Player

Start playing from the specified location.

start(URI) - Method in interface org.glassfish.cafe.api.Recorder

Start recording to the specified URI.

start(String) - Method in interface org.glassfish.cafe.api.Recorder

Start recording to the specified location.

startWatching(CommunicationSession) - Method in interface org.glassfish.cafe.api.Group

Creates a new PresenceWatcher in the provided CommunicationSession, and issues the update() method for the current group on the newly created PresenceWatcher.

stop() - Method in interface org.glassfish.cafe.api.Player

Stop the playback.

stop() - Method in interface org.glassfish.cafe.api.Recorder

Stop recording the communication.

STREET - Static variable in interface org.glassfish.cafe.api.presence.CivicLocationInfo

STREET_SUFFIX - Static variable in interface org.glassfish.cafe.api.presence.CivicLocationInfo

T

TextMessage - Interface in org.glassfish.cafe.api

Represents the TextMessage in an IMConversation between participants.

toString() - Method in enum org.glassfish.cafe.api.MessageRecipient.CopyControl

TRAILING_STREET_SUFFIX - Static variable in interface org.glassfish.cafe.api.presence.CivicLocationInfo

TransportProtected - Annotation Type in org.glassfish.cafe.api.security

The transport should be secured using TLS/SSL

U

update() - Method in interface org.glassfish.cafe.api.UserProcedure

Starts the procedure or requests a refresh or update of remote data by sending a message.

UserParticipant - Interface in org.glassfish.cafe.api

Represents a user participant in the communication.

UserProcedure - Interface in org.glassfish.cafe.api

Represents a user procedure, in which a user starts an action or discloses information to the network or to a server, with a limited validity period.

UserProcedure.State - Enum in org.glassfish.cafe.api

UserProcedureEvent - Annotation Type in org.glassfish.cafe.api.bean

Indicate that the method should be activated at receipt of an event.

UserProcedureEvent.Type - Enum in org.glassfish.cafe.api.bean

UserProcedureMessage - Interface in org.glassfish.cafe.api

V

valueOf(String) - Static method in enum org.glassfish.cafe.api.bean.CommunicationEvent.Type

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.glassfish.cafe.api.bean.ParticipantEvent.Type

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.glassfish.cafe.api.bean.ProtocolEvent.Type

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.glassfish.cafe.api.bean.UserProcedureEvent.Type

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.glassfish.cafe.api.Communication.State

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.glassfish.cafe.api.MessageIndication.State

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.glassfish.cafe.api.MessageRecipient.CopyControl

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.glassfish.cafe.api.presence.PeerPresentity.SubscriptionState

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.glassfish.cafe.api.presence.PresenceInformation.Status

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.glassfish.cafe.api.presence.PresenceWatcherFilter.Type

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.glassfish.cafe.api.presence.WatcherInfo.Event

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.glassfish.cafe.api.presence.WatcherInfo.Status

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.glassfish.cafe.api.Reason

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.glassfish.cafe.api.RuleSetType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.glassfish.cafe.api.security.AssertionScheme

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.glassfish.cafe.api.UserProcedure.State

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.glassfish.cafe.api.bean.CommunicationEvent.Type

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.glassfish.cafe.api.bean.ParticipantEvent.Type

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.glassfish.cafe.api.bean.ProtocolEvent.Type

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.glassfish.cafe.api.bean.UserProcedureEvent.Type

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.glassfish.cafe.api.Communication.State

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.glassfish.cafe.api.MessageIndication.State

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.glassfish.cafe.api.MessageRecipient.CopyControl

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.glassfish.cafe.api.presence.PeerPresentity.SubscriptionState

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.glassfish.cafe.api.presence.PresenceInformation.Status

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.glassfish.cafe.api.presence.PresenceWatcherFilter.Type

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.glassfish.cafe.api.presence.WatcherInfo.Event

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.glassfish.cafe.api.presence.WatcherInfo.Status

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.glassfish.cafe.api.Reason

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.glassfish.cafe.api.RuleSetType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.glassfish.cafe.api.security.AssertionScheme

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.glassfish.cafe.api.UserProcedure.State

Returns an array containing the constants of this enum type, in the order they are declared.

W

WatcherInfo - Interface in org.glassfish.cafe.api.presence

Watcher Info entity represents the information of a Watcher.

WatcherInfo.Event - Enum in org.glassfish.cafe.api.presence

WatcherInfo.Status - Enum in org.glassfish.cafe.api.presence

WatcherInfoMessage - Interface in org.glassfish.cafe.api

The WatcherInfoSubscriberNotifyMessage represents the actual information received as result of initiating a PresenceWatcher.

WatcherInfoSubscriber - Interface in org.glassfish.cafe.api

The Presence WatcherInfo Subscriber is an entity that subscribes to the dynamically changing set of presence watchers.

WatcherInfoSubscriberFilter - Interface in org.glassfish.cafe.api.presence

A watcher info filter enables the possibility to set filters and limit the data received in the ImsWatcherInfoDocument.

A B C D E F G H I L M N O P R S T U V W