Zahida,

There are two different perspectives to consider:

1. The processor API, which allows you to implement your own
   processors.

2. The XPL pipeline engine API, which allows you to embed the pipeline
   engine in your application to run piplines.

For the processor API, see:

  http://www.orbeon.com/ois/doc/reference-processor-api

as well as the Java processor documentation:

  http://www.orbeon.com/ois/doc/processors-java

There is some Javadoc as well under doc/index.html, which is a little
incomplete, I realize.

For the pipeline API, the main documentation at the moment is the page
you pointed out:

  http://www.orbeon.com/ois/doc/integration-pipeline-api

See also the source file OXF.java, which is the main command-line
application class.

What information are you looking for that you think is missing? Just
running a pipeline is actually a fairly simple matter. Where I see
some documentation missing is:

1. Use of the ExternalContext interface by processors
2. Caching facilities offered to processors

Both of those areas are more related to the processor API.

To answer your second question, there is no guarantee that the
documented API will never change (there is no W3C or POSIX spec for
it!), but if it does it will be hopefully for good reasons, and we
will try to keep backward compatibility if possible, especially if
some users are depending on it.

-Erik

Zahida Chaudri wrote:
> Hi,
>
> Are there and java APIs for the Orbeon pipeline engine, or any
> generated javadoc?
>
> I've checked http://www.orbeon.com/ois/doc/integration-pipeline-api
> but was really looking for more information.
>
> Also are the interfaces specified or will / can the interfaces change?
>
> Thanks,
>
> Zahida.


------------------------------------------------------- The SF.Net email is sponsored by: Beat the post-holiday blues Get a FREE limited edition SourceForge.net t-shirt from ThinkGeek. It's fun and FREE -- well, almost....http://www.thinkgeek.com/sfshirt _______________________________________________ orbeon-user mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/orbeon-user

Reply via email to