org.apache.ws.eventing
Class AbstractSubscription

java.lang.Object
  extended byorg.apache.ws.eventing.AbstractSubscription
All Implemented Interfaces:
org.apache.ws.resource.Resource, Subscription
Direct Known Subclasses:
Subscription, Subscription

public abstract class AbstractSubscription
extends java.lang.Object
implements Subscription, org.apache.ws.resource.Resource


Field Summary
protected  NotificationConsumer consumer
           
protected  SubscriptionEndConsumer endconsumer
           
protected  java.util.Calendar m_creationTime
           
protected  org.apache.ws.addressing.EndpointReference m_endpointReference
          The EndpointReference for this resource
protected  java.lang.String m_id
           
protected  java.util.Calendar m_terminationTime
           
protected  boolean m_usenotify
           
protected  org.apache.ws.resource.ResourceHome rH
           
protected  org.apache.ws.resource.ResourceKey rK
           
 
Constructor Summary
AbstractSubscription()
           
 
Method Summary
 void addTerminationListener(org.apache.ws.resource.lifetime.ResourceTerminationListener resourceTerminationListener)
           
 java.util.Calendar getCreationTime()
          Returns the time at which this subscription was created.
 org.apache.ws.addressing.EndpointReference getEndpointReference()
          Returns the EndpointReference associated with this Resource.
 Filter getFilters()
          Returns a list of any notification filters that are associated with this subscription.
 java.lang.Object getID()
           
 NotificationConsumer getNotificationConsumer()
          Get the notification consumer associated with this subscription.
 NotificationProducer getNotificationProducer()
          Get the notification producer associated with this subscription.
 org.apache.ws.resource.ResourceKey getResourceKey()
           
 SubscriptionEndConsumer getSubscriptionEndConsumer()
          Get the subscriptionEnd consumer associated with this subscription.
 java.util.Calendar getTerminationTime()
          Gets the termination time for this subscription (i.e.
 boolean getUseNotify()
          Returns the delivery mode to be used for notifications sent for this subscription.
 void setEpr(org.apache.ws.addressing.EndpointReference epr)
           
 void setID(java.lang.Object id)
           
 void setNotificationConsumer(NotificationConsumer consumer)
           
 void setResourceHome(org.apache.ws.resource.ResourceHome rH)
           
 void setResourceKey(org.apache.ws.resource.ResourceKey rK)
           
 void setSubscriptionEndConsumer(SubscriptionEndConsumer endconsumer)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.ws.pubsub.Subscription
setTerminationTime, unsubscribe
 
Methods inherited from interface org.apache.ws.resource.Resource
destroy, init
 

Field Detail

consumer

protected NotificationConsumer consumer

endconsumer

protected SubscriptionEndConsumer endconsumer

m_id

protected java.lang.String m_id

m_terminationTime

protected java.util.Calendar m_terminationTime

m_creationTime

protected java.util.Calendar m_creationTime

rH

protected org.apache.ws.resource.ResourceHome rH

rK

protected org.apache.ws.resource.ResourceKey rK

m_usenotify

protected boolean m_usenotify

m_endpointReference

protected org.apache.ws.addressing.EndpointReference m_endpointReference
The EndpointReference for this resource

Constructor Detail

AbstractSubscription

public AbstractSubscription()
Method Detail

setResourceKey

public void setResourceKey(org.apache.ws.resource.ResourceKey rK)

getResourceKey

public org.apache.ws.resource.ResourceKey getResourceKey()

setResourceHome

public void setResourceHome(org.apache.ws.resource.ResourceHome rH)

setEpr

public void setEpr(org.apache.ws.addressing.EndpointReference epr)

getID

public java.lang.Object getID()
Specified by:
getID in interface org.apache.ws.resource.Resource

setID

public void setID(java.lang.Object id)
Specified by:
setID in interface org.apache.ws.resource.Resource

setNotificationConsumer

public void setNotificationConsumer(NotificationConsumer consumer)

setSubscriptionEndConsumer

public void setSubscriptionEndConsumer(SubscriptionEndConsumer endconsumer)

getNotificationConsumer

public NotificationConsumer getNotificationConsumer()
Description copied from interface: Subscription
Get the notification consumer associated with this subscription.

Specified by:
getNotificationConsumer in interface Subscription
Returns:
the notification consumer

getSubscriptionEndConsumer

public SubscriptionEndConsumer getSubscriptionEndConsumer()
Description copied from interface: Subscription
Get the subscriptionEnd consumer associated with this subscription.

Specified by:
getSubscriptionEndConsumer in interface Subscription
Returns:
the subscriptionEnd consumer

getNotificationProducer

public NotificationProducer getNotificationProducer()
Description copied from interface: Subscription
Get the notification producer associated with this subscription.

Specified by:
getNotificationProducer in interface Subscription
Returns:
the notification producer

getCreationTime

public java.util.Calendar getCreationTime()
Description copied from interface: Subscription
Returns the time at which this subscription was created.

Specified by:
getCreationTime in interface Subscription
Returns:
the time at which this subscription was created

getUseNotify

public boolean getUseNotify()
Description copied from interface: Subscription
Returns the delivery mode to be used for notifications sent for this subscription. If null, a delivery mode was not specified, and a default delivery mode will be used.

Specified by:
getUseNotify in interface Subscription
Returns:
the delivery mode to be used for notifications sent for this subscription

getFilters

public Filter getFilters()
Description copied from interface: Subscription
Returns a list of any notification filters that are associated with this subscription. The filters are ordered in the order in which they will be applied to notifications.

Specified by:
getFilters in interface Subscription
Returns:
a list of any notification filters that are associated with this subscription

getTerminationTime

public java.util.Calendar getTerminationTime()
Description copied from interface: Subscription
Gets the termination time for this subscription (i.e. the time at which it expires).

Specified by:
getTerminationTime in interface Subscription
Returns:
the termination time

addTerminationListener

public void addTerminationListener(org.apache.ws.resource.lifetime.ResourceTerminationListener resourceTerminationListener)
Specified by:
addTerminationListener in interface org.apache.ws.resource.Resource

getEndpointReference

public org.apache.ws.addressing.EndpointReference getEndpointReference()
Returns the EndpointReference associated with this Resource.

Specified by:
getEndpointReference in interface org.apache.ws.resource.Resource
Returns:
The Resource's EndpointReference or null if the EndpointReference has not been set. Note: It is the responsibility of the Resource creator to set the EndpointReference (i.e. ResourceHome impl)


Copyright © 2004-2005 Apache Software Foundation. All Rights Reserved.