masonjm 2004/08/08 21:53:25
Modified: webdavclient/clientlib/src/java/org/apache/webdav/lib
NotificationListener.java
Log:
Added some documentation
Revision Changes Path
1.5 +21 -3
jakarta-slide/webdavclient/clientlib/src/java/org/apache/webdav/lib/NotificationListener.java
Index: NotificationListener.java
===================================================================
RCS file:
/home/cvs/jakarta-slide/webdavclient/clientlib/src/java/org/apache/webdav/lib/NotificationListener.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- NotificationListener.java 6 Aug 2004 14:24:57 -0000 1.4
+++ NotificationListener.java 9 Aug 2004 04:53:24 -0000 1.5
@@ -145,6 +145,24 @@
timer.schedule(poll, pollInterval, pollInterval);
}
+ /**
+ * Registers a Subscriber with the remote server.
+ *
+ * @param method the "notification type", determines for what events do you
+ * want do subscribe. one of "Update", "Update/newmember",
+ * "Delete", "Move".
+ * @param uri the resource for that you subscribe
+ * @param depth the depth of the collection tree that you want to observe
+ * @param lifetime the duration for that you want to observe (in seconds)
+ * @param notificationDelay the time the server waits before it sends a notify
+ * message to the host provided in the constructor
+ * (in seconds)
+ * @param listener the Subscriber that is called on incomming notifications
+ * @param credentials credentials for authentication on the server observed
+ *
+ * @see WebdavResource#subscribeMethod
+ * @see
http://msdn.microsoft.com/library/default.asp?url=/library/en-us/e2k3/e2k3/_webdav_subscribe.asp
+ */
public void subscribe(String method, String uri, int depth, int lifetime, int
notificationDelay, Subscriber listener, Credentials credentials) {
SubscribeMethod subscribeMethod = new SubscribeMethod(repositoryDomain+uri);
subscribeMethod.addRequestHeader(SubscribeMethod.H_NOTIFICATION_TYPE,
method);
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
