You are viewing a plain text version of this content. The canonical link for it is here.
Posted to pubscribe-commits@ws.apache.org by sc...@apache.org on 2005/07/26 23:11:50 UTC
svn commit: r225396 - in
/webservices/pubscribe/trunk/src/java/org/apache/ws/notification: base/
base/faults/ base/v2004_06/porttype/ tool/ topics/
Author: scamp
Date: Tue Jul 26 14:11:36 2005
New Revision: 225396
URL: http://svn.apache.org/viewcvs?rev=225396&view=rev
Log:
updated javadocs
Modified:
webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/NotificationProducerResource.java
webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/Subscription.java
webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/WsnNamespaceVersionHolder.java
webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/faults/InvalidTopicExpressionFaultException.java
webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/faults/NoCurrentMessageOnTopicFaultException.java
webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/faults/PauseFailedFaultException.java
webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/faults/ResumeFailedFaultException.java
webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/faults/SubscribeCreationFailedFaultException.java
webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/faults/TopicNotSupportedFaultException.java
webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/faults/TopicPathDialectUnknownFaultException.java
webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/v2004_06/porttype/NotificationConsumerPortType.java
webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/v2004_06/porttype/NotificationProducerPortType.java
webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/v2004_06/porttype/SubscriptionManagerPortType.java
webservices/pubscribe/trunk/src/java/org/apache/ws/notification/tool/WsnWsdl2Java.java
webservices/pubscribe/trunk/src/java/org/apache/ws/notification/tool/WsnWsdl2JavaTask.java
webservices/pubscribe/trunk/src/java/org/apache/ws/notification/topics/ResourcePropertyValueChangeTopic.java
webservices/pubscribe/trunk/src/java/org/apache/ws/notification/topics/Topic.java
webservices/pubscribe/trunk/src/java/org/apache/ws/notification/topics/TopicSpace.java
webservices/pubscribe/trunk/src/java/org/apache/ws/notification/topics/TopicSpaceSet.java
Modified: webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/NotificationProducerResource.java
URL: http://svn.apache.org/viewcvs/webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/NotificationProducerResource.java?rev=225396&r1=225395&r2=225396&view=diff
==============================================================================
--- webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/NotificationProducerResource.java (original)
+++ webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/NotificationProducerResource.java Tue Jul 26 14:11:36 2005
@@ -25,7 +25,11 @@
*/
public interface NotificationProducerResource extends PropertiesResource
{
-
+ /**
+ * Returns the TopicSpaceSet for the NotificationProducer
+ *
+ * @return the TopicSpaceSet for this NotificationProducer
+ */
TopicSpaceSet getTopicSpaceSet();
}
Modified: webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/Subscription.java
URL: http://svn.apache.org/viewcvs/webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/Subscription.java?rev=225396&r1=225395&r2=225396&view=diff
==============================================================================
--- webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/Subscription.java (original)
+++ webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/Subscription.java Tue Jul 26 14:11:36 2005
@@ -111,12 +111,33 @@
*/
EndpointReference getConsumerReference();
+ /**
+ * Sets the policy for the subscription
+ *
+ * @param policy
+ */
void setPolicy( Object policy );
+ /**
+ * Sets the precondition for the subscription.
+ *
+ * @param precondition
+ */
void setPrecondition( QueryExpression precondition );
+ /**
+ * Sets the selector for the subscription
+ *
+ * @param selector
+ */
void setSelector( QueryExpression selector );
- void setUseNotify( boolean useNotify );
+ /**
+ * Sets the boolean useNotify flag on the subscription to determine if the notification is wrapped
+ * in a Notify element.
+ *
+ * @param useNotify
+ */
+ void setUseNotify( boolean useNotify );
}
Modified: webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/WsnNamespaceVersionHolder.java
URL: http://svn.apache.org/viewcvs/webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/WsnNamespaceVersionHolder.java?rev=225396&r1=225395&r2=225396&view=diff
==============================================================================
--- webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/WsnNamespaceVersionHolder.java (original)
+++ webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/WsnNamespaceVersionHolder.java Tue Jul 26 14:11:36 2005
@@ -3,11 +3,31 @@
import org.apache.ws.resource.properties.NamespaceVersionHolder;
/**
+ * An extension of the {@link NamespaceVersionHolder} which adds WSN-specific
+ * getters for the WSN namespaces.
+ *
+ * Implementations of this interface are used to provide an object which contains all the
+ * namespaces supported by a given Resource. This allows us to group the properly associated versioned
+ * namespaces together in one place.
+ *
* @author Sal Campana
*/
public interface WsnNamespaceVersionHolder extends NamespaceVersionHolder
{
+ /**
+ * Returns the namespace for the Topics Spec
+ *
+ * @return Topic namespace
+ */
String getTopicsXsdNamespace();
+ /**
+ * Returns the BaseNotification namespace
+ * @return BaseNotification namespace
+ */
String getBaseNotificationXsdNamespace();
+ /**
+ * Returns the Brokered Notification namespace
+ * @return Brokered Notification namespace
+ */
String getBrokeredNotificationXsdNamespace();
}
Modified: webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/faults/InvalidTopicExpressionFaultException.java
URL: http://svn.apache.org/viewcvs/webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/faults/InvalidTopicExpressionFaultException.java?rev=225396&r1=225395&r2=225396&view=diff
==============================================================================
--- webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/faults/InvalidTopicExpressionFaultException.java (original)
+++ webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/faults/InvalidTopicExpressionFaultException.java Tue Jul 26 14:11:36 2005
@@ -19,6 +19,10 @@
m_name = new QName( namespaceVersionHolder.getBaseNotificationXsdNamespace(), "InvalidTopicExpressionFault", BaseNotificationConstants.NSPREFIX_WSNT_SCHEMA );
}
+ /**
+ * Returns the {@link QName} of this fault
+ * @return fault QName
+ */
public QName getBaseFaultName()
{
return m_name;
Modified: webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/faults/NoCurrentMessageOnTopicFaultException.java
URL: http://svn.apache.org/viewcvs/webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/faults/NoCurrentMessageOnTopicFaultException.java?rev=225396&r1=225395&r2=225396&view=diff
==============================================================================
--- webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/faults/NoCurrentMessageOnTopicFaultException.java (original)
+++ webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/faults/NoCurrentMessageOnTopicFaultException.java Tue Jul 26 14:11:36 2005
@@ -19,6 +19,10 @@
m_name = new QName( namespaceVersionHolder.getBaseNotificationXsdNamespace(), "NoCurrentMessageOnTopicFault", BaseNotificationConstants.NSPREFIX_WSNT_SCHEMA );
}
+ /**
+ * Returns the {@link QName} of this fault
+ * @return fault QName
+ */
public QName getBaseFaultName()
{
return m_name;
Modified: webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/faults/PauseFailedFaultException.java
URL: http://svn.apache.org/viewcvs/webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/faults/PauseFailedFaultException.java?rev=225396&r1=225395&r2=225396&view=diff
==============================================================================
--- webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/faults/PauseFailedFaultException.java (original)
+++ webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/faults/PauseFailedFaultException.java Tue Jul 26 14:11:36 2005
@@ -20,7 +20,10 @@
new QName( namespaceVersionHolder.getBaseNotificationXsdNamespace(), "PauseFailedFault",
BaseNotificationConstants.NSPREFIX_WSNT_SCHEMA );
}
-
+ /**
+ * Returns the {@link QName} of this fault
+ * @return fault QName
+ */
public QName getBaseFaultName()
{
return m_name;
Modified: webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/faults/ResumeFailedFaultException.java
URL: http://svn.apache.org/viewcvs/webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/faults/ResumeFailedFaultException.java?rev=225396&r1=225395&r2=225396&view=diff
==============================================================================
--- webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/faults/ResumeFailedFaultException.java (original)
+++ webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/faults/ResumeFailedFaultException.java Tue Jul 26 14:11:36 2005
@@ -20,7 +20,10 @@
new QName( namespaceVersionHolder.getBaseNotificationXsdNamespace(), "ResumeFailedFault",
BaseNotificationConstants.NSPREFIX_WSNT_SCHEMA );
}
-
+ /**
+ * Returns the {@link QName} of this fault
+ * @return fault QName
+ */
public QName getBaseFaultName()
{
return m_name;
Modified: webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/faults/SubscribeCreationFailedFaultException.java
URL: http://svn.apache.org/viewcvs/webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/faults/SubscribeCreationFailedFaultException.java?rev=225396&r1=225395&r2=225396&view=diff
==============================================================================
--- webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/faults/SubscribeCreationFailedFaultException.java (original)
+++ webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/faults/SubscribeCreationFailedFaultException.java Tue Jul 26 14:11:36 2005
@@ -18,7 +18,10 @@
super(namespaceVersionHolder, "Unable to create subscription due to internal server error.");
m_name = new QName( namespaceVersionHolder.getBaseNotificationXsdNamespace(), "SubscribeCreationFailedFault", BaseNotificationConstants.NSPREFIX_WSNT_SCHEMA );
}
-
+ /**
+ * Returns the {@link QName} of this fault
+ * @return fault QName
+ */
public QName getBaseFaultName()
{
return m_name;
Modified: webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/faults/TopicNotSupportedFaultException.java
URL: http://svn.apache.org/viewcvs/webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/faults/TopicNotSupportedFaultException.java?rev=225396&r1=225395&r2=225396&view=diff
==============================================================================
--- webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/faults/TopicNotSupportedFaultException.java (original)
+++ webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/faults/TopicNotSupportedFaultException.java Tue Jul 26 14:11:36 2005
@@ -18,7 +18,10 @@
super(namespaceVersionHolder, faultString);
m_name = new QName( namespaceVersionHolder.getBaseNotificationXsdNamespace(), "TopicNotSupportedFault", BaseNotificationConstants.NSPREFIX_WSNT_SCHEMA );
}
-
+ /**
+ * Returns the {@link QName} of this fault
+ * @return fault QName
+ */
public QName getBaseFaultName()
{
return m_name;
Modified: webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/faults/TopicPathDialectUnknownFaultException.java
URL: http://svn.apache.org/viewcvs/webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/faults/TopicPathDialectUnknownFaultException.java?rev=225396&r1=225395&r2=225396&view=diff
==============================================================================
--- webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/faults/TopicPathDialectUnknownFaultException.java (original)
+++ webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/faults/TopicPathDialectUnknownFaultException.java Tue Jul 26 14:11:36 2005
@@ -18,7 +18,10 @@
super(namespaceVersionHolder, faultString);
m_name = new QName( namespaceVersionHolder.getBaseNotificationXsdNamespace(), "TopicPathDialectUnknownFault", BaseNotificationConstants.NSPREFIX_WSNT_SCHEMA );
}
-
+ /**
+ * Returns the {@link QName} of this fault
+ * @return fault QName
+ */
public QName getBaseFaultName()
{
return m_name;
Modified: webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/v2004_06/porttype/NotificationConsumerPortType.java
URL: http://svn.apache.org/viewcvs/webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/v2004_06/porttype/NotificationConsumerPortType.java?rev=225396&r1=225395&r2=225396&view=diff
==============================================================================
--- webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/v2004_06/porttype/NotificationConsumerPortType.java (original)
+++ webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/v2004_06/porttype/NotificationConsumerPortType.java Tue Jul 26 14:11:36 2005
@@ -25,10 +25,14 @@
*/
public interface NotificationConsumerPortType
{
-
+ /**
+ * QName of the NotificationConsumer
+ */
QName NAME = new QName( BaseNotificationConstants.NSURI_WSNT_WSDL, "NotificationConsumer", BaseNotificationConstants.NSPREFIX_WSNT_WSDL );
/**
+ * Method for receiving notifications.
+ *
* @param requestDoc
*/
void notify( NotifyDocument requestDoc );
Modified: webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/v2004_06/porttype/NotificationProducerPortType.java
URL: http://svn.apache.org/viewcvs/webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/v2004_06/porttype/NotificationProducerPortType.java?rev=225396&r1=225395&r2=225396&view=diff
==============================================================================
--- webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/v2004_06/porttype/NotificationProducerPortType.java (original)
+++ webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/v2004_06/porttype/NotificationProducerPortType.java Tue Jul 26 14:11:36 2005
@@ -28,8 +28,13 @@
*/
public interface NotificationProducerPortType
{
-
+ /**
+ * QName of NotificationProducer.
+ */
QName NAME = new QName( BaseNotificationConstants.NSURI_WSNT_WSDL, "NotificationProducer", BaseNotificationConstants.NSPREFIX_WSNT_WSDL );
+ /**
+ * QName of NotificationProducerRP Resource Properties Document.
+ */
QName PROPS_DOC_NAME = new QName( BaseNotificationConstants.NSURI_WSNT_SCHEMA, "NotificationProducerRP", BaseNotificationConstants.NSPREFIX_WSNT_SCHEMA );
/**
@@ -51,16 +56,18 @@
"TopicExpressionDialects", BaseNotificationConstants.NSPREFIX_WSNT_SCHEMA );
/**
+ * Method used to subscribe for notifications.
*
* @param requestDoc
- * @return
+ * @return SubscribeResponseDocument
*/
SubscribeResponseDocument subscribe( SubscribeDocument requestDoc );
/**
+ * Method used for retrieving the current message from the NotificationProducer.
*
* @param requestDoc
- * @return
+ * @return GetCurrentMessageResponseDocument
*/
GetCurrentMessageResponseDocument getCurrentMessage( GetCurrentMessageDocument requestDoc );
Modified: webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/v2004_06/porttype/SubscriptionManagerPortType.java
URL: http://svn.apache.org/viewcvs/webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/v2004_06/porttype/SubscriptionManagerPortType.java?rev=225396&r1=225395&r2=225396&view=diff
==============================================================================
--- webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/v2004_06/porttype/SubscriptionManagerPortType.java (original)
+++ webservices/pubscribe/trunk/src/java/org/apache/ws/notification/base/v2004_06/porttype/SubscriptionManagerPortType.java Tue Jul 26 14:11:36 2005
@@ -28,9 +28,14 @@
*/
public interface SubscriptionManagerPortType
{
-
+ /**
+ * QName of SubscriptionManager
+ */
QName NAME = new QName( BaseNotificationConstants.NSURI_WSNT_WSDL, "SubscriptionManager",
BaseNotificationConstants.NSPREFIX_WSNT_WSDL );
+ /**
+ * QName of the SubscriptionManagerRP Resource Property Document
+ */
QName PROPS_DOC_NAME = new QName( BaseNotificationConstants.NSURI_WSNT_SCHEMA, "SubscriptionManagerRP",
BaseNotificationConstants.NSPREFIX_WSNT_SCHEMA );
@@ -77,16 +82,20 @@
BaseNotificationConstants.NSPREFIX_WSNT_SCHEMA );
/**
+ * Method used to pause a subscription
+ *
* @param requestDoc
*
- * @return
+ * @return PauseSubscriptionResponseDocument
*/
PauseSubscriptionResponseDocument pauseSubscription( PauseSubscriptionDocument requestDoc );
/**
+ * Method used to resume a subscription
+ *
* @param requestDoc
*
- * @return
+ * @return ResumeSubscriptionResponseDocument
*/
ResumeSubscriptionResponseDocument resumeSubscription( ResumeSubscriptionDocument requestDoc );
Modified: webservices/pubscribe/trunk/src/java/org/apache/ws/notification/tool/WsnWsdl2Java.java
URL: http://svn.apache.org/viewcvs/webservices/pubscribe/trunk/src/java/org/apache/ws/notification/tool/WsnWsdl2Java.java?rev=225396&r1=225395&r2=225396&view=diff
==============================================================================
--- webservices/pubscribe/trunk/src/java/org/apache/ws/notification/tool/WsnWsdl2Java.java (original)
+++ webservices/pubscribe/trunk/src/java/org/apache/ws/notification/tool/WsnWsdl2Java.java Tue Jul 26 14:11:36 2005
@@ -53,9 +53,20 @@
addPortType2JavaInfo(new SubscriptionManagerPortType2JavaInfo());
}
- protected ServiceProperties buildServiceProperties(ResourceDefinition resourceDefinition, File file, File file1)
+ /**
+ * Adds to the {@link ServiceProperties} object by making a call to super and
+ * then adding anything impl specific to be used by the VelocityContext for code generation.
+ *
+ * {@see Wsdl2Java#buildServiceProperties(ResourceDefinition resourceDefinition, File wsdlfile, File servicedir)}
+ *
+ * @param resourceDefinition The definition we are working on.
+ * @param wsdlfile The wsdl file.
+ * @param servicedir The directory we are generating to for this service.
+ * @return the updated ServiceProperties
+ */
+ protected ServiceProperties buildServiceProperties(ResourceDefinition resourceDefinition, File wsdlfile, File servicedir)
{
- ServiceProperties serviceProperties = super.buildServiceProperties(resourceDefinition, file, file1);
+ ServiceProperties serviceProperties = super.buildServiceProperties(resourceDefinition, wsdlfile, servicedir);
serviceProperties.setNamespaceVersionHolder(WsnNamespaceVersionHolderImpl.class);//make sure to add different ones as new versions comeout
//tell service props which properties we handle for the user...
@@ -68,13 +79,18 @@
return serviceProperties;
}
+ /**
+ * Returns the name of the webapp for use in generating code.
+ *
+ * @return the webapp name.
+ */
protected String getWebbappName()
{
return WEBAPP_NAME;
}
/**
- * Provides a hook for adding to the Velocity Context.
+ * Provides a hook for adding directly to the Velocity Context.
*
* @param context
* @return VelocityContext
Modified: webservices/pubscribe/trunk/src/java/org/apache/ws/notification/tool/WsnWsdl2JavaTask.java
URL: http://svn.apache.org/viewcvs/webservices/pubscribe/trunk/src/java/org/apache/ws/notification/tool/WsnWsdl2JavaTask.java?rev=225396&r1=225395&r2=225396&view=diff
==============================================================================
--- webservices/pubscribe/trunk/src/java/org/apache/ws/notification/tool/WsnWsdl2JavaTask.java (original)
+++ webservices/pubscribe/trunk/src/java/org/apache/ws/notification/tool/WsnWsdl2JavaTask.java Tue Jul 26 14:11:36 2005
@@ -29,15 +29,25 @@
{
/**
- * DOCUMENT_ME
+ * Returns a simple statement of what the task is.
*
- * @return DOCUMENT_ME
+ * @return the simple string
*/
public String toString()
{
return "WsnWsdl2Java Ant task";
}
+ /**
+ * Method which builds the implementation of Wsdl2Java, which in this case is {@link WsnWsdl2Java}.
+ *
+ * @param wsdlFiles The wsdl files to be processed.
+ * @param outputDir The directory where the generated code will go.
+ * @param classpathFiles The classpath.
+ * @param options {@link Wsdl2Java.Wsdl2JavaOptions}
+ * @return The implementation of Wsdl2Java
+ * @throws Exception
+ */
protected Wsdl2Java createWsdl2Java( File[] wsdlFiles, File outputDir, File[] classpathFiles, Wsdl2Java.Wsdl2JavaOptions options )
throws Exception
{
Modified: webservices/pubscribe/trunk/src/java/org/apache/ws/notification/topics/ResourcePropertyValueChangeTopic.java
URL: http://svn.apache.org/viewcvs/webservices/pubscribe/trunk/src/java/org/apache/ws/notification/topics/ResourcePropertyValueChangeTopic.java?rev=225396&r1=225395&r2=225396&view=diff
==============================================================================
--- webservices/pubscribe/trunk/src/java/org/apache/ws/notification/topics/ResourcePropertyValueChangeTopic.java (original)
+++ webservices/pubscribe/trunk/src/java/org/apache/ws/notification/topics/ResourcePropertyValueChangeTopic.java Tue Jul 26 14:11:36 2005
@@ -19,6 +19,8 @@
/**
* A topic that acts as a listener for resource property value change events.
+ *
+ * @author Sal Campana
*/
public interface ResourcePropertyValueChangeTopic extends Topic, ResourcePropertyValueChangeListener
{
Modified: webservices/pubscribe/trunk/src/java/org/apache/ws/notification/topics/Topic.java
URL: http://svn.apache.org/viewcvs/webservices/pubscribe/trunk/src/java/org/apache/ws/notification/topics/Topic.java?rev=225396&r1=225395&r2=225396&view=diff
==============================================================================
--- webservices/pubscribe/trunk/src/java/org/apache/ws/notification/topics/Topic.java (original)
+++ webservices/pubscribe/trunk/src/java/org/apache/ws/notification/topics/Topic.java Tue Jul 26 14:11:36 2005
@@ -102,5 +102,10 @@
*/
TopicSpace getTopicSpace();
+ /**
+ * Returns whether this Topic is visible or not.
+ *
+ * @return true if the Topic is visible, else false.
+ */
boolean isVisible();
}
Modified: webservices/pubscribe/trunk/src/java/org/apache/ws/notification/topics/TopicSpace.java
URL: http://svn.apache.org/viewcvs/webservices/pubscribe/trunk/src/java/org/apache/ws/notification/topics/TopicSpace.java?rev=225396&r1=225395&r2=225396&view=diff
==============================================================================
--- webservices/pubscribe/trunk/src/java/org/apache/ws/notification/topics/TopicSpace.java (original)
+++ webservices/pubscribe/trunk/src/java/org/apache/ws/notification/topics/TopicSpace.java Tue Jul 26 14:11:36 2005
@@ -16,7 +16,7 @@
package org.apache.ws.notification.topics;
/**
- * A topic space (i.e. a hierarchy of topics within a particular namespace).
+ * A topic space (a hierarchy of topics within a particular namespace).
* Provides methods for managing the topics and performing queries on them.
*/
public interface TopicSpace extends TopicSet
Modified: webservices/pubscribe/trunk/src/java/org/apache/ws/notification/topics/TopicSpaceSet.java
URL: http://svn.apache.org/viewcvs/webservices/pubscribe/trunk/src/java/org/apache/ws/notification/topics/TopicSpaceSet.java?rev=225396&r1=225395&r2=225396&view=diff
==============================================================================
--- webservices/pubscribe/trunk/src/java/org/apache/ws/notification/topics/TopicSpaceSet.java (original)
+++ webservices/pubscribe/trunk/src/java/org/apache/ws/notification/topics/TopicSpaceSet.java Tue Jul 26 14:11:36 2005
@@ -36,12 +36,34 @@
*/
TopicSpace addTopicSpace( TopicSpace topicSpace );
+ /**
+ * Removes a TopicSpace from the TopicSpaceSet for a given namespace uri.
+ *
+ * @param namespaceURI
+ */
void removeTopicSpace( String namespaceURI );
+ /**
+ * Returns a TopicSpace for a given namespace uri.
+ *
+ * @param namespaceURI
+ * @return the TopicSpace for the given uri, or null if there is no TopicSpace found.
+ */
TopicSpace getTopicSpace( String namespaceURI );
-
+ /**
+ * Resturns the TopicSpaces maintained by this TopicSpaceSet
+ *
+ * @return An array of TopicSpace objects.
+ */
TopicSpace[] getTopicSpaces();
+ /**
+ * Evaluates a {@link TopicExpression} against the TopicSpaceSet and returns an array of matching Topics.
+ *
+ * @param topicExpr The topicexpression (query) to be used to search againt the TopicSpaceSet.
+ * @return An array of Topics which were found based on the topicexpression
+ * @throws TopicExpressionException
+ */
Topic[] evaluateTopicExpression(TopicExpression topicExpr) throws TopicExpressionException;
/**
@@ -50,5 +72,11 @@
*/
boolean isFixed();
+ /**
+ * Sets the boolean that indicates if this topic set is fixed as defined by
+ * the WS-BaseNotification specification.
+ *
+ * @param fixed
+ */
void setFixed( boolean fixed );
}