Apache CXF API

org.apache.cxf.wsn
Class AbstractSubscription

java.lang.Object
  extended by org.apache.cxf.wsn.AbstractEndpoint
      extended by org.apache.cxf.wsn.AbstractSubscription
All Implemented Interfaces:
EndpointMBean, PausableSubscriptionManager
Direct Known Subclasses:
JmsSubscription

public abstract class AbstractSubscription
extends AbstractEndpoint
implements PausableSubscriptionManager


Field Summary
protected  AbstractNotificationBroker broker
           
protected  W3CEndpointReference consumerReference
           
protected  QueryExpressionType contentFilter
           
protected  DatatypeFactory datatypeFactory
           
static QName QNAME_MESSAGE_CONTENT
           
static QName QNAME_PRODUCER_PROPERTIES
           
static QName QNAME_TOPIC_EXPRESSION
           
static QName QNAME_USE_RAW
           
protected  XMLGregorianCalendar terminationTime
           
protected  TopicExpressionType topic
           
protected  boolean useRaw
           
static String WSN_URI
           
static String XPATH1_URI
           
 
Fields inherited from class org.apache.cxf.wsn.AbstractEndpoint
address, endpoint, manager, name
 
Constructor Summary
AbstractSubscription(String name)
           
 
Method Summary
 void create(Subscribe subscribeRequest)
           
 AbstractNotificationBroker getBroker()
           
protected  XMLGregorianCalendar getCurrentTime()
           
 XMLGregorianCalendar getTerminationTime()
           
protected  XMLGregorianCalendar parseTerminationTime(String value)
           
protected abstract  void pause()
           
 PauseSubscriptionResponse pauseSubscription(PauseSubscription pauseSubscriptionRequest)
           
 RenewResponse renew(Renew renewRequest)
           
protected abstract  void renew(XMLGregorianCalendar time)
           
protected abstract  void resume()
           
 ResumeSubscriptionResponse resumeSubscription(ResumeSubscription resumeSubscriptionRequest)
           
 void setBroker(AbstractNotificationBroker broker)
           
 void setTerminationTime(XMLGregorianCalendar terminationTime)
           
protected abstract  void start()
           
protected  void unsubscribe()
           
 UnsubscribeResponse unsubscribe(Unsubscribe unsubscribeRequest)
           
protected  XMLGregorianCalendar validateInitialTerminationTime(String value)
           
protected  void validateSubscription(Subscribe subscribeRequest)
           
protected  XMLGregorianCalendar validateTerminationTime(String value)
           
 
Methods inherited from class org.apache.cxf.wsn.AbstractEndpoint
getAddress, getEpr, getManager, getMBeanName, getName, register, setAddress, setManager, unregister
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

WSN_URI

public static final String WSN_URI
See Also:
Constant Field Values

XPATH1_URI

public static final String XPATH1_URI
See Also:
Constant Field Values

QNAME_TOPIC_EXPRESSION

public static final QName QNAME_TOPIC_EXPRESSION

QNAME_PRODUCER_PROPERTIES

public static final QName QNAME_PRODUCER_PROPERTIES

QNAME_MESSAGE_CONTENT

public static final QName QNAME_MESSAGE_CONTENT

QNAME_USE_RAW

public static final QName QNAME_USE_RAW

datatypeFactory

protected DatatypeFactory datatypeFactory

terminationTime

protected XMLGregorianCalendar terminationTime

useRaw

protected boolean useRaw

topic

protected TopicExpressionType topic

contentFilter

protected QueryExpressionType contentFilter

consumerReference

protected W3CEndpointReference consumerReference

broker

protected AbstractNotificationBroker broker
Constructor Detail

AbstractSubscription

public AbstractSubscription(String name)
Method Detail

renew

public RenewResponse renew(Renew renewRequest)
                    throws ResourceUnknownFault,
                           UnacceptableTerminationTimeFault
Specified by:
renew in interface PausableSubscriptionManager
Parameters:
renewRequest -
Returns:
returns org.oasis_open.docs.wsn.b_1.RenewResponse
Throws:
UnacceptableTerminationTimeFault
ResourceUnknownFault

unsubscribe

public UnsubscribeResponse unsubscribe(Unsubscribe unsubscribeRequest)
                                throws ResourceUnknownFault,
                                       UnableToDestroySubscriptionFault
Specified by:
unsubscribe in interface PausableSubscriptionManager
Parameters:
unsubscribeRequest -
Returns:
returns org.oasis_open.docs.wsn.b_1.UnsubscribeResponse
Throws:
UnableToDestroySubscriptionFault
ResourceUnknownFault

pauseSubscription

public PauseSubscriptionResponse pauseSubscription(PauseSubscription pauseSubscriptionRequest)
                                            throws PauseFailedFault,
                                                   ResourceUnknownFault
Specified by:
pauseSubscription in interface PausableSubscriptionManager
Parameters:
pauseSubscriptionRequest -
Returns:
returns org.oasis_open.docs.wsn.b_1.PauseSubscriptionResponse
Throws:
PauseFailedFault
ResourceUnknownFault

resumeSubscription

public ResumeSubscriptionResponse resumeSubscription(ResumeSubscription resumeSubscriptionRequest)
                                              throws ResourceUnknownFault,
                                                     ResumeFailedFault
Specified by:
resumeSubscription in interface PausableSubscriptionManager
Parameters:
resumeSubscriptionRequest -
Returns:
returns org.oasis_open.docs.wsn.b_1.ResumeSubscriptionResponse
Throws:
ResumeFailedFault
ResourceUnknownFault

validateInitialTerminationTime

protected XMLGregorianCalendar validateInitialTerminationTime(String value)
                                                       throws UnacceptableInitialTerminationTimeFault
Throws:
UnacceptableInitialTerminationTimeFault

validateTerminationTime

protected XMLGregorianCalendar validateTerminationTime(String value)
                                                throws UnacceptableTerminationTimeFault
Throws:
UnacceptableTerminationTimeFault

parseTerminationTime

protected XMLGregorianCalendar parseTerminationTime(String value)

getCurrentTime

protected XMLGregorianCalendar getCurrentTime()

getTerminationTime

public XMLGregorianCalendar getTerminationTime()

setTerminationTime

public void setTerminationTime(XMLGregorianCalendar terminationTime)

create

public void create(Subscribe subscribeRequest)
            throws InvalidFilterFault,
                   InvalidMessageContentExpressionFault,
                   InvalidProducerPropertiesExpressionFault,
                   InvalidTopicExpressionFault,
                   SubscribeCreationFailedFault,
                   TopicExpressionDialectUnknownFault,
                   TopicNotSupportedFault,
                   UnacceptableInitialTerminationTimeFault,
                   UnrecognizedPolicyRequestFault,
                   UnsupportedPolicyRequestFault
Throws:
InvalidFilterFault
InvalidMessageContentExpressionFault
InvalidProducerPropertiesExpressionFault
InvalidTopicExpressionFault
SubscribeCreationFailedFault
TopicExpressionDialectUnknownFault
TopicNotSupportedFault
UnacceptableInitialTerminationTimeFault
UnrecognizedPolicyRequestFault
UnsupportedPolicyRequestFault

start

protected abstract void start()
                       throws SubscribeCreationFailedFault
Throws:
SubscribeCreationFailedFault

pause

protected abstract void pause()
                       throws PauseFailedFault
Throws:
PauseFailedFault

resume

protected abstract void resume()
                        throws ResumeFailedFault
Throws:
ResumeFailedFault

renew

protected abstract void renew(XMLGregorianCalendar time)
                       throws UnacceptableTerminationTimeFault
Throws:
UnacceptableTerminationTimeFault

unsubscribe

protected void unsubscribe()
                    throws UnableToDestroySubscriptionFault
Throws:
UnableToDestroySubscriptionFault

validateSubscription

protected void validateSubscription(Subscribe subscribeRequest)
                             throws InvalidFilterFault,
                                    InvalidMessageContentExpressionFault,
                                    InvalidProducerPropertiesExpressionFault,
                                    InvalidTopicExpressionFault,
                                    SubscribeCreationFailedFault,
                                    TopicExpressionDialectUnknownFault,
                                    TopicNotSupportedFault,
                                    UnacceptableInitialTerminationTimeFault,
                                    UnrecognizedPolicyRequestFault,
                                    UnsupportedPolicyRequestFault
Throws:
InvalidFilterFault
InvalidMessageContentExpressionFault
InvalidProducerPropertiesExpressionFault
InvalidTopicExpressionFault
SubscribeCreationFailedFault
TopicExpressionDialectUnknownFault
TopicNotSupportedFault
UnacceptableInitialTerminationTimeFault
UnrecognizedPolicyRequestFault
UnsupportedPolicyRequestFault

getBroker

public AbstractNotificationBroker getBroker()

setBroker

public void setBroker(AbstractNotificationBroker broker)

Apache CXF API

Apache CXF