[jboss-cvs] JBossAS SVN: r71671 - projects/docs/trunk/AS_5/Administration_And_Configuration_Guide/en-US.
jboss-cvs-commits at lists.jboss.org
jboss-cvs-commits at lists.jboss.org
Wed Apr 2 22:12:55 EDT 2008
Author: skittoli at redhat.com
Date: 2008-04-02 22:12:55 -0400 (Wed, 02 Apr 2008)
New Revision: 71671
Modified:
projects/docs/trunk/AS_5/Administration_And_Configuration_Guide/en-US/resolved.xml
Log:
updated docs
Modified: projects/docs/trunk/AS_5/Administration_And_Configuration_Guide/en-US/resolved.xml
===================================================================
--- projects/docs/trunk/AS_5/Administration_And_Configuration_Guide/en-US/resolved.xml 2008-04-03 02:04:32 UTC (rev 71670)
+++ projects/docs/trunk/AS_5/Administration_And_Configuration_Guide/en-US/resolved.xml 2008-04-03 02:12:55 UTC (rev 71671)
@@ -767,7 +767,7 @@
The above table shows a list of supported endpoint parameter types. The recommended approach is to use the javax.activation.DataHandler classes to represent binary data as service endpoint parameters.
</para>
- <note><title/><para>Microsoft endpoints tend to send any data as application/octet-stream. The only Java type that can easily cope with this ambiguity is javax.activation.DataHandler</para></note>
+ <note><title>Note</title><para>Microsoft endpoints tend to send any data as application/octet-stream. The only Java type that can easily cope with this ambiguity is javax.activation.DataHandler</para></note>
</section>
@@ -958,27 +958,32 @@
<para>
With rpc style web services the portType names the operation (i.e. the java method on the endpoint)
-<programlisting>
-<![CDATA[ <portType name='EndpointInterface'>
- <operation name='echo' parameterOrder='String_1'>
- <input message='tns:EndpointInterface_echo'/>
- <output message='tns:EndpointInterface_echoResponse'/>
- </operation>
- </portType> ]]></programlisting>
+</para>
+
+<programlisting role="XML"><portType name='EndpointInterface'>
+ <operation name='echo' parameterOrder='String_1'>
+ <input message='tns:EndpointInterface_echo'/>
+<output message='tns:EndpointInterface_echoResponse'/>
+ </operation>
+ </portType></programlisting>
+<para>
Operation parameters are defined by individual message parts.
-<programlisting role="XML"><![CDATA[
- <message name='EndpointInterface_echo'>
- <part name='String_1' type='xsd:string'/>
- </message>
- <message name='EndpointInterface_echoResponse'>
- <part name='result' type='xsd:string'/>
- </message>]]></programlisting>
-
+</para>
+
+<programlisting role="XML">
+ <message name='EndpointInterface_echo'>
+ <part name='String_1' type='xsd:string'/>
+ </message>
+ <message name='EndpointInterface_echoResponse'>
+ <part name='result' type='xsd:string'/>
+ </message></programlisting>
+
+<para>
Note, there is no complex type in XML schema that could validate the entire SOAP message payload.
+</para>
-<programlisting>
-<![CDATA[
+<programlisting role="JAVA">
@WebService
@SOAPBinding(style = SOAPBinding.Style.RPC)
public class JSEBean01
@@ -989,8 +994,9 @@
{
...
}
-} ]]></programlisting>
+} </programlisting>
+<para>
The element names of RPC parameters/return values may be defined using the JAX-WS Annotations#javax.jws.WebParam and JAX-WS Annotations#javax.jws.WebResult respectively.
</para>
@@ -1030,7 +1036,8 @@
<section><title>Plain old Java Object (POJO)</title>
<para>Let's take a look at simple POJO endpoint implementation. All endpoint associated metadata is provided via JSR-181 annotations
-<programlisting><![CDATA[@WebService
+ </para>
+<programlisting role="JAVA">@WebService
@SOAPBinding(style = SOAPBinding.Style.RPC)
public class JSEBean01
{
@@ -1039,44 +1046,42 @@
{
...
}
- } ]]></programlisting>
+ } </programlisting>
- </para>
+
</section>
<section><title>The endpoint as a web application</title>
<para>
A JAX-WS java service endpoint (JSE) is deployed as a web application.
-
-<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>
- <url-pattern>/*</url-pattern>
- </servlet-mapping>
-</web-app> ]]>
-</programlisting>
-
</para>
-
+<programlisting><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>
+ <url-pattern>/*</url-pattern>
+ </servlet-mapping>
+</web-app></programlisting>
+
</section>
<section><title>Packaging the endpoint</title>
<para>
A JSR-181 java service endpoint (JSE) is packaged as a web application in a *.war file.
-
-<programlisting><![CDATA[<war warfile="${build.dir}/libs/jbossws-samples-jsr181pojo.war" webxml="${build.resources.dir}/samples/jsr181pojo/WEB-INF/web.xml">
- <classes dir="${build.dir}/classes">
- <include name="org/jboss/test/ws/samples/jsr181pojo/JSEBean01.class"/>
- </classes>
-</war> ]]></programlisting>
+ </para>
-Note, only the endpoint implementation bean and web.xml are required.
+<programlisting role="XML"><war warfile="${build.dir}/libs/jbossws-samples-jsr181pojo.war" webxml="${build.resources.dir}/samples/jsr181pojo/WEB-INF/web.xml">
+ <classes dir="${build.dir}/classes">
+<include name="org/jboss/test/ws/samples/jsr181pojo/JSEBean01.class"/>
+ </classes>
+</war> </programlisting>
+
+<para>
+Note that only the endpoint implementation bean and web.xml are required.
</para>
</section>
@@ -1099,10 +1104,10 @@
<section>
<title>EJB3 Stateless Session Bean (SLSB)</title>
<para>The JAX-WS programming model support the same set of annotations on EJB3 stateless session beans as on <ulink url="http://jbws.dyndns.org/mediawiki/index.php?title=JAX-WS_User_Guide#_Plain_old_Java_Object_.28POJO.29"># Plain old Java Object (POJO)</ulink> endpoints. EJB-2.1 endpoints are supported using the JAX-RPC progamming model.</para>
-<programlisting> <![CDATA[
+<programlisting role="JAVA">
@Stateless
@Remote(EJB3RemoteInterface.class)
- @RemoteBinding(jndiBinding = "/ejb3/EJB3EndpointInterface")
+ @RemoteBinding(jndiBinding = "/ejb3/EJB3EndpointInterface")
@WebService
@SOAPBinding(style = SOAPBinding.Style.RPC)
@@ -1113,14 +1118,14 @@
{
...
}
- }]]> </programlisting>
+ } </programlisting>
<para>Above you see an EJB-3.0 stateless session bean that exposes one method both on the remote interface and on and as an endpoint operation.</para>
<para>
<emphasis role="bold">Packaging the endpoint</emphasis>
</para>
<para>A JSR-181 EJB service endpoint is packaged as an ordinary ejb deployment.</para>
-<programlisting><jar jarfile="${build.dir}/libs/jbossws-samples-jsr181ejb.jar">
+<programlisting role="XML"><jar jarfile="${build.dir}/libs/jbossws-samples-jsr181ejb.jar">
<fileset dir="${build.dir}/classes">
<include name="org/jboss/test/ws/samples/jsr181ejb/EJB3Bean01.class"/>
<include name="org/jboss/test/ws/samples/jsr181ejb/EJB3RemoteInterface.class"/>
@@ -1139,7 +1144,7 @@
<para>JAX-WS services typically implement a native Java service endpoint interface (SEI), perhaps mapped from a WSDL port type, either directly or via the use of annotations.</para>
<para>Java SEIs provide a high level Java-centric abstraction that hides the details of converting between Java objects and their XML representations for use in XML-based messages. However, in some cases it is desirable for services to be able to operate at the XML message level. The Provider interface offers an alternative to SEIs and may be implemented by services wishing to work at the XML message level.</para>
<para>A Provider based service instance’s invoke method is called for each message received for the service.</para>
-<programlisting> <![CDATA[
+<programlisting role="JAVA">
@WebServiceProvider
@ServiceMode(value = Service.Mode.PAYLOAD)
public class ProviderBeanPayload implements Provider<Source>
@@ -1148,13 +1153,13 @@
{
// Access the entire request PAYLOAD and return the response PAYLOAD
}
-}]]> </programlisting>
+} </programlisting>
<para>Note, Service.Mode.PAYLOAD is the default and does not have to be declared explicitly. You can also use Service.Mode.MESSAGE to access the entire SOAP message (i.e. with MESSAGE the Provider can also see SOAP Headers)</para>
</section>
<section>
<title>WebServiceContext</title>
<para>The WebServiceContext is treated as an injectable resource that can be set at the time an endpoint is initialized. The WebServiceContext object will then use thread-local information to return the correct information regardless of how many threads are concurrently being used to serve requests addressed to the same endpoint object.</para>
-<programlisting> <![CDATA[
+<programlisting role="JAVA">
@WebService
public class EndpointJSE
{
@@ -1165,7 +1170,7 @@
public String testGetMessageContext()
{
SOAPMessageContext jaxwsContext = (SOAPMessageContext)wsCtx.getMessageContext();
-return jaxwsContext != null ? "pass" : "fail";
+return jaxwsContext != null ? "pass" : "fail";
}
..
@WebMethod
@@ -1180,8 +1185,7 @@
{
return wsCtx.isUserInRole(role);
}
-}
-]]> </programlisting>
+}</programlisting>
</section>
<section>
<title>Web Service Clients</title>
@@ -1198,15 +1202,15 @@
<para>The generated implementation class can be recognised as it will have two public constructors, one with no arguments and one with two arguments, representing the wsdl location (a java.net.URL) and the service name (a javax.xml.namespace.QName) respectively.</para>
<para>Usually you will use the no-argument constructor. In this case the WSDL location and service name are those found in the WSDL. These are set implicitly from the WebServiceClient annotation that decorates the generated class.</para>
<para>The following code snippet shows the generated constructors from the generated class:</para>
-<programlisting> <![CDATA[
+<programlisting role="JAVA">
// Generated Service Class
- @WebServiceClient(name="StockQuoteService", targetNamespace="http://example.com/stocks", wsdlLocation="http://example.com/stocks.wsdl")
+ @WebServiceClient(name="StockQuoteService", targetNamespace="http://example.com/stocks", wsdlLocation="http://example.com/stocks.wsdl")
public class StockQuoteService extends javax.xml.ws.Service
{
public StockQuoteService()
{
-super(new URL("http://example.com/stocks.wsdl"), new QName("http://example.com/stocks", "StockQuoteService"));
+super(new URL("http://example.com/stocks.wsdl"), new QName("http://example.com/stocks", "StockQuoteService"));
}
public StockQuoteService(String wsdlLocation, QName serviceName)
@@ -1215,16 +1219,16 @@
}
...
-}]]> </programlisting>
+}</programlisting>
<para>Section <ulink url="http://jbws.dyndns.org/mediawiki/index.php?title=JAX-WS_User_Guide#Dynamic_Proxy">#Dynamic Proxy</ulink> explains how to obtain a port from the service and how to invoke an operation on the port. If you need to work with the XML payload directly or with the XML representation of the entire SOAP message, have a look at <ulink url="http://jbws.dyndns.org/mediawiki/index.php?title=JAX-WS_User_Guide#Dispatch">#Dispatch</ulink>.</para>
<para>
<emphasis role="bold">Dynamic case</emphasis>
</para>
<para>In the dynamic case, when nothing is generated, a web service client uses <literal>Service.create</literal> to create Service instances, the following code illustrates this process.</para>
-<programlisting> <![CDATA[
-URL wsdlLocation = new URL("http://example.org/my.wsdl");
-QName serviceName = new QName("http://example.org/sample", "MyService");
-Service service = Service.create(wsdlLocation, serviceName);]]> </programlisting>
+<programlisting role="JAVA">
+URL wsdlLocation = new URL("http://example.org/my.wsdl");
+QName serviceName = new QName("http://example.org/sample", "MyService");
+Service service = Service.create(wsdlLocation, serviceName);</programlisting>
<para>This is the nastiest way to work with JBossWs. Older versions have extensive details on DII as it was then known.</para>
</section>
@@ -1243,7 +1247,7 @@
<section>
<title>Dynamic Proxy</title>
<para>You can create an instance of a client proxy using one of getPort methods on the <ulink url="http://jbws.dyndns.org/mediawiki/index.php?title=JAX-WS_User_Guide#Service">#Service</ulink>.</para>
-<programlisting> <![CDATA[
+<programlisting role="JAVA">
/**
* The getPort method returns a proxy. A service client
* uses this proxy to invoke operations on the target
@@ -1269,12 +1273,12 @@
public <T> T getPort(Class<T> serviceEndpointInterface)
{
...
- }]]> </programlisting>
+ }</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[
- at WebServiceClient(name = "TestEndpointService", targetNamespace = "http://org.jboss.ws/wsref",
- wsdlLocation = "http://localhost.localdomain:8080/jaxws-samples-webserviceref?wsdl")
+<programlisting role="JAVA">
+ at WebServiceClient(name = "TestEndpointService", targetNamespace = "http://org.jboss.ws/wsref",
+ wsdlLocation = "http://localhost.localdomain:8080/jaxws-samples-webserviceref?wsdl")
public class TestEndpointService extends Service
{
@@ -1284,13 +1288,13 @@
super(wsdlLocation, serviceName);
}
- @WebEndpoint(name = "TestEndpointPort")
+ @WebEndpoint(name = "TestEndpointPort")
public TestEndpoint getTestEndpointPort()
{
return (TestEndpoint)super.getPort(TESTENDPOINTPORT, TestEndpoint.class);
}
- }
- ]]> </programlisting>
+ }</programlisting>
+
</section>
<section>
<title>WebServiceRef</title>
@@ -1304,7 +1308,7 @@
<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[
+<programlisting role="XML">
public class EJB3Client implements EJB3Remote
{
@WebServiceRef
@@ -1312,7 +1316,7 @@
@WebServiceRef
public TestEndpoint port3;
-]]> </programlisting>
+</programlisting>
<para>
<emphasis role="bold">WebServiceRef Customization</emphasis>
</para>
@@ -1329,7 +1333,7 @@
</listitem>
</itemizedlist>
<para>Example:</para>
-<programlisting> <![CDATA[
+<programlisting role="XML">
<service-ref>
<service-ref-name>OrganizationService</service-ref-name>
<wsdl-override>file:/wsdlRepository/organization-service.wsdl</wsdl-override>
@@ -1358,9 +1362,9 @@
<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>
+</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>
<title>Dispatch</title>
@@ -1369,16 +1373,17 @@
<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[
+
+<programlisting role="JAVA">
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/'/>";
+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/'/>";
+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>
</section>
<section>
<title>Asynchronous Invocations</title>
@@ -1395,27 +1400,28 @@
</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[
+
+<programlisting role="JAVA">
public void testInvokeAsync() throws Exception
{
-URL wsdlURL = new URL("http://" + getServerHost() + ":8080/jaxws-samples-asynchronous?wsdl");
-QName serviceName = new QName(targetNS, "TestEndpointService");
+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");
+Response response = port.echoAsync("Async");
// access future
String retStr = (String) response.get();
-assertEquals("Async", retStr);
+assertEquals("Async", retStr);
}
-]]> </programlisting>
+ </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[
- at WebService (name="PingEndpoint")
+<programlisting role="JAVA">
+ at WebService (name="PingEndpoint")
@SOAPBinding(style = SOAPBinding.Style.RPC)
public class PingEndpointImpl
{
@@ -1425,18 +1431,17 @@
@Oneway
public void ping()
{
-log.info("ping");
-feedback = "ok";
+log.info("ping");
+feedback = "ok";
}
..
@WebMethod
public String feedback()
{
-log.info("feedback");
+log.info("feedback");
return feedback;
}
-}
-]]> </programlisting>
+}</programlisting>
</section>
</section>
<section>
@@ -1469,14 +1474,13 @@
<section>
<title>Service endpoint handlers</title>
<para>On the service endpoint, handlers are defined using the @HandlerChain annotation.</para>
-<programlisting> <![CDATA[
+<programlisting role="JAVA">
@WebService
- at HandlerChain(file = "jaxws-server-source-handlers.xml")
+ at HandlerChain(file = "jaxws-server-source-handlers.xml")
public class SOAPEndpointSourceImpl
{
...
-}
-]]> </programlisting>
+}</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>
@@ -1484,7 +1488,7 @@
<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[
+<programlisting role="JAVA">
Service service = Service.create(wsdlURL, serviceName);
Endpoint port = (Endpoint)service.getPort(Endpoint.class);
@@ -1494,7 +1498,7 @@
handlerChain.add(new AuthorizationHandler());
handlerChain.add(new RoutingHandler());
bindingProvider.getBinding().setHandlerChain(handlerChain); // important!
-]]> </programlisting>
+</programlisting>
</section>
</section>
<section>
@@ -1504,14 +1508,14 @@
<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[
+<programlisting role="XML">
CommonMessageContext msgContext = MessageContextAssociation.peekMessageContext();
-msgContext.setProperty(<Name>, <Value>);
-]]> </programlisting>
+msgContext.setProperty(<Name>, <Value>);</programlisting>
+
</section>
<section>
<title>Logical Message Context</title>
- <para><ulink url="#">#Logical Handlers</ulink> are passed a message context of type LogicalMessageContext when invoked. LogicalMessageContext extends MessageContext with methods to obtain and modify the message payload, it does not provide access to the protocol specific aspects of amessage. A protocol binding defines what component of a message are available via a logical message context. The SOAP binding defines that a logical handler deployed in a SOAP binding can access the contents of the SOAP body but not the SOAP headers whereas the XML/HTTP binding defines that a logical handler can access the entire XML payload of a message.</para>
+ <para><literal>#Logical Handlers</literal> are passed a message context of type LogicalMessageContext when invoked. LogicalMessageContext extends MessageContext with methods to obtain and modify the message payload, it does not provide access to the protocol specific aspects of amessage. A protocol binding defines what component of a message are available via a logical message context. The SOAP binding defines that a logical handler deployed in a SOAP binding can access the contents of the SOAP body but not the SOAP headers whereas the XML/HTTP binding defines that a logical handler can access the entire XML payload of a message.</para>
</section>
<section>
<title>SOAP Message Context</title>
@@ -1521,23 +1525,24 @@
<section>
<title>Fault Handling</title>
<para>An implementation may thow a SOAPFaultException</para>
-<programlisting> <![CDATA[
+<programlisting role="JAVA">
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");
+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>
<para>or an application specific user exception</para>
-<programlisting> <![CDATA[
+
+<programlisting role="JAVA">
public void throwApplicationException() throws UserException
{
-throw new UserException("validation", 123, "Some validation error");
+throw new UserException("validation", 123, "Some validation error");
}
-]]> </programlisting>
+</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>
@@ -1643,7 +1648,7 @@
<para>
<emphasis role="bold">MTOM enabled service implementations</emphasis>
</para>
-<programlisting> <![CDATA[
+<programlisting role="JAVA">
package org.jboss.test.ws.jaxws.samples.xop.doclit;
import javax.ejb.Remote;
@@ -1652,14 +1657,13 @@
import javax.xml.ws.BindingType;
@Remote
- at WebService(targetNamespace = "http://org.jboss.ws/xop/doclit")
+ at WebService(targetNamespace = "http://org.jboss.ws/xop/doclit")
@SOAPBinding(style = SOAPBinding.Style.DOCUMENT, parameterStyle = SOAPBinding.ParameterStyle.BARE)
- at BindingType(value="http://schemas.xmlsoap.org/wsdl/soap/http?mtom=true") (1)
+ at BindingType(value="http://schemas.xmlsoap.org/wsdl/soap/http?mtom=true") (1)
public interface MTOMEndpoint {
[...]
-}
-]]> </programlisting>
+}</programlisting>
<orderedlist>
<listitem>
<para>The MTOM enabled SOAP 1.1 binding ID</para>
@@ -1669,7 +1673,7 @@
<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[
+<programlisting role="JAVA">
[...]
Service service = Service.create(wsdlURL, serviceName);
port = service.getPort(MTOMEndpoint.class);
@@ -1677,7 +1681,7 @@
// enable MTOM
binding = (SOAPBinding)((BindingProvider)port).getBinding();
binding.setMTOMEnabled(true);
-]]> </programlisting>
+</programlisting>
<para>
<note><title>Note</title>
@@ -1693,7 +1697,7 @@
<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[
+<programlisting role="JAVA">
/**
* Payload bean that will use SwaRef encoding
*/
@@ -1722,10 +1726,9 @@
{
this.data = data;
}
-}
-]]> </programlisting>
+}</programlisting>
<para>With document wrapped endpoints you may even specify the <literal>@XmlAttachmentRef</literal> annotation on the service endpoint interface:</para>
-<programlisting> <![CDATA[
+<programlisting role="JAVA">
@WebService
public interface DocWrappedEndpoint
{
@@ -1736,28 +1739,27 @@
@XmlAttachmentRef
DataHandler parameterAnnotation(@XmlAttachmentRef DataHandler data, String test);
-}
-]]> </programlisting>
+}</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/'>
+<programlisting role="XML">
+<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/'>
+<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>
</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 role="XML">
+<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>
@@ -1841,7 +1843,7 @@
<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[
+<programlisting role="JAVA">
package echo;
@javax.jws.WebService
@@ -1852,10 +1854,10 @@
return input;
}
}
-]]> </programlisting>
+</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[
+<programlisting role="JAVA">
$ javac -d . -classpath jboss-jaxws.jar Echo.java
$ wsprovide -w echo.Echo
Generating WSDL:
@@ -1863,24 +1865,22 @@
Writing Classes:
echo/jaxws/Echo.class
echo/jaxws/EchoResponse.class
-]]> </programlisting>
+</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'/>
+<programlisting role="XML">
+<service name='EchoService'>
+<port binding='tns:EchoBinding' name='EchoPort'>
+<soap:address location='REPLACE_WITH_ACTUAL_URL'/>
</port>
-</service>
-]]> </programlisting>
+</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'/>
+<programlisting role="XML">
+<portType name='Echo'>
+<operation name='echo' parameterOrder='echo'>
+<input message='tns:Echo_echo'/>
+<output message='tns:Echo_echoResponse'/>
</operation>
-</portType>
-]]> </programlisting>
+</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>
@@ -1888,11 +1888,11 @@
</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">
+<programlisting role="XML">
+<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>
@@ -1904,7 +1904,7 @@
<url-pattern>/Echo</url-pattern>
</servlet-mapping>
</web-app>
-]]> </programlisting>
+</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
@@ -2020,24 +2020,23 @@
</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[
- at WebService(name = "Echo", targetNamespace = "http://echo/")
+<programlisting role="JAVA">
+ at WebService(name = "Echo", targetNamespace = "http://echo/")
public interface Echo {
@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")
+ 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 = "")
+ at WebParam(name = "arg0", targetNamespace = "")
String arg0);
-}
-]]> </programlisting>
+}</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[
+<programlisting role="JAVA">
package echo;
- at javax.jws.WebService(endpointInterface="echo.Echo")
+ at javax.jws.WebService(endpointInterface="echo.Echo")
public class EchoImpl implements Echo
{
public String echo(String arg0)
@@ -2045,7 +2044,7 @@
return arg0;
}
}
-]]> </programlisting>
+</programlisting>
</section>
<section>
<title>Client Side</title>
@@ -2058,23 +2057,21 @@
, 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'/>
+<programlisting role="XML">
+<service name='EchoService'>
+<port binding='tns:EchoBinding' name='EchoPort'>
+<soap:address location='REPLACE_WITH_ACTUAL_URL'/>
</port>
-</service>
-]]> </programlisting>
+</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"/>
+<programlisting role="XML">
+<service name="EchoService">
+<port binding="tns:EchoBinding" name="EchoPort">
+<soap:address location="http://localhost.localdomain:8080/echo/Echo"/>
</port>
-</service>
-]]> </programlisting>
+</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[
+<programlisting>
$ wsconsume -k http://localhost:8080/echo/Echo?wsdl
echo/Echo.java
echo/EchoResponse.java
@@ -2087,11 +2084,10 @@
echo/EchoService.java
echo/Echo_Type.java
echo/ObjectFactory.java
-echo/package-info.java
-]]> </programlisting>
+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[
- at WebServiceClient(name = "EchoService", targetNamespace = "http://echo/", wsdlLocation = "http://localhost:8080/echo/Echo?wsdl")
+<programlisting role="JAVA">
+ 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;
@@ -2099,7 +2095,7 @@
static {
URL url = null;
try {
-url = new URL("http://localhost:8080/echo/Echo?wsdl");
+url = new URL("http://localhost:8080/echo/Echo?wsdl");
} catch (MalformedURLException e) {
e.printStackTrace();
}
@@ -2111,15 +2107,14 @@
}
public EchoService() {
-super(ECHOSERVICE_WSDL_LOCATION, new QName("http://echo/", "EchoService"));
+super(ECHOSERVICE_WSDL_LOCATION, new QName("http://echo/", "EchoService"));
}
- at WebEndpoint(name = "EchoPort")
+ at WebEndpoint(name = "EchoPort")
public Echo getEchoPort() {
-return (Echo)super.getPort(new QName("http://echo/", "EchoPort"), Echo.class);
+return (Echo)super.getPort(new QName("http://echo/", "EchoPort"), Echo.class);
}
-}
-]]> </programlisting>
+}</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>
@@ -2129,7 +2124,7 @@
</para>
<para>All that is left to do, is write and compile the client:</para>
-<programlisting> <![CDATA[
+<programlisting role="JAVA">
import echo.*;
..
public class EchoClient
@@ -2138,35 +2133,34 @@
{
if (args.length != 1)
{
-System.err.println("usage: EchoClient <message>");
+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]));
+System.out.println("Server said: " + echo.echo(args[0]));
}
-}
-]]> </programlisting>
+}</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>
<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[
+<programlisting role="JAVA">
...
EchoService service = new EchoService();
Echo echo = service.getEchoPort();
/* Set NEW Endpoint Location */
-String endpointURL = "http://NEW_ENDPOINT_URL";
+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>
+System.out.println("Server said: " + echo.echo(args[0]));
+...</programlisting>
+
</section>
<section>
<title>Command-line & Ant Task Reference</title>
@@ -2232,10 +2226,10 @@
<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[
- 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")
+<programlisting role="JAVA">
+ 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")
@SOAPBinding(style = SOAPBinding.Style.RPC)
public class StatefulEndpointImpl implements StatefulEndpoint, ServiceLifecycle
{
@@ -2250,13 +2244,12 @@
@WebMethod
public String getItems()
{ ... }
-}
-]]> </programlisting>
+}</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">
+<programlisting role="XML">
+<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>
@@ -2267,14 +2260,14 @@
</handler-chain>
</handler-chains>
-]]> </programlisting>
+</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[
+<programlisting role="JAVA">
Service service = Service.create(wsdlURL, serviceName);
port1 = (StatefulEndpoint)service.getPort(StatefulEndpoint.class);
BindingProvider bindingProvider = (BindingProvider)port1;
@@ -2283,93 +2276,92 @@
customHandlerChain.add(new ClientHandler());
customHandlerChain.add(new WSAddressingClientHandler());
bindingProvider.getBinding().setHandlerChain(customHandlerChain);
-]]> </programlisting>
+</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[
+<programlisting role="JAVA">
public class AddressingStatefulTestCase extends JBossWSTest
{
public void testAddItem() throws Exception
{
-port1.addItem("Ice Cream");
-port1.addItem("Ferrari");
+port1.addItem("Ice Cream");
+port1.addItem("Ferrari");
-port2.addItem("Mars Bar");
-port2.addItem("Porsche");
+port2.addItem("Mars Bar");
+port2.addItem("Porsche");
}
public void testGetItems() throws Exception
{
String items1 = port1.getItems();
-assertEquals("[Ice Cream, Ferrari]", items1);
+assertEquals("[Ice Cream, Ferrari]", items1);
String items2 = port2.getItems();
-assertEquals("[Mars Bar, Porsche]", items2);
+assertEquals("[Mars Bar, Porsche]", items2);
}
-}
-]]> </programlisting>
+}</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'>
+<programlisting role="XML">
+<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>
+<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'>
+<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'>
+<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>
+<ns1:clientid xmlns:ns1='http://somens'>clientid-1</ns1:clientid>
</env:Header>
<env:Body>
-<ns1:addItemResponse xmlns:ns1='http://org.jboss.ws/samples/wsaddr'/>
+<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'>
+<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>
+<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'/>
+<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'>
+<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>
+<ns1:clientid xmlns:ns1='http://somens'>clientid-1</ns1:clientid>
</env:Header>
<env:Body>
-<ns1:getItemsResponse xmlns:ns1='http://org.jboss.ws/samples/wsaddr'>
+<ns1:getItemsResponse xmlns:ns1='http://org.jboss.ws/samples/wsaddr'>
<result>[Ice Cream, Ferrari]</result>
</ns1:getItemsResponse>
</env:Body>
</env:Envelope>
-]]> </programlisting>
+</programlisting>
</section>
</section>
<section>
@@ -2442,7 +2434,7 @@
<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[
+<programlisting role="JAVA">
package org.jboss.test.ws.jaxws.samples.wseventing;
..
import javax.jws.WebService;
@@ -2457,12 +2449,12 @@
* @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")
- at EndpointConfig(configName = "Standard WSAddressing Endpoint") (3)
+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);
@@ -2471,8 +2463,7 @@
{
return log;
}
-}
-]]> </programlisting>
+}</programlisting>
<orderedlist>
<listitem>
<para> Of course we need a <literal>@WebService</literal> annotation</para>
@@ -2492,41 +2483,41 @@
<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"?>
+<programlisting role="XML">
+<?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/">
+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' />
+(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 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">
+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: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>
@@ -2534,28 +2525,27 @@
</wsdl:types>
-<wsdl:message name='SystemInfoMsg'>
-<wsdl:part name='body' element='tns:SystemStatus'/>
+<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'/>
+(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: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"/>
+<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
</wsdl:binding>
-</wsdl:definitions>
-]]> </programlisting>
+</wsdl:definitions></programlisting>
<orderedlist>
<listitem>
<para> Import the default eventing WSDL, that includes service and port declarations.</para>
@@ -2574,24 +2564,24 @@
<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[
+<programlisting>
java:/EventDispatcher
-]]> </programlisting>
+</programlisting>
<para>The event dispatcher interface:</para>
-<programlisting> <![CDATA[
+<programlisting role="JAVA">
public interface EventDispatcher
{
void dispatch(URI eventSourceNS, Element payload);
}
-]]> </programlisting>
+</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");
+<programlisting role="JAVA">
+(1) URI eventSourceURI = new URI("http://http://www.jboss.org/sysmon/SystemInfo");
+(2) Element payload = DOMUtils.parse("SOME XML STRING");
try
{
InitialContext iniCtx = getInitialContext();
@@ -2602,8 +2592,7 @@
catch (Exception e)
{
//
-}
-]]> </programlisting>
+} </programlisting>
<orderedlist>
<listitem>
<para> Address your event source correctly (TargetNamespace+PortTypeName)</para>
@@ -2688,23 +2677,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">
+<programlisting role="XML">
+<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"/>
+(6) <sign type="x509v3" alias="wsse"/>
(7) <requires>
(8) <signature/>
</requires>
</config>
</jboss-ws-security>
-]]> </programlisting>
+</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>
@@ -2732,30 +2721,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[
+<programlisting role="JAVA">
@WebService
- at EndpointConfig(configName = "Standard WSSecurity Endpoint")
+ at EndpointConfig(configName = "Standard WSSecurity Endpoint")
public class HelloJavaBean
{
...
}
-]]> </programlisting>
+</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">
+<programlisting role="XML">
+<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"/>
+(2) <sign type="x509v3" alias="wsse"/>
(3) <requires>
(4) <signature/>
</requires>
</config>
</jboss-ws-security>
-]]> </programlisting>
+</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>
@@ -2774,43 +2763,43 @@
<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 role="XML">
+<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/">
+<programlisting role="XML">
+<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: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 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">
+<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>
+</programlisting>
</section>
</section>
@@ -2853,28 +2842,27 @@
<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[
+<programlisting role="XML">
<!-- Datasource to Database-->
-<attribute name="DataSourceUrl">java:/DefaultDS</attribute>
-]]> </programlisting>
+<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-->
- <attribute name="CreateOnStart">false</attribute>
- <!-- Should all tables be dropped on Stop-->
- <attribute name="DropOnStop">true</attribute>
- <!-- Should all tables be dropped on Start-->
- <attribute name="DropOnStart">false</attribute>
- ]]> </programlisting>
+<programlisting role="XML">
+<!-- Should all tables be created on Start-->
+ <attribute name="CreateOnStart">false</attribute>
+ <!-- Should all tables be dropped on Stop-->
+ <attribute name="DropOnStop">true</attribute>
+ <!-- Should all tables be dropped on Start-->
+ <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>
+<programlisting role="XML"><!-- 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>
+<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[
@@ -2924,24 +2912,24 @@
</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");
+<programlisting role="JAVA">
+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);
+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);
+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>
<para>Authentication with the registry.</para>
-<programlisting> <![CDATA[
+<programlisting role="JAVA">
/**
* Does authentication with the uddi registry
*/
@@ -2953,40 +2941,40 @@
connection.setCredentials(creds);
}
-]]> </programlisting>
+</programlisting>
<para>Save a Business</para>
-<programlisting> <![CDATA[
+<programlisting role="JAVA">
/**
* 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"));
+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"));
+serviceBinding.setDescription(blm.createInternationalString("Test Service Binding"));
//Turn validation of URI off
serviceBinding.setValidateURI(false);
-serviceBinding.setAccessURI("http://testjboss.org");
+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");
+PersonName personName = blm.createPersonName("Anil S");
TelephoneNumber telephoneNumber = blm.createTelephoneNumber();
-telephoneNumber.setNumber("111-111-7777");
+telephoneNumber.setNumber("111-111-7777");
telephoneNumber.setType(null);
-PostalAddress address = blm.createPostalAddress("111", "My Drive", "BuckHead", "GA", "USA", "1111-111", "");
+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");
+EmailAddress emailAddress = blm.createEmailAddress("anil at apache.org");
emailAddresses.add(emailAddress);
Collection numbers = new ArrayList();
@@ -2996,22 +2984,22 @@
user.setEmailAddresses(emailAddresses);
user.setTelephoneNumbers(numbers);
-ClassificationScheme cScheme = getClassificationScheme("ntis-gov:naics", "");
-Key cKey = blm.createKey("uuid:C0B9FE13-324F-413D-5A5B-2004DB8E5CC2");
+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");
+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");
+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");
+ExternalIdentifier ei = blm.createExternalIdentifier(cScheme1, "D-U-N-S number", "08-146-6849");
org.addExternalIdentifier(ei);
org.addService(service);
return org;
}
-]]> </programlisting>
+</programlisting>
<para>Query a Business</para>
-<programlisting> <![CDATA[
+<programlisting role="JAVA">
/**
* Locale aware Search a business in the registry
*/
@@ -3026,7 +3014,7 @@
Collection findQualifiers = new ArrayList();
findQualifiers.add(FindQualifier.SORT_BY_NAME_ASC);
Collection namePatterns = new ArrayList();
-String pattern = "%" + bizname + "%";
+String pattern = "%" + bizname + "%";
LocalizedString ls = blm.createLocalizedString(Locale.getDefault(), pattern);
namePatterns.add(ls);
@@ -3037,20 +3025,20 @@
Collection orgs = response.getCollection();
if (orgs == null)
{
-log.debug(" -- Matched 0 orgs");
+log.debug(" -- Matched 0 orgs");
}
else
{
-log.debug(" -- Matched " + orgs.size() + " organizations -- ");
+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));
+log.debug("Org name: " + getName(org));
+log.debug("Org description: " + getDescription(org));
+log.debug("Org key id: " + getKey(org));
checkUser(org);
checkServices(org);
}
@@ -3061,7 +3049,7 @@
connection.close();
}
}
-]]> </programlisting>
+</programlisting>
<para>For more examples of code using the JAXR API, please refer to the resources in the Resources Section.</para>
</section>
<section>
@@ -3121,42 +3109,42 @@
<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[
- at WebService(name = "Hello",
-targetNamespace = "http://org.jboss.ws/samples/wssecuritypolicy",
-wsdlLocation="WEB-INF/wsdl/HelloService.wsdl")
+<programlisting role="JAVA">
+ at 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)
+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'>
+<?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: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: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: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: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:encrypt alias='wsse' type='x509v3'/>
<sp:requires>
<sp:encryption/>
</sp:requires>
@@ -3164,38 +3152,37 @@
</sp:jboss-ws-security>
</wsp:All>
</wsp:Policy>
-<message name='Hello_echoUserType'>
-<part name='user' type='ns1:UserType'/>
+<message name='Hello_echoUserType'>
+<part name='user' type='ns1:UserType'/>
</message>
-<message name='Hello_echoUserTypeResponse'>
-<part name='return' type='ns1:UserType'/>
+<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'/>
+<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=''/>
+<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'/>
+<soap:body namespace='http://org.jboss.ws/samples/wssecuritypolicy' use='literal'/>
</input>
<output>
-<soap:body namespace='http://org.jboss.ws/samples/wssecuritypolicy' use='literal'/>
+<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'/>
+<service name='HelloService'>
+<port binding='tns:HelloBinding' name='HelloPort'>
+<soap:address location='REPLACE_WITH_ACTUAL_URL'/>
</port>
</service>
-</definitions>
-]]> </programlisting>
+</definitions></programlisting>
<para>Please note in the wsdl file the wsp:Policy element and the wsp:PolicyReference in 'HelloBinding' binding Element.</para>
</section>
@@ -3203,8 +3190,7 @@
<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[
-/**
+<programlisting role="JAVA">/**
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@@ -3218,37 +3204,36 @@
public String policyFileLocation();
public PolicyScopeLevel scope();
-}
-]]> </programlisting>
+}</programlisting>
<para>And here you have the previous section example re-implemented using annotations and xml policy file:</para>
-<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 ) })
+<programlisting role="JAVA">
+ at WebService(name = "Hello", targetNamespace = "http://org.jboss.ws/samples/wssecurityAnnotatedpolicy")
+ at 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)
+public UserType echoUserType(@WebParam(name = "user") UserType in0)
{
log.info(in0);
return in0;
}
}
-<?xml version="1.0" encoding="UTF-8"?>
+<?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: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: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:encrypt type="x509v3" alias="wsse"/>
<sp:requires>
<sp:encryption/>
</sp:requires>
@@ -3257,7 +3242,7 @@
</wsp:All>
</wsp:ExactlyOne>
</wsp:Policy>
-]]> </programlisting>
+</programlisting>
</section>
</section>
</section>
@@ -3269,8 +3254,7 @@
<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[
-/**
+<programlisting role="JAVA">/**
* Defines an endpoint or client configuration.
* This annotation is valid on an endpoint implementaion bean or a SEI.
*
@@ -3288,7 +3272,7 @@
* Server side default: Standard Endpoint
* Client side default: Standard Client
*/
-String configName() default "";
+String configName() default "";
...
/**
* The optional config-file element is a URL or resource name for the configuration.
@@ -3296,14 +3280,12 @@
* Server side default: standard-jaxws-endpoint-config.xml
* Client side default: standard-jaxws-client-config.xml
*/
-String configFile() default "";
-}
-]]> </programlisting>
+String configFile() default "";
+}</programlisting>
</section>
<section>
<title>WebContext</title>
-<programlisting> <![CDATA[
-/**
+<programlisting role="JAVA">/**
* Provides web context specific meta data to EJB based web service endpoints.
*
* @author thomas.diesler at jboss.org
@@ -3319,7 +3301,7 @@
*
* Applies to server side port components only.
*/
-String contextRoot() default "";
+String contextRoot() default "";
...
/**
* The virtual hosts that the web service endpoint is deployed to.
@@ -3334,16 +3316,16 @@
*
* Applies to server side port components only.
*/
-String urlPattern() default "";
+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".
+* Legal values for this element are "BASIC", or "CLIENT-CERT".
*/
-String authMethod() default "";
+String authMethod() default "";
/**
* The transportGuarantee specifies that the communication
@@ -3351,31 +3333,30 @@
* 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
+* 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 "";
+String transportGuarantee() default "";
/**
-* A secure endpoint does not by default publish it's wsdl on an unsecure transport.
+* 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>
+} </programlisting>
+
+</section>
<section>
<title>SecurityDomain</title>
-<programlisting> <![CDATA[
-/**
+<programlisting role="JAVA">/**
* Annotation for specifying the JBoss security domain for an EJB
*
-* @author <a href="mailto:bill at jboss.org">Bill Burke</a>
+* @author <a href="mailto:bill at jboss.org">Bill Burke</a>
**/
@Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME)
public @interface SecurityDomain
@@ -3385,17 +3366,16 @@
*
* Do not use the JNDI name
*
-* Good: "MyDomain"
-* Bad: "java:/jaas/MyDomain"
+* Good: "MyDomain"
+* Bad: "java:/jaas/MyDomain"
*/
String value();
/**
* The name for the unauthenticated pricipal
*/
-String unauthenticatedPrincipal() default "";
-}
-]]> </programlisting>
+String unauthenticatedPrincipal() default "";
+}</programlisting>
</section>
</section>
</section>
More information about the jboss-cvs-commits
mailing list