xlawrence 2005/04/25 10:34:48 CEST
Modified files: (Branch: JAHIA-4-1-BRANCH)
src/java/org/jahia/blogs BlogPingListener.java BlogTester.java
MovableTypeAPIImpl.java
TrackBackPingServlet.java
src/java/org/jahia/blogs/actions AddTrackBackPingAction.java
EditPostAction.java
GetPostCategoriesAction.java
GetTrackBackPingsAction.java
NewPostAction.java
SetPostCategoriesAction.java
Log:
Updated Javadoc comments
Revision Changes Path
1.1.2.4 +12 -2 jahia/src/java/org/jahia/blogs/BlogPingListener.java
http://jahia.mine.nu:8080/cgi-bin/cvsweb.cgi/jahia/src/java/org/jahia/blogs/BlogPingListener.java.diff?r1=1.1.2.3&r2=1.1.2.4&f=h
1.1.2.4 +1 -0 jahia/src/java/org/jahia/blogs/BlogTester.java
http://jahia.mine.nu:8080/cgi-bin/cvsweb.cgi/jahia/src/java/org/jahia/blogs/BlogTester.java.diff?r1=1.1.2.3&r2=1.1.2.4&f=h
1.1.2.3 +1 -0 jahia/src/java/org/jahia/blogs/MovableTypeAPIImpl.java
http://jahia.mine.nu:8080/cgi-bin/cvsweb.cgi/jahia/src/java/org/jahia/blogs/MovableTypeAPIImpl.java.diff?r1=1.1.2.2&r2=1.1.2.3&f=h
1.1.2.3 +1 -0 jahia/src/java/org/jahia/blogs/TrackBackPingServlet.java
http://jahia.mine.nu:8080/cgi-bin/cvsweb.cgi/jahia/src/java/org/jahia/blogs/TrackBackPingServlet.java.diff?r1=1.1.2.2&r2=1.1.2.3&f=h
1.1.2.4 +1 -0
jahia/src/java/org/jahia/blogs/actions/AddTrackBackPingAction.java
http://jahia.mine.nu:8080/cgi-bin/cvsweb.cgi/jahia/src/java/org/jahia/blogs/actions/AddTrackBackPingAction.java.diff?r1=1.1.2.3&r2=1.1.2.4&f=h
1.1.2.8 +1 -1
jahia/src/java/org/jahia/blogs/actions/EditPostAction.java
http://jahia.mine.nu:8080/cgi-bin/cvsweb.cgi/jahia/src/java/org/jahia/blogs/actions/EditPostAction.java.diff?r1=1.1.2.7&r2=1.1.2.8&f=h
1.1.2.2 +2 -0
jahia/src/java/org/jahia/blogs/actions/GetPostCategoriesAction.java
http://jahia.mine.nu:8080/cgi-bin/cvsweb.cgi/jahia/src/java/org/jahia/blogs/actions/GetPostCategoriesAction.java.diff?r1=1.1.2.1&r2=1.1.2.2&f=h
1.1.2.3 +2 -0
jahia/src/java/org/jahia/blogs/actions/GetTrackBackPingsAction.java
http://jahia.mine.nu:8080/cgi-bin/cvsweb.cgi/jahia/src/java/org/jahia/blogs/actions/GetTrackBackPingsAction.java.diff?r1=1.1.2.2&r2=1.1.2.3&f=h
1.1.2.10 +0 -2 jahia/src/java/org/jahia/blogs/actions/NewPostAction.java
http://jahia.mine.nu:8080/cgi-bin/cvsweb.cgi/jahia/src/java/org/jahia/blogs/actions/NewPostAction.java.diff?r1=1.1.2.9&r2=1.1.2.10&f=h
1.1.2.2 +2 -0
jahia/src/java/org/jahia/blogs/actions/SetPostCategoriesAction.java
http://jahia.mine.nu:8080/cgi-bin/cvsweb.cgi/jahia/src/java/org/jahia/blogs/actions/SetPostCategoriesAction.java.diff?r1=1.1.2.1&r2=1.1.2.2&f=h
Index: BlogPingListener.java
===================================================================
RCS file:
/home/cvs/repository/jahia/src/java/org/jahia/blogs/Attic/BlogPingListener.java,v
retrieving revision 1.1.2.3
retrieving revision 1.1.2.4
diff -u -r1.1.2.3 -r1.1.2.4
--- BlogPingListener.java 22 Apr 2005 16:00:23 -0000 1.1.2.3
+++ BlogPingListener.java 25 Apr 2005 08:34:47 -0000 1.1.2.4
@@ -69,6 +69,10 @@
import org.apache.log4j.Logger;
/**
+ * Jahia Listener reacting to any added or updated Container matching
+ * the BLOG_TB_PING_LIST definition. Once a Container containing a ping url
is
+ * added or updated, a trackback ping request is sent to the url present in
the
+ * container.
*
* @author Xavier Lawrence
*/
@@ -79,6 +83,9 @@
static BlogDefinitionNames containerNames = new BlogDefinitionNames();
+ /**
+ * Sends a ping
+ */
public void containerAdded(JahiaEvent je) {
JahiaContainer source = (JahiaContainer)je.getObject();
@@ -101,7 +108,7 @@
}
/**
- * Does the same as containerAdded
+ * Does the same as containerAdded (calls method containerAdded)
*/
public void containerUpdated(JahiaEvent je) {
containerAdded(je);
@@ -130,7 +137,9 @@
}
/**
- *
+ * Fetches the data required by the ping request
+ * @return An Array of String containing in respective order:
+ * pingURL, postURL, postTitle, postExcerpt & blogName
*/
protected String[] preparePingData(JahiaEvent je)
throws JahiaException {
@@ -186,6 +195,7 @@
/**
+ * Sends a ping request by sending an HTTP POST
*/
protected static String sendPing(String pingURL, String postURL,
String postTitle, String postExcerpt, String blogName)
Index: BlogTester.java
===================================================================
RCS file:
/home/cvs/repository/jahia/src/java/org/jahia/blogs/Attic/BlogTester.java,v
retrieving revision 1.1.2.3
retrieving revision 1.1.2.4
diff -u -r1.1.2.3 -r1.1.2.4
--- BlogTester.java 22 Apr 2005 14:01:21 -0000 1.1.2.3
+++ BlogTester.java 25 Apr 2005 08:34:47 -0000 1.1.2.4
@@ -50,6 +50,7 @@
import org.apache.log4j.Logger;
/**
+ * Simple tester class for testing the XML-RPC methods and the ping servlet.
*
* @author Xavier Lawrence
*/
Index: MovableTypeAPIImpl.java
===================================================================
RCS file:
/home/cvs/repository/jahia/src/java/org/jahia/blogs/Attic/MovableTypeAPIImpl.java,v
retrieving revision 1.1.2.2
retrieving revision 1.1.2.3
diff -u -r1.1.2.2 -r1.1.2.3
--- MovableTypeAPIImpl.java 21 Apr 2005 14:46:13 -0000 1.1.2.2
+++ MovableTypeAPIImpl.java 25 Apr 2005 08:34:47 -0000 1.1.2.3
@@ -54,6 +54,7 @@
import org.apache.log4j.Logger;
/**
+ * Implementation of the MovableTypeAPI.
*
* @author Xavier Lawrence
*/
Index: TrackBackPingServlet.java
===================================================================
RCS file:
/home/cvs/repository/jahia/src/java/org/jahia/blogs/Attic/TrackBackPingServlet.java,v
retrieving revision 1.1.2.2
retrieving revision 1.1.2.3
diff -u -r1.1.2.2 -r1.1.2.3
--- TrackBackPingServlet.java 22 Apr 2005 15:59:50 -0000 1.1.2.2
+++ TrackBackPingServlet.java 25 Apr 2005 08:34:47 -0000 1.1.2.3
@@ -57,6 +57,7 @@
import java.io.InputStreamReader;
/**
+ * Simple Servlet reacting to POST methods containing TrackBack ping requests
*
* @author Xavier Lawrence
*/
Index: AddTrackBackPingAction.java
===================================================================
RCS file:
/home/cvs/repository/jahia/src/java/org/jahia/blogs/actions/Attic/AddTrackBackPingAction.java,v
retrieving revision 1.1.2.3
retrieving revision 1.1.2.4
diff -u -r1.1.2.3 -r1.1.2.4
--- AddTrackBackPingAction.java 22 Apr 2005 12:56:52 -0000 1.1.2.3
+++ AddTrackBackPingAction.java 25 Apr 2005 08:34:48 -0000 1.1.2.4
@@ -62,6 +62,7 @@
/**
+ * Action used to Add a TrackBack ping to a given post
*
* @author Xavier Lawrence
*/
Index: EditPostAction.java
===================================================================
RCS file:
/home/cvs/repository/jahia/src/java/org/jahia/blogs/actions/Attic/EditPostAction.java,v
retrieving revision 1.1.2.7
retrieving revision 1.1.2.8
diff -u -r1.1.2.7 -r1.1.2.8
--- EditPostAction.java 22 Apr 2005 16:00:24 -0000 1.1.2.7
+++ EditPostAction.java 25 Apr 2005 08:34:48 -0000 1.1.2.8
@@ -312,7 +312,7 @@
}
/**
- *
+ * Returns the existring ping urls of a given post in a Vector Object
*/
protected Vector getExistingPingURLs(JahiaContainerList list)
throws JahiaException {
Index: GetPostCategoriesAction.java
===================================================================
RCS file:
/home/cvs/repository/jahia/src/java/org/jahia/blogs/actions/Attic/GetPostCategoriesAction.java,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -u -r1.1.2.1 -r1.1.2.2
--- GetPostCategoriesAction.java 21 Apr 2005 08:20:22 -0000 1.1.2.1
+++ GetPostCategoriesAction.java 25 Apr 2005 08:34:48 -0000 1.1.2.2
@@ -63,6 +63,8 @@
/**
+ * Action used to get a post's categories from the Jahia content repository.
+ * Compliant with MovableType API's getPostCategories method.
*
* @author Xavier Lawrence
*/
Index: GetTrackBackPingsAction.java
===================================================================
RCS file:
/home/cvs/repository/jahia/src/java/org/jahia/blogs/actions/Attic/GetTrackBackPingsAction.java,v
retrieving revision 1.1.2.2
retrieving revision 1.1.2.3
diff -u -r1.1.2.2 -r1.1.2.3
--- GetTrackBackPingsAction.java 21 Apr 2005 14:46:14 -0000 1.1.2.2
+++ GetTrackBackPingsAction.java 25 Apr 2005 08:34:48 -0000 1.1.2.3
@@ -61,6 +61,8 @@
import java.util.Enumeration;
/**
+ * Action used to get a post's TrackBakc pings from the Jahia content
repository.
+ * Compliant with MovableType API's getTrackBackPings method.
*
* @author Xavier Lawrence
*/
Index: NewPostAction.java
===================================================================
RCS file:
/home/cvs/repository/jahia/src/java/org/jahia/blogs/actions/Attic/NewPostAction.java,v
retrieving revision 1.1.2.9
retrieving revision 1.1.2.10
diff -u -r1.1.2.9 -r1.1.2.10
--- NewPostAction.java 22 Apr 2005 16:00:24 -0000 1.1.2.9
+++ NewPostAction.java 25 Apr 2005 08:34:48 -0000 1.1.2.10
@@ -246,7 +246,6 @@
String excerpt = (String)struct.get(MetaPostInfo.MT_EXCERPT);
if (excerpt != null && excerpt.length() > 0) {
- log.debug("storing excerpt");
field.setValue(excerpt);
}
}
@@ -305,7 +304,6 @@
log.debug("pingURLContainer: "+pingURLContainer.getID());
ctnListID = pingURLContainer.getListID();
- log.debug("on list: "+ctnListID);
field = pingURLContainer.getField(containerNames.
getValue(containerNames.TB_PING_URL));
Index: SetPostCategoriesAction.java
===================================================================
RCS file:
/home/cvs/repository/jahia/src/java/org/jahia/blogs/actions/Attic/SetPostCategoriesAction.java,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -u -r1.1.2.1 -r1.1.2.2
--- SetPostCategoriesAction.java 21 Apr 2005 08:20:22 -0000 1.1.2.1
+++ SetPostCategoriesAction.java 25 Apr 2005 08:34:48 -0000 1.1.2.2
@@ -60,6 +60,8 @@
import org.apache.log4j.Logger;
/**
+ * Action used to set a post's categories pings into the Jahia content
repository.
+ * Compliant with MovableType API's setPostCategories method.
*
* @author Xavier Lawrence
*/