9 Web Services Tools

Example 9-1 Sample Web Services Assembly Tool Configuration File

<web-service>

    <display-name>Web Services Example</display-name>
    <description>Java Web Service Example</description>
    <!-- Specifies the resulting web service archive will be stored in ./ws_example.ear -->
    <destination-path>./ws_example.ear</destination-path>
    <!-- Specifies the temporary directory that web service assembly 
         tool can create temporary files. -->
    <temporary-directory>./tmp</temporary-directory>
    <!-- Specifies the web service will be accessed in the servlet context
         named "/webservices". -->
    <context>/webservices</context>

    <!-- Specifies the web service will be stateless -->
    <stateless-java-service>
        <interface-name>oracle.j2ee.ws_example.StatelessExample</interface-name>
        <class-name>oracle.j2ee.ws_example.StatelessExampleImpl</class-name>
        <!-- Specifies the web service will be accessed in the uri named
             "statelessTest" within the servlet context. -->
        <uri>/statelessTest</uri>
        <!-- Specifies the location of Java class files are under ./src -->
        <java-resource>./src</java-resource>
    </stateless-java-service>

    <stateful-java-service>
        <interface-name>oracle.j2ee.ws_example.StatefulExample</interface-name>
        <class-name>oracle.j2ee.ws_example.StatefulExampleImpl</class-name>
        <!-- Specifies the web service will be accessed in the uri named
             "statefulTest" within the servlet context. -->
        <uri>/statefulTest</uri>
        <!-- Specifies the location of Java class files are under ./src -->
        <java-resource>./src</java-resource>
    </stateful-java-service>

  </web-service>

Example 9-5 Assembly Tool Input File DTD

<?xml version="1.0" encoding="UCS-2"?> 
<!-- Specify the properties of the web services to be assembled. --> 
<!ELEMENT web-service ((display-name)?,(description)?,destination-path,temporary-directory,context,(datasource-JNDI-name)?,(stateful-java-service)*,(stateless-java-service)*,(stateless-stored-procedure-java-service)*,(stateless-session-ejb-service)*,(jms-doc-service)*,(option)*,(wsdl-gen)?,(proxy-gen)?)> 
<!ELEMENT display-name (#PCDATA)*> 
<!ELEMENT description (#PCDATA)*> 
<!-- Specify the full path of the resulting EAR file. For example, 
"/home/demo/webservices.ear" --> 
<!ELEMENT destination-path (#PCDATA)*> 
<!-- Specify a directory where the assembly tool can create temporary 
directories and files. --> 
<!ELEMENT temporary-directory (#PCDATA)*> 
<!-- Specify the context root of the web services. For example, "/webservices". --> 
<!ELEMENT context (#PCDATA)*> 
<!-- for specifying database  resource refs -->
<!ELEMENT datasource-JNDI-name (#PCDATA)*>

<!-- Specify the properties of a stateful  Java service --> 
<!ELEMENT stateful-java-service ((interface-name)?,class-name,uri,(java-resource)*,(ejb-resource)*,(scope)*,(session-timeout)*,(message-style)?)> 
<!-- Specify the properties of a stateless Java service --> 
<!ELEMENT stateless-java-service ((interface-name)?,class-name,uri,(java-resource)*,(ejb-resource)*,(message-style)?)> 
<!-- Specify the properties of a stateless stored procedure Java service --> 
<!ELEMENT stateless-stored-procedure-java-service ((interface-name)?,(class-name)?,uri,database-JNDI-name,(java-resource)?,(jar-generation)?)> 
<!-- Specify the properties of a stateless session ejb service --> 
<!ELEMENT stateless-session-ejb-service (path,uri,ejb-name,(ejb-resource)*)> 

<!-- Specify the java interface which defines the public methods to be exposed 
in the web service. For example, "com.foo.myproject.helloWorld". --> 
<!ELEMENT interface-name (#PCDATA)*> 
<!-- Specify the java class to be exposed as a web service. If interface-name is 
not specified, all the public methods in this class will be exposed. For example, 
     "com.foo.myproject.helloWorldImpl". --> 
<!ELEMENT class-name (#PCDATA)*> 
<!-- Specify the uri of this service. This uri is used in the URL to access the 
WSDL and client jar, and invoke the web service. For example, "/myService". --> 
<!ELEMENT uri (#PCDATA)*> 
<!-- 
Specify the java resources used in this service.
The value can be a directory or a file that implements the web services. If it 
is a directory, all the files and subdirectories under the directory are copied 
and packaged in the Enterprise ARchive. If the java resource should belong to a 
java package, you should either package it as a jar file and specify it as a 
java resource, or create the necessary directory and specify the directory which  
contains this directory structure as java resource. For example, you want to 
include  "com.mycompany.mypackage.foo" class as a java resource of the web 
services, you can either package this class file in foo.jar and specify 
<java-resource>c:/mydir/foo.jar</java-resource>, or place the class under 
d:/mydir/com/mycompany/mypackage/foo.class and specify the java resource as 
<java-resource>c:/mydir/</java-resource>. 
--> 
<!ELEMENT java-resource (#PCDATA)*> 
<!-- Specify the ejb resources used in this service. ejb-resource should be a 
jar file that implements a enterprise java bean. --> 
<!ELEMENT ejb-resource (#PCDATA)*> 
<!-- Specify the database JNDI name for stateless PL/SQL web service. --> 
<!ELEMENT database-jndi-name (#PCDATA)*> 
<!-- Specifies the path of the EJB jar file to exposed as web services. --> 
<!ELEMENT path (#PCDATA)*> 
<!-- Specify the ejb-name of the session bean to be exposed as web services. 
ejb-name should match the <ejb-name> value in the META-INF/ejb-jar.xml of the bean. --> 
<!ELEMENT ejb-name (#PCDATA)*>
<!-- Specify scope of Stateful Java service -->
<!ELEMENT scope (#PCDATA)*>
<!-- Specify session timeout  of Stateful Java service -->
<!ELEMENT session-timeout (#PCDATA)*>
<!-- Specify the directory location of the generated wsdl-->
<!ELEMENT wsdl-dir (#PCDATA)*>
<!-- Specify that wsdl generation is to happen 'force' 'httpServerURL' 'packageIt'-->
<!ELEMENT wsdl-gen (wsdl-dir,(option)*)>
<!-- Specifyg the directory location of the generated proxy-->
<!ELEMENT proxy-dir (#PCDATA)*>
<!ELEMENT option (#PCDATA)*>
<!ATTLIST option name CDATA #REQUIRED>

<!-- Specifying that proxy generation is asked for , it can have optional tags as 
'include-source' 'wsdl-location' -->
<!ELEMENT proxy-gen (proxy-dir,(option)*)>
<!ELEMENT jar-generation (db-package-name,db-schema,db-url,prefix,(method-name)*)> 
<!ELEMENT database-JNDI-name (#PCDATA)*>  
<!ELEMENT db-package-name (#PCDATA)*> 
<!ELEMENT db-url (#PCDATA)*> 
<!ELEMENT db-schema (#PCDATA)*> 
<!ELEMENT prefix (#PCDATA)*> 
<!ELEMENT method-name (#PCDATA)*> 
 <!-- specify the message style ,if this tag is not present it is considered to have 'rpc' ..it can have values of 'rpc' or 'doc' or 'document' -->
<!ELEMENT message-style (#PCDATA)*>

<!ELEMENT connection-factory-resource-ref (#PCDATA)*> 
<!ELEMENT topic-resource-ref (#PCDATA)*>  
<!ELEMENT queue-resource-ref (#PCDATA)*>  
<!--Resource ref of the return destination factory-->
<!ELEMENT reply-to-connection-factory-resource-ref (#PCDATA)*> 
<!--Resource ref of the return destination Topic. --> 
<!ELEMENT reply-to-topic-resource-ref (#PCDATA)*> 
<!--Resource ref of the return destination Queue. -->  
<!ELEMENT reply-to-queue-resource-ref (#PCDATA)*>  
<!--jms-priority ,jms-message-type,jms-delvery-mode ,jms-expiration The JMS properties are only set for enqueuing operations, i..e, for send operations only. -->
<!ELEMENT jms-priority (#PCDATA)*>  
<!ELEMENT jms-message-type (#PCDATA)*>  
<!ELEMENT jms-delivery-mode (#PCDATA)*>  
<!ELEMENT jms-expiration (#PCDATA)*>  
<!-- operation property is optional. Possible values for this parameter are: send, receive, and both. If not provided, the value defaults to both. -->
<!ELEMENT operation (#PCDATA)*>  
<!ELEMENT jms-doc-service (uri,connection-factory-resource-ref,(topic-resource-ref)?,(queue-resource-ref)?,(reply-to-connection-factory-resource-ref)?,(reply-to-topic-resource-ref)?,(reply-to-queue-resource-ref)?,(jms-priority)?,(jms-message-type)?,(jms-delivery-mode)?,(jms-expiration)?,(operation)?)>