[CONF] Apache CXF 2.0 Documentation: JAX-WS Configuration (page edited)

[confluence]

Page Edited : CXF20DOC : JAX-WS Configuration JAX-WS Configuration has been edited by willem jiang (Mar 03, 2008). Change summary: Added <jaxws:server> and <jaxws:client> samples (View changes) Content: Please see the Configuration section to learn how to supply a configuration to CXF. The following sections include just JAX-WS specific configuration items. Configuring an Endpoint A JAX-WS Endpoint can be configured in XML in addition to using the JAX-WS APIs. Once you've created your server implementation, you simply need to provide the class name and an address. Here is a simple example: <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:jaxws="http://cxf.apache.org/jaxws" xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.0.xsd http://cxf.apache.org/jaxws http://cxf.apache.org/schemas/jaxws.xsd"> <jaxws:endpoint id="classImpl" implementor="org.apache.cxf.jaxws.service.Hello" endpointName="e:HelloEndpointCustomized" serviceName="s:HelloServiceCustomized" address="http://localhost:8080/test" xmlns:e="http://service.jaxws.cxf.apache.org/endpoint" xmlns:s="http://service.jaxws.cxf.apache.org/service"/> </beans> Be sure to include the JAX-WS schemaLocation attribute specified on the root beans element. This allows CXF to validate the file and is required. Also note the namespace declarations at the end of the <jaxws:endpoint/> tag--these are required because the combined "{namespace}localName" syntax is presently not supported for this tag's attribute values. The jaxws:endpoint element supports many additional attributes: Name Value endpointName The endpoint name this service is implementing, it maps to the wsdl:[EMAIL PROTECTED] In the format of "ns:ENDPOINT_NAME" where ns is a namespace prefix valid at this scope. publish Whether the endpoint should be published now, or whether it will be published at a later point. serviceName The service name this service is implementing, it maps to the wsdl:[EMAIL PROTECTED] In the format of "ns:SERVICE_NAME" where ns is a namespace prefix valid at this scope. wsdlLocation The location of the WSDL. Can be on the classpath, file system, or be hosted remotely. bindingUri The bindingUri for the service model to use address The service publish address bus The bus name that will be used in the jaxws endpoint. implementor The implementor of jaxws endpoint. You can specify the implementor class name here, or just the ref bean name in the format of "#REF_BEAN_NAME" implementorClass The implementor class name, it is really useful when you specify the implementor with the ref bean which is wrapped by using Spring AOP It also supports many child elements: Name Value jaxws:executor A Java executor which will be used for the service. This can be supplied using the Spring <bean class="MyExecutor"/> syntax. jaxws:inInterceptors The incoming interceptors for this endpoint. A list of <bean>s or <ref>s. jaxws:inFaultInterceptors The incoming fault interceptors for this endpoint. A list of <bean>s or <ref>s. jaxws:outInterceptors The outgoing interceptors for this endpoint. A list of <bean>s or <ref>s. jaxws:outFaultInterceptors The outgoing fault interceptors for this endpoint. A list of <bean>s or <ref>s. jaxws:properties A properties map which should be supplied to the JAX-WS endpoint. See below. jaxws:dataBinding You can specify the which DataBinding will be use in the endpoint , This can be supplied using the Spring <bean class="MyDataBinding"/> syntax. jaxws:binding You can specify the BindingFactory for this endpoint to use. This can be supplied using the Spring <bean class="MyBindingFactory"/> syntax. jaxws:features The features that hold the interceptors for this endpoint. A list of <bean>s or <ref>s jaxws:invoker The invoker which will be supplied to this endpoint. This can be supplied using the Spring <bean class="MyInvoker"/> syntax. jaxws:schemaLocations The schema locations for endpoint to use. A list of <schemaLocation>s jaxws:serviceFactory The service factory for this endpoint to use. This can be supplied using the Spring <bean class="MyServiceFactory"/> syntax Here is a more advanced example which shows how to provide interceptors and properties: <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:jaxws="http://cxf.apache.org/jaxws" xmlns:soap="http://cxf.apache.org/bindings/soap" xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.0.xsd http://cxf.apache.org/bindings/soap http://cxf.apache.org/schemas/configuration/soap.xsd http://cxf.apache.org/jaxws http://cxf.apache.org/schemas/jaxws.xsd"> <import resource="classpath:META-INF/cxf/cxf.xml"/> <import resource="classpath:META-INF/cxf/cxf-extension-soap.xml"/> <jaxws:endpoint id="helloWorld" implementor="demo.spring.HelloWorldImpl" address="http://localhost/HelloWorld"> <jaxws:inInterceptors> <bean class="com.acme.SomeInterceptor"/> <ref bean="anotherInterceptor"/> </jaxws:inInterceptor> <jaxws:properties> <entry key="mtom-enabled" value="true"/> </jaxws:properties> </jaxws:endpoint> <bean id="anotherInterceptor" class="com.acme.SomeInterceptor"/> <jaxws:endpoint id="simpleWithBinding" implementor="#greeter" address="http://localhost:8080/simpleWithAddress"> <jaxws:binding> <soap:soapBinding mtomEnabled="true" version="1.2"/> </jaxws:binding> </jaxws:endpoint> <jaxws:endpoint id="inlineInvoker" address="http://localhost:8080/simpleWithAddress"> <jaxws:implementor> <bean class="org.apache.hello_world_soap_http.GreeterImpl"/> </jaxws:implementor> <jaxws:invoker> <bean class="org.apache.cxf.jaxws.spring.NullInvoker"/> </jaxws:invoker> </jaxws:endpoint> </beans> If you are a Spring user, you'll notice that the jaxws:properties element follows the Spring Map syntax. Configuring a Client Proxy Building a Client using this configuration is only applicable for those wishing to inject a Client into their Spring ApplicationContext. To build a Client using Spring, you'll need to declare a proxy factory bean and also a client bean which is created by that proxy factory. Here is an example: <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:jaxws="http://cxf.apache.org/jaxws" xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.0.xsd http://cxf.apache.org/jaxws http://cxf.apache.org/schemas/jaxws.xsd"> <bean id="proxyFactory" class="org.apache.cxf.jaxws.JaxWsProxyFactoryBean"> <property name="serviceClass" value="demo.spring.HelloWorld"/> <property name="address" value="http://localhost:9002/HelloWorld"/> </bean> <bean id="client" class="demo.spring.HelloWorld" factory-bean="proxyFactory" factory-method="create"/> </beans> The JaxWsProxyFactoryBean in this case takes two properties. The service class, which is the interface of the Client proxy you wish to create. The address is the address of the service you wish to call. The second bean definition is for the client. In this case it implements the HelloWorld interface and is created by the proxyFactory <bean> by calling the create() method. You can then reference this "client" bean and inject it anywhere into your application. Here is an example of a very simple Java class which accesses the client bean: include org.springframework.context.support.ClassPathXmlApplicationContext; public final class HelloWorldClient { private HelloWorldClient() { } public static void main(String args[]) throws Exception { ClassPathXmlApplicationContext context = new ClassPathXmlApplicationContext( new String[]{"my/path/to/client-beans.xml"}); HelloWorld client = (HelloWorld)context.getBean("client"); String response = client.sayHi("Dan"); System.out.println("Response: " + response); System.exit(0); } } The ProxyFactoryBean supports many other properties: Name Value clientFactoryBean The ClientFactoryBean used in construction of this proxy. password The password which the transport should use. username The username which the transport should use. wsdlURL The wsdl the client should use to configure itself. Configuring an Endpoint/Client Proxy Using CXF APIs JAX-WS endpoints and client proxies are implemented on top of CXF's frontend-neutral endpoint API. You can therefore use CXF APIs to enhance the functionality of a JAX-WS endpoint or client proxy, for example by adding interceptors. To cast a client proxy to a CXF client: GreeterService gs = new GreeterService(); Greeter greeter = gs.getGreeterPort(); org.apache.cxf.endpoint.Client client = org.apache.cxf.frontend.ClientProxy.getClient(greeter); org.apache.cxf.endpoint.Endpoint cxfEndpoint = client.getEndpoint(); cxfEndpoint.getOutInterceptors().add(...); To cast a JAX-WS endpoint to a CXF server: javax.xml.ws.Endpoint jaxwsEndpoint = javax.xml.ws.Endpoint.publish("http://localhost:9020/SoapContext/GreeterPort", new GreeterImpl()); org.apache.cxf.jaxws.EndpointImpl jaxwsEndpointImpl = (org.apache.cxf.jaxws.EndpointImpl)jaxwsEndpoint; org.apache.cxf.endpoint.Server server = jaxwsEndpointImpl.getServer(); org.apache.cxf.endpoint.Endpoint cxfEndpoint = server.getEndpoint(); cxfEndpoint.getOutInterceptors().add(...); org.apache.cxf.service.Service cxfService = cxfEndpoint.getService(); cxfService.getOutInterceptors().add(...); Configure the JAXWS Server/Client Using Spring CXF provides <jaxws:server>, <jaxws:client> to configure the server/client side endpoint. Here are some exmples: <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:jaxws="http://cxf.apache.org/jaxws" xmlns:soap="http://cxf.apache.org/bindings/soap" xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.0.xsd http://cxf.apache.org/bindings/soap http://cxf.apache.org/schemas/configuration/soap.xsd http://cxf.apache.org/jaxws http://cxf.apache.org/schemas/jaxws.xsd"> <jaxws:server id="inlineImplementor" address="http://localhost:8080/simpleWithAddress"> <jaxws:serviceBean> <bean class="org.apache.hello_world_soap_http.GreeterImpl"/> </jaxws:serviceBean> </jaxws:server> <jaxws:server id="bookServer" serviceClass="org.apache.cxf.anonymous_complex_type.AnonymousComplexTypeImpl" address="http://localhost:8080/act" bus="cxf"> <jaxws:invoker> <bean class="org.apache.cxf.service.invoker.BeanInvoker"> <constructor-arg> <bean class="org.apache.cxf.anonymous_complex_type.AnonymousComplexTypeImpl"/> </constructor-arg> </bean> </jaxws:invoker> <jaxws:dataBinding> <bean class="org.apache.cxf.jaxb.JAXBDataBinding"> <property name="namespaceMap"> <map> <entry> <key><value>http://cxf.apache.org/anonymous_complex_type/</value></key> <value>BeepBeep</value> </entry> </map> </property> </bean> </jaxws:dataBinding> </jaxws:server> <jaxws:client id="bookClient" serviceClass="org.apache.cxf.anonymous_complex_type.AnonymousComplexType" address="http://localhost:8080/act"/> </beans> Since JAXWS frontend server and client spring configuration parser are inherited from simple front, Please ref Simple Frontend Configuration for the attribute and elements definition.

Powered by Atlassian Confluence (Version: 2.2.9 Build:#527 Sep 07, 2006) - Bug/feature request

Unsubscribe or edit your notifications preferences