You are viewing a plain text version of this content. The canonical link for it is here.

Posted to user@uima.apache.org by Baptiste GAILLARD <ba...@gmail.com> on 2007/11/29 14:31:37 UTC

How to use a SOAP component in a CPE ?

Hi,

I'm trying to use the CPEGui tool to build and run a CPE which contains an
Analysis Engine deployed via SOAP.

I've read the following in the UIMA documentation:
Note

The UIMA SDK also supports using unmanaged remote services via the
web-standard SOAP communications protocol (see Section 3.6.1, "Deploying as
SOAP Service"<http://incubator.apache.org/uima/downloads/releaseDocs/2.2.0-incubating/docs/html/tutorials_and_users_guides/tutorials_and_users_guides.html#ugr.tug.application.how_to_deploy_as_soap>.
This approach is based on a proxy implementation, where the proxy is
essentially running in an integrated mode. To use this approach with the
CPM, use the Integrated mode, with the component being an Aggregate which,
in turn, connects to a remote service.

 So I try to wrap a Soap service descriptor into an aggreagate AE:

-- AggregateWordsListAnnotatorSoapService.xml --

<?xml version="1.0" encoding="UTF-8" ?>
<analysisEngineDescription xmlns="http://uima.apache.org/resourceSpecifier">
    <frameworkImplementation>org.apache.uima.java</frameworkImplementation>
    <primitive>false</primitive>
    <delegateAnalysisEngineSpecifiers>
        <delegateAnalysisEngine key="WordsListAnnotatorSoapService">
            <import location="file:/D:\uimaj-
2.1.0-incubating-bin\apache-uima\bin\WordsListAnnotatorSoapService.xml"/>
        </delegateAnalysisEngine>
    </delegateAnalysisEngineSpecifiers>
    <analysisEngineMetaData>
        <name>WordsListAnnotatorSoapService</name>
        <description></description>
        <version>1.0</version>
        <vendor>The Apache Software Foundation</vendor>
        <flowConstraints>
            <fixedFlow>
                <node>WordsListAnnotatorSoapService</node>
            </fixedFlow>
        </flowConstraints>
    </analysisEngineMetaData>
</analysisEngineDescription>


My Soap service descriptor is the following:

<?xml version="1.0" encoding="UTF-8" ?>
<uriSpecifier xmlns="http://uima.apache.org/resourceSpecifier">
    <resourceType>AnalysisEngine</resourceType>
    <uri>http://localhost:8070/axis/services/urn:WordsListAnnotator</uri>
    <protocol>SOAP</protocol>
</uriSpecifier>


But, when I try to add the Aggregate AE "
AggregateWordsListAnnotatorSoapService.xml" with the "cpeGui.bat" tool the
following error is displayed :

org.apache.uima.collection.metadata.CpeDescriptionException: The object
reference casProcessor=NULL is invalid. (Thread Name: AWT-EventQueue-0).


So, do you know why this error appear ?
Why the isn't any sample CPE descriptor using components deployed via SOAP
in the UIMA examples ?

Thanks,


Baptiste GAILLARD

Re: OS licensing for TAEs

Posted by Marshall Schor <ms...@schor.com>.

Hi Girish. 

I am not a lawyer, so this is not in any way official advice.  However,
the Apache license version 2 was designed to allow commercial use of its
software by others with minimal conditions.  Please read the license,
http://www.apache.org/licenses/LICENSE-2.0
<http://apache.org/licenses/LICENSE-2.0> for details, especially section
4, which allows you to redistribute Apache licensed components, and
specifies the restrictions. 

The license, in particular, says you can release your TAEs under any
license you wish, provided that it complies with the conditions stated
in the Apache License. 

-Marshall

Chavan, Girish wrote:
> Do I have to release the TAEs that I produce under the Apache License?
> In other words, even If I just use any libraries released under Apache,
> and that have to be included with the software I produce for it to work,
> does that restrict my software to be released under the Apache license?
>
>
> thanks
> -Girish
>
>
>

OS licensing for TAEs

Posted by "Chavan, Girish" <ch...@upmc.edu>.

Do I have to release the TAEs that I produce under the Apache License?
In other words, even If I just use any libraries released under Apache,
and that have to be included with the software I produce for it to work,
does that restrict my software to be released under the Apache license?


thanks
-Girish

Re: When to add CAS Consumer to CPM, and when to add it to the end of a user's AE

Posted by Adam Lally <al...@alum.rpi.edu>.

On Dec 7, 2007 11:03 AM, Adam Lally <al...@alum.rpi.edu> wrote:
> If you need a CAS Consumer that processes CASes created within an
> aggregate AnalysisEngine, then you need to add the CasMultiplier to
> that aggregate AnalysisEngine, and not to the CPE.
>

Sorry, I typed the wrong thing there.  I meant to say: ...you need to
add the _CasConsumer_ to that aggregate AnalysisEngine, and not to the
CPE.

-Adam

Re: When to add CAS Consumer to CPM, and when to add it to the end of a user's AE

Posted by Adam Lally <al...@alum.rpi.edu>.

Hi,

On Dec 7, 2007 10:50 AM, Chavan, Girish <ch...@upmc.edu> wrote:
> Hi All,
>
> I am a newbie with UIMA, and some of my terminologies might be a bit off
> here. Please bear with me.

Looks to me like you got the terminology right.

> Here's my question:
> I am going through the code in 'DocumentAnalyzer.java' and I see that it
> creates an Aggregate AE which contains the user specified AE and a CAS
> consumer to the end of it. However, the CPM also seems to have a
> addCasConsumer() method. Why would you not add the CasConsumer to the
> CPM instead of tagging it at the end of the user's AE? The comment talks
> about how this is done to support a user AE which might have a CAS
> Multiplier.
> When a CasConsumer is added to a CPM, does it only see CASes that were
> output by the CollectionReader?, and not all CASes coming out of the
> user's AE?
>

Yes, that's right.  It's currently a limitation that a CasConsumer
won't see CASes that are created by a CasMultiplier within the user's
AE.  This is explained here:
http://incubator.apache.org/uima/downloads/releaseDocs/2.2.0-incubating/docs/html/tutorials_and_users_guides/tutorials_and_users_guides.html#ugr.tug.cm.using_cm_in_cpe

If you need a CAS Consumer that processes CASes created within an
aggregate AnalysisEngine, then you need to add the CasMultiplier to
that aggregate AnalysisEngine, and not to the CPE.

-Adam

When to add CAS Consumer to CPM, and when to add it to the end of a user's AE

Posted by "Chavan, Girish" <ch...@upmc.edu>.

Hi All,

I am a newbie with UIMA, and some of my terminologies might be a bit off
here. Please bear with me.
Here's my question:
I am going through the code in 'DocumentAnalyzer.java' and I see that it
creates an Aggregate AE which contains the user specified AE and a CAS
consumer to the end of it. However, the CPM also seems to have a
addCasConsumer() method. Why would you not add the CasConsumer to the
CPM instead of tagging it at the end of the user's AE? The comment talks
about how this is done to support a user AE which might have a CAS
Multiplier. 
When a CasConsumer is added to a CPM, does it only see CASes that were
output by the CollectionReader?, and not all CASes coming out of the
user's AE?

Kind Regards,
Girish Chavan
UPitt.

Re: How to use a SOAP component in a CPE ?

Posted by Marshall Schor <ms...@schor.com>.

I've entered 2 Jira issues for this,
https://issues.apache.org/jira/browse/UIMA-670 for making it basically
work and https://issues.apache.org/jira/browse/UIMA-671 for adding
support for the CPM calls of batchProcessComplete and
collectionProcessComplete.

My guess is that these may take some time to fix, and are not scheduled
for the 2.2.1 release (now in its final stages of testing before
releasing, we hope), so in the meanwhile, I hope you can use the
work-arounds.

-Marshall

Adam Lally wrote:
> On Dec 6, 2007 9:44 AM, Baptiste GAILLARD <ba...@gmail.com> wrote:
>   
>> Hi again,
>>
>> sorry but I still have problems even with the Cas Consumer inside an
>> aggregate Analysis Engine.
>>
>>     
>
> I scanned through the code and it looks like we have a bug with remote
> CAS Consumers.
>
> I can think of two possible workarounds: Either wrap the CAS Consumer
> in an Aggregate AE _on the service side_, or you might just be able to
> change the <resourceType> in your client descriptor to AnalysisEngine
> instead of CasConsumer.
>
> However, I saw while looking at the code that the
> batchProcessComplete() and collectionProcessComplete() methods are
> unimplemented through the SOAP interface.  So if you need those you
> may be out of luck, sorry.
>
> In recent versions of UIMA there is essentially no difference between
> an AnalysisEngine and a CasConsumer, but apparently the SOAP Service
> adapter hasn't kept up with the times. :(
>
> -Adam
>
>
>