protected static class EventPackageSupport.Subscription
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
protected javax.sip.address.Address |
address
The subscription
Address /Request URI associated with
this instance and the target of the SUBSCRIBE requests being created
as descriptions of this instance or of the NOTIFY requests being
sent. |
protected java.lang.String |
eventId
The id tag to be present in Event headers in order to have this
Subscription associated with a specific
Request or Response . |
Constructor and Description |
---|
Subscription(javax.sip.address.Address address,
java.lang.String eventId)
Initializes a new
Subscription instance with a specific
subscription Address /Request URI and a specific id tag
of the associated Event headers. |
Modifier and Type | Method and Description |
---|---|
protected boolean |
addressEquals(javax.sip.address.Address address)
Determines whether the Address/Request URI of this
Subscription is equal to a specific Address in the
sense of identifying one and the same resource.
|
protected boolean |
equals(javax.sip.address.Address address,
java.lang.String eventId)
Determines whether this Subscription is identified by a
specific subscription Address/Request URI and a specific id
tag of Event headers.
|
javax.sip.address.Address |
getAddress()
Gets the subscription
Address /Request URI associated
with this instance and the target of the SUBSCRIBE requests being
created as descriptions of this instance or of the NOTIFY requests
being sent. |
protected javax.sip.Dialog |
getDialog()
Gets the
Dialog which was created by the SUBSCRIBE
request associated with this Subscription or which was
used to send that request in. |
java.lang.String |
getEventId()
Gets the id tag to be present in Event headers in order to have this
Subscription associated with a specific
Request or Response . |
protected void |
removed()
Notifies this
Subscription that it has been removed from
the list of subscriptions of the EventPackageSupport
which used to contain it. |
protected void |
setDialog(javax.sip.Dialog dialog)
Sets the
Dialog which was created by the SUBSCRIBE
request associated with this Subscription or which was
used to send that request in. |
protected void |
setTimerTask(java.util.TimerTask timerTask)
Sets the
TimerTask associated this
Subscription . |
protected final javax.sip.address.Address address
Address
/Request URI associated with
this instance and the target of the SUBSCRIBE requests being created
as descriptions of this instance or of the NOTIFY requests being
sent.protected final java.lang.String eventId
Subscription
associated with a specific
Request
or Response
.public Subscription(javax.sip.address.Address address, java.lang.String eventId)
Subscription
instance with a specific
subscription Address
/Request URI and a specific id tag
of the associated Event headers.address
- the subscription Address
/Request URI which is
to be the target of the SUBSCRIBE requests associated with
the new instance or of the NOTIFY requests to be senteventId
- the value of the id tag to be placed in the Event headers
of the SUBSCRIBE and/or 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
themprotected boolean addressEquals(javax.sip.address.Address address)
address
- the Address to be checked for value equality
to the Address/Request URI of this Subscriptionprotected boolean equals(javax.sip.address.Address address, java.lang.String eventId)
address
- the subscription Address/Request URI to be
compared to the respective property of this SubscriptioneventId
- the id tag of Event headers to be compared to the
respective property of this Subscriptionpublic final javax.sip.address.Address getAddress()
Address
/Request URI associated
with this instance and the target of the SUBSCRIBE requests being
created as descriptions of this instance or of the NOTIFY requests
being sent.Address
/Request URI associated
with this instance and the target of the SUBSCRIBE requests
being created as descriptions of this instance or of the
NOTIFY requests being sentprotected javax.sip.Dialog getDialog()
Dialog
which was created by the SUBSCRIBE
request associated with this Subscription
or which was
used to send that request in.Dialog
which was created by the SUBSCRIBE
request associated with this Subscription
or
which was used to send that request in; null if the
success of the SUBSCRIBE request has not been confirmed yet
or this Subscription
was removed from the list
of the EventPackageSupport
it used to be inpublic final java.lang.String getEventId()
Subscription
associated with a specific
Request
or Response
. It is also being added
to the Event headers when they are created during the generation of
Request
s or Response
s describing this
Subscription
instance.Subscription
associated with a specific
Request
or Response
protected void removed()
Subscription
that it has been removed from
the list of subscriptions of the EventPackageSupport
which used to contain it.protected void setDialog(javax.sip.Dialog dialog)
Dialog
which was created by the SUBSCRIBE
request associated with this Subscription
or which was
used to send that request in.dialog
- the Dialog
which was created by the SUBSCRIBE
request associated with this Subscription
or
which was used to send that request inprotected void setTimerTask(java.util.TimerTask timerTask)
TimerTask
associated this
Subscription
. If this Subscription
already
knows of a different TimerTask
, that different one is
first canceled before remembering the specified new one.timerTask
- a TimerTask
to be associated with this
Subscription
Jitsi, the OpenSource Java VoIP and Instant Messaging client.
Distributable under Apache license.