Java, CSSDK, Eclipse - where did I go wrong?

I'm working on some java code (yikes! ;-) within Eclipse, and while I thought I had things configured correctly, I'm running into a problem which calls that into question.
The code essentially looks like this:

package xxxx;
// ...
import com.interwoven.cssdk.workflow.*;

public class Foo {
    // ...
    private Integer jobid;

    public static void main(String[] args) {
        Foo bar = new Foo();
        // ...
        bar.jobid = args[5];
        // ...
        CSWorkflow job = getWorkflow(bar.jobid); // #=# PROBLEM
    }
    // ...
}

However, it doesn't like the line indicated, when I hover the mouse over

CSWorkflow

Eclipse displays the error message:[indent]CSWorkflow cannot be resolved to a type[/indent]Now, when I added the import line, it was more than willing to help complete the import directive, so it "knows" about

com.interwoven.cssdk.workflow.*

, which I would have thought would have been sufficient to allow it to resolve the type

CSWorkflow

- but that doesn't seem to be the case.

Am I missing some other necessary imports?
Could I have managed to add the CSSDK libraries (Referenced Libraries > cssdkjava.jar > com.interwoven.xxxxxx) incorrectly to the project or perhaps I need to somehow indicate that they exist in more than one way?

Any ideas?

Find more posts tagged with

Comments

Migrateduser

For what it's worth, com.interwoven.cssdk.workflow.CSWorkflow.class is in cssdkiface.jar - make sure that one is referenced in your libraries.

Migrateduser

What I mentioned might be more significant than I first thought as within cssdkjava.jar there exists a com.interwoven.cssdk.workflow.java package, so your import would still be valid if you only included cssdkjava.jar but left out cssdkiface.jar.

I don't know if it's recommended or not, but it may be best, at least at first, to not use a wildcard in your import statements - that way if you're missing something, you will know right away.

For example,

[left]

 import com.interwoven.cssdk.workflow.CSExternalTask; [/left]

import com.interwoven.cssdk.workflow.CSTask;

import com.interwoven.cssdk.workflow.CSURLExternalTask;

import com.interwoven.cssdk.workflow.CSWorkflow;

import com.interwoven.cssdk.access.CSUser;

import com.interwoven.cssdk.common.CSClient;

import com.interwoven.cssdk.common.CSException;

import com.interwoven.cssdk.filesys.CSArea;

import com.interwoven.cssdk.filesys.CSAreaRelativePath;

import com.interwoven.cssdk.filesys.CSDir;

import com.interwoven.cssdk.filesys.CSFile;

import com.interwoven.cssdk.filesys.CSHole;

import com.interwoven.cssdk.filesys.CSPathCommentPair;

import com.interwoven.cssdk.filesys.CSSimpleFile;

import com.interwoven.cssdk.filesys.CSWorkarea;

[left]

[/left]

Migrateduser

Another nice thing about Eclipse - the plug-ins. We loaded a handy decompiler so you can drill into Interwoven's jar files and actually see their code.

click "Help" -> Software Updates -> Available Software

Add Site -> http://java.decompiler.free.fr/jd-eclipse/update

check the JD-Eclipse Plug-in

fi_sampledata.rptdesign

Adam Stoller

For what it's worth, com.interwoven.cssdk.workflow.CSWorkflow.class is in cssdkiface.jar - make sure that one is referenced in your libraries.

Cool - that solves part of the problem - now it's the right-hand-side:

...
        CSWorkflow job = getWorkflow(bar.jobid); 
...

This, somewhat obviously after the fact, gives me:[indent]The method getWorkflow(Integer) is undefined for the type Bar[/indent]So I tried:

        CSWorkflow job = CSWorkflow.getWorkflow(bar.jobid);

Nope. Or:

        CSWorkflow job = new CSWorkflow().getWorkflow(bar.jobid);

This first tells me I need sharedutils100.jar (added) and then complains that (a) I cannot instantiate the type CSWorkflow and (b) the method getWorkflow(Integer) is undefined for the type CSWorkflow;

That actually makes sense because there is no constructor for CSWorkflow and the method actually comes from the CSWorkflowEngine interface.

Okay - so perhaps the problem is that I'm dealing with an "interface" instead of a "class" ?

This is where I start to have a big problem with javadocs that don't tend to provide reasonable [simplified] real-world usage examples.

You wouldn't happen to know how I should actually do this, would you? (and be willing to share? ;-)

Migrateduser

I'm pretty sure you can't create a CSWorkflow from a JobID. You'd think that would make sense, wouldn't you? It took me a while to get an appreciation for how Java works with respect to TeamSite "things". I'm not sure what you can do from nothing - meaning just creating a standalone Java class with a main(), what you can do without using workflow - or some context. I'm sure there are people out there who use Java a lot more than me and know how you can get something that contains some context and then use that to get other interesting things (like workflows and tasts, for instance).

In workflow, you autimatically get passed a CSClient object and a CSExternalTask object and from there you can get all sorts of things. But from nothing, I don't know what you can do.

Adam Stoller

Thanks, I'll continue to search other avenues and update if/when I get something that works (assuming someone hasn't posted it here - in which case I'll just confirm that it works ;-)

mart2001

Are you trying this through the urlexternaltask (or externaltask) of a workflow or are you trying to get the workflow just from the command line?

If you are using the urlexternaltask, you'll have to override the execute method which will give you the client and task object.

public void execute(CSClient client, CSExternalTask task, Hashtable params) throws CSException {}

From the task object, you can get the workflow by using
task.getWorkflow() method. Would be similar with externaltask.

If you are doing it directly from the command line, you'll need to create the client object first. Autonomy Interwoven has a CreateClient.java sample available. (But you'll need to type in username, password, and role on command line)

Once you have the client object, you can get the task and workflow object. You'll need to know their id's in order to get those objects from the client object.

How do you get those id's? Well, if you are running it through the workflow, you can get those automatically. But if you are running it through the command line, you'll need to hard code it, read it from a file, or pass it through command line arguments.

CSWorkflow job = getWorkflow(bar.jobid); // #=# PROBLEM

When you have something like that, you'll need to write y our own getWorkflow(arg1) method.
You'll need to do something like:
client.getWorkflow(wfid);

That is assuming you have the client object. You'll need either the client object or the task object in order to get the workflow object.

Adam Stoller

Are you trying this through the urlexternaltask (or externaltask) of a workflow or are you trying to get the workflow just from the command line?

Command line - I'm trying to write an iwat trigger script in Java.

...
If you are doing it directly from the command line, you'll need to create the client object first. Autonomy Interwoven has a CreateClient.java sample available. (But you'll need to type in username, password, and role on command line)

Once you have the client object, you can get the task and workflow object. You'll need to know their id's in order to get those objects from the client object.

How do you get those id's? ... if you are running it through the command line, you'll need to hard code it, read it from a file, or pass it through command line arguments.

Ugh - okay, I vaguely recall running into this before - a Perl script can utilize the effective UID of the process to access this information without actually going through an authentication process, but a java program needs to go through the authentication process and thus you have to do something that is not secure (hard-coding in source or config file) in order to get a "secure" connection. Sigh.

Thanks - I'll see what I can do with that information - as it should get me further along (sort of)

mart2001

There's always encryption methods... AES, Blowfish, DES, etc...

Also, you won't be able to instantiate interface and abstract classes...

Crsb

If you are doing it directly from the command line, you'll need to create the client object first. Autonomy Interwoven has a CreateClient.java sample available. (But you'll need to type in username, password, and role on command line)

that will work if you are running your code outside TeamSite.

You'll need to do something like:
client.getWorkflow(wfid);

that should be client.getWorkflow(jobID, true/false);

from cssdk docs:

[html]
getWorkflow
CSWorkflow getWorkflow(int id,
boolean validate)
throws CSAuthorizationException,
CSExpiredSessionException,
CSRemoteException,
CSExceptionGets the CSWorkflow object from the server corresponding to this id.

Parameters:
id - workflow id
validate - When validate = true, if the workflow id does not exist on the TeamSite® Server, null is returned. When validate = false, any id given returns a shallow CSWorkflow object, any call made with this object will validate the object before performing the operation.
Returns:
Workflow object requested
Throws:
CSAuthorizationException - if the user is not authorized to perform this operation
CSExpiredSessionException - if the user's session has expired
CSRemoteException - if the ContentServices SOAP or JNI server has an error and cannot return the requested data
CSException - if the server cannot perform this operation for any other reason
[/html]

Adam Stoller

Okay - so for the time being we'll assume that it is okay for me to hard-code userid and password into the java source code (or some config file, etc. - or I've found some way to handle the encryption stuff)... I end up with some code that looks like this:

...
import java.util.Locale;
import java.util.Properties;

import com.interwoven.cssdk.workflow.*;
import com.interwoven.cssdk.access.CSAuthenticationException;
import com.interwoven.cssdk.access.CSUser;
import com.interwoven.cssdk.common.CSClient;
import com.interwoven.cssdk.common.CSException;
import com.interwoven.cssdk.common.CSRemoteException;
import com.interwoven.cssdk.factory.*;
...
    private static CSClient getClient() {
        Properties localProperties = new Properties();
        Locale locale = Locale.ENGLISH;
        localProperties.setProperty("cssdk.cfg.path", "c:/iw-home/cssdk/cssdk.cfg");
        CSFactory factory = CSFactory.getFactory(localProperties);
        CSClient client = null;
        try {
            client = factory.getClient("DOMAIN\\userid","master","password",
                locale.getDefault(),"TeamSite","");
        } catch (CSAuthenticationException e) {
            e.printStackTrace();
        } catch (CSRemoteException e) {
            e.printStackTrace();
        } catch (CSException e) {
            e.printStackTrace();
        }
        return client;
    }
}

[Note: The javadocs say to use CSLocalFactory, but I couldn't get that to resolve so I went with the vanilla CSFactory - not sure if this matters]

We'll further assume (since I haven't gotten to the point of running this yet) that the above works and returns to me a CSClient object, and I use that object to get my workflow object and use that to get a list of task objects like so:

        CSClient client = getClient();
        CSWorkflow job = client.getWorkflow(bar.jobid, true);
        if (!job.isValid()) {
            return; // exit - log error?
        }

        CSTask[] taskList = job.getTasks();
        ...

Now I traverse through this list of task objects, find one with the taskname I'm looking for and then go to set the ownership of that task - seems simple enough:

        for (int taskobj = 0; taskobj < taskList.length; taskobj++) {
            ...
            taskList[taskobj].setOwner(userid);
        }

But wait! setOwner expects a CSUser object and all I have is a String representation of the userid. Okay, let's look that up in the javadocs - great! It's another interface, no constructor! I looked through all the other docs in the CSSDK doc jar and I cannot see how I take a String (e.g.: "ghoti") and turn it into a CSUser object to use as an argument for setOwner().

Can anyone enlighten me on this one?

Crsb

[Note: The javadocs say to use CSLocalFactory, but I couldn't get that to resolve so I went with the vanilla CSFactory - not sure if this matters]

i think CSLocalFactory is deprecated as of cssdk 3.1.1, replaced with CSJavaFactory so import com.interwoven.cssdk.factory.CSJavaFactory;

But wait! setOwner expects a CSUser object and all I have is a String representation of the userid. Okay, let's look that up in the javadocs - great! It's another interface, no constructor! I looked through all the other docs in the CSSDK doc jar and I cannot see how I take a String (e.g.: "ghoti") and turn it into a CSUser object to use as an argument for setOwner().

Can anyone enlighten me on this one?

try CSUser user = client.getUser("username", true/false)
cssdk docs:


getUser
CSUser getUser(java.lang.String userName,
               boolean validate)
               throws CSAuthorizationException,
                      CSExpiredSessionException,
                      CSRemoteException,
                      CSExceptionGets the CSUser object whose name is provided. 

Parameters:
userName - name of the user
validate - When validate = true If the user does not exist on the TeamSite® Server a null is returned. When validate = false, any string given returns a shallow CSUser object, Any call made with this object will validate the object before performing the operation. 
Returns:
User object requested

Adam Stoller

i think CSLocalFactory is deprecated as of cssdk 3.1.1, replaced with CSJavaFactory so import com.interwoven.cssdk.factory.CSJavaFactory;

CSFactory seems to be okay so far (at least as far as Eclipse in editing mode is concerned.

try CSUser user = client.getUser("username", true/false)

Bingo! Somehow I missed seeing that in the docs, I probably looked at all the classes except the CSClient one when I was trying to figure out how to do this.

So I now have code that, as far as editing in Eclipse is concerned, contains no [known] errors or warnings. I've taken what was a 61 line Perl script (including comments and blank lines) that took somewhere between 15 and 60 minutes to write and turned it into a 206 line Java class (including very few comments and some blank lines) in probably just under 8 hours (thanks much to the help I got here and from a few other folks).

Ah progress!! Tomorrow I'll see about actually trying to run this on my dev server.

Thanks much!

Migrateduser

This is a magical day. Fish is drinking the Java kool-aid...

Next up....Nipper...

Welcome to the dark side...

Adam Stoller

This is a magical day. Fish is drinking the Java kool-aid...

Yecch, ptui - way too sweet, I'm used to just drinking plain water ;-)

Jamik

could be worse...you could be drinking the .NET koolaid

mart2001

Next up would be to re-write it in C#.

It is going to look eerily similar to the Java code...