org.globus.wsrf
Interface Subscription

All Superinterfaces:

Resource, ResourceLifetime

All Known Subinterfaces:

LocalInvocationEnabledSubscription

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.

Method Summary

org.apache.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.
QueryExpressionType	getPrecondition() Get the precondition associated with this subscription
org.apache.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.
QueryExpressionType	getSelector() Get the selector expression associated with this subscription
java.lang.Object	getSubscriptionPolicy() Get the policy associated with this subscription
TopicExpressionType	getTopicExpression() Get the topic expression associated with this subscription
boolean	getUseNotify() Wrap notification messages in the notify element?
boolean	isPaused() Is the subscription paused?
void	pause() Pause the subscription
void	resume() Resume the subscription

Methods inherited from interface org.globus.wsrf.ResourceLifetime

getCurrentTime, getTerminationTime, setTerminationTime

Method Detail

isPaused

public boolean isPaused()

Is the subscription paused?

Returns:

True if the subscription is paused, false if not.

pause

public void pause()
           throws java.lang.Exception

Pause the subscription

Throws:

java.lang.Exception

resume

public void resume()
            throws java.lang.Exception

Resume the subscription

Throws:

java.lang.Exception

getConsumerReference

public org.apache.axis.message.addressing.EndpointReferenceType getConsumerReference()

Get the consumer endpoint reference associated with this subscription

Returns:

The consumer endpoint reference

getProducerReference

public org.apache.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

getPrecondition

public QueryExpressionType getPrecondition()

Get the precondition associated with this subscription

Returns:

The precondition. May be null if no precondition was specified in the subscription.

getSelector

public QueryExpressionType getSelector()

Get the selector expression associated with this subscription

Returns:

The selector. May be null if no selector was specified in the subscription.

getSubscriptionPolicy

public java.lang.Object getSubscriptionPolicy()

Get the policy associated with this subscription

Returns:

The policy. May be null if no policy was specified in the subscription.

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.