net.java.sip.communicator.impl.protocol.sip
Class EventPackageNotifier.Subscription

java.lang.Object
  net.java.sip.communicator.impl.protocol.sip.EventPackageSupport.Subscription
      net.java.sip.communicator.impl.protocol.sip.EventPackageNotifier.Subscription

Enclosing class:

EventPackageNotifier

public abstract static class EventPackageNotifier.Subscription
extends EventPackageSupport.Subscription

Represents a general event package subscription in the sense of RFC 3265 "Session Initiation Protocol (SIP)-Specific Event Notification" from the point of view of the notifier and its signaling characteristics such as Request URI, id tag value of its Event header, the Dialog which has been created by the associated SUBSCRIBE request or through which NOTIFY requests are to be sent. Additionally, represents the subscription-specific processing of the related Requests and Response s thus allowing implementers to tap into the general event package subscription operations and provide the event package-specific processing.

Field Summary

Fields inherited from class net.java.sip.communicator.impl.protocol.sip.EventPackageSupport.Subscription

address, eventId

Constructor Summary

EventPackageNotifier.Subscription(javax.sip.address.Address fromAddress, String eventId)
Initializes a new Subscription instance with a specific subscription Address/Request URI and a specific id tag of the associated Event headers.

Method Summary

protected abstract byte[]

createNotifyContent(String subscriptionState, String reason) Creates the content of the NOTIFY request to be sent to the target represented by this Subscription and having a specific subscription state and a specific reason for that subscription state.

Methods inherited from class net.java.sip.communicator.impl.protocol.sip.EventPackageSupport.Subscription

addressEquals, equals, getAddress, getDialog, getEventId, removed, setDialog, setTimerTask

Methods inherited from class java.lang.Object

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

Constructor Detail

EventPackageNotifier.Subscription

public EventPackageNotifier.Subscription(javax.sip.address.Address fromAddress,
                                         String eventId)

Initializes a new Subscription instance with a specific subscription Address/Request URI and a specific id tag of the associated Event headers.

Parameters:

fromAddress - the subscription Address/Request URI which is to be the target of the NOTIFY requests associated with the new instance

eventId - the value of the id tag to be placed in the Event headers of the NOTIFY requests created for the new instance and to be present in the received Event headers in order to have the new instance associated with them

Method Detail

createNotifyContent

protected abstract byte[] createNotifyContent(String subscriptionState,
                                              String reason)

Creates the content of the NOTIFY request to be sent to the target represented by this Subscription and having a specific subscription state and a specific reason for that subscription state.

Parameters:

subscriptionState - the subscription state to be notified about in the NOTIFY request which is to carry the returned content

reason - the reason for the subscription state to be notified about in the NOTIFY request which is to carry the returned content

Returns:

an array of bytes representing the content of the NOTIFY request to be sent to the target represented by this Subscription