cisco.uc.cuae.legacy
Class BasePresenceServer

java.lang.Object
  cisco.uc.cuae.legacy.BasePresenceServer

All Implemented Interfaces:

CuaeCommon, CuaeCommonServer, Presence, PresenceServer, etch.bindings.java.support.ObjSession

public class BasePresenceServer
extends java.lang.Object
implements PresenceServer, etch.bindings.java.support.ObjSession

Base implementation of PresenceServer, with default method implementations which throw UnsupportedOperationException. Extend this class to provide implementations of messages from the client.

See Also:

ImplPresenceServer

Nested Class Summary

Nested classes/interfaces inherited from interface cisco.uc.cuae.legacy.Presence

Presence.NonTriggeringSubscribeOptions, Presence.NonTriggeringSubscribeResult, Presence.NotifyOptions, Presence.SubscriptionTerminatedOptions, Presence.TriggeringSubscribeOptions, Presence.TriggeringSubscribeResult, Presence.UnsubscribeOptions, Presence.UnsubscribeResult

Nested classes/interfaces inherited from interface cisco.uc.cuae.legacy.CuaeCommon

CuaeCommon.CuaeResult

Constructor Summary

BasePresenceServer()

Method Summary

void	_sessionControl(java.lang.Object control, java.lang.Object value)
void	_sessionNotify(java.lang.Object event)
java.lang.Object	_sessionQuery(java.lang.Object query)
Presence.NonTriggeringSubscribeResult	nonTriggeringSubscribe(java.lang.String sessionId, java.lang.String requestUri, java.lang.String subscriber, java.lang.String password, Presence.NonTriggeringSubscribeOptions options) NonTriggeringSubscribe will register for status changes with a presence server; the status changes will result in non-triggering events.
Presence.TriggeringSubscribeResult	triggeringSubscribe(java.lang.String sessionId, java.lang.String requestUri, java.lang.String subscriber, java.lang.String password, Presence.TriggeringSubscribeOptions options) TriggeringSubscribe will register for status changes with a presence server; the status changes will result in triggering events.
Presence.UnsubscribeResult	unsubscribe(java.lang.String sessionId, java.lang.String requestUri, java.lang.String subscriber, java.lang.String password, java.lang.Boolean triggering, Presence.UnsubscribeOptions options) Unsubscribe will terminate a subscription.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BasePresenceServer

public BasePresenceServer()

Method Detail

_sessionQuery

public java.lang.Object _sessionQuery(java.lang.Object query)
                               throws java.lang.Exception

Specified by:

_sessionQuery in interface etch.bindings.java.support.ObjSession

Throws:

java.lang.Exception

_sessionControl

public void _sessionControl(java.lang.Object control,
                            java.lang.Object value)
                     throws java.lang.Exception

Specified by:

_sessionControl in interface etch.bindings.java.support.ObjSession

Throws:

java.lang.Exception

_sessionNotify

public void _sessionNotify(java.lang.Object event)
                    throws java.lang.Exception

Specified by:

_sessionNotify in interface etch.bindings.java.support.ObjSession

Throws:

java.lang.Exception

triggeringSubscribe

public Presence.TriggeringSubscribeResult triggeringSubscribe(java.lang.String sessionId,
                                                              java.lang.String requestUri,
                                                              java.lang.String subscriber,
                                                              java.lang.String password,
                                                              Presence.TriggeringSubscribeOptions options)

Description copied from interface: PresenceServer

TriggeringSubscribe will register for status changes with a presence server; the status changes will result in triggering events. The Presence Provider stores registrations only in memory. If the provider is disabled, or if the Cisco Unified Application Server service is restarted, all outstanding subscriptions will be lost. If the notify event results in a no handler, then the Presence Provider will remove the subscription automatically. Often an application will wish to be subscribed to a presentity for the duration of the application being installed and running. If building an application like that has this requirement, StaticConstruction is most likely the best-fit for reaching this requirement. Specifically, such an application can issue TriggeringSubscribe or NonTriggeringSubscribe in the StaticConstruction-triggered script to set up the subscription once the application is loaded. TriggeringSubscribe is used to cause another script to initiate every time a watched presentity changes status by firing a triggering Notify event. You can end a subscription by using the Unsubscribe action. TriggeringSubscribe and NonTriggeringSubscribe offer the same feature from the perspective that both provide a means to watch for presence changes of a presentity. The difference is that one action creates a triggering timer, and the other creates a non-triggering timer. Because script instances are a licensable resource and should be managed closely, the developer of the application must carefully consider which action is more appropriate. If the TriggeringSubscribe is successful, and the subscription is later ended by either the application with Unsubscribe or by the presence server, then the SubscriptionTerminated will be sent as a triggering event as well.

Specified by:

triggeringSubscribe in interface PresenceServer

Parameters:

sessionId - The session Id for this method call

requestUri - The URI of the presentity to be watched.

subscriber - The identity of the watcher.

password - The password of the watcher.

options - An object holding all the optional parameters

nonTriggeringSubscribe

public Presence.NonTriggeringSubscribeResult nonTriggeringSubscribe(java.lang.String sessionId,
                                                                    java.lang.String requestUri,
                                                                    java.lang.String subscriber,
                                                                    java.lang.String password,
                                                                    Presence.NonTriggeringSubscribeOptions options)

Description copied from interface: PresenceServer

NonTriggeringSubscribe will register for status changes with a presence server; the status changes will result in non-triggering events. The Presence Provider stores registrations only in memory. If the provider is disabled, or if the Cisco Unified Application Server service is restarted, all outstanding subscriptions will be lost. If the notify event results in a no handler, then the Presence Provider will remove the subscription automatically. Often an application will wish to be subscribed to a presentity for the duration of the application being installed and running. If building an application like that has this requirement, StaticConstruction is most likely the best-fit for reaching this requirement. Specifically, such an application can issue TriggeringSubscribe or NonTriggeringSubscribe in the StaticConstruction-triggered script to set up the subscription once the application is loaded. NonTriggeringSubscribe is used to cause a Notify event to fire every time a watched presentity changes status within the same script which initiated the NonTriggeringSubscribe action. You can end a subscription by using the Unsubscribe action. TriggeringSubscribe and NonTriggeringSubscribe offer the same feature from the perspective that both provide a means to watch for presence changes of a presentity. The difference is that one action creates a triggering timer, and the other creates a non-triggering timer. Because script instances are a licensable resource and should be managed closely, the developer of the application must carefully consider which action is more appropriate. If the NonTriggeringSubscribe is successful, and the subscription is later ended by either the application with Unsubscribe or by the presence server, then the SubscriptionTerminated will be sent as a non-triggering event as well to the script instance that initiated the NotTriggeringSubscribe action.

Specified by:

nonTriggeringSubscribe in interface PresenceServer

Parameters:

sessionId - The session Id for this method call

requestUri - The URI of the presentity to be watched.

subscriber - The identity of the watcher.

password - The password of the watcher.

options - An object holding all the optional parameters

unsubscribe

public Presence.UnsubscribeResult unsubscribe(java.lang.String sessionId,
                                              java.lang.String requestUri,
                                              java.lang.String subscriber,
                                              java.lang.String password,
                                              java.lang.Boolean triggering,
                                              Presence.UnsubscribeOptions options)

Description copied from interface: PresenceServer

Unsubscribe will terminate a subscription. None. The Unsubscribe action will indicate with the ResultCode result data parameter if the unsubscription was successful. Also, the SubscriptionTerminated event will also occur after this action has successfully completed. Both indicate the same thing: that the subscription is over. However, because SubscriptionTerminated also occurs when the presence server ends the subscription, the event handler of the SubscriptionTerminated event may offer a cleaner location to perform end-of-subscription logic.

Specified by:

unsubscribe in interface PresenceServer

Parameters:

sessionId - The session Id for this method call

requestUri - The URI of the presentity to unsubscribe from. This must be the same as the value supplied in the TriggeringSubscribe or NonTriggeringSubscribe action.

subscriber - The identity of the watcher. This must be the same as the value supplied in the TriggeringSubscribe or NonTriggeringSubscribe action.

password - The password of the watcher.

triggering - Indicates if the subscription you are cancelling is triggering timer, and the other creates a non-triggering.

options - An object holding all the optional parameters