Author: agilliland
Date: Wed Apr 19 12:15:41 2006
New Revision: 395359
URL: http://svn.apache.org/viewcvs?rev=395359&view=rev
Log:
code reformatting.
Modified:
incubator/roller/branches/roller-newbackend/src/org/roller/model/PingQueueManager.java
Modified:
incubator/roller/branches/roller-newbackend/src/org/roller/model/PingQueueManager.java
URL:
http://svn.apache.org/viewcvs/incubator/roller/branches/roller-newbackend/src/org/roller/model/PingQueueManager.java?rev=395359&r1=395358&r2=395359&view=diff
==============================================================================
---
incubator/roller/branches/roller-newbackend/src/org/roller/model/PingQueueManager.java
(original)
+++
incubator/roller/branches/roller-newbackend/src/org/roller/model/PingQueueManager.java
Wed Apr 19 12:15:41 2006
@@ -8,27 +8,23 @@
package org.roller.model;
+import java.io.Serializable;
+import java.util.List;
import org.roller.RollerException;
import org.roller.pojos.AutoPingData;
import org.roller.pojos.PingQueueEntryData;
-import org.roller.pojos.WebsiteData;
import org.roller.pojos.PingTargetData;
+import org.roller.pojos.WebsiteData;
-import java.io.Serializable;
-import java.util.List;
/**
* PingQueueManager. This interface describes the manager for the weblog
update ping request queue. The queue is
* processed by the <code>PingQueueProcesssor</code> and
<code>PingQueueTask</code> components in the application
* layer.
*/
-public interface PingQueueManager extends Serializable
-{
- /**
- * Release all resources associated with Roller session.
- */
- public void release();
-
+public interface PingQueueManager extends Serializable {
+
+
/**
* Add a new persistent entry to the queue. If the queue already contains
an entry for the ping target and website
* specified by this auto ping configuration, a new one will not be added.
@@ -36,16 +32,8 @@
* @param autoPing auto ping configuration for the ping request to be
queued.
*/
public void addQueueEntry(AutoPingData autoPing) throws RollerException;
-
- /**
- * Retrieve an entry from the queue.
- *
- * @param id the unique id of the entry.
- * @return the queue entry with the specified id.
- * @throws RollerException
- */
- public PingQueueEntryData retrieveQueueEntry(String id) throws
RollerException;
-
+
+
/**
* Store the given queue entry.
*
@@ -53,7 +41,8 @@
* @throws RollerException
*/
public void storeQueueEntry(PingQueueEntryData pingQueueEntry) throws
RollerException;
-
+
+
/**
* Remove a queue entry.
*
@@ -61,35 +50,56 @@
* @throws RollerException
*/
public void removeQueueEntry(PingQueueEntryData pingQueueEntry) throws
RollerException;
-
+
+
+ /**
+ * Remove all of the queue entries that reference the given ping target.
This is used when the ping target is being
+ * deleted (application-level cascading).
+ *
+ * @param pingTarget the ping target for which queue entries are to be
removed
+ */
+ public void removeQueueEntriesByPingTarget(PingTargetData pingTarget)
throws RollerException;
+
+
+ /**
+ * Remove all of the queue entries that reference the given website. This
is used when the website is being deleted
+ * (application-level cascading).
+ *
+ * @param website the website for which queue entreis are to be removed
+ */
+ public void removeQueueEntriesByWebsite(WebsiteData website) throws
RollerException;
+
+
/**
* Drop the queue. Removes all elements from the queue.
*
* @throws RollerException
*/
public void dropQueue() throws RollerException;
-
+
+
/**
- * Get all of the queue entries.
+ * Retrieve an entry from the queue.
*
- * @return the queue as a <code>List</code> of [EMAIL PROTECTED]
PingQueueEntryData} objects.
+ * @param id the unique id of the entry.
+ * @return the queue entry with the specified id.
* @throws RollerException
*/
- public List getAllQueueEntries() throws RollerException;
-
+ public PingQueueEntryData retrieveQueueEntry(String id) throws
RollerException;
+
+
/**
- * Remove all of the queue entries that reference the given ping target.
This is used when the ping target is being
- * deleted (application-level cascading).
+ * Get all of the queue entries.
*
- * @param pingTarget the ping target for which queue entries are to be
removed
+ * @return the queue as a <code>List</code> of [EMAIL PROTECTED]
PingQueueEntryData} objects.
+ * @throws RollerException
*/
- public void removeQueueEntriesByPingTarget(PingTargetData pingTarget)
throws RollerException;
-
+ public List getAllQueueEntries() throws RollerException;
+
+
/**
- * Remove all of the queue entries that reference the given website. This
is used when the website is being deleted
- * (application-level cascading).
- *
- * @param website the website for which queue entreis are to be removed
+ * Release all resources associated with Roller session.
*/
- public void removeQueueEntriesByWebsite(WebsiteData website) throws
RollerException;
+ public void release();
+
}
