org.glassfish.cafe.spi
Interface CafeModuleRuntime

public interface CafeModuleRuntime

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

Method Summary

String	getDomainName() Return the Domain name configuration on the Java EE application.
String	getDomainProxy() Return the Domain Proxy configuration on the Java EE application.
Object	getProtocolObjectFactory() Return protocol specific factory object.
String	getRegistrar() Return the Registrar configuration on the Java EE application.
String	getXcapRoot() Return the XCAP root configuration on the Java EE application.
void	invokeBean(CommunicationContext cc, Enum event, CommunicationSession session) This method can be used by a CafeModule to execute any event on CommunicationBean.

Method Detail

invokeBean

void invokeBean(CommunicationContext cc,
                Enum event,
                CommunicationSession session)

This method can be used by a CafeModule to execute any event on CommunicationBean. CAFE framework will find the specific event by searching the annotation matching the event type Enum specified and the type of Communication or UserProcedure as specified in the CommunicationContext. The CommunicationContext object provided by the framework will not be directly provided to the CommunicationBean. Instead, the information in the context will be used to populate an appropriate implementation of the CommunicationContext object inside CAFE framework.

Parameters:

cc - CommunicationContext instance.

event - The type of the event.

session - The CommunicationSession object for using in the invocation. This is the CommunicationSession object used to create the Communication or UserProcedure for which this event is being invoked.

See Also:

CommunicationBean, CommunicationContext, CommunicationEvent, UserProcedureEvent, ParticipantEvent

getDomainProxy

String getDomainProxy()

Return the Domain Proxy configuration on the Java EE application.

Returns:

Domain Proxy configuration

See Also:

CommunicationBean

getDomainName

String getDomainName()

Return the Domain name configuration on the Java EE application.

Returns:

Domain name configuration

See Also:

CommunicationBean

getRegistrar

String getRegistrar()

Return the Registrar configuration on the Java EE application.

Returns:

Configured registrar

See Also:

CommunicationBean

getXcapRoot

String getXcapRoot()

Return the XCAP root configuration on the Java EE application.

Returns:

Configured XCAP root.

See Also:

CommunicationBean

getProtocolObjectFactory

Object getProtocolObjectFactory()

Return protocol specific factory object.

Returns:

protocol specific factory object (SipFactory)

See Also:

CommunicationBean