[jboss-cvs] JBossAS SVN: r67235 - projects/docs/trunk/Server_Configuration_Guide/en-US.
jboss-cvs-commits at lists.jboss.org
jboss-cvs-commits at lists.jboss.org
Sun Nov 18 12:26:29 EST 2007
Author: skittoli at redhat.com
Date: 2007-11-18 12:26:29 -0500 (Sun, 18 Nov 2007)
New Revision: 67235
Modified:
projects/docs/trunk/Server_Configuration_Guide/en-US/Author_Group.xml
projects/docs/trunk/Server_Configuration_Guide/en-US/EJB3.xml
projects/docs/trunk/Server_Configuration_Guide/en-US/Web_Services.xml
Log:
minor fixes-authors and web services files
Modified: projects/docs/trunk/Server_Configuration_Guide/en-US/Author_Group.xml
===================================================================
--- projects/docs/trunk/Server_Configuration_Guide/en-US/Author_Group.xml 2007-11-18 16:47:36 UTC (rev 67234)
+++ projects/docs/trunk/Server_Configuration_Guide/en-US/Author_Group.xml 2007-11-18 17:26:29 UTC (rev 67235)
@@ -11,6 +11,15 @@
<orgname>Red Hat</orgname>
</affiliation>-->
</author>
+ <author>
+ <firstname>Bill</firstname>
+ <surname>Burke</surname>
+ <!--<affiliation>
+ <shortaffil></shortaffil>
+ <jobtitle></jobtitle>
+ <orgname>Red Hat</orgname>
+ </affiliation>-->
+ </author>
<author>
<firstname>Carlo</firstname>
@@ -23,6 +32,16 @@
</author>
<author>
+ <firstname>Heiko</firstname>
+ <surname>Braun</surname>
+ <!--<affiliation>
+ <shortaffil></shortaffil>
+ <jobtitle></jobtitle>
+ <orgname>Red Hat</orgname>
+ </affiliation>-->
+ </author>
+
+ <author>
<firstname>Michael</firstname>
<surname>Yuan</surname>
<!-- <affiliation>
Modified: projects/docs/trunk/Server_Configuration_Guide/en-US/EJB3.xml
===================================================================
--- projects/docs/trunk/Server_Configuration_Guide/en-US/EJB3.xml 2007-11-18 16:47:36 UTC (rev 67234)
+++ projects/docs/trunk/Server_Configuration_Guide/en-US/EJB3.xml 2007-11-18 17:26:29 UTC (rev 67235)
@@ -5,12 +5,12 @@
<chapter id="EJB3_Services">
<title>Enterprise Applications with EJB3 Services</title>
- <!--<para>In the previous chapter, we discussed how to write simple web applications packaged in WAR files. Using JavaServer Faces (JSF), you can write web applications that conform to strict MVC-based component models. However, for most JBoss platform users, the web applcation in the WAR is just the UI frontend. The real business logic of the application, such as database access, transactions, secuirty etc., is handled by enterprise business components such as Enterprise JavaBeans (EJBs).</para>-->
- <para>EJB3 (Enterprise JavaBean 3.0) provides the core component model for Java EE 5 applications. An EJB3 bean is a managed component that is automatically wired to take advantage of all services the J2EE server container provides, such as transaction, security, persistence, naming, dependency injection, etc. The managed component allows developers to focus on the business logic, and leave the cross-cutting concerns to the container as configurations. As an application developer, you need not create or destroy the components yourself. You only need to ask for an EJB3 bean from the Java EE container by its name, and then you can call its methods with all configured container services applied. You can get access to an EJB3 bean from either inside or outside of the J2EE container.</para>
- <para>JBoss AS 4.2 supports EJB3 out of the box. For JBoss AS 4.0.x, you can add support for EJB3 by manually installing the JBoss EJB3 deployer, or installing the server from a JEMS GUI installer and select a EJB3 profile.</para>
+ <para>EJB3 (Enterprise Java Bean 3.0) provides the core component model for Java EE 5 applications. An EJB3 bean is a managed component that is automatically wired to take advantage of all services the Java EE 5 server container provides, such as transaction, security, persistence, naming, dependency injection, etc. The managed component allows developers to focus on the business logic, and leave the cross-cutting concerns to the container as configurations. As an application developer, you need not create or destroy the components yourself. You only need to ask for an EJB3 bean from the Java EE container by its name, and then you can call its methods with all configured container services applied. You can get access to an EJB3 bean from either inside or outside of the Java EE container. </para>
+ <para>JBoss AS 4.2 supports EJB3 out of the box. Note that JBoss AS 4.2 is a J2EE server, so it does not support the full EJB3 feature set. </para>
+
<para>The details of the EJB3 component programming model is beyond the scope of this guide. Most EJB3 interfaces and annotations are part of the Java EE 5 standard and hence they are the same for all Java EE 5 compliant application servers. Interested readers should refer to the EJB3 specification or numerous EJB3 books to learn more about EJB3 programming.</para>
<para>In this chapter, we only cover EJB3 configuration issues that are specific to the JBoss AS. For instance, we discuss the JNDI naming conventions for EJB3 components inside the JBoss AS, the optional configurations for the Hibernate persistence engine for entity beans, as well as custom options in the JBoss EJB3 deployer.</para>
@@ -38,12 +38,12 @@
]]>
</programlisting>
- <para>When you invoke a session bean method, the method execution is automatically managed by the transaction manager and the security manager in the server. You can specify the transactional or security properties for each method using annotations on the method. A session bean instance can be reused by many clients. Depending on whether the server maintains the bean's internal state between two clients, the session bean can be stateless or stateful. Depending on whether the bean is available to remote clients (i.e., clients outside of the current JVM for the server), the session bean can be local or remote. All these are configurable via standard annotations on the beans.</para>
+ <para>When you invoke a session bean method, the method execution is automatically managed by the transaction manager and the security manager in the server. You can specify the transactional or security properties for each method using annotations on the method. A session bean instance can be reused by many clients. Depending on whether the server maintains the bean's internal state between two clients, the session bean can be stateless or stateful. Depending on whether the bean has a remote business interface clients outside of the current JVM can call upon the EJB3 bean. All these are configurable via standard annotations on the beans. Note that the transactional or security properties are only active when the bean is called through a business interface.</para>
- <para>After you define a session bean, how does the client get access to it? As we discussed, the client does not create or destroy EJB3 components, it merely asks the server for a reference of an existing instance managed by the server. That is done via JNDI. In JBoss AS, the default local JNDI name for a session bean is dependent on the deployment packaging of the bean class.</para>
+ <para>After you define a session bean, how does the client get a reference to it? As we discussed, the client does not create or destroy EJB3 components, it merely asks the server for a reference of an existing instance managed by the server. That is done via JNDI. In JBoss AS, the default local JNDI name for a session bean is dependent on the deployment packaging of the bean class.</para>
<itemizedlist>
- <listitem><para>If the bean is deployed in a standalone JAR file in the <varname>jboss-as/production/deploy</varname> directory, the bean is accessible via local JNDI name <varname>MyBean/local</varname>, where <varname>MyBean</varname> is the implementation class name of the bean as we showed earlier. The "local" JNDI in JBoss AS means that the JNDI name is relative to <varname>java:comp/env/</varname>.</para></listitem>
+ <listitem><para>If the bean is deployed in a standalone JAR file in the <varname>JBOSS_DIST/default/deploy</varname> directory, the bean is accessible via local JNDI name <varname>MyBean/local</varname>, where <varname>MyBean</varname> is the implementation class name of the bean as we showed earlier. The "local" JNDI in JBoss AS means that the JNDI name is relative to <varname>java:comp/env/</varname>.</para></listitem>
<listitem><para>If the JAR file containing the bean is packaged in an EAR file, the local JNDI name for the bean is <varname>myapp/MyBean/local</varname>, where <varname>myapp</varname> is the root name of the EAR archive file (e.g., <varname>myapp.ear</varname>, see later for the EAR packaging of EJB3 beans). </para></listitem>
</itemizedlist>
@@ -188,7 +188,7 @@
@PersistenceContext
EntityManager em;
-Customer customer = new Cutomer ();
+Customer customer = new Customer ();
// populate data in customer
// Save the newly created customer object to DB
@@ -258,7 +258,7 @@
<section>
<title>Use Alternative Databases</title>
- <para>To use an alternative database other than the built-in HSQL DB to back your entity beans, you need to first define the data source for the database and register it in the JNDI. This is done via the *-ds.xml files in the deploy directory. Please see <xref linkend="Connectors_on_JBoss-Configuring_JDBC_DataSources"/> for more details. Examples of *-ds.xml files for various databases are available in jboss-as/docs/examples/jca directory in the server.</para>
+ <para>To use an alternative database other than the built-in HSQL DB to back your entity beans, you need to first define the data source for the database and register it in the JNDI. This is done via the *-ds.xml files in the deploy directory. Please see <xref linkend="Connectors_on_JBoss-Configuring_JDBC_DataSources"/> for more details. Examples of *-ds.xml files for various databases are available in JBOSS_DIST/docs/examples/jca directory in the server.</para>
<para>Then, in the persistence.xml, you need to change the jta-data-source attribute to point to the new data source in JNDI (e.g., java:/MysqlDS if you are using the default mysql-ds.xml to setup a MySQL external database).</para>
@@ -278,7 +278,7 @@
<section>
<title>Default Hibernate options</title>
- <para>Hibernate has many configuration properties. For the properties that you do not specify in the persistence.xml file, JBoss AS will provide a reasonable set of default values. The default Hibernate property values are specified in the <varname>jboss-as/server/production/deploy/ejb3.deployer/MEAT-INF/persistence.properties</varname> file. Below is the <varname>persistence.properties</varname> file bundled in JBoss AS 4.2. Notice the options that are commented out. They give you an idea of available properties in your <varname>persistence.xml</varname> file.</para>
+ <para>Hibernate has many configuration properties. For the properties that you do not specify in the persistence.xml file, JBoss AS will provide a reasonable set of default values. The default Hibernate property values are specified in the <varname>JBOSS_DIST/server/default/deploy/ejb3.deployer/MEAT-INF/persistence.properties</varname> file. Below is the <varname>persistence.properties</varname> file bundled in JBoss AS 4.2. Notice the options that are commented out. They give you an idea of available properties in your <varname>persistence.xml</varname> file.</para>
<programlisting>
<![CDATA[
@@ -398,9 +398,9 @@
<section>
<title>Deploy the EJB3 JAR</title>
- <para>When you drop JAR files into the <varname>jboss-as/server/production/deploy/</varname> directory, it will be automatically picked up and processed by the server. All the EJB3 beans defined in the JAR file will then be available to other applications deployed inside or outside of the server via JNDI names like <varname>MyBean/local</varname>, where <varname>MyBean</varname> is the implementation class name for the session bean. The deployment is done via the JBoss EJB3 deployer in jboss-as/server/production/ejb3.deployer/. The META-INF/persistence.properties file we discussed earlier to configure the default behavior of EJB3 entity manager is located in the EJB3 deployer.</para>
+ <para>When you drop JAR files into the <varname>JBOSS_DIST/server/default/deploy/</varname> directory, it will be automatically picked up and processed by the server. All the EJB3 beans defined in the JAR file will then be available to other applications deployed inside or outside of the server via JNDI names like <varname>MyBean/local</varname>, where <varname>MyBean</varname> is the implementation class name for the session bean. The deployment is done via the JBoss EJB3 deployer in JBOSS_DIST/server/default/ejb3.deployer/. The META-INF/persistence.properties file we discussed earlier to configure the default behavior of EJB3 entity manager is located in the EJB3 deployer.</para>
- <para>The EJB3 deployer automatically scans JARs on the classpath to look for EJB3 annotations. When it finds classes with EJB3 annotations, it would deploy them as EJB3 services. However, scanning all JARs on the classpath could be very time-consuming if you have large applications with many JARs deployed. In the jboss-as/server/production/ejb3.deployer/META-INF/jboss-service.xml file, you can tell the EJB3 deployer to ignore JARs you know do not contain EJB3 beans. The non-EJB3 JAR files shipped with the JBoss AS are already listed in the jboss.ejb3:service=JarsIgnoredForScanning MBean service:</para>
+ <para>The EJB3 deployer automatically scans JARs on the classpath to look for EJB3 annotations. When it finds classes with EJB3 annotations, it would deploy them as EJB3 services. However, scanning all JARs on the classpath could be very time-consuming if you have large applications with many JARs deployed. In the JBOSS_DIST/server/default/ejb3.deployer/META-INF/jboss-service.xml file, you can tell the EJB3 deployer to ignore JARs you know do not contain EJB3 beans. The non-EJB3 JAR files shipped with the JBoss AS are already listed in the jboss.ejb3:service=JarsIgnoredForScanning MBean service:</para>
<programlisting>
@@ -496,7 +496,7 @@
]]>
</programlisting>
- <para>The EAR deployment is configured by the jboss-as/server/production/deploy/ear-deploy.xml file. This file contains three attributes as follows.</para>
+ <para>The EAR deployment is configured by the JBOSS_DIST/server/default/deploy/ear-deploy.xml file. This file contains three attributes as follows.</para>
<programlisting>
<![CDATA[
Modified: projects/docs/trunk/Server_Configuration_Guide/en-US/Web_Services.xml
===================================================================
--- projects/docs/trunk/Server_Configuration_Guide/en-US/Web_Services.xml 2007-11-18 16:47:36 UTC (rev 67234)
+++ projects/docs/trunk/Server_Configuration_Guide/en-US/Web_Services.xml 2007-11-18 17:26:29 UTC (rev 67235)
@@ -243,18 +243,17 @@
<para>
A JAX-WS java service endpoint (JSE) is deployed as a web application.
-<programlisting>
- <![CDATA[
- <web-app ...>
- <servlet>
+<programlisting><![CDATA[
+<web-app ...>
+ <servlet>
+ <servlet-name>TestService</servlet-name>
+ <servlet-class>org.jboss.test.ws.jaxws.samples.jsr181pojo.JSEBean01</servlet-class>
+ </servlet>
+ <servlet-mapping>
<servlet-name>TestService</servlet-name>
- <servlet-class>org.jboss.test.ws.jaxws.samples.jsr181pojo.JSEBean01</servlet-class>
- </servlet>
- <servlet-mapping>
- <servlet-name>TestService</servlet-name>
- <url-pattern>/*</url-pattern>
- </servlet-mapping>
- </web-app> ]]>
+ <url-pattern>/*</url-pattern>
+ </servlet-mapping>
+</web-app> ]]>
</programlisting>
</para>
@@ -470,25 +469,25 @@
}]]> </programlisting>
<para>The service endpoint interface (SEI) is usually generated using tools. For details see <ulink url="http://jbws.dyndns.org/mediawiki/index.php?title=JAX-WS_User_Guide#_Top_Down_.28WSDL_to_Java.29"># Top Down (WSDL to Java)</ulink></para>
<para>A generated static <ulink url="http://jbws.dyndns.org/mediawiki/index.php?title=JAX-WS_User_Guide#Service">#Service</ulink> usually also offers typed methods to get ports. These methods also return dynamic proxies that implement the SEI.</para>
- <programlisting> <![CDATA[
- @WebServiceClient(name = "TestEndpointService", targetNamespace = "http://org.jboss.ws/wsref",
- wsdlLocation = "http://localhost.localdomain:8080/jaxws-samples-webserviceref?wsdl")
-
- public class TestEndpointService extends Service
- {
- ...
-
- public TestEndpointService(URL wsdlLocation, QName serviceName) {
- super(wsdlLocation, serviceName);
- }
-
- @WebEndpoint(name = "TestEndpointPort")
- public TestEndpoint getTestEndpointPort()
- {
- return (TestEndpoint)super.getPort(TESTENDPOINTPORT, TestEndpoint.class);
- }
- }
- ]]> </programlisting>
+<programlisting> <![CDATA[
+ at WebServiceClient(name = "TestEndpointService", targetNamespace = "http://org.jboss.ws/wsref",
+ wsdlLocation = "http://localhost.localdomain:8080/jaxws-samples-webserviceref?wsdl")
+
+ public class TestEndpointService extends Service
+ {
+ ...
+
+ public TestEndpointService(URL wsdlLocation, QName serviceName) {
+ super(wsdlLocation, serviceName);
+ }
+
+ @WebEndpoint(name = "TestEndpointPort")
+ public TestEndpoint getTestEndpointPort()
+ {
+ return (TestEndpoint)super.getPort(TESTENDPOINTPORT, TestEndpoint.class);
+ }
+ }
+ ]]> </programlisting>
</section>
<section>
<title>WebServiceRef</title>
@@ -502,15 +501,15 @@
<para> To define a reference whose type is a SEI. In this case, the type element MAY be present with its default value if the type of the reference can be inferred from the annotated field/method declaration, but the value element MUST always be present and refer to a generated service class type (a subtype of javax.xml.ws.Service). The wsdlLocation element, if present, overrides theWSDL location information specified in the WebService annotation of the referenced generated service class.</para>
</listitem>
</orderedlist>
- <programlisting> <![CDATA[
- public class EJB3Client implements EJB3Remote
- {
- @WebServiceRef
- public TestEndpointService service4;
-
- @WebServiceRef
- public TestEndpoint port3;
- ]]> </programlisting>
+<programlisting> <![CDATA[
+public class EJB3Client implements EJB3Remote
+{
+ @WebServiceRef
+ public TestEndpointService service4;
+
+ @WebServiceRef
+ public TestEndpoint port3;
+]]> </programlisting>
<para>
<emphasis role="bold">WebServiceRef Customization</emphasis>
</para>
@@ -527,37 +526,37 @@
</listitem>
</itemizedlist>
<para>Example:</para>
- <programlisting> <![CDATA[
- <service-ref>
- <service-ref-name>OrganizationService</service-ref-name>
- <wsdl-override>file:/wsdlRepository/organization-service.wsdl</wsdl-override>
- </service-ref>
-
- <service-ref>
- <service-ref-name>OrganizationService</service-ref-name>
- <config-name>Secure Client Config</config-name>
- <config-file>META-INF/jbossws-client-config.xml</config-file>
- <handler-chain>META-INF/jbossws-client-handlers.xml</handler-chain>
- </service-ref>
-
- <service-ref>
- <service-ref-name>SecureService</service-ref-name>
- <service-class-name>org.jboss.tests.ws.jaxws.webserviceref.SecureEndpointService</service-class-name>
- <service-qname>{http://org.jboss.ws/wsref}SecureEndpointService</service-qname>
- <port-info>
- <service-endpoint-interface>org.jboss.tests.ws.jaxws.webserviceref.SecureEndpoint</service-endpoint-interface>
- <port-qname>{http://org.jboss.ws/wsref}SecureEndpointPort</port-qname>
- <stub-property>
- <name>javax.xml.ws.security.auth.username</name>
- <value>kermit</value>
- </stub-property>
- <stub-property>
- <name>javax.xml.ws.security.auth.password</name>
- <value>thefrog</value>
- </stub-property>
- </port-info>
- </service-ref>
- ]]> </programlisting>
+<programlisting> <![CDATA[
+<service-ref>
+<service-ref-name>OrganizationService</service-ref-name>
+<wsdl-override>file:/wsdlRepository/organization-service.wsdl</wsdl-override>
+</service-ref>
+..
+<service-ref>
+<service-ref-name>OrganizationService</service-ref-name>
+<config-name>Secure Client Config</config-name>
+<config-file>META-INF/jbossws-client-config.xml</config-file>
+<handler-chain>META-INF/jbossws-client-handlers.xml</handler-chain>
+</service-ref>
+
+<service-ref>
+<service-ref-name>SecureService</service-ref-name>
+<service-class-name>org.jboss.tests.ws.jaxws.webserviceref.SecureEndpointService</service-class-name>
+<service-qname>{http://org.jboss.ws/wsref}SecureEndpointService</service-qname>
+<port-info>
+<service-endpoint-interface>org.jboss.tests.ws.jaxws.webserviceref.SecureEndpoint</service-endpoint-interface>
+<port-qname>{http://org.jboss.ws/wsref}SecureEndpointPort</port-qname>
+<stub-property>
+<name>javax.xml.ws.security.auth.username</name>
+<value>kermit</value>
+</stub-property>
+<stub-property>
+<name>javax.xml.ws.security.auth.password</name>
+<value>thefrog</value>
+</stub-property>
+</port-info>
+</service-ref>
+]]> </programlisting>
<para>For details please see <emphasis role="bold">service-ref_5_0.dtd</emphasis> in the jboss docs directory.</para>
</section>
<section>
@@ -567,16 +566,16 @@
<para><emphasis role="bold">Message</emphasis> In this mode, client applications work directly with protocol-specific message structures. E.g., when used with a SOAP protocol binding, a client application would work directly with a SOAP message.</para>
<para><emphasis role="bold">Message Payload</emphasis> In this mode, client applications work with the payload of messages rather than the messages themselves. E.g., when used with a SOAP protocol binding, a client application would work with the contents of the SOAP Body rather than the SOAP message as a whole.</para>
<para>Dispatch is a low level API that requires clients to construct messages or message payloads as XML and requires an intimate knowledge of the desired message or payload structure. Dispatch is a generic class that supports input and output of messages or message payloads of any type.</para>
- <programlisting> <![CDATA[
- Service service = Service.create(wsdlURL, serviceName);
- Dispatch dispatch = service.createDispatch(portName, StreamSource.class, Mode.PAYLOAD);
-
- String payload = "<ns1:ping xmlns:ns1='http://oneway.samples.jaxws.ws.test.jboss.org/'/>";
- dispatch.invokeOneWay(new StreamSource(new StringReader(payload)));
-
- payload = "<ns1:feedback xmlns:ns1='http://oneway.samples.jaxws.ws.test.jboss.org/'/>";
- Source retObj = (Source)dispatch.invoke(new StreamSource(new StringReader(payload)));
- ]]> </programlisting>
+<programlisting> <![CDATA[
+Service service = Service.create(wsdlURL, serviceName);
+Dispatch dispatch = service.createDispatch(portName, StreamSource.class, Mode.PAYLOAD);
+
+String payload = "<ns1:ping xmlns:ns1='http://oneway.samples.jaxws.ws.test.jboss.org/'/>";
+dispatch.invokeOneWay(new StreamSource(new StringReader(payload)));
+
+payload = "<ns1:feedback xmlns:ns1='http://oneway.samples.jaxws.ws.test.jboss.org/'/>";
+Source retObj = (Source)dispatch.invoke(new StreamSource(new StringReader(payload)));
+]]> </programlisting>
</section>
<section>
<title>Asynchronous Invocations</title>
@@ -593,48 +592,48 @@
</para>-->
<para>BindingProvider instances may provide asynchronous operation capabilities. When used, asynchronous operation invocations are decoupled from the BindingProvider instance at invocation time such that the response context is not updated when the operation completes. Instead a separate response context is made available using the Response interface.</para>
- <programlisting> <![CDATA[
- public void testInvokeAsync() throws Exception
- {
- URL wsdlURL = new URL("http://" + getServerHost() + ":8080/jaxws-samples-asynchronous?wsdl");
- QName serviceName = new QName(targetNS, "TestEndpointService");
- Service service = Service.create(wsdlURL, serviceName);
- TestEndpoint port = service.getPort(TestEndpoint.class);
-
- Response response = port.echoAsync("Async");
-
- // access future
- String retStr = (String) response.get();
- assertEquals("Async", retStr);
- }
- ]]> </programlisting>
+<programlisting> <![CDATA[
+public void testInvokeAsync() throws Exception
+{
+URL wsdlURL = new URL("http://" + getServerHost() + ":8080/jaxws-samples-asynchronous?wsdl");
+QName serviceName = new QName(targetNS, "TestEndpointService");
+Service service = Service.create(wsdlURL, serviceName);
+TestEndpoint port = service.getPort(TestEndpoint.class);
+
+Response response = port.echoAsync("Async");
+
+// access future
+String retStr = (String) response.get();
+assertEquals("Async", retStr);
+}
+]]> </programlisting>
</section>
<section>
<title>Oneway Invocations</title>
<para>@Oneway indicates that the given web method has only an input message and no output. Typically, a oneway method returns the thread of control to the calling application prior to executing the actual business method.</para>
- <programlisting> <![CDATA[
- @WebService (name="PingEndpoint")
- @SOAPBinding(style = SOAPBinding.Style.RPC)
- public class PingEndpointImpl
- {
- private static String feedback;
-
- @WebMethod
- @Oneway
- public void ping()
- {
- log.info("ping");
- feedback = "ok";
- }
-
- @WebMethod
- public String feedback()
- {
- log.info("feedback");
- return feedback;
- }
- }
- ]]> </programlisting>
+<programlisting> <![CDATA[
+ at WebService (name="PingEndpoint")
+ at SOAPBinding(style = SOAPBinding.Style.RPC)
+public class PingEndpointImpl
+{
+ private static String feedback;
+..
+ at WebMethod
+ at Oneway
+public void ping()
+{
+log.info("ping");
+feedback = "ok";
+}
+..
+ at WebMethod
+public String feedback()
+{
+log.info("feedback");
+return feedback;
+}
+}
+]]> </programlisting>
</section>
</section>
<section>
@@ -667,14 +666,14 @@
<section>
<title>Service endpoint handlers</title>
<para>On the service endpoint, handlers are defined using the @HandlerChain annotation.</para>
- <programlisting> <![CDATA[
- @WebService
- @HandlerChain(file = "jaxws-server-source-handlers.xml")
- public class SOAPEndpointSourceImpl
- {
- ...
- }
- ]]> </programlisting>
+<programlisting> <![CDATA[
+ at WebService
+ at HandlerChain(file = "jaxws-server-source-handlers.xml")
+public class SOAPEndpointSourceImpl
+{
+...
+}
+]]> </programlisting>
<para>The location of the handler chain file supports 2 formats</para>
<para>1. An absolute java.net.URL in externalForm. (ex: <ulink url="http://myhandlers.foo.com/handlerfile1.xml">http://myhandlers.foo.com/handlerfile1.xml</ulink>)</para>
<para>2. A relative path from the source file or class file. (ex: bar/handlerfile1.xml)</para>
@@ -682,17 +681,17 @@
<section>
<title>Service client handlers</title>
<para>On the client side, handler can be configured using the @HandlerChain annotation on the SEI or dynamically using the API.</para>
- <programlisting> <![CDATA[
- Service service = Service.create(wsdlURL, serviceName);
- Endpoint port = (Endpoint)service.getPort(Endpoint.class);
-
- BindingProvider bindingProvider = (BindingProvider)port;
- List<Handler> handlerChain = new ArrayList<Handler>();
- handlerChain.add(new LogHandler());
- handlerChain.add(new AuthorizationHandler());
- handlerChain.add(new RoutingHandler());
- bindingProvider.getBinding().setHandlerChain(handlerChain); // important!
- ]]> </programlisting>
+<programlisting> <![CDATA[
+Service service = Service.create(wsdlURL, serviceName);
+Endpoint port = (Endpoint)service.getPort(Endpoint.class);
+
+BindingProvider bindingProvider = (BindingProvider)port;
+List<Handler> handlerChain = new ArrayList<Handler>();
+handlerChain.add(new LogHandler());
+handlerChain.add(new AuthorizationHandler());
+handlerChain.add(new RoutingHandler());
+bindingProvider.getBinding().setHandlerChain(handlerChain); // important!
+]]> </programlisting>
</section>
</section>
<section>
@@ -702,10 +701,10 @@
<section>
<title>Accessing the message context</title>
<para>There is currently no portable way of doing this in 4.0.5. <literal>@WebServiceContext</literal> injection will be available with 4.2. In the meantime you can access the message context like this:</para>
- <programlisting> <![CDATA[
- CommonMessageContext msgContext = MessageContextAssociation.peekMessageContext();
- msgContext.setProperty(<Name>, <Value>);
- ]]> </programlisting>
+<programlisting> <![CDATA[
+CommonMessageContext msgContext = MessageContextAssociation.peekMessageContext();
+msgContext.setProperty(<Name>, <Value>);
+]]> </programlisting>
</section>
<section>
<title>Logical Message Context</title>
@@ -719,23 +718,23 @@
<section>
<title>Fault Handling</title>
<para>An implementation may thow a SOAPFaultException</para>
- <programlisting> <![CDATA[
- public void throwSoapFaultException()
- {
- SOAPFactory factory = SOAPFactory.newInstance();
- SOAPFault fault = factory.createFault("this is a fault string!", new QName("http://foo", "FooCode"));
- fault.setFaultActor("mr.actor");
- fault.addDetail().addChildElement("test");
- throw new SOAPFaultException(fault);
- }
- ]]> </programlisting>
+<programlisting> <![CDATA[
+public void throwSoapFaultException()
+{
+SOAPFactory factory = SOAPFactory.newInstance();
+SOAPFault fault = factory.createFault("this is a fault string!", new QName("http://foo", "FooCode"));
+fault.setFaultActor("mr.actor");
+fault.addDetail().addChildElement("test");
+throw new SOAPFaultException(fault);
+}
+]]> </programlisting>
<para>or an application specific user exception</para>
- <programlisting> <![CDATA[
- public void throwApplicationException() throws UserException
- {
- throw new UserException("validation", 123, "Some validation error");
- }
- ]]> </programlisting>
+<programlisting> <![CDATA[
+public void throwApplicationException() throws UserException
+{
+throw new UserException("validation", 123, "Some validation error");
+}
+]]> </programlisting>
<para>
<note><title>Note</title>
<para>In case of the latter JBossWS generates the required fault wrapper beans at runtime if they are not part of the deployment</para>
@@ -841,23 +840,23 @@
<para>
<emphasis role="bold">MTOM enabled service implementations</emphasis>
</para>
- <programlisting> <![CDATA[
- package org.jboss.test.ws.jaxws.samples.xop.doclit;
-
- import javax.ejb.Remote;
- import javax.jws.WebService;
- import javax.jws.soap.SOAPBinding;
- import javax.xml.ws.BindingType;
-
- @Remote
- @WebService(targetNamespace = "http://org.jboss.ws/xop/doclit")
- @SOAPBinding(style = SOAPBinding.Style.DOCUMENT, parameterStyle = SOAPBinding.ParameterStyle.BARE)
- @BindingType(value="http://schemas.xmlsoap.org/wsdl/soap/http?mtom=true") (1)
- public interface MTOMEndpoint {
-
- [...]
- }
- ]]> </programlisting>
+<programlisting> <![CDATA[
+package org.jboss.test.ws.jaxws.samples.xop.doclit;
+
+import javax.ejb.Remote;
+import javax.jws.WebService;
+import javax.jws.soap.SOAPBinding;
+import javax.xml.ws.BindingType;
+
+ at Remote
+ at WebService(targetNamespace = "http://org.jboss.ws/xop/doclit")
+ at SOAPBinding(style = SOAPBinding.Style.DOCUMENT, parameterStyle = SOAPBinding.ParameterStyle.BARE)
+ at BindingType(value="http://schemas.xmlsoap.org/wsdl/soap/http?mtom=true") (1)
+public interface MTOMEndpoint {
+
+[...]
+}
+]]> </programlisting>
<orderedlist>
<listitem>
<para>The MTOM enabled SOAP 1.1 binding ID</para>
@@ -867,15 +866,15 @@
<emphasis role="bold">MTOM enabled clients</emphasis>
</para>
<para>Web service clients can use the same approach described above or rely on the <literal>Binding</literal> API to enable MTOM (Excerpt taken from the <literal>org.jboss.test.ws.jaxws.samples.xop.doclit.XOPTestCase</literal>):</para>
- <programlisting> <![CDATA[
- [...]
- Service service = Service.create(wsdlURL, serviceName);
- port = service.getPort(MTOMEndpoint.class);
-
- // enable MTOM
- binding = (SOAPBinding)((BindingProvider)port).getBinding();
- binding.setMTOMEnabled(true);
- ]]> </programlisting>
+<programlisting> <![CDATA[
+[...]
+Service service = Service.create(wsdlURL, serviceName);
+port = service.getPort(MTOMEndpoint.class);
+
+// enable MTOM
+binding = (SOAPBinding)((BindingProvider)port).getBinding();
+binding.setMTOMEnabled(true);
+]]> </programlisting>
<para>
<note><title>Note</title>
@@ -891,71 +890,71 @@
<section>
<title>Using SwaRef with JAX-WS endpoints</title>
<para>JAX-WS endpoints delegate all marshalling/unmarshalling to the JAXB API. The most simple way to enable SwaRef encoding for <literal>DataHandler</literal> types is to annotate a payload bean with the <literal>@XmlAttachmentRef</literal> annotation as shown below:</para>
- <programlisting> <![CDATA[
- /**
- * Payload bean that will use SwaRef encoding
- */
- @XmlRootElement
- public class DocumentPayload
- {
- private DataHandler data;
-
- public DocumentPayload()
- {
- }
-
- public DocumentPayload(DataHandler data)
- {
- this.data = data;
- }
-
- @XmlElement
- @XmlAttachmentRef
- public DataHandler getData()
- {
- return data;
- }
-
- public void setData(DataHandler data)
- {
- this.data = data;
- }
- }
- ]]> </programlisting>
+<programlisting> <![CDATA[
+/**
+* Payload bean that will use SwaRef encoding
+*/
+ at XmlRootElement
+public class DocumentPayload
+{
+private DataHandler data;
+
+public DocumentPayload()
+{
+}
+
+public DocumentPayload(DataHandler data)
+{
+this.data = data;
+}
+
+ at XmlElement
+ at XmlAttachmentRef
+public DataHandler getData()
+{
+return data;
+}
+
+public void setData(DataHandler data)
+{
+this.data = data;
+}
+}
+]]> </programlisting>
<para>With document wrapped endpoints you may even specify the <literal>@XmlAttachmentRef</literal> annotation on the service endpoint interface:</para>
- <programlisting> <![CDATA[
- @WebService
- public interface DocWrappedEndpoint
- {
- @WebMethod
- DocumentPayload beanAnnotation(DocumentPayload dhw, String test);
-
- @WebMethod
- @XmlAttachmentRef
- DataHandler parameterAnnotation(@XmlAttachmentRef DataHandler data, String test);
-
- }
- ]]> </programlisting>
+<programlisting> <![CDATA[
+ at WebService
+public interface DocWrappedEndpoint
+{
+ at WebMethod
+DocumentPayload beanAnnotation(DocumentPayload dhw, String test);
+
+ at WebMethod
+ at XmlAttachmentRef
+DataHandler parameterAnnotation(@XmlAttachmentRef DataHandler data, String test);
+
+}
+]]> </programlisting>
<para>The message would then refer to the attachment part by CID:</para>
- <programlisting> <![CDATA[
- <env:Envelope xmlns:env='http://schemas.xmlsoap.org/soap/envelope/'>
- <env:Header/>
- <env:Body>
- <ns2:parameterAnnotation xmlns:ns2='http://swaref.samples.jaxws.ws.test.jboss.org/'>
- <arg0>cid:0-1180017772935-32455963 at ws.jboss.org</arg0>
- <arg1>Wrapped test</arg1>
- </ns2:parameterAnnotation>
- </env:Body>
- </env:Envelope>
- ]]> </programlisting>
+<programlisting> <![CDATA[
+<env:Envelope xmlns:env='http://schemas.xmlsoap.org/soap/envelope/'>
+<env:Header/>
+<env:Body>
+<ns2:parameterAnnotation xmlns:ns2='http://swaref.samples.jaxws.ws.test.jboss.org/'>
+<arg0>cid:0-1180017772935-32455963 at ws.jboss.org</arg0>
+<arg1>Wrapped test</arg1>
+</ns2:parameterAnnotation>
+</env:Body>
+</env:Envelope>
+]]> </programlisting>
</section>
<section>
<title>Starting from WSDL</title>
<para>If you chose the contract first approach then you need to ensure that any element declaration that should use SwaRef encoding simply refers to wsi:swaRef schema type:</para>
- <programlisting> <![CDATA[
- <element name="data" type="wsi:swaRef"
- xmlns:wsi="http://ws-i.org/profiles/basic/1.1/xsd"/>
- ]]> </programlisting>
+<programlisting> <![CDATA[
+<element name="data" type="wsi:swaRef"
+xmlns:wsi="http://ws-i.org/profiles/basic/1.1/xsd"/>
+]]> </programlisting>
<para>Any wsi:swaRef schema type would then be mapped to DataHandler.</para>
</section>
</section>
@@ -1039,46 +1038,46 @@
<title>Bottom-Up (Using wsprovide)</title>
<para>The bottom-up strategy involves developing the Java code for your service, and then annotating it using JAX-WS annotations. These annotations can be used to customize the contract that is generated for your service. For example, you can change the operation name to map to anything you like. However, all of the annotations have sensible defaults, so only the @WebService annotation is required.</para>
<para>This can be as simple as creating a single class:</para>
- <programlisting> <![CDATA[
- package echo;
-
- @javax.jws.WebService
- public class Echo
- {
- public String echo(String input)
- {
- return input;
- }
- }
- ]]> </programlisting>
+<programlisting> <![CDATA[
+package echo;
+
+ at javax.jws.WebService
+public class Echo
+{
+public String echo(String input)
+{
+return input;
+}
+}
+]]> </programlisting>
<para>A JSE or EJB3 deployment can be built using this class, and it is the only Java code needed to deploy on JBossWS. The WSDL, and all other Java artifacts called "wrapper classes" will be generated for you at deploy time. This actually goes beyond the JAX-WS specification, which requires that wrapper classes be generated using an offline tool. The reason for this requirement is purely a vender implementation problem, and since we do not believe in burdening a developer with a bunch of additional steps, we generate these as well. However, if you want your deployment to be portable to other application servers, you will unfortunately need to use a tool and add the generated classes to your deployment.</para>
<para>This is the primary purpose of the <ulink url="http://jbws.dyndns.org/mediawiki/index.php?title=Wsprovide">wsprovide</ulink> tool, to generate portable JAX-WS artifacts. Additionally, it can be used to "provide" the abstract contract (WSDL file) for your service. This can be obtained by invoking <ulink url="http://jbws.dyndns.org/mediawiki/index.php?title=Wsprovide">wsprovide</ulink> using the "-w" option:</para>
- <programlisting> <![CDATA[
- $ javac -d . -classpath jboss-jaxws.jar Echo.java
- $ wsprovide -w echo.Echo
- Generating WSDL:
- EchoService.wsdl
- Writing Classes:
- echo/jaxws/Echo.class
- echo/jaxws/EchoResponse.class
- ]]> </programlisting>
+<programlisting> <![CDATA[
+$ javac -d . -classpath jboss-jaxws.jar Echo.java
+$ wsprovide -w echo.Echo
+Generating WSDL:
+EchoService.wsdl
+Writing Classes:
+echo/jaxws/Echo.class
+echo/jaxws/EchoResponse.class
+]]> </programlisting>
<para>Inspecting the WSDL reveals a service called EchoService:</para>
- <programlisting> <![CDATA[
- <service name='EchoService'>
- <port binding='tns:EchoBinding' name='EchoPort'>
- <soap:address location='REPLACE_WITH_ACTUAL_URL'/>
- </port>
- </service>
- ]]> </programlisting>
+<programlisting> <![CDATA[
+<service name='EchoService'>
+<port binding='tns:EchoBinding' name='EchoPort'>
+<soap:address location='REPLACE_WITH_ACTUAL_URL'/>
+</port>
+</service>
+]]> </programlisting>
<para>As expected, this service defines one operation, "echo":</para>
- <programlisting> <![CDATA[
- <portType name='Echo'>
- <operation name='echo' parameterOrder='echo'>
- <input message='tns:Echo_echo'/>
- <output message='tns:Echo_echoResponse'/>
- </operation>
- </portType>
- ]]> </programlisting>
+<programlisting> <![CDATA[
+<portType name='Echo'>
+<operation name='echo' parameterOrder='echo'>
+<input message='tns:Echo_echo'/>
+<output message='tns:Echo_echoResponse'/>
+</operation>
+</portType>
+]]> </programlisting>
<para>
<note><title>Note</title>
<para>Remember that <emphasis role="bold">when deploying on JBossWS you do not need to run this tool.</emphasis> You only need it for generating portable artifacts and/or the abstract contract for your service.</para>
@@ -1086,40 +1085,40 @@
</para>
<para>Let's create a POJO endpoint for deployment on JBoss AS. A simple web.xml needs to be created:</para>
- <programlisting> <![CDATA[
- <web-app xmlns="http://java.sun.com/xml/ns/j2ee"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd"
- version="2.4">
-
- <servlet>
- <servlet-name>Echo</servlet-name>
- <servlet-class>echo.Echo</servlet-class>
- </servlet>
-
- <servlet-mapping>
- <servlet-name>Echo</servlet-name>
- <url-pattern>/Echo</url-pattern>
- </servlet-mapping>
- </web-app>
- ]]> </programlisting>
+<programlisting> <![CDATA[
+<web-app xmlns="http://java.sun.com/xml/ns/j2ee"
+xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd"
+version="2.4">
+
+<servlet>
+<servlet-name>Echo</servlet-name>
+<servlet-class>echo.Echo</servlet-class>
+</servlet>
+
+<servlet-mapping>
+<servlet-name>Echo</servlet-name>
+<url-pattern>/Echo</url-pattern>
+</servlet-mapping>
+</web-app>
+]]> </programlisting>
<para>The web.xml and the single class can now be used to create a war:</para>
- <programlisting> <![CDATA[
- $ mkdir -p WEB-INF/classes
- $ cp -rp echo WEB-INF/classes/
- $ cp web.xml WEB-INF
- $ jar cvf echo.war WEB-INF
- added manifest
- adding: WEB-INF/(in = 0) (out= 0)(stored 0%)
- adding: WEB-INF/classes/(in = 0) (out= 0)(stored 0%)
- adding: WEB-INF/classes/echo/(in = 0) (out= 0)(stored 0%)
- adding: WEB-INF/classes/echo/Echo.class(in = 340) (out= 247)(deflated 27%)
- adding: WEB-INF/web.xml(in = 576) (out= 271)(deflated 52%)
- ]]> </programlisting>
+<programlisting> <![CDATA[
+$ mkdir -p WEB-INF/classes
+$ cp -rp echo WEB-INF/classes/
+$ cp web.xml WEB-INF
+$ jar cvf echo.war WEB-INF
+added manifest
+adding: WEB-INF/(in = 0) (out= 0)(stored 0%)
+adding: WEB-INF/classes/(in = 0) (out= 0)(stored 0%)
+adding: WEB-INF/classes/echo/(in = 0) (out= 0)(stored 0%)
+adding: WEB-INF/classes/echo/Echo.class(in = 340) (out= 247)(deflated 27%)
+adding: WEB-INF/web.xml(in = 576) (out= 271)(deflated 52%)
+]]> </programlisting>
<para>The war can then be deployed:</para>
- <programlisting> <![CDATA[
- cp echo.war /usr/local/jboss-4.2.0.GA-ejb3/server/default/deploy
- ]]> </programlisting>
+<programlisting> <![CDATA[
+ cp echo.war /usr/local/jboss-4.2.0.GA-ejb3/server/default/deploy
+]]> </programlisting>
<para>This will internally invoke <ulink url="http://jbws.dyndns.org/mediawiki/index.php?title=Wsprovide">wsprovide</ulink>, which will generate the WSDL. If deployment was successful, and you are using the default settings, it should be available here: <ulink url="http://localhost:8080/echo/Echo?wsdl">http://localhost:8080/echo/Echo?wsdl</ulink></para>
<para>For a portable JAX-WS deployment, the wrapper classes generated earlier could be added to the deployment.</para>
</section>
@@ -1127,26 +1126,27 @@
<title>Top-Down (Using wsconsume)</title>
<para>The top-down development strategy begins with the abstract contract for the service, which includes the WSDL file and zero or more schema files. The <ulink url="http://jbws.dyndns.org/mediawiki/index.php?title=Wsconsume">wsconsume</ulink> tool is then used to consume this contract, and produce annotated Java classes (and optionally sources) that define it.</para>
<para>
- <emphasis role="bold">Note</emphasis>
- </para>
- <para>wsconsume seems to have a problem with symlinks on unix systems</para>
+ <note><title>Note</title>
+ <para>wsconsume seems to have a problem with symlinks on unix systems</para>
+ </note>
+ </para>
<para>Using the WSDL file from the bottom-up example, a new Java implementation that adheres to this service can be generated. The "-k" option is passed to <ulink url="http://jbws.dyndns.org/mediawiki/index.php?title=Wsconsume">wsconsume</ulink> to preserve the Java source files that are generated, instead of providing just classes:</para>
- <programlisting> <![CDATA[
-
- $ wsconsume -k EchoService.wsdl
- echo/Echo.java
- echo/EchoResponse.java
- echo/EchoService.java
- echo/Echo_Type.java
- echo/ObjectFactory.java
- echo/package-info.java
- echo/Echo.java
- echo/EchoResponse.java
- echo/EchoService.java
- echo/Echo_Type.java
- echo/ObjectFactory.java
- echo/package-info.java
- ]]> </programlisting>
+<programlisting> <![CDATA[
+
+$ wsconsume -k EchoService.wsdl
+echo/Echo.java
+echo/EchoResponse.java
+echo/EchoService.java
+echo/Echo_Type.java
+echo/ObjectFactory.java
+echo/package-info.java
+echo/Echo.java
+echo/EchoResponse.java
+echo/EchoService.java
+echo/Echo_Type.java
+echo/ObjectFactory.java
+echo/package-info.java
+]]> </programlisting>
<para>The following table shows the purpose of each generated file:</para>
<informaltable frame="all">
<tgroup cols="2">
@@ -1217,32 +1217,32 @@
</tgroup>
</informaltable>
<para>Examining the Service Endpoint Interface reveals annotations that are more explicit than in the class written by hand in the bottom-up example, however, these evaluate to the same contract:</para>
- <programlisting> <![CDATA[
- @WebService(name = "Echo", targetNamespace = "http://echo/")
- public interface Echo {
- @WebMethod
- @WebResult(targetNamespace = "")
- @RequestWrapper(localName = "echo", targetNamespace = "http://echo/", className = "echo.Echo_Type")
- @ResponseWrapper(localName = "echoResponse", targetNamespace = "http://echo/", className = "echo.EchoResponse")
- public String echo(
- @WebParam(name = "arg0", targetNamespace = "")
- String arg0);
-
- }
- ]]> </programlisting>
+<programlisting> <![CDATA[
+ at WebService(name = "Echo", targetNamespace = "http://echo/")
+public interface Echo {
+ at WebMethod
+ at WebResult(targetNamespace = "")
+ at RequestWrapper(localName = "echo", targetNamespace = "http://echo/", className = "echo.Echo_Type")
+ at ResponseWrapper(localName = "echoResponse", targetNamespace = "http://echo/", className = "echo.EchoResponse")
+public String echo(
+ at WebParam(name = "arg0", targetNamespace = "")
+String arg0);
+
+}
+]]> </programlisting>
<para>The only missing piece (besides the packaging) is the implementation class, which can now be written, using the above interface.</para>
- <programlisting> <![CDATA[
- package echo;
-
- @javax.jws.WebService(endpointInterface="echo.Echo")
- public class EchoImpl implements Echo
- {
- public String echo(String arg0)
- {
- return arg0;
- }
- }
- ]]> </programlisting>
+<programlisting> <![CDATA[
+package echo;
+
+ at javax.jws.WebService(endpointInterface="echo.Echo")
+public class EchoImpl implements Echo
+{
+public String echo(String arg0)
+{
+return arg0;
+}
+}
+]]> </programlisting>
</section>
<section>
<title>Client Side</title>
@@ -1255,68 +1255,68 @@
, even if the client is running on the same server.</para>
<para>Let's repeat the process of the top-down section, although using the deployed WSDL, instead of the one generated offline by <ulink url="http://jbws.dyndns.org/mediawiki/index.php?title=Wsprovide">wsprovide</ulink>. The reason why we do this is just to get the right value for soap:address. This value must be computed at deploy time, since it is based on container configuration specifics. You could of course edit the WSDL file yourself, although you need to ensure that the path is correct.</para>
<para>Offline version:</para>
- <programlisting> <![CDATA[
- <service name='EchoService'>
- <port binding='tns:EchoBinding' name='EchoPort'>
- <soap:address location='REPLACE_WITH_ACTUAL_URL'/>
- </port>
- </service>
- ]]> </programlisting>
+<programlisting> <![CDATA[
+<service name='EchoService'>
+<port binding='tns:EchoBinding' name='EchoPort'>
+<soap:address location='REPLACE_WITH_ACTUAL_URL'/>
+</port>
+</service>
+]]> </programlisting>
<para>Online version:</para>
- <programlisting> <![CDATA[
- <service name="EchoService">
- <port binding="tns:EchoBinding" name="EchoPort">
- <soap:address location="http://localhost.localdomain:8080/echo/Echo"/>
- </port>
- </service>
- ]]> </programlisting>
+<programlisting> <![CDATA[
+<service name="EchoService">
+<port binding="tns:EchoBinding" name="EchoPort">
+<soap:address location="http://localhost.localdomain:8080/echo/Echo"/>
+</port>
+</service>
+]]> </programlisting>
<para>Using the online deployed version with <ulink url="http://jbws.dyndns.org/mediawiki/index.php?title=Wsconsume">wsconsume</ulink>:</para>
- <programlisting> <![CDATA[
- $ wsconsume -k http://localhost:8080/echo/Echo?wsdl
- echo/Echo.java
- echo/EchoResponse.java
- echo/EchoService.java
- echo/Echo_Type.java
- echo/ObjectFactory.java
- echo/package-info.java
- echo/Echo.java
- echo/EchoResponse.java
- echo/EchoService.java
- echo/Echo_Type.java
- echo/ObjectFactory.java
- echo/package-info.java
- ]]> </programlisting>
+<programlisting> <![CDATA[
+$ wsconsume -k http://localhost:8080/echo/Echo?wsdl
+echo/Echo.java
+echo/EchoResponse.java
+echo/EchoService.java
+echo/Echo_Type.java
+echo/ObjectFactory.java
+echo/package-info.java
+echo/Echo.java
+echo/EchoResponse.java
+echo/EchoService.java
+echo/Echo_Type.java
+echo/ObjectFactory.java
+echo/package-info.java
+]]> </programlisting>
<para> The one class that was not examined in the top-down section, was EchoService.java. Notice how it stores the location the WSDL was obtained from.</para>
- <programlisting> <![CDATA[
- @WebServiceClient(name = "EchoService", targetNamespace = "http://echo/", wsdlLocation = "http://localhost:8080/echo/Echo?wsdl")
- public class EchoService extends Service
- {
- private final static URL ECHOSERVICE_WSDL_LOCATION;
-
- static {
- URL url = null;
- try {
- url = new URL("http://localhost:8080/echo/Echo?wsdl");
- } catch (MalformedURLException e) {
- e.printStackTrace();
- }
- ECHOSERVICE_WSDL_LOCATION = url;
- }
-
- public EchoService(URL wsdlLocation, QName serviceName) {
- super(wsdlLocation, serviceName);
- }
-
- public EchoService() {
- super(ECHOSERVICE_WSDL_LOCATION, new QName("http://echo/", "EchoService"));
- }
-
- @WebEndpoint(name = "EchoPort")
- public Echo getEchoPort() {
- return (Echo)super.getPort(new QName("http://echo/", "EchoPort"), Echo.class);
- }
- }
- ]]> </programlisting>
+<programlisting> <![CDATA[
+ at WebServiceClient(name = "EchoService", targetNamespace = "http://echo/", wsdlLocation = "http://localhost:8080/echo/Echo?wsdl")
+public class EchoService extends Service
+{
+private final static URL ECHOSERVICE_WSDL_LOCATION;
+
+static {
+URL url = null;
+try {
+url = new URL("http://localhost:8080/echo/Echo?wsdl");
+} catch (MalformedURLException e) {
+e.printStackTrace();
+}
+ECHOSERVICE_WSDL_LOCATION = url;
+}
+
+public EchoService(URL wsdlLocation, QName serviceName) {
+super(wsdlLocation, serviceName);
+}
+
+public EchoService() {
+super(ECHOSERVICE_WSDL_LOCATION, new QName("http://echo/", "EchoService"));
+}
+
+ at WebEndpoint(name = "EchoPort")
+public Echo getEchoPort() {
+return (Echo)super.getPort(new QName("http://echo/", "EchoPort"), Echo.class);
+}
+}
+]]> </programlisting>
<para>As you can see, this generated class extends the main client entry point in JAX-WS, javax.xml.ws.Service. While you can use Service directly, this is far simpler since it provides the configuration info for you. The only method we really care about is the getEchoPort() method, which returns an instance of our Service Endpoint Interface. Any WS operation can then be called by just invoking a method on the returned interface.</para>
<para>
@@ -1326,44 +1326,44 @@
</para>
<para>All that is left to do, is write and compile the client:</para>
- <programlisting> <![CDATA[
- import echo.*;
-
- public class EchoClient
- {
- public static void main(String args[])
- {
- if (args.length != 1)
- {
- System.err.println("usage: EchoClient <message>");
- System.exit(1);
- }
-
- EchoService service = new EchoService();
- Echo echo = service.getEchoPort();
- System.out.println("Server said: " + echo.echo(args[0]));
- }
- }
- ]]> </programlisting>
+<programlisting> <![CDATA[
+import echo.*;
+..
+public class EchoClient
+{
+public static void main(String args[])
+{
+if (args.length != 1)
+{
+System.err.println("usage: EchoClient <message>");
+System.exit(1);
+}
+
+EchoService service = new EchoService();
+Echo echo = service.getEchoPort();
+System.out.println("Server said: " + echo.echo(args[0]));
+}
+}
+]]> </programlisting>
<para>It can then be easily executed using the <ulink url="http://jbws.dyndns.org/mediawiki/index.php?title=Wsrunclient">wsrunclient</ulink> tool. This is just a convenience tool that invokes java with the needed classpath:</para>
- <programlisting> <![CDATA[
- $ wsrunclient EchoClient 'Hello World!'
- Server said: Hello World!
- ]]> </programlisting>
+<programlisting> <![CDATA[
+$ wsrunclient EchoClient 'Hello World!'
+Server said: Hello World!
+]]> </programlisting>
<para>It is easy to change the endpoint address of your operation at runtime, setting the ENDPOINT_ADDRESS_PROPERTY as shown below:</para>
- <programlisting> <![CDATA[
- ...
- EchoService service = new EchoService();
- Echo echo = service.getEchoPort();
-
- /* Set NEW Endpoint Location */
- String endpointURL = "http://NEW_ENDPOINT_URL";
- BindingProvider bp = (BindingProvider)echo;
- bp.getRequestContext().put(BindingProvider.ENDPOINT_ADDRESS_PROPERTY, endpointURL);
-
- System.out.println("Server said: " + echo.echo(args[0]));
- ...
- ]]> </programlisting>
+<programlisting> <![CDATA[
+...
+EchoService service = new EchoService();
+Echo echo = service.getEchoPort();
+
+/* Set NEW Endpoint Location */
+String endpointURL = "http://NEW_ENDPOINT_URL";
+BindingProvider bp = (BindingProvider)echo;
+bp.getRequestContext().put(BindingProvider.ENDPOINT_ADDRESS_PROPERTY, endpointURL);
+
+System.out.println("Server said: " + echo.echo(args[0]));
+...
+]]> </programlisting>
</section>
<section>
<title>Command-line & Ant Task Reference</title>
@@ -1429,143 +1429,144 @@
<section>
<title>Addressing Endpoint</title>
<para>The following endpoint implementation has a set of operation for a typical stateful shopping chart application.</para>
- <programlisting> <![CDATA[
- @WebService(name = "StatefulEndpoint", targetNamespace = "http://org.jboss.ws/samples/wsaddressing", serviceName = "TestService")
- @EndpointConfig(configName = "Standard WSAddressing Endpoint")
- @HandlerChain(file = "WEB-INF/jaxws-handlers.xml")
- @SOAPBinding(style = SOAPBinding.Style.RPC)
- public class StatefulEndpointImpl implements StatefulEndpoint, ServiceLifecycle
- {
- @WebMethod
- public void addItem(String item)
- { ... }
-
- @WebMethod
- public void checkout()
- { ... }
-
- @WebMethod
- public String getItems()
- { ... }
- }
- ]]> </programlisting>
+<programlisting> <![CDATA[
+ at WebService(name = "StatefulEndpoint", targetNamespace = "http://org.jboss.ws/samples/wsaddressing", serviceName = "TestService")
+ at EndpointConfig(configName = "Standard WSAddressing Endpoint")
+ at HandlerChain(file = "WEB-INF/jaxws-handlers.xml")
+ at SOAPBinding(style = SOAPBinding.Style.RPC)
+public class StatefulEndpointImpl implements StatefulEndpoint, ServiceLifecycle
+{
+ at WebMethod
+public void addItem(String item)
+{ ... }
+
+ at WebMethod
+public void checkout()
+{ ... }
+
+ at WebMethod
+public String getItems()
+{ ... }
+}
+]]> </programlisting>
<para>It uses the <ulink url="http://jbws.dyndns.org/mediawiki/index.php?title=JAX-WS_Endpoint_Configuration#_Standard_WSAddressing_Endpoint">JAX-WS Endpoint Configuration# Standard WSAddressing Endpoint</ulink> to enable the server side addressing handler. It processes the incomming WS-Addressing header elements and provides access to them through the JSR-261 API.</para>
<para>The endpoint handler chain</para>
- <programlisting> <![CDATA[
- <handler-chains xmlns="http://java.sun.com/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://java.sun.com/xml/ns/javaee javaee_web_services_1_2.xsd">
-
- <handler-chain>
- <protocol-bindings>##SOAP11_HTTP</protocol-bindings>
- <handler>
- <handler-name>Application Server Handler</handler-name>
- <handler-class>org.jboss.test.ws.jaxws.samples.wsaddressing.ServerHandler</handler-class>
- </handler>
- </handler-chain>
-
- </handler-chains>
- ]]> </programlisting>
+<programlisting> <![CDATA[
+<handler-chains xmlns="http://java.sun.com/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+xsi:schemaLocation="http://java.sun.com/xml/ns/javaee javaee_web_services_1_2.xsd">
+
+<handler-chain>
+<protocol-bindings>##SOAP11_HTTP</protocol-bindings>
+<handler>
+<handler-name>Application Server Handler</handler-name>
+<handler-class>org.jboss.test.ws.jaxws.samples.wsaddressing.ServerHandler</handler-class>
+</handler>
+</handler-chain>
+
+</handler-chains>
+]]> </programlisting>
<para>defines an application specific hander that assignes/processes stateful client ids.</para>
</section>
<section>
<title>Addressing Client</title>
<para>On the client side there are simmilar handlers that does the reverse. It uses the JSR-261 API to add WS-Addressing header elements including the clientid association.</para>
<para> The client sets a custom handler chain in the binding</para>
- <programlisting> <![CDATA[
- Service service = Service.create(wsdlURL, serviceName);
- port1 = (StatefulEndpoint)service.getPort(StatefulEndpoint.class);
- BindingProvider bindingProvider = (BindingProvider)port1;
-
- List<Handler> customHandlerChain = new ArrayList<Handler>();
- customHandlerChain.add(new ClientHandler());
- customHandlerChain.add(new WSAddressingClientHandler());
- bindingProvider.getBinding().setHandlerChain(customHandlerChain);
- ]]> </programlisting>
- <para>The WSAddressingClientHandler is provided by JBossWS and reads/writes the addressing properties and puts then into the message context.</para>
+<programlisting> <![CDATA[
+Service service = Service.create(wsdlURL, serviceName);
+port1 = (StatefulEndpoint)service.getPort(StatefulEndpoint.class);
+BindingProvider bindingProvider = (BindingProvider)port1;
+
+List<Handler> customHandlerChain = new ArrayList<Handler>();
+customHandlerChain.add(new ClientHandler());
+customHandlerChain.add(new WSAddressingClientHandler());
+bindingProvider.getBinding().setHandlerChain(customHandlerChain);
+]]> </programlisting>
+
+<para>The WSAddressingClientHandler is provided by JBossWS and reads/writes the addressing properties and puts then into the message context.</para>
<para>
<emphasis role="bold">A client connecting to the stateful endpoint</emphasis>
</para>
- <programlisting> <![CDATA[
- public class AddressingStatefulTestCase extends JBossWSTest
- {
- public void testAddItem() throws Exception
- {
- port1.addItem("Ice Cream");
- port1.addItem("Ferrari");
-
- port2.addItem("Mars Bar");
- port2.addItem("Porsche");
- }
-
- public void testGetItems() throws Exception
- {
- String items1 = port1.getItems();
- assertEquals("[Ice Cream, Ferrari]", items1);
-
- String items2 = port2.getItems();
- assertEquals("[Mars Bar, Porsche]", items2);
- }
- }
- ]]> </programlisting>
+<programlisting> <![CDATA[
+public class AddressingStatefulTestCase extends JBossWSTest
+{
+public void testAddItem() throws Exception
+{
+port1.addItem("Ice Cream");
+port1.addItem("Ferrari");
+
+port2.addItem("Mars Bar");
+port2.addItem("Porsche");
+}
+
+public void testGetItems() throws Exception
+{
+String items1 = port1.getItems();
+assertEquals("[Ice Cream, Ferrari]", items1);
+
+String items2 = port2.getItems();
+assertEquals("[Mars Bar, Porsche]", items2);
+}
+}
+]]> </programlisting>
<para>
<emphasis role="bold">SOAP message exchange</emphasis>
</para>
<para>Below you see the SOAP messages that are beeing exchanged.</para>
- <programlisting> <![CDATA[
- <env:Envelope xmlns:env='http://schemas.xmlsoap.org/soap/envelope/'>
- <env:Header xmlns:wsa='http://schemas.xmlsoap.org/ws/2004/08/addressing'>
- <wsa:To>uri:jbossws-samples-wsaddr/TestService</wsa:To>
- <wsa:Action>http://org.jboss.ws/addressing/stateful/action</wsa:Action>
- <wsa:ReferenceParameters>
- <ns1:clientid xmlns:ns1='http://somens'>clientid-1</ns1:clientid>
- </wsa:ReferenceParameters>
- </env:Header>
- <env:Body>
- <ns1:addItem xmlns:ns1='http://org.jboss.ws/samples/wsaddr'>
- <String_1>Ice Cream</String_1>
- </ns1:addItem>
- </env:Body>
- </env:Envelope>
-
- <env:Envelope xmlns:env='http://schemas.xmlsoap.org/soap/envelope/'>
- <env:Header xmlns:wsa='http://schemas.xmlsoap.org/ws/2004/08/addressing'>
- <wsa:To>http://www.w3.org/2005/08/addressing/anonymous</wsa:To>
- <wsa:Action>http://org.jboss.ws/addressing/stateful/actionReply</wsa:Action>
- <ns1:clientid xmlns:ns1='http://somens'>clientid-1</ns1:clientid>
- </env:Header>
- <env:Body>
- <ns1:addItemResponse xmlns:ns1='http://org.jboss.ws/samples/wsaddr'/>
- </env:Body>
- </env:Envelope>
-
- ...
-
- <env:Envelope xmlns:env='http://schemas.xmlsoap.org/soap/envelope/'>
- <env:Header xmlns:wsa='http://schemas.xmlsoap.org/ws/2004/08/addressing'>
- <wsa:To>uri:jbossws-samples-wsaddr/TestService</wsa:To>
- <wsa:Action>http://org.jboss.ws/addressing/stateful/action</wsa:Action>
- <wsa:ReferenceParameters>
- <ns1:clientid xmlns:ns1='http://somens'>clientid-1</ns1:clientid>
- </wsa:ReferenceParameters>
- </env:Header>
- <env:Body>
- <ns1:getItems xmlns:ns1='http://org.jboss.ws/samples/wsaddr'/>
- </env:Body>
- </env:Envelope>
-
- <env:Envelope xmlns:env='http://schemas.xmlsoap.org/soap/envelope/'>
- <env:Header xmlns:wsa='http://schemas.xmlsoap.org/ws/2004/08/addressing'>
- <wsa:To>http://www.w3.org/2005/08/addressing/anonymous</wsa:To>
- <wsa:Action>http://org.jboss.ws/addressing/stateful/actionReply</wsa:Action>
- <ns1:clientid xmlns:ns1='http://somens'>clientid-1</ns1:clientid>
- </env:Header>
- <env:Body>
- <ns1:getItemsResponse xmlns:ns1='http://org.jboss.ws/samples/wsaddr'>
- <result>[Ice Cream, Ferrari]</result>
- </ns1:getItemsResponse>
- </env:Body>
- </env:Envelope>
- ]]> </programlisting>
+<programlisting> <![CDATA[
+<env:Envelope xmlns:env='http://schemas.xmlsoap.org/soap/envelope/'>
+<env:Header xmlns:wsa='http://schemas.xmlsoap.org/ws/2004/08/addressing'>
+<wsa:To>uri:jbossws-samples-wsaddr/TestService</wsa:To>
+<wsa:Action>http://org.jboss.ws/addressing/stateful/action</wsa:Action>
+<wsa:ReferenceParameters>
+<ns1:clientid xmlns:ns1='http://somens'>clientid-1</ns1:clientid>
+</wsa:ReferenceParameters>
+</env:Header>
+<env:Body>
+<ns1:addItem xmlns:ns1='http://org.jboss.ws/samples/wsaddr'>
+<String_1>Ice Cream</String_1>
+</ns1:addItem>
+</env:Body>
+</env:Envelope>
+
+<env:Envelope xmlns:env='http://schemas.xmlsoap.org/soap/envelope/'>
+<env:Header xmlns:wsa='http://schemas.xmlsoap.org/ws/2004/08/addressing'>
+<wsa:To>http://www.w3.org/2005/08/addressing/anonymous</wsa:To>
+<wsa:Action>http://org.jboss.ws/addressing/stateful/actionReply</wsa:Action>
+<ns1:clientid xmlns:ns1='http://somens'>clientid-1</ns1:clientid>
+</env:Header>
+<env:Body>
+<ns1:addItemResponse xmlns:ns1='http://org.jboss.ws/samples/wsaddr'/>
+</env:Body>
+</env:Envelope>
+
+...
+
+<env:Envelope xmlns:env='http://schemas.xmlsoap.org/soap/envelope/'>
+<env:Header xmlns:wsa='http://schemas.xmlsoap.org/ws/2004/08/addressing'>
+<wsa:To>uri:jbossws-samples-wsaddr/TestService</wsa:To>
+<wsa:Action>http://org.jboss.ws/addressing/stateful/action</wsa:Action>
+<wsa:ReferenceParameters>
+<ns1:clientid xmlns:ns1='http://somens'>clientid-1</ns1:clientid>
+</wsa:ReferenceParameters>
+</env:Header>
+<env:Body>
+<ns1:getItems xmlns:ns1='http://org.jboss.ws/samples/wsaddr'/>
+</env:Body>
+</env:Envelope>
+
+<env:Envelope xmlns:env='http://schemas.xmlsoap.org/soap/envelope/'>
+<env:Header xmlns:wsa='http://schemas.xmlsoap.org/ws/2004/08/addressing'>
+<wsa:To>http://www.w3.org/2005/08/addressing/anonymous</wsa:To>
+<wsa:Action>http://org.jboss.ws/addressing/stateful/actionReply</wsa:Action>
+<ns1:clientid xmlns:ns1='http://somens'>clientid-1</ns1:clientid>
+</env:Header>
+<env:Body>
+<ns1:getItemsResponse xmlns:ns1='http://org.jboss.ws/samples/wsaddr'>
+<result>[Ice Cream, Ferrari]</result>
+</ns1:getItemsResponse>
+</env:Body>
+</env:Envelope>
+]]> </programlisting>
</section>
</section>
<section>
@@ -1638,37 +1639,37 @@
<section>
<title>Setup an event source endpoint</title>
<para>With JAX-WS the event source setup has actually become quiet easy. All you need to do is to subclass your endpoint implementation from <literal>AbstractEventSourceEndpoint</literal> and a subscription manager from <literal>AbstractSubscriptionManagerEndpoint</literal> and finally point that implementation to a <ulink url="http://jbws.dyndns.org/mediawiki/index.php?title=JAX-WS_User_Guide#The_WSDL_that_describes_an_event_source">event source specific WSDL</ulink>.</para>
- <programlisting> <![CDATA[
- package org.jboss.test.ws.jaxws.samples.wseventing;
-
- import javax.jws.WebService;
-
- import org.jboss.logging.Logger;
- import org.jboss.ws.annotation.EndpointConfig;
- import org.jboss.ws.extensions.eventing.jaxws.AbstractEventSourceEndpoint;
-
- /**
- * @author Heiko.Braun at jboss.org
- * @version $Id$
- * @since 18.01.2007
- */
- @WebService( (1)
- name = "EventSource",
- portName = "EventSourcePort",
- targetNamespace = "http://schemas.xmlsoap.org/ws/2004/08/eventing",
- wsdlLocation = "/WEB-INF/wsdl/sysmon.wsdl", (2)
- endpointInterface = "org.jboss.ws.extensions.eventing.jaxws.EventSourceEndpoint")
- @EndpointConfig(configName = "Standard WSAddressing Endpoint") (3)
- public class SysmonRegistrationEndpoint extends AbstractEventSourceEndpoint { (4)
-
- private static final Logger log = Logger.getLogger(SysmonRegistrationEndpoint.class);
-
- protected Logger getLogger()
- {
- return log;
- }
- }
- ]]> </programlisting>
+<programlisting> <![CDATA[
+package org.jboss.test.ws.jaxws.samples.wseventing;
+..
+import javax.jws.WebService;
+
+import org.jboss.logging.Logger;
+import org.jboss.ws.annotation.EndpointConfig;
+import org.jboss.ws.extensions.eventing.jaxws.AbstractEventSourceEndpoint;
+
+/**
+* @author Heiko.Braun at jboss.org
+* @version $Id$
+* @since 18.01.2007
+*/
+ at WebService( (1)
+name = "EventSource",
+portName = "EventSourcePort",
+targetNamespace = "http://schemas.xmlsoap.org/ws/2004/08/eventing",
+wsdlLocation = "/WEB-INF/wsdl/sysmon.wsdl", (2)
+endpointInterface = "org.jboss.ws.extensions.eventing.jaxws.EventSourceEndpoint")
+ at EndpointConfig(configName = "Standard WSAddressing Endpoint") (3)
+public class SysmonRegistrationEndpoint extends AbstractEventSourceEndpoint { (4)
+
+private static final Logger log = Logger.getLogger(SysmonRegistrationEndpoint.class);
+
+protected Logger getLogger()
+{
+return log;
+}
+}
+]]> </programlisting>
<orderedlist>
<listitem>
<para> Of course we need a <literal>@WebService</literal> annotation</para>
@@ -1688,70 +1689,70 @@
<title>The WSDL that describes an event source</title>
<para>Even though we are already using the annotation driven approach, JBossWS eventing still requires an event source specific WSDL.</para>
<para>The following excerpt shows the relevant WSDL details that describe an event source.</para>
- <programlisting> <![CDATA[
- <?xml version="1.0" encoding="UTF-8"?>
-
- <wsdl:definitions
- targetNamespace="http://www.jboss.org/sysmon"
- xmlns:tns="http://www.jboss.org/sysmon"
- xmlns:wse='http://schemas.xmlsoap.org/ws/2004/08/eventing'
- xmlns:wsdl='http://schemas.xmlsoap.org/wsdl/'
- xmlns:wsa10='http://www.w3.org/2005/08/addressing'
- xmlns:xs='http://www.w3.org/2001/XMLSchema'
- xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/">
-
- <wsdl:import
- (1) namespace='http://schemas.xmlsoap.org/ws/2004/08/eventing'
- location='jbwse.wsdl' />
-
- <wsdl:types>
-
- <xs:schema targetNamespace='http://schemas.xmlsoap.org/ws/2004/08/eventing'>
- (2) <xs:include schemaLocation='jbwse.xsd'/>
- </xs:schema>
-
- (3) <xs:schema
- targetNamespace="http://www.jboss.org/sysmon"
- elementFormDefault="qualified"
- blockDefault="#all">
- <xs:element name="SystemStatus">
- <xs:complexType>
- <xs:sequence>
- <xs:element name="Time " type="xs:dateTime"/>
- <xs:element name="HostName" type="xs:string"/>
- <xs:element name="HostAddress" type="xs:string"/>
- <xs:element name="ActiveThreadCount" type="xs:int"/>
- <xs:element name="FreeMemory" type="xs:string"/>
- <xs:element name="MaxMemory" type="xs:string"/>
- </xs:sequence>
- </xs:complexType>
- </xs:element>
- </xs:schema>
-
- </wsdl:types>
-
- <wsdl:message name='SystemInfoMsg'>
- <wsdl:part name='body' element='tns:SystemStatus'/>
- </wsdl:message>
-
- (4) <wsdl:portType name='SystemInfo' wse:EventSource='true'>
- <wsdl:operation name='SysmonOp'>
- <wsdl:output message='tns:SystemInfoMsg'/>
- </wsdl:operation>
- </wsdl:portType>
-
- <wsdl:binding name="SystemInfoBinding" type="tns:SystemInfo">
- <soap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http"/>
- <wsdl:operation name="SysmonOp">
- <soap:operation soapAction=""/>
- <wsdl:output>
- <soap:body use="literal"/>
- </wsdl:output>
- </wsdl:operation>
- </wsdl:binding>
-
- </wsdl:definitions>
- ]]> </programlisting>
+<programlisting> <![CDATA[
+<?xml version="1.0" encoding="UTF-8"?>
+
+<wsdl:definitions
+targetNamespace="http://www.jboss.org/sysmon"
+xmlns:tns="http://www.jboss.org/sysmon"
+xmlns:wse='http://schemas.xmlsoap.org/ws/2004/08/eventing'
+xmlns:wsdl='http://schemas.xmlsoap.org/wsdl/'
+xmlns:wsa10='http://www.w3.org/2005/08/addressing'
+xmlns:xs='http://www.w3.org/2001/XMLSchema'
+xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/">
+
+<wsdl:import
+(1) namespace='http://schemas.xmlsoap.org/ws/2004/08/eventing'
+location='jbwse.wsdl' />
+
+<wsdl:types>
+
+<xs:schema targetNamespace='http://schemas.xmlsoap.org/ws/2004/08/eventing'>
+(2) <xs:include schemaLocation='jbwse.xsd'/>
+</xs:schema>
+
+(3) <xs:schema
+targetNamespace="http://www.jboss.org/sysmon"
+elementFormDefault="qualified"
+blockDefault="#all">
+<xs:element name="SystemStatus">
+<xs:complexType>
+<xs:sequence>
+<xs:element name="Time " type="xs:dateTime"/>
+<xs:element name="HostName" type="xs:string"/>
+<xs:element name="HostAddress" type="xs:string"/>
+<xs:element name="ActiveThreadCount" type="xs:int"/>
+<xs:element name="FreeMemory" type="xs:string"/>
+<xs:element name="MaxMemory" type="xs:string"/>
+</xs:sequence>
+</xs:complexType>
+</xs:element>
+</xs:schema>
+
+</wsdl:types>
+
+<wsdl:message name='SystemInfoMsg'>
+<wsdl:part name='body' element='tns:SystemStatus'/>
+</wsdl:message>
+
+(4) <wsdl:portType name='SystemInfo' wse:EventSource='true'>
+<wsdl:operation name='SysmonOp'>
+<wsdl:output message='tns:SystemInfoMsg'/>
+</wsdl:operation>
+</wsdl:portType>
+
+<wsdl:binding name="SystemInfoBinding" type="tns:SystemInfo">
+<soap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http"/>
+<wsdl:operation name="SysmonOp">
+<soap:operation soapAction=""/>
+<wsdl:output>
+<soap:body use="literal"/>
+</wsdl:output>
+</wsdl:operation>
+</wsdl:binding>
+
+</wsdl:definitions>
+]]> </programlisting>
<orderedlist>
<listitem>
<para> Import the default eventing WSDL, that includes service and port declarations.</para>
@@ -1770,34 +1771,36 @@
<section>
<title>Emitting notifications</title>
<para>JBossWS-Eventing registeres a event dispatcher within local JNDI tree that can be used to emit notifications from applications.</para>
- <programlisting> <![CDATA[
- java:/EventDispatcher
- ]]> </programlisting>
- <para>The event dispatcher interface:</para>
- <programlisting> <![CDATA[
- public interface EventDispatcher
- {
- void dispatch(URI eventSourceNS, Element payload);
- }
- ]]> </programlisting>
- <para>
+<programlisting> <![CDATA[
+java:/EventDispatcher
+]]> </programlisting>
+
+<para>The event dispatcher interface:</para>
+<programlisting> <![CDATA[
+public interface EventDispatcher
+{
+void dispatch(URI eventSourceNS, Element payload);
+}
+]]> </programlisting>
+
+<para>
<emphasis role="bold">Example notification</emphasis>
</para>
- <programlisting> <![CDATA[
- (1) URI eventSourceURI = new URI("http://http://www.jboss.org/sysmon/SystemInfo");
- (2) Element payload = DOMUtils.parse("SOME XML STRING");
- try
- {
- InitialContext iniCtx = getInitialContext();
- (3) EventDispatcher delegate = (EventDispatcher)
- iniCtx.lookup(EventingConstants.DISPATCHER_JNDI_NAME);
- (4) delegate.dispatch(eventSourceURI, payload);
- }
- catch (Exception e)
- {
- //
- }
- ]]> </programlisting>
+<programlisting> <![CDATA[
+(1) URI eventSourceURI = new URI("http://http://www.jboss.org/sysmon/SystemInfo");
+(2) Element payload = DOMUtils.parse("SOME XML STRING");
+try
+{
+InitialContext iniCtx = getInitialContext();
+(3) EventDispatcher delegate = (EventDispatcher)
+iniCtx.lookup(EventingConstants.DISPATCHER_JNDI_NAME);
+(4) delegate.dispatch(eventSourceURI, payload);
+}
+catch (Exception e)
+{
+//
+}
+]]> </programlisting>
<orderedlist>
<listitem>
<para> Address your event source correctly (TargetNamespace+PortTypeName)</para>
@@ -1813,9 +1816,9 @@
</listitem>
</orderedlist>
<para>The SubscriptionManager MBean is the actual core component that drives the JBossWS-Eventing implementation. It can be accessed through the jmx-console.</para>
- <programlisting> <![CDATA[
- jboss.ws.eventing:service=SubscriptionManager
- ]]> </programlisting>
+<programlisting> <![CDATA[
+jboss.ws.eventing:service=SubscriptionManager
+]]> </programlisting>
<para>Management operations exist to monitor and maintain active subscritions and deployed event sources. The current implementation is backed by a ThreadPoolExecutor, that asynchronously delivers messages to event sink endpoints. It can be configured through the following attributes:</para>
<itemizedlist>
<listitem>
@@ -1882,23 +1885,23 @@
<section>
<title>Server side WSSE declaration (jboss-wsse-server.xml)</title>
<para>In this example we configure both the client and the server to sign the message body. Both also require this from each other. So, if you remove either the client or the server security deployment descriptor, you will notice that the other party will throw a fault explaining that the message did not conform to the proper security requirements.</para>
- <programlisting> <![CDATA[
- <jboss-ws-security xmlns="http://www.jboss.com/ws-security/config"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://www.jboss.com/ws-security/config
- http://www.jboss.com/ws-security/schema/jboss-ws-security_1_0.xsd">
- (1) <key-store-file>WEB-INF/wsse.keystore</key-store-file>
- (2) <key-store-password>jbossws</key-store-password>
- (3) <trust-store-file>WEB-INF/wsse.truststore</trust-store-file>
- (4) <trust-store-password>jbossws</trust-store-password>
- (5) <config>
- (6) <sign type="x509v3" alias="wsse"/>
- (7) <requires>
- (8) <signature/>
- </requires>
- </config>
- </jboss-ws-security>
- ]]> </programlisting>
+<programlisting> <![CDATA[
+<jboss-ws-security xmlns="http://www.jboss.com/ws-security/config"
+xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+xsi:schemaLocation="http://www.jboss.com/ws-security/config
+http://www.jboss.com/ws-security/schema/jboss-ws-security_1_0.xsd">
+(1) <key-store-file>WEB-INF/wsse.keystore</key-store-file>
+(2) <key-store-password>jbossws</key-store-password>
+(3) <trust-store-file>WEB-INF/wsse.truststore</trust-store-file>
+(4) <trust-store-password>jbossws</trust-store-password>
+(5) <config>
+(6) <sign type="x509v3" alias="wsse"/>
+(7) <requires>
+(8) <signature/>
+</requires>
+</config>
+</jboss-ws-security>
+]]> </programlisting>
<orderedlist>
<listitem>
<para> This specifies that the key store we wish to use is WEB-INF/wsse.keystore, which is located in our war file.</para>
@@ -1926,30 +1929,30 @@
</listitem>
</orderedlist>
<para>By default an endpoint does not use the WS-Security configuration. Use the proprietary @EndpointConfig annotation to set the config name. See <ulink url="http://jbws.dyndns.org/mediawiki/index.php?title=JAX-WS_Endpoint_Configuration">JAX-WS_Endpoint_Configuration</ulink> for the list of available config names.</para>
- <programlisting> <![CDATA[
- @WebService
- @EndpointConfig(configName = "Standard WSSecurity Endpoint")
- public class HelloJavaBean
- {
- ...
- }
- ]]> </programlisting>
+<programlisting> <![CDATA[
+ at WebService
+ at EndpointConfig(configName = "Standard WSSecurity Endpoint")
+public class HelloJavaBean
+{
+...
+}
+]]> </programlisting>
</section>
<section>
<title>Client side WSSE declaration (jboss-wsse-client.xml)</title>
- <programlisting> <![CDATA[
- <jboss-ws-security xmlns="http://www.jboss.com/ws-security/config"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://www.jboss.com/ws-security/config
- http://www.jboss.com/ws-security/schema/jboss-ws-security_1_0.xsd">
- (1) <config>
- (2) <sign type="x509v3" alias="wsse"/>
- (3) <requires>
- (4) <signature/>
- </requires>
- </config>
- </jboss-ws-security>
- ]]> </programlisting>
+<programlisting> <![CDATA[
+<jboss-ws-security xmlns="http://www.jboss.com/ws-security/config"
+xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+xsi:schemaLocation="http://www.jboss.com/ws-security/config
+http://www.jboss.com/ws-security/schema/jboss-ws-security_1_0.xsd">
+(1) <config>
+(2) <sign type="x509v3" alias="wsse"/>
+(3) <requires>
+(4) <signature/>
+</requires>
+</config>
+</jboss-ws-security>
+]]> </programlisting>
<orderedlist>
<listitem>
<para> Here we start our root config block. The root config block is the default configuration for all web service clients (Call, Proxy objects).</para>
@@ -1968,57 +1971,60 @@
<title>Client side key store configuration</title>
<para>We did not specify a key store or trust store, because client apps instead use the wsse System properties instead. If this was a web or ejb client (meaning a webservice client in a war or ejb jar file), then we would have specified them in the client descriptor.</para>
<para>Here is an excerpt from the JBossWS samples:</para>
- <programlisting> <![CDATA[
- <sysproperty key="org.jboss.ws.wsse.keyStore"
- value="${tests.output.dir}/resources/jaxrpc/samples/wssecurity/wsse.keystore"/>
- <sysproperty key="org.jboss.ws.wsse.trustStore"
- value="${tests.output.dir}/resources/jaxrpc/samples/wssecurity/wsse.truststore"/>
- <sysproperty key="org.jboss.ws.wsse.keyStorePassword" value="jbossws"/>
- <sysproperty key="org.jboss.ws.wsse.trustStorePassword" value="jbossws"/>
- <sysproperty key="org.jboss.ws.wsse.keyStoreType" value="jks"/>
- <sysproperty key="org.jboss.ws.wsse.trustStoreType" value="jks"/>
- ]]> </programlisting>
+<programlisting> <![CDATA[
+<sysproperty key="org.jboss.ws.wsse.keyStore"
+value="${tests.output.dir}/resources/jaxrpc/samples/wssecurity/wsse.keystore"/>
+<sysproperty key="org.jboss.ws.wsse.trustStore"
+value="${tests.output.dir}/resources/jaxrpc/samples/wssecurity/wsse.truststore"/>
+<sysproperty key="org.jboss.ws.wsse.keyStorePassword" value="jbossws"/>
+<sysproperty key="org.jboss.ws.wsse.trustStorePassword" value="jbossws"/>
+<sysproperty key="org.jboss.ws.wsse.keyStoreType" value="jks"/>
+<sysproperty key="org.jboss.ws.wsse.trustStoreType" value="jks"/>
+]]> </programlisting>
<para>
<emphasis role="bold">SOAP message exchange</emphasis>
</para>
<para>Below you see the incomming SOAP message with the details of the security headers ommited. The idea is, that the SOAP body is still plain text, but it is signed in the security header and can therefore not manipulated in transit.</para>
<para>Incomming SOAPMessage</para>
- <programlisting> <![CDATA[
- <env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
- <env:Header>
- <wsse:Security env:mustUnderstand="1" ...>
- <wsu:Timestamp wsu:Id="timestamp">...</wsu:Timestamp>
- <wsse:BinarySecurityToken ...>
- ...
- </wsse:BinarySecurityToken>
- <ds:Signature xmlns:ds="http://www.w3.org/2000/09/xmldsig#">
- ...
- </ds:Signature>
- </wsse:Security>
- </env:Header>
- <env:Body wsu:Id="element-1-1140197309843-12388840" ...>
- <ns1:echoUserType xmlns:ns1="http://org.jboss.ws/samples/wssecurity">
- <UserType_1 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
- <msg>Kermit</msg>
- </UserType_1>
- </ns1:echoUserType>
- </env:Body>
- </env:Envelope>
- ]]> </programlisting>
- </section>
+<programlisting> <![CDATA[
+<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
+<env:Header>
+<wsse:Security env:mustUnderstand="1" ...>
+<wsu:Timestamp wsu:Id="timestamp">...</wsu:Timestamp>
+<wsse:BinarySecurityToken ...>
+...
+</wsse:BinarySecurityToken>
+<ds:Signature xmlns:ds="http://www.w3.org/2000/09/xmldsig#">
+...
+</ds:Signature>
+</wsse:Security>
+</env:Header>
+<env:Body wsu:Id="element-1-1140197309843-12388840" ...>
+<ns1:echoUserType xmlns:ns1="http://org.jboss.ws/samples/wssecurity">
+<UserType_1 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+<msg>Kermit</msg>
+</UserType_1>
+</ns1:echoUserType>
+</env:Body>
+</env:Envelope>
+]]> </programlisting>
+
+</section>
</section>
<section>
<title>Installing the BouncyCastle JCE provider (JDK 1.4)</title>
<para>The information below has originaly been provided by <ulink url="http://www.bouncycastle.org/specifications.html#install">The Legion of the Bouncy Castle</ulink>.</para>
<para>The provider can be configured as part of your environment via static registration by adding an entry to the java.security properties file (found in $JAVA_HOME/jre/lib/security/java.security, where $JAVA_HOME is the location of your JDK/JRE distribution). You'll find detailed instructions in the file but basically it comes down to adding a line:</para>
- <programlisting> <![CDATA[
- security.provider.<n>=org.bouncycastle.jce.provider.BouncyCastleProvider
- ]]> </programlisting>
+<programlisting> <![CDATA[
+security.provider.<n>=org.bouncycastle.jce.provider.BouncyCastleProvider
+]]> </programlisting>
<para>Where <n> is the preference you want the provider at.</para>
<para>
- <emphasis role="bold">Note</emphasis>
- </para>
+ <note><title>Note</title>
+
<para>Issues may arise if the Sun provided providers are not first.</para>
+ </note>
+ </para>
<para>Where you put the jar is mostly up to you, although with jdk1.4 the best (and in some cases only) place to have it is in $JAVA_HOME/jre/lib/ext. Under Windows there will normally be a JRE and a JDK install of Java if you think you have installed it correctly and it still doesn't work chances are you have added the provider to the installation not being used.</para>
</section>
<section>
@@ -2044,10 +2050,10 @@
<para>Configuration of the jUDDI registry happens via an MBean Service that is deployed in the juddi-service.sar archive in the "all" configuration. The configuration of this service can be done in the jboss-service.xml of the META-INF directory in the juddi-service.sar</para>
<para>Let us look at the individual configuration items that can be changed.</para>
<para>DataSources configuration</para>
- <programlisting> <![CDATA[
- <!-- Datasource to Database-->
- <attribute name="DataSourceUrl">java:/DefaultDS</attribute>
- ]]> </programlisting>
+<programlisting> <![CDATA[
+<!-- Datasource to Database-->
+<attribute name="DataSourceUrl">java:/DefaultDS</attribute>
+]]> </programlisting>
<para>Database Tables (Should they be created on start, Should they be dropped on stop, Should they be dropped on start etc)</para>
<programlisting> <![CDATA[
<!-- Should all tables be created on Start-->
@@ -2058,33 +2064,33 @@
<attribute name="DropOnStart">false</attribute>
]]> </programlisting>
<para>JAXR Connection Factory to be bound in JNDI. (Should it be bound? and under what name?)</para>
- <programlisting> <![CDATA[
- <!-- Should I bind a Context to which JaxrConnectionFactory bound-->
- <attribute name="ShouldBindJaxr">true</attribute>
-
- <!-- Context to which JaxrConnectionFactory to bind to. If you have remote clients, please bind it to the global namespace(default behavior).
- To just cater to clients running on the same VM as JBoss, change to java:/JAXR -->
- <attribute name="BindJaxr">JAXR</attribute>
- ]]> </programlisting>
+<programlisting> <![CDATA[
+<!-- Should I bind a Context to which JaxrConnectionFactory bound-->
+<attribute name="ShouldBindJaxr">true</attribute>
+
+<!-- Context to which JaxrConnectionFactory to bind to. If you have remote clients, please bind it to the global namespace(default behavior).
+To just cater to clients running on the same VM as JBoss, change to java:/JAXR -->
+<attribute name="BindJaxr">JAXR</attribute>
+]]> </programlisting>
<para>Other common configuration:</para>
<para>Add authorized users to access the jUDDI registry. (Add a sql insert statement in a single line)</para>
- <programlisting> <![CDATA[
- Look at the script META-INF/ddl/juddi_data.ddl for more details. Example for a user 'jboss'
-
- INSERT INTO PUBLISHER (PUBLISHER_ID,PUBLISHER_NAME,
- EMAIL_ADDRESS,IS_ENABLED,IS_ADMIN)
- VALUES ('jboss','JBoss User','jboss at xxx','true','true');
- ]]> </programlisting>
+<programlisting> <![CDATA[
+Look at the script META-INF/ddl/juddi_data.ddl for more details. Example for a user 'jboss'
+
+INSERT INTO PUBLISHER (PUBLISHER_ID,PUBLISHER_NAME,
+EMAIL_ADDRESS,IS_ENABLED,IS_ADMIN)
+VALUES ('jboss','JBoss User','jboss at xxx','true','true');
+]]> </programlisting>
</section>
<section>
<title>JBoss JAXR Configuration</title>
<para>In this section, we will discuss the configuration needed to run the JAXR API. The JAXR configuration relies on System properties passed to the JVM. The System properties that are needed are:</para>
- <programlisting> <![CDATA[
- javax.xml.registry.ConnectionFactoryClass=org.apache.ws.scout.registry.ConnectionFactoryImpl
- jaxr.query.url=http://localhost:8080/juddi/inquiry
- jaxr.publish.url=http://localhost:8080/juddi/publish
- juddi.proxy.transportClass=org.jboss.jaxr.juddi.transport.SaajTransport
- ]]> </programlisting>
+<programlisting> <![CDATA[
+javax.xml.registry.ConnectionFactoryClass=org.apache.ws.scout.registry.ConnectionFactoryImpl
+jaxr.query.url=http://localhost:8080/juddi/inquiry
+jaxr.publish.url=http://localhost:8080/juddi/publish
+juddi.proxy.transportClass=org.jboss.jaxr.juddi.transport.SaajTransport
+]]> </programlisting>
<para>Please remember to change the hostname from "localhost" to the hostname of the UDDI service/JBoss Server.</para>
<para>You can pass the System Properties to the JVM in the following ways:</para>
<itemizedlist>
@@ -2095,9 +2101,9 @@
<para> When the client code is running in an external JVM. Then you can pass the properties either as "-D" options to the java process or explicitly set them in the client code(not recommended).</para>
</listitem>
</itemizedlist>
- <programlisting> <![CDATA[
- System.setProperty(propertyname, propertyvalue);
- ]]> </programlisting>
+<programlisting> <![CDATA[
+System.setProperty(propertyname, propertyvalue);
+]]> </programlisting>
</section>
<section>
<title>JAXR Sample Code</title>
@@ -2115,144 +2121,144 @@
</itemizedlist>
<para>Let us now look at some of the common programming tasks performed while using the JAXR API:</para>
<para>Getting a JAXR Connection to the registry.</para>
- <programlisting> <![CDATA[
- String queryurl = System.getProperty("jaxr.query.url", "http://localhost:8080/juddi/inquiry");
- String puburl = System.getProperty("jaxr.publish.url", "http://localhost:8080/juddi/publish");
-
- Properties props = new Properties();
- props.setProperty("javax.xml.registry.queryManagerURL", queryurl);
- props.setProperty("javax.xml.registry.lifeCycleManagerURL", puburl);
-
- String transportClass = System.getProperty("juddi.proxy.transportClass", "org.jboss.jaxr.juddi.transport.SaajTransport");
- System.setProperty("juddi.proxy.transportClass", transportClass);
-
- // Create the connection, passing it the configuration properties
- factory = ConnectionFactory.newInstance();
- factory.setProperties(props);
- connection = factory.createConnection();
- ]]> </programlisting>
+<programlisting> <![CDATA[
+String queryurl = System.getProperty("jaxr.query.url", "http://localhost:8080/juddi/inquiry");
+String puburl = System.getProperty("jaxr.publish.url", "http://localhost:8080/juddi/publish");
+..
+Properties props = new Properties();
+props.setProperty("javax.xml.registry.queryManagerURL", queryurl);
+props.setProperty("javax.xml.registry.lifeCycleManagerURL", puburl);
+
+String transportClass = System.getProperty("juddi.proxy.transportClass", "org.jboss.jaxr.juddi.transport.SaajTransport");
+System.setProperty("juddi.proxy.transportClass", transportClass);
+
+// Create the connection, passing it the configuration properties
+factory = ConnectionFactory.newInstance();
+factory.setProperties(props);
+connection = factory.createConnection();
+]]> </programlisting>
<para>Authentication with the registry.</para>
- <programlisting> <![CDATA[
- /**
- * Does authentication with the uddi registry
- */
- protected void login() throws JAXRException
- {
- PasswordAuthentication passwdAuth = new PasswordAuthentication(userid, passwd.toCharArray());
- Set creds = new HashSet();
- creds.add(passwdAuth);
-
- connection.setCredentials(creds);
- }
- ]]> </programlisting>
+<programlisting> <![CDATA[
+/**
+* Does authentication with the uddi registry
+*/
+protected void login() throws JAXRException
+{
+PasswordAuthentication passwdAuth = new PasswordAuthentication(userid, passwd.toCharArray());
+Set creds = new HashSet();
+creds.add(passwdAuth);
+
+connection.setCredentials(creds);
+}
+]]> </programlisting>
<para>Save a Business</para>
- <programlisting> <![CDATA[
- /**
- * Creates a Jaxr Organization with 1 or more services
- */
- protected Organization createOrganization(String orgname) throws JAXRException
- {
- Organization org = blm.createOrganization(getIString(orgname));
- org.setDescription(getIString("JBoss Inc"));
- Service service = blm.createService(getIString("JBOSS JAXR Service"));
- service.setDescription(getIString("Services of XML Registry"));
- //Create serviceBinding
- ServiceBinding serviceBinding = blm.createServiceBinding();
- serviceBinding.setDescription(blm.createInternationalString("Test Service Binding"));
-
- //Turn validation of URI off
- serviceBinding.setValidateURI(false);
- serviceBinding.setAccessURI("http://testjboss.org");
-
- // Add the serviceBinding to the service
- service.addServiceBinding(serviceBinding);
-
- User user = blm.createUser();
- org.setPrimaryContact(user);
- PersonName personName = blm.createPersonName("Anil S");
- TelephoneNumber telephoneNumber = blm.createTelephoneNumber();
- telephoneNumber.setNumber("111-111-7777");
- telephoneNumber.setType(null);
- PostalAddress address = blm.createPostalAddress("111", "My Drive", "BuckHead", "GA", "USA", "1111-111", "");
- Collection postalAddresses = new ArrayList();
- postalAddresses.add(address);
- Collection emailAddresses = new ArrayList();
- EmailAddress emailAddress = blm.createEmailAddress("anil at apache.org");
- emailAddresses.add(emailAddress);
-
- Collection numbers = new ArrayList();
- numbers.add(telephoneNumber);
- user.setPersonName(personName);
- user.setPostalAddresses(postalAddresses);
- user.setEmailAddresses(emailAddresses);
- user.setTelephoneNumbers(numbers);
-
- ClassificationScheme cScheme = getClassificationScheme("ntis-gov:naics", "");
- Key cKey = blm.createKey("uuid:C0B9FE13-324F-413D-5A5B-2004DB8E5CC2");
- cScheme.setKey(cKey);
- Classification classification = blm.createClassification(cScheme, "Computer Systems Design and Related Services", "5415");
- org.addClassification(classification);
- ClassificationScheme cScheme1 = getClassificationScheme("D-U-N-S", "");
- Key cKey1 = blm.createKey("uuid:3367C81E-FF1F-4D5A-B202-3EB13AD02423");
- cScheme1.setKey(cKey1);
- ExternalIdentifier ei = blm.createExternalIdentifier(cScheme1, "D-U-N-S number", "08-146-6849");
- org.addExternalIdentifier(ei);
- org.addService(service);
- return org;
- }
- ]]> </programlisting>
+<programlisting> <![CDATA[
+/**
+* Creates a Jaxr Organization with 1 or more services
+*/
+protected Organization createOrganization(String orgname) throws JAXRException
+{
+Organization org = blm.createOrganization(getIString(orgname));
+org.setDescription(getIString("JBoss Inc"));
+Service service = blm.createService(getIString("JBOSS JAXR Service"));
+service.setDescription(getIString("Services of XML Registry"));
+//Create serviceBinding
+ServiceBinding serviceBinding = blm.createServiceBinding();
+serviceBinding.setDescription(blm.createInternationalString("Test Service Binding"));
+
+//Turn validation of URI off
+serviceBinding.setValidateURI(false);
+serviceBinding.setAccessURI("http://testjboss.org");
+..
+// Add the serviceBinding to the service
+service.addServiceBinding(serviceBinding);
+
+User user = blm.createUser();
+org.setPrimaryContact(user);
+PersonName personName = blm.createPersonName("Anil S");
+TelephoneNumber telephoneNumber = blm.createTelephoneNumber();
+telephoneNumber.setNumber("111-111-7777");
+telephoneNumber.setType(null);
+PostalAddress address = blm.createPostalAddress("111", "My Drive", "BuckHead", "GA", "USA", "1111-111", "");
+Collection postalAddresses = new ArrayList();
+postalAddresses.add(address);
+Collection emailAddresses = new ArrayList();
+EmailAddress emailAddress = blm.createEmailAddress("anil at apache.org");
+emailAddresses.add(emailAddress);
+
+Collection numbers = new ArrayList();
+numbers.add(telephoneNumber);
+user.setPersonName(personName);
+user.setPostalAddresses(postalAddresses);
+user.setEmailAddresses(emailAddresses);
+user.setTelephoneNumbers(numbers);
+
+ClassificationScheme cScheme = getClassificationScheme("ntis-gov:naics", "");
+Key cKey = blm.createKey("uuid:C0B9FE13-324F-413D-5A5B-2004DB8E5CC2");
+cScheme.setKey(cKey);
+Classification classification = blm.createClassification(cScheme, "Computer Systems Design and Related Services", "5415");
+org.addClassification(classification);
+ClassificationScheme cScheme1 = getClassificationScheme("D-U-N-S", "");
+Key cKey1 = blm.createKey("uuid:3367C81E-FF1F-4D5A-B202-3EB13AD02423");
+cScheme1.setKey(cKey1);
+ExternalIdentifier ei = blm.createExternalIdentifier(cScheme1, "D-U-N-S number", "08-146-6849");
+org.addExternalIdentifier(ei);
+org.addService(service);
+return org;
+}
+]]> </programlisting>
<para>Query a Business</para>
- <programlisting> <![CDATA[
- /**
- * Locale aware Search a business in the registry
- */
- public void searchBusiness(String bizname) throws JAXRException
- {
- try
- {
- // Get registry service and business query manager
- this.getJAXREssentials();
-
- // Define find qualifiers and name patterns
- Collection findQualifiers = new ArrayList();
- findQualifiers.add(FindQualifier.SORT_BY_NAME_ASC);
- Collection namePatterns = new ArrayList();
- String pattern = "%" + bizname + "%";
- LocalizedString ls = blm.createLocalizedString(Locale.getDefault(), pattern);
- namePatterns.add(ls);
-
- // Find based upon qualifier type and values
- BulkResponse response = bqm.findOrganizations(findQualifiers, namePatterns, null, null, null, null);
-
- // check how many organisation we have matched
- Collection orgs = response.getCollection();
- if (orgs == null)
- {
- log.debug(" -- Matched 0 orgs");
-
- }
- else
- {
- log.debug(" -- Matched " + orgs.size() + " organizations -- ");
-
- // then step through them
- for (Iterator orgIter = orgs.iterator(); orgIter.hasNext();)
- {
- Organization org = (Organization)orgIter.next();
- log.debug("Org name: " + getName(org));
- log.debug("Org description: " + getDescription(org));
- log.debug("Org key id: " + getKey(org));
- checkUser(org);
- checkServices(org);
- }
- }
- }
- finally
- {
- connection.close();
- }
- }
- ]]> </programlisting>
+<programlisting> <![CDATA[
+/**
+* Locale aware Search a business in the registry
+*/
+public void searchBusiness(String bizname) throws JAXRException
+{
+try
+{
+// Get registry service and business query manager
+this.getJAXREssentials();
+
+// Define find qualifiers and name patterns
+Collection findQualifiers = new ArrayList();
+findQualifiers.add(FindQualifier.SORT_BY_NAME_ASC);
+Collection namePatterns = new ArrayList();
+String pattern = "%" + bizname + "%";
+LocalizedString ls = blm.createLocalizedString(Locale.getDefault(), pattern);
+namePatterns.add(ls);
+
+// Find based upon qualifier type and values
+BulkResponse response = bqm.findOrganizations(findQualifiers, namePatterns, null, null, null, null);
+
+// check how many organisation we have matched
+Collection orgs = response.getCollection();
+if (orgs == null)
+{
+log.debug(" -- Matched 0 orgs");
+
+}
+else
+{
+log.debug(" -- Matched " + orgs.size() + " organizations -- ");
+
+// then step through them
+for (Iterator orgIter = orgs.iterator(); orgIter.hasNext();)
+{
+Organization org = (Organization)orgIter.next();
+log.debug("Org name: " + getName(org));
+log.debug("Org description: " + getDescription(org));
+log.debug("Org key id: " + getKey(org));
+checkUser(org);
+checkServices(org);
+}
+}
+}
+finally
+{
+connection.close();
+}
+}
+]]> </programlisting>
<para>For more examples of code using the JAXR API, please refer to the resources in the Resources Section.</para>
</section>
<section>
@@ -2303,151 +2309,152 @@
<section>
<title>Specification</title>
<para>WS-Policy is defined by the combination of the following specifications:</para>
- <programlisting> <![CDATA[
- * <ulink url="http://www.w3.org/Submission/WS-Policy/"> WS-Policy specification</ulink>
- * <ulink url="http://www.w3.org/Submission/WS-PolicyAttachment/"> WS-Policy-Attachment specification</ulink>
- ]]> </programlisting>
+<programlisting> <![CDATA[
+* <ulink url="http://www.w3.org/Submission/WS-Policy/"> WS-Policy specification</ulink>
+* <ulink url="http://www.w3.org/Submission/WS-PolicyAttachment/"> WS-Policy-Attachment specification</ulink>
+ ]]> </programlisting>
</section>
<section>
<title>Using policies in a user provided wsdl</title>
<para>To attach policies in this manner, the only thing you have to do in a webservice class is to provide a custom wsdl. This will cause JBossws to skip wsdl generation at deploy time, since the wsdl file you provided will be published. Please refer to specification (WS-Policy-Attachment) to learn how to modify wsdl to attach a policy.</para>
<para>Here you find an example of a webservice class and provided wsdl with a policy containing a domain assertion for JBoss wssecurity.</para>
- <programlisting> <![CDATA[
- @WebService(name = "Hello",
- targetNamespace = "http://org.jboss.ws/samples/wssecuritypolicy",
- wsdlLocation="WEB-INF/wsdl/HelloService.wsdl")
- @SOAPBinding(style = SOAPBinding.Style.RPC)
- public class HelloJavaBean
- {
- private Logger log = Logger.getLogger(HelloJavaBean.class);
-
- @WebMethod
- public UserType echoUserType(@WebParam(name = "user") UserType in0)
- {
- log.info(in0);
- return in0;
- }
- }
- <?xml version="1.0" encoding="UTF-8"?>
- <definitions name='HelloService' targetNamespace='http://org.jboss.ws/samples/wssecuritypolicy' xmlns='http://schemas.xmlsoap.org/wsdl/' xmlns:ns1='http://org.jboss.ws/samples/wssecurity' xmlns:soap='http://schemas.xmlsoap.org/wsdl/soap/' xmlns:tns='http://org.jboss.ws/samples/wssecuritypolicy' xmlns:wsp='http://schemas.xmlsoap.org/ws/2004/09/policy' xmlns:xsd='http://www.w3.org/2001/XMLSchema'>
- <types>
- <xs:schema targetNamespace='http://org.jboss.ws/samples/wssecurity' version='1.0' xmlns:xs='http://www.w3.org/2001/XMLSchema'>
- <xs:complexType name='UserType'>
- <xs:sequence>
- <xs:element minOccurs='0' name='msg' type='xs:string'/>
- </xs:sequence>
- </xs:complexType>
- </xs:schema>
- </types>
- <wsp:Policy wsu:Id='X509EndpointPolicy' xmlns:wsu='http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd'>
- <wsp:All>
- <sp:jboss-ws-security xmlns:sp='http://www.jboss.com/ws-security/schema/jboss-ws-security_1_0.xsd'>
- <sp:key-store-file>WEB-INF/wsse.keystore</sp:key-store-file>
- <sp:key-store-password>jbossws</sp:key-store-password>
- <sp:trust-store-file>WEB-INF/wsse.truststore</sp:trust-store-file>
- <sp:trust-store-password>jbossws</sp:trust-store-password>
- <sp:config>
- <sp:encrypt alias='wsse' type='x509v3'/>
- <sp:requires>
- <sp:encryption/>
- </sp:requires>
- </sp:config>
- </sp:jboss-ws-security>
- </wsp:All>
- </wsp:Policy>
- <message name='Hello_echoUserType'>
- <part name='user' type='ns1:UserType'/>
- </message>
- <message name='Hello_echoUserTypeResponse'>
- <part name='return' type='ns1:UserType'/>
- </message>
- <portType name='Hello'>
- <operation name='echoUserType' parameterOrder='user'>
- <input message='tns:Hello_echoUserType'/>
- <output message='tns:Hello_echoUserTypeResponse'/>
- </operation>
- </portType>
- <binding name='HelloBinding' type='tns:Hello'>
- <wsp:PolicyReference URI='#X509EndpointPolicy'/>
- <soap:binding style='rpc' transport='http://schemas.xmlsoap.org/soap/http'/>
- <operation name='echoUserType'>
- <soap:operation soapAction=''/>
- <input>
- <soap:body namespace='http://org.jboss.ws/samples/wssecuritypolicy' use='literal'/>
- </input>
- <output>
- <soap:body namespace='http://org.jboss.ws/samples/wssecuritypolicy' use='literal'/>
- </output>
- </operation>
- </binding>
- <service name='HelloService'>
- <port binding='tns:HelloBinding' name='HelloPort'>
- <soap:address location='REPLACE_WITH_ACTUAL_URL'/>
- </port>
- </service>
- </definitions>
- ]]> </programlisting>
- <para>Please note in the wsdl file the wsp:Policy element and the wsp:PolicyReference in 'HelloBinding' binding Element.</para>
+<programlisting> <![CDATA[
+ at WebService(name = "Hello",
+targetNamespace = "http://org.jboss.ws/samples/wssecuritypolicy",
+wsdlLocation="WEB-INF/wsdl/HelloService.wsdl")
+ at SOAPBinding(style = SOAPBinding.Style.RPC)
+public class HelloJavaBean
+{
+private Logger log = Logger.getLogger(HelloJavaBean.class);
+..
+ at WebMethod
+public UserType echoUserType(@WebParam(name = "user") UserType in0)
+{
+log.info(in0);
+return in0;
+}
+}
+<?xml version="1.0" encoding="UTF-8"?>
+<definitions name='HelloService' targetNamespace='http://org.jboss.ws/samples/wssecuritypolicy' xmlns='http://schemas.xmlsoap.org/wsdl/' xmlns:ns1='http://org.jboss.ws/samples/wssecurity' xmlns:soap='http://schemas.xmlsoap.org/wsdl/soap/' xmlns:tns='http://org.jboss.ws/samples/wssecuritypolicy' xmlns:wsp='http://schemas.xmlsoap.org/ws/2004/09/policy' xmlns:xsd='http://www.w3.org/2001/XMLSchema'>
+<types>
+<xs:schema targetNamespace='http://org.jboss.ws/samples/wssecurity' version='1.0' xmlns:xs='http://www.w3.org/2001/XMLSchema'>
+<xs:complexType name='UserType'>
+<xs:sequence>
+<xs:element minOccurs='0' name='msg' type='xs:string'/>
+</xs:sequence>
+</xs:complexType>
+</xs:schema>
+</types>
+<wsp:Policy wsu:Id='X509EndpointPolicy' xmlns:wsu='http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd'>
+<wsp:All>
+<sp:jboss-ws-security xmlns:sp='http://www.jboss.com/ws-security/schema/jboss-ws-security_1_0.xsd'>
+<sp:key-store-file>WEB-INF/wsse.keystore</sp:key-store-file>
+<sp:key-store-password>jbossws</sp:key-store-password>
+<sp:trust-store-file>WEB-INF/wsse.truststore</sp:trust-store-file>
+<sp:trust-store-password>jbossws</sp:trust-store-password>
+<sp:config>
+<sp:encrypt alias='wsse' type='x509v3'/>
+<sp:requires>
+<sp:encryption/>
+</sp:requires>
+</sp:config>
+</sp:jboss-ws-security>
+</wsp:All>
+</wsp:Policy>
+<message name='Hello_echoUserType'>
+<part name='user' type='ns1:UserType'/>
+</message>
+<message name='Hello_echoUserTypeResponse'>
+<part name='return' type='ns1:UserType'/>
+</message>
+<portType name='Hello'>
+<operation name='echoUserType' parameterOrder='user'>
+<input message='tns:Hello_echoUserType'/>
+<output message='tns:Hello_echoUserTypeResponse'/>
+</operation>
+</portType>
+<binding name='HelloBinding' type='tns:Hello'>
+<wsp:PolicyReference URI='#X509EndpointPolicy'/>
+<soap:binding style='rpc' transport='http://schemas.xmlsoap.org/soap/http'/>
+<operation name='echoUserType'>
+<soap:operation soapAction=''/>
+<input>
+<soap:body namespace='http://org.jboss.ws/samples/wssecuritypolicy' use='literal'/>
+</input>
+<output>
+<soap:body namespace='http://org.jboss.ws/samples/wssecuritypolicy' use='literal'/>
+</output>
+</operation>
+</binding>
+<service name='HelloService'>
+<port binding='tns:HelloBinding' name='HelloPort'>
+<soap:address location='REPLACE_WITH_ACTUAL_URL'/>
+</port>
+</service>
+</definitions>
+]]> </programlisting>
+
+<para>Please note in the wsdl file the wsp:Policy element and the wsp:PolicyReference in 'HelloBinding' binding Element.</para>
</section>
<section>
<title>Using policies with JBoss annotations</title>
<para>Using JBoss proprietary annotation you only have to provide the policy xml, leaving wsdl generation to the JBossWS deployer.</para>
<para>There are two annotations to use, the first one (@PolicyAttachment) containing an array of the second one (@Policy): this lets you have many policies attached to a class or method. In future domain policy implementations might ship domain annotations extending the @Policy annotation to provide needed metadata directly as annotation parameters. The current @Policy annotation takes a reference to a xml file containing a generic policy description written respecting ws-policy specification rules.</para>
- <programlisting> <![CDATA[
- /**
-
- @Target(ElementType.TYPE)
- @Retention(RetentionPolicy.RUNTIME)
- public @interface PolicyAttachment {
- Policy[] value();
- }
-
- @Retention(RetentionPolicy.RUNTIME)
- public @interface Policy {
-
- public String policyFileLocation();
-
- public PolicyScopeLevel scope();
- }
- ]]> </programlisting>
+<programlisting> <![CDATA[
+/**
+
+ at Target(ElementType.TYPE)
+ at Retention(RetentionPolicy.RUNTIME)
+public @interface PolicyAttachment {
+Policy[] value();
+}
+...
+ at Retention(RetentionPolicy.RUNTIME)
+public @interface Policy {
+
+public String policyFileLocation();
+
+public PolicyScopeLevel scope();
+}
+]]> </programlisting>
<para>And here you have the previous section example re-implemented using annotations and xml policy file:</para>
- <programlisting> <![CDATA[
- @WebService(name = "Hello", targetNamespace = "http://org.jboss.ws/samples/wssecurityAnnotatedpolicy")
- @PolicyAttachment({@Policy( policyFileLocation="WEB-INF/Policy.xml", scope = PolicyScopeLevel.WSDL_PORT ) })
- @SOAPBinding(style = SOAPBinding.Style.RPC)
- public class HelloJavaBean
- {
- private Logger log = Logger.getLogger(HelloJavaBean.class);
-
- @WebMethod
- public UserType echoUserType(@WebParam(name = "user") UserType in0)
- {
- log.info(in0);
- return in0;
- }
- }
- <?xml version="1.0" encoding="UTF-8"?>
-
- <wsp:Policy wsu:Id="X509EndpointPolicy" xmlns:wsp="http://schemas.xmlsoap.org/ws/2004/09/policy"
- xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
- <wsp:ExactlyOne>
- <wsp:All>
- <sp:jboss-ws-security xmlns:sp="http://www.jboss.com/ws-security/schema/jboss-ws-security_1_0.xsd">
- <sp:key-store-file>WEB-INF/wsse.keystore</sp:key-store-file>
- <sp:key-store-password>jbossws</sp:key-store-password>
- <sp:trust-store-file>WEB-INF/wsse.truststore</sp:trust-store-file>
- <sp:trust-store-password>jbossws</sp:trust-store-password>
- <sp:config>
- <sp:encrypt type="x509v3" alias="wsse"/>
- <sp:requires>
- <sp:encryption/>
- </sp:requires>
- </sp:config>
- </sp:jboss-ws-security>
- </wsp:All>
- </wsp:ExactlyOne>
- </wsp:Policy>
- ]]> </programlisting>
+<programlisting> <![CDATA[
+ at WebService(name = "Hello", targetNamespace = "http://org.jboss.ws/samples/wssecurityAnnotatedpolicy")
+ at PolicyAttachment({@Policy( policyFileLocation="WEB-INF/Policy.xml", scope = PolicyScopeLevel.WSDL_PORT ) })
+ at SOAPBinding(style = SOAPBinding.Style.RPC)
+public class HelloJavaBean
+{
+private Logger log = Logger.getLogger(HelloJavaBean.class);
+
+ at WebMethod
+public UserType echoUserType(@WebParam(name = "user") UserType in0)
+{
+log.info(in0);
+return in0;
+}
+}
+<?xml version="1.0" encoding="UTF-8"?>
+...
+<wsp:Policy wsu:Id="X509EndpointPolicy" xmlns:wsp="http://schemas.xmlsoap.org/ws/2004/09/policy"
+xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
+<wsp:ExactlyOne>
+<wsp:All>
+<sp:jboss-ws-security xmlns:sp="http://www.jboss.com/ws-security/schema/jboss-ws-security_1_0.xsd">
+<sp:key-store-file>WEB-INF/wsse.keystore</sp:key-store-file>
+<sp:key-store-password>jbossws</sp:key-store-password>
+<sp:trust-store-file>WEB-INF/wsse.truststore</sp:trust-store-file>
+<sp:trust-store-password>jbossws</sp:trust-store-password>
+<sp:config>
+<sp:encrypt type="x509v3" alias="wsse"/>
+<sp:requires>
+<sp:encryption/>
+</sp:requires>
+</sp:config>
+</sp:jboss-ws-security>
+</wsp:All>
+</wsp:ExactlyOne>
+</wsp:Policy>
+]]> </programlisting>
</section>
</section>
</section>
@@ -2459,138 +2466,138 @@
<para>For the set of standard annotations, please have a look at <ulink url="http://jbws.dyndns.org/mediawiki/index.php?title=JAX-WS_Annotations">JAX-WS Annotations</ulink></para>
<section>
<title>EndpointConfig</title>
- <programlisting> <![CDATA[
- /**
- * Defines an endpoint or client configuration.
- * This annotation is valid on an endpoint implementaion bean or a SEI.
- *
- * @author Heiko.Braun at jboss.org
- * @since 16.01.2007
- */
- @Retention(value = RetentionPolicy.RUNTIME)
- @Target(value = { ElementType.TYPE })
- public @interface EndpointConfig {
-
- /**
- * The optional config-name element gives the configuration name that must be present in
- * the configuration given by element config-file.
- *
- * Server side default: Standard Endpoint
- * Client side default: Standard Client
- */
- String configName() default "";
-
- /**
- * The optional config-file element is a URL or resource name for the configuration.
- *
- * Server side default: standard-jaxws-endpoint-config.xml
- * Client side default: standard-jaxws-client-config.xml
- */
- String configFile() default "";
- }
- ]]> </programlisting>
+<programlisting> <![CDATA[
+/**
+* Defines an endpoint or client configuration.
+* This annotation is valid on an endpoint implementaion bean or a SEI.
+*
+* @author Heiko.Braun at jboss.org
+* @since 16.01.2007
+*/
+ at Retention(value = RetentionPolicy.RUNTIME)
+ at Target(value = { ElementType.TYPE })
+public @interface EndpointConfig {
+...
+/**
+* The optional config-name element gives the configuration name that must be present in
+* the configuration given by element config-file.
+*
+* Server side default: Standard Endpoint
+* Client side default: Standard Client
+*/
+String configName() default "";
+...
+/**
+* The optional config-file element is a URL or resource name for the configuration.
+*
+* Server side default: standard-jaxws-endpoint-config.xml
+* Client side default: standard-jaxws-client-config.xml
+*/
+String configFile() default "";
+}
+]]> </programlisting>
</section>
<section>
<title>WebContext</title>
- <programlisting> <![CDATA[
- /**
- * Provides web context specific meta data to EJB based web service endpoints.
- *
- * @author thomas.diesler at jboss.org
- * @since 26-Apr-2005
- */
- @Retention(value = RetentionPolicy.RUNTIME)
- @Target(value = { ElementType.TYPE })
- public @interface WebContext {
-
- /**
- * The contextRoot element specifies the context root that the web service endpoint is deployed to.
- * If it is not specified it will be derived from the deployment short name.
- *
- * Applies to server side port components only.
- */
- String contextRoot() default "";
-
- /**
- * The virtual hosts that the web service endpoint is deployed to.
- *
- * Applies to server side port components only.
- */
- String[] virtualHosts() default {};
-
- /**
- * Relative path that is appended to the contextRoot to form fully qualified
- * endpoint address for the web service endpoint.
- *
- * Applies to server side port components only.
- */
- String urlPattern() default "";
-
- /**
- * The authMethod is used to configure the authentication mechanism for the web service.
- * As a prerequisite to gaining access to any web service which are protected by an authorization
- * constraint, a user must have authenticated using the configured mechanism.
- *
- * Legal values for this element are "BASIC", or "CLIENT-CERT".
- */
- String authMethod() default "";
-
- /**
- * The transportGuarantee specifies that the communication
- * between client and server should be NONE, INTEGRAL, or
- * CONFIDENTIAL. NONE means that the application does not require any
- * transport guarantees. A value of INTEGRAL means that the application
- * requires that the data sent between the client and server be sent in
- * such a way that it can't be changed in transit. CONFIDENTIAL means
- * that the application requires that the data be transmitted in a
- * fashion that prevents other entities from observing the contents of
- * the transmission. In most cases, the presence of the INTEGRAL or
- * CONFIDENTIAL flag will indicate that the use of SSL is required.
- */
- String transportGuarantee() default "";
-
- /**
- * A secure endpoint does not by default publish it's wsdl on an unsecure transport.
- * You can override this behaviour by explicitly setting the secureWSDLAccess flag to false.
- *
- * Protect access to WSDL. See http://jira.jboss.org/jira/browse/JBWS-723
- */
- boolean secureWSDLAccess() default true;
- }
- ]]> </programlisting>
+<programlisting> <![CDATA[
+/**
+* Provides web context specific meta data to EJB based web service endpoints.
+*
+* @author thomas.diesler at jboss.org
+* @since 26-Apr-2005
+*/
+ at Retention(value = RetentionPolicy.RUNTIME)
+ at Target(value = { ElementType.TYPE })
+public @interface WebContext {
+...
+/**
+* The contextRoot element specifies the context root that the web service endpoint is deployed to.
+* If it is not specified it will be derived from the deployment short name.
+*
+* Applies to server side port components only.
+*/
+String contextRoot() default "";
+...
+/**
+* The virtual hosts that the web service endpoint is deployed to.
+*
+* Applies to server side port components only.
+*/
+String[] virtualHosts() default {};
+
+/**
+* Relative path that is appended to the contextRoot to form fully qualified
+* endpoint address for the web service endpoint.
+*
+* Applies to server side port components only.
+*/
+String urlPattern() default "";
+
+/**
+* The authMethod is used to configure the authentication mechanism for the web service.
+* As a prerequisite to gaining access to any web service which are protected by an authorization
+* constraint, a user must have authenticated using the configured mechanism.
+*
+* Legal values for this element are "BASIC", or "CLIENT-CERT".
+*/
+String authMethod() default "";
+
+/**
+* The transportGuarantee specifies that the communication
+* between client and server should be NONE, INTEGRAL, or
+* CONFIDENTIAL. NONE means that the application does not require any
+* transport guarantees. A value of INTEGRAL means that the application
+* requires that the data sent between the client and server be sent in
+* such a way that it can't be changed in transit. CONFIDENTIAL means
+* that the application requires that the data be transmitted in a
+* fashion that prevents other entities from observing the contents of
+* the transmission. In most cases, the presence of the INTEGRAL or
+* CONFIDENTIAL flag will indicate that the use of SSL is required.
+*/
+String transportGuarantee() default "";
+
+/**
+* A secure endpoint does not by default publish it's wsdl on an unsecure transport.
+* You can override this behaviour by explicitly setting the secureWSDLAccess flag to false.
+*
+* Protect access to WSDL. See http://jira.jboss.org/jira/browse/JBWS-723
+*/
+boolean secureWSDLAccess() default true;
+}
+]]> </programlisting>
</section>
<section>
<title>SecurityDomain</title>
- <programlisting> <![CDATA[
- /**
- * Annotation for specifying the JBoss security domain for an EJB
- *
- * @author <a href="mailto:bill at jboss.org">Bill Burke</a>
- **/
- @Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME)
- public @interface SecurityDomain
- {
- /**
- * The required name for the security domain.
- *
- * Do not use the JNDI name
- *
- * Good: "MyDomain"
- * Bad: "java:/jaas/MyDomain"
- */
- String value();
-
- /**
- * The name for the unauthenticated pricipal
- */
- String unauthenticatedPrincipal() default "";
- }
- ]]> </programlisting>
+<programlisting> <![CDATA[
+/**
+* Annotation for specifying the JBoss security domain for an EJB
+*
+* @author <a href="mailto:bill at jboss.org">Bill Burke</a>
+**/
+ at Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME)
+public @interface SecurityDomain
+{
+/**
+* The required name for the security domain.
+*
+* Do not use the JNDI name
+*
+* Good: "MyDomain"
+* Bad: "java:/jaas/MyDomain"
+*/
+String value();
+
+/**
+* The name for the unauthenticated pricipal
+*/
+String unauthenticatedPrincipal() default "";
+}
+]]> </programlisting>
</section>
</section>
</section>
<section>
- <title>Appendix</title>
+ <title>Web Services Appendix</title>
<para>
<ulink url="http://jbws.dyndns.org/mediawiki/index.php?title=JAX-WS_Endpoint_Configuration">JAX-WS Endpoint Configuration</ulink>
</para>
More information about the jboss-cvs-commits
mailing list