Return to Jive Software

Skip navigation
Up to Discussions in Jive Forums
1,624 Views 5 Replies Last post: Nov 4, 2009 3:16 PM by kevin.imber RSS
timcolson Novice
timcolson
30 posts since
May 25, 2007
Currently Being Moderated

Oct 9, 2009 12:54 PM

Jive Forums bug in moveForums() remote API method?

Last night I tried in vain to use the remote API in Jive Forums 5.5.19 to move a Forum to a different Category.

 

In the Jive Web Services Developer Guide the Forum Service has a moveForums method that takes to long IDs:

 

moveForums  -   Move the forum with the specified ID to the category with the specified ID.

 

There is another method to "mergeForums()" and I'm using that just fine.

 

moveForums( F, C) ... Jive throws an exception from "Forum F is not in category C"....

 

Yeah, I know that, that's the category I want to move it to...so, move it!

The category does exist. If I try a category for C that does not, I get an (expected) error that the category is not found.

 

Exception in thread "main" org.codehaus.xfire.XFireRuntimeException: Could not invoke service.. Nested exception is org.codehaus.xfire.fault.XFireFault: Forum 1686 is not in category 262

org.codehaus.xfire.fault.XFireFault: Forum 1686 is not in category 262

at org.codehaus.xfire.fault.Soap11FaultSerializer.readMessage(Soap11FaultSerializer.java:31)

at org.codehaus.xfire.fault.SoapFaultSerializer.readMessage(SoapFaultSerializer.java:28)

at org.codehaus.xfire.soap.handler.ReadHeadersHandler.checkForFault(ReadHeadersHandler.java:111)

at org.codehaus.xfire.soap.handler.ReadHeadersHandler.invoke(ReadHeadersHandler.java:67)

at org.codehaus.xfire.handler.HandlerPipeline.invoke(HandlerPipeline.java:131)

at org.codehaus.xfire.client.Client.onReceive(Client.java:382)

at org.codehaus.xfire.transport.http.HttpChannel.sendViaClient(HttpChannel.java:139)

at org.codehaus.xfire.transport.http.HttpChannel.send(HttpChannel.java:48)

at org.codehaus.xfire.handler.OutMessageSender.invoke(OutMessageSender.java:26)

at org.codehaus.xfire.handler.HandlerPipeline.invoke(HandlerPipeline.java:131)

at org.codehaus.xfire.client.Invocation.invoke(Invocation.java:75)

at org.codehaus.xfire.client.Client.invoke(Client.java:335)

at org.codehaus.xfire.client.XFireProxy.handleRequest(XFireProxy.java:77)

at org.codehaus.xfire.client.XFireProxy.invoke(XFireProxy.java:57)

at $Proxy4.moveForums(Unknown Source)

at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)

at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)

at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)

at java.lang.reflect.Method.invoke(Method.java:597)

at com.jivesoftware.forum.webservices.ServiceLocator$ExceptionHandler.invoke(ServiceLocator.java:381)

at $Proxy4.moveForums(Unknown Source)

at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)

at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)

at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)

at java.lang.reflect.Method.invoke(Method.java:597)

at com.jivesoftware.forum.webservices.ServiceLocator$CacheHandler.invoke(ServiceLocator.java:522)

at $Proxy5.moveForums(Unknown Source)

 

For fun, I also tried changing the order of the arguments - moveForums( C, F)... Jive says "Forum C not found", totally expected that.

 

As a workaround, I tried to just get the Forum f, set the category ID manually with f. setCategory(C) and then forumSvc.updateForum(f).

 

That works great for setting the name (i.e. to rename the forum), but oddly, it fails with the exact same stack track as above.

 

import com.jivesoftware.forum.webservices

 

ForumService forumSvc; // injected and known to work for mergeForums(id,id)

 

// Fails as described above...

forumSvc.moveForums( forumID, catID);

 

// Fails to actually update the forum

Forum f = forumSvc.getForum((long)forumID);

Long oldCatID = f.getCategoryID();

f.setCategoryID(destinationCategoryID);

forumSvc.updateForum(f);

 

 

 

I'm bummed. I have thousands of forums (yes, really, and please don't ask why) that I need to merge and move. Ever tried doing this with a 5,000 item drop-down in the Admin UI? Nah, I'm sure you haven't. Take it from me, it's not pretty. If the remote API "moveForums()" would work as advertised, I'm happy.

 

I don't know what's going on. Ideas? Anybody at Jive able to have a quick peek at the source for this and/or tell me if this is a known issue that might be fixed in a patch I don't have installed? :-)

 

 

-Tim

timcolson Novice
timcolson
30 posts since
May 25, 2007
Currently Being Moderated
Oct 12, 2009 3:03 PM in response to: timcolson
Re: Jive Forums bug in moveForums() remote API method?

FYI - I downloaded Jive Forums 5.5.30 and started it locally - hoping perhaps the issue I'm seeing would be magically resolved.

 

Unfortunately, no luck. In a way, I suppose it is good news that I can reproduce the problem with a bare-bones install of the latest available-before-it-was-killed 5.5.30 Jive Forum. ;-)

 

I have the source code too... so I'm going to dig in to see if I can fix it myself.

 

Begs the question though, is it just my code or has no one ever used the moveForums() API call? (Including the person who wrote the API call and presumably a test case for it?)

 

-Tim

timcolson Novice
timcolson
30 posts since
May 25, 2007
Currently Being Moderated
Oct 12, 2009 4:40 PM in response to: timcolson
Re: Jive Forums bug in moveForums() remote API method?

Digging into the source... fun. :-)

 

 

com.jivesoftware.forum.database.DbForumCategory appears to be the class that implements the ForumCategory interface which includes moveForum() -- note this is singular, and it appears to be called by the moveForums() plural call inside com.jivesoftware.forum.webservices.server.ForumServiceImpl.

 

Okay so on to the details...

 

protected static final String FIND_FORUM_INDEX =
 
            "SELECT categoryIndex FROM jiveForum WHERE forumID=? AND categoryID=?";
 
 
public void moveForum(Forum forum, ForumCategory destinationCategory) {
        Connection con = null;
        PreparedStatement pstmt = null;
        boolean abortTransaction = false;
        try {
            con = ConnectionManager.getTransactionConnection();
            // First, find the old index value for the forum.
            pstmt = con.prepareStatement(FIND_FORUM_INDEX);
            pstmt.setLong(1, forum.getID());
            pstmt.setLong(2, this.id);
            ResultSet rs = pstmt.executeQuery();
            int oldIndex;
            try {
                // If we didn't find a row, that means the forum does not belong
                // to the category. In that case, throw an exception.
                if (!rs.next()) {
                    throw new IllegalArgumentException("Forum " + forum.getID() +
                            " is not in category " + this.id);
                }
                oldIndex = rs.getInt(1);
            } finally {
                ConnectionManager.closeResultSet(rs);
            }
            pstmt.close();

 

 

 

The first thing that happens is running SQL to find out if the given ForumID param exists inside THIS category. If not, it throws an error and dies.

 

LOL. So this seems to be the problem I'm seeing, and after looking closer at the ForumService implementation, I believe I have found the root problem.

 

 

The Category object is the thingy that does the actual moving. It seems that Jive expects the Current Category to do the moving of the forum into the Destination Category. That makes sense....but....

 

  class ForumServiceImpl
   public void moveForums(long forumID, long categoryID)
            throws ForumNotFoundException, ForumCategoryNotFoundException {
 
        ForumFactory factory = WSUtil.getForumFactory();
 
        com.jivesoftware.forum.Forum forum = factory.getForum(forumID);
 
        // This is incorrectly grabbing the DESTINATION Category 
        // based on the incoming parameter ID
 
 
       com.jivesoftware.forum.ForumCategory category = factory.getForumCategory(categoryID);
 
       category.moveForum(forum, category);
 
    }
 

 

 

 

Well, that seems silly, doesn't it? We're asking the destination category to move a forum that it does not contain.
So perhaps the trick to fix this is relatively simple:
class ForumServiceImpl 
 
  public void moveForums(long forumID, long categoryID)
            throws ForumNotFoundException, ForumCategoryNotFoundException {
 
        ForumFactory factory = WSUtil.getForumFactory();
 
        com.jivesoftware.forum.Forum forum = factory.getForum(forumID);
 
        // get current Category from the forum itself
        com.jivesoftware.forum.ForumCategory currentCategory = forum.getForumCategory();
        // look up the destinationCategory based on the param
        com.jivesoftware.forum.ForumCategory destinationCategory = factory.getForumCategory(categoryID);
                        
        currentCategory.moveForum(forum, destinationCategory);
    }

 

 

Now if I can get the whole thing to compile (grrr, out of heap memory on OS X errors) and build a WAR file, I can test it and see if this fixes the remote API!

 

-Tim

P.S. Test cases? Hmm... Nope, I don't see any.

 

 

timcolson Novice
timcolson
30 posts since
May 25, 2007
Currently Being Moderated
Oct 12, 2009 4:46 PM in response to: timcolson
Re: Jive Forums bug in moveForums() remote API method?

Woot! (i.e. it works)

 

Now the question becomes, "What's the best way to get this into our production system?"

 

Sure sure, I could just replace the WAR file on the prod server.... but, uh, I'm a bit nervous that the WAR file I created is truly the same as the binary from Jive with only changes to that one class. Paranoia perhaps? I suppose I could stop the server and just update the one class file for ForumServiceImpl, eh?

 

 

-Tim

timcolson Novice
timcolson
30 posts since
May 25, 2007
Currently Being Moderated
Oct 13, 2009 3:05 PM in response to: timcolson
Re: Jive Forums bug in moveForums() remote API method?

Just for completeness... in case folks run across this thread and want to fix this too....

 

The deployment method we chose was to unpack the war, replace the ForumServiceImpl class and repackage the WAR.

 

Seems to work a treat. ;-)

 

Cheers,

Tim Colson

kevin.imber Jive Employee
kevin.imber
2,726 posts since
Oct 19, 2009
Currently Being Moderated
Nov 4, 2009 3:16 PM in response to: timcolson
Re: Jive Forums bug in moveForums() remote API method?

Hey Tim,

 

I'm glad that you figured this out.  Let me know if you have any other questions.

 

Thanks,

Kevin

More Like This

  • Retrieving data ...

Bookmarked By (0)

To better serve our customers we have included functionality to automatically follow up on a case after it has been idle for more than 5 days, and then auto close after an additional 3 days of inactivity. Choose No to acknowledge that this case will remain idle for longer than 5 days.
Making cases public allows other customers to learn from the solution of the case. It can also be used to gain feedback from others in the community. Ask our Support Engineers for more info, but we encourage you to make your cases public.