org.globus.wsrf
Interface Subscription

All Superinterfaces:
Resource, ResourceLifetime
All Known Subinterfaces:
LocalInvocationEnabledSubscription, PausableSubscription
All Known Implementing Classes:
SimpleSubscription

public interface Subscription
extends Resource, ResourceLifetime

Interface to be implemented by subscription resources. Exposes the information associated with a subscription request as well as resource lifetime related state. FIXME; we could separate this out as two separate interfaces, since subscriptions can be non-WS resources. For now leaving it as it is.


Method Summary
 org.globus.axis.message.addressing.EndpointReferenceType getConsumerReference()
          Get the consumer endpoint reference associated with this subscription
 java.util.Calendar getCreationTime()
          Get the time at which the resource was created.
 FilterType getFilterType()
           
 org.globus.axis.message.addressing.EndpointReferenceType getProducerReference()
          Get the producer endpoint reference associated with this subscription
 java.lang.Object getResource()
          Get the producing resource
 ClientSecurityDescriptor getSecurityProperties()
          Get security properties that determine security for the notification call.
 TopicExpressionType getTopicExpression()
          Get the topic expression associated with this subscription
 boolean getUseNotify()
          Wrap notification messages in the notify element?
 
Methods inherited from interface org.globus.wsrf.ResourceLifetime
getCurrentTime, getTerminationTime, setTerminationTime
 

Method Detail

getConsumerReference

public org.globus.axis.message.addressing.EndpointReferenceType getConsumerReference()
Get the consumer endpoint reference associated with this subscription

Returns:
The consumer endpoint reference

getProducerReference

public org.globus.axis.message.addressing.EndpointReferenceType getProducerReference()
Get the producer endpoint reference associated with this subscription

Returns:
The producer endpoint reference

getTopicExpression

public TopicExpressionType getTopicExpression()
Get the topic expression associated with this subscription

Returns:
The topic expression

getFilterType

public FilterType getFilterType()

getUseNotify

public boolean getUseNotify()
Wrap notification messages in the notify element?

Returns:
True (default) if notify should be used, false if not.

getResource

public java.lang.Object getResource()
                             throws java.lang.Exception
Get the producing resource

Returns:
The producing resource
Throws:
java.lang.Exception

getCreationTime

public java.util.Calendar getCreationTime()
Get the time at which the resource was created.

Returns:
The creation time

getSecurityProperties

public ClientSecurityDescriptor getSecurityProperties()
Get security properties that determine security for the notification call. If any. Returns null for insecure subcriptions

Returns:
map of security properties.