org.mobicents.slee.sippresence.client
Interface PresenceClientControlSbbLocalObject

All Superinterfaces:

javax.slee.SbbLocalObject

All Known Subinterfaces:

InternalPresenceClientControlSbbLocalObject

All Known Implementing Classes:

InternalPresenceClientControlSbb

public interface PresenceClientControlSbbLocalObject
extends javax.slee.SbbLocalObject

Client interface to a presence server.

Author:

martins

Method Summary

void	modifyPublication(java.lang.Object requestId, java.lang.String entity, java.lang.String eTag, java.lang.String document, java.lang.String contentType, java.lang.String contentSubType, int expires) Modifies the publication identified by the specified Entity and ETag.
void	newPublication(java.lang.Object requestId, java.lang.String entity, java.lang.String document, java.lang.String contentType, java.lang.String contentSubType, int expires) Creates a new publication for the specified Entity.
void	newSubscription(java.lang.String subscriber, java.lang.String subscriberdisplayName, java.lang.String notifier, java.lang.String eventPackage, java.lang.String subscriptionId, int expires) Creates a subscription
void	refreshPublication(java.lang.Object requestId, java.lang.String entity, java.lang.String eTag, int expires) Refreshes the publication identified by the specified Entity and ETag.
void	refreshSubscription(java.lang.String subscriber, java.lang.String notifier, java.lang.String eventPackage, java.lang.String subscriptionId, int expires) Refreshes a subscription
void	removePublication(java.lang.Object requestId, java.lang.String entity, java.lang.String eTag) Removes the publication identified by the specified Entity and ETag.
void	removeSubscription(java.lang.String subscriber, java.lang.String notifier, java.lang.String eventPackage, java.lang.String subscriptionId) Terminates a subscription.
void	setParentSbb(PresenceClientControlParentSbbLocalObject parentSbb) Used to set the call back sbb local object in the sbb implementing this interface.

Methods inherited from interface javax.slee.SbbLocalObject

getSbbPriority, isIdentical, remove, setSbbPriority

Method Detail

setParentSbb

void setParentSbb(PresenceClientControlParentSbbLocalObject parentSbb)

Used to set the call back sbb local object in the sbb implementing this interface. Must be used whenever a new object of this interface is created. An example: ChildRelation childRelation = getChildRelation(); PresenceClientControlSbbLocalObject childSbb = (PresenceClientControlSbbLocalObject) childRelation.create(); childSbb.setParentSbb( (PresenceClientControlParentSbbLocalObject)this.getSbbContext().getSbbLocalObject());

Parameters:

parent -

newPublication

void newPublication(java.lang.Object requestId,
                    java.lang.String entity,
                    java.lang.String document,
                    java.lang.String contentType,
                    java.lang.String contentSubType,
                    int expires)

Creates a new publication for the specified Entity.

Parameters:

requestId - an object that identifies the request, the child sbb will return it when providing the response

entity -

document -

contentType -

contentSubType -

expires - the time in seconds, which the publication is valid

refreshPublication

void refreshPublication(java.lang.Object requestId,
                        java.lang.String entity,
                        java.lang.String eTag,
                        int expires)

Refreshes the publication identified by the specified Entity and ETag.

Parameters:

requestId - an object that identifies the request, the child sbb will return it when providing the response

entity -

eTag -

expires - the time in seconds, which the publication is valid

modifyPublication

void modifyPublication(java.lang.Object requestId,
                       java.lang.String entity,
                       java.lang.String eTag,
                       java.lang.String document,
                       java.lang.String contentType,
                       java.lang.String contentSubType,
                       int expires)

Modifies the publication identified by the specified Entity and ETag.

Parameters:

requestId - an object that identifies the request, the child sbb will return it when providing the response

entity -

eTag -

document -

contentType -

contentSubType -

expires - the time in seconds, which the publication is valid

removePublication

void removePublication(java.lang.Object requestId,
                       java.lang.String entity,
                       java.lang.String eTag)

Removes the publication identified by the specified Entity and ETag.

Parameters:

requestId - an object that identifies the request, the child sbb will return it when providing the response

entity -

eventPackage -

eTag -

newSubscription

void newSubscription(java.lang.String subscriber,
                     java.lang.String subscriberdisplayName,
                     java.lang.String notifier,
                     java.lang.String eventPackage,
                     java.lang.String subscriptionId,
                     int expires)

Creates a subscription

Parameters:

subscriber -

notifier -

eventPackage - only event packages "presence" and "presence.winfo" may be supported by the presence server

subscriptionId -

expires -

refreshSubscription

void refreshSubscription(java.lang.String subscriber,
                         java.lang.String notifier,
                         java.lang.String eventPackage,
                         java.lang.String subscriptionId,
                         int expires)

Refreshes a subscription

Parameters:

subscriber -

notifier -

eventPackage - only event packages "presence" and "presence.winfo" may be supported by the presence server

subscriptionId -

expires -

removeSubscription

void removeSubscription(java.lang.String subscriber,
                        java.lang.String notifier,
                        java.lang.String eventPackage,
                        java.lang.String subscriptionId)

Terminates a subscription.

Parameters:

subscriber -

notifier -

eventPackage - only event packages "presence" and "presence.winfo" may be supported by the presence server

subscriptionId -