com.ibm.soa.parlayx21.presence
Interface PresenceNotification

All Superinterfaces:
java.rmi.Remote
All Known Subinterfaces:
PresenceNotification_RI
All Known Implementing Classes:
PresenceNotificationBindingStub, PresenceNotificationProxy

public interface PresenceNotification
extends java.rmi.Remote

The interface contains the operations for the presence notification.

This client callback interface is used by the presence consumer interface to send notifications.

Referenced faults

None.


Method Summary
 void notifySubscription(java.net.URI presentity, PresencePermission[] decisions)
          This asynchronous method notifies the watcher that the server or the presentity handled the pending subscription.
 void statusChanged(java.lang.String correlator, java.net.URI presentity, PresenceAttribute[] changedAttributes)
          The asynchronous operation is called by the Web Service when an attribute for which notifications were requested changes.
 void statusEnd(java.lang.String correlator)
          The notifications have ended for this correlator.
 void subscriptionEnded(java.net.URI presentity, java.lang.String reason)
          This asynchronous operation is called by the Web Service to notify the watcher (application) that the subscription has terminated.
 

Method Detail

statusChanged

void statusChanged(java.lang.String correlator,
                   java.net.URI presentity,
                   PresenceAttribute[] changedAttributes)
                   throws java.rmi.RemoteException

The asynchronous operation is called by the Web Service when an attribute for which notifications were requested changes.

Parameters:
correlator - xsd:string

Identifies the notification request.

presentity - xsd:anyURI

The presentity whose presence status has changed.

changedAttributes - PresenceAttribute [1..unbounded]

The new presence data.

Throws:
java.rmi.RemoteException

statusEnd

void statusEnd(java.lang.String correlator)
               throws java.rmi.RemoteException

The notifications have ended for this correlator. This message will be delivered when the duration or count for notifications have been completed. This message will not be delivered in the case of an error ending the notifications or deliberate ending of the notifications (using endPresenceNotification operation).

Referenced faults

None.

Parameters:
correlator - xsd:string

Correlator provided in request to set up this notification.

Throws:
java.rmi.RemoteException

notifySubscription

void notifySubscription(java.net.URI presentity,
                        PresencePermission[] decisions)
                        throws java.rmi.RemoteException

This asynchronous method notifies the watcher that the server or the presentity handled the pending subscription.

Referenced faults

None.

Parameters:
presentity - xsd:anyURI

The presentity whose attributes the watcher wants to monitor.

decisions - PresencePermission [0..unbounded]

Denote the attributes the server/presentity accepted to expose.

Throws:
java.rmi.RemoteException

subscriptionEnded

void subscriptionEnded(java.net.URI presentity,
                       java.lang.String reason)
                       throws java.rmi.RemoteException

This asynchronous operation is called by the Web Service to notify the watcher (application) that the subscription has terminated. Typical reasons are a timeout of the underlying SIP soft state subscription (in accordance with [8] and [5]) or the decision of the presentity to block further presence information to that watcher. Since the subscription request has no expiration parameters, the service implementation may provide an inactivity timer that also triggers the subscriptionEnded operation.

Referenced faults

None.

Parameters:
presentity - xsd:anyURI

The presentity to which the subscription has terminated.

reason - xsd:string

Timeout, Blocked.

Throws:
java.rmi.RemoteException


Copyright © 2003 IBM Corp. All Rights Reserved.