Create CXF Client

By admin | September 23, 2011 | Updated : May 17, 2020 cxf, soap, webservice, wsimport, 4 Comments

Create CXF Client Example explains step by step details of how to create a CXF web service client / wsdl soap client using Apache CXF WebService Framework

For Creating Apache CXF Client, We are using org.apache.cxf.jaxws.JaxWsProxyFactoryBean. The factory option is particular to CXF and it is non-standard. This will give you a great control over the endpoint.

The Other options like Wsimport tool available with JDK are standard but that will give you less control. For example you can add a logging interceptor in order to show the logs when accessing your service using org.apache.cxf.jaxws.JaxWsProxyFactoryBean.

For publishing a web service, you can follow this tutorial CXF Web Service Tutorial. This client is based on mentioned Tutorial

Note

For running this client you need to refer the classes created on CXF Web Service Tutorial

You can also read about implementing an Asynchronous client CXF Asynchronous Client

Required Libraries

You need to download following libraries in order to Generate CXF Client

Following jar must be in classpath

cxf-core-3.3.6.jar
cxf-rt-bindings-soap-3.3.6.jar
cxf-rt-databinding-jaxb-3.3.6.jar
cxf-rt-features-logging-3.3.6.jar
cxf-rt-frontend-jaxws-3.3.6.jar
cxf-rt-frontend-simple-3.3.6.jar
cxf-rt-transports-http-3.3.6.jar
cxf-rt-wsdl-3.3.6.jar
httpasyncclient-4.1.4.jar
httpclient-4.5.12.jar
httpcore-4.4.13.jar
httpcore-nio-4.4.13.jar
neethi-3.1.1.jar
slf4j-api-1.7.29.jar
slf4j-jdk14-1.7.29.jar
spring-aop-5.1.14.RELEASE.jar
spring-beans-5.1.14.RELEASE.jar
spring-context-5.1.14.RELEASE.jar
spring-core-5.1.14.RELEASE.jar
spring-expression-5.1.14.RELEASE.jar
spring-jcl-5.1.14.RELEASE.jar
spring-web-5.1.14.RELEASE.jar
stax2-api-3.1.4.jar
woodstox-core-5.0.3.jar
wsdl4j-1.6.3.jar
xmlschema-core-2.2.5.jar

Create CXF Client

import org.apache.cxf.ext.logging.LoggingInInterceptor;
import org.apache.cxf.ext.logging.LoggingOutInterceptor;
import org.apache.cxf.jaxws.JaxWsProxyFactoryBean;

import com.student.ChangeStudentDetails;
import com.student.Student;

// CXF JAX-WS Client / Consuming Web Services With CXF

public final class StudentClient {

    public static void main(String args[]) throws Exception {

      JaxWsProxyFactoryBean factory = new JaxWsProxyFactoryBean();

      factory.setServiceClass(ChangeStudentDetails.class);
      factory.setAddress("http://localhost:8080/CXFTutorial/ChangeStudent?wsdl");
      factory.getInInterceptors().add(new LoggingInInterceptor());
      factory.getOutInterceptors().add(new LoggingOutInterceptor());
      ChangeStudentDetails client = (ChangeStudentDetails) factory.create();
      Student student = new Student();
      student.setName("Rockey");
      Student changeName = client.changeName(student);
      System.out.println("Server said: " + changeName.getName());
      System.exit(0);
    }
}

Output

Server said: Hello Rockey

You might also like following tutorials :

4 Responses to "Create CXF Client"

lacike 2011-11-09 20:47:01.0

For all you that are wondering where to get the service class - just make a reference to server project classes folder in client project build path ;-)

admin 2011-11-11 20:27:01.0

Thanks for your suggestion, I have updated the post

sorty 2011-11-13 20:47:01.0

When invoking the client, it takes 50-60 seconds after i am getting <b>java.net.SocketTimeoutException: Read timed out</b>, following are the stacktrace,,,, could you help me

Caused by: org.apache.cxf.interceptor.Fault: Could not send Message.
at org.apache.cxf.interceptor.MessageSenderInterceptor$MessageSenderEndingInterceptor.handleMessage(MessageSenderInterceptor.java:64)
at org.apache.cxf.phase.PhaseInterceptorChain.doIntercept(PhaseInterceptorChain.java:220)
at org.apache.cxf.endpoint.ClientImpl.invoke(ClientImpl.java:276)
at org.apache.cxf.endpoint.ClientImpl.invoke(ClientImpl.java:222)
at org.apache.cxf.frontend.ClientProxy.invokeSync(ClientProxy.java:73)
at org.apache.cxf.jaxws.JaxWsClientProxy.invoke(JaxWsClientProxy.java:171)
... 26 more
Caused by: java.net.SocketTimeoutException: Read timed out
at java.net.SocketInputStream.socketRead0(Native Method)
at java.net.SocketInputStream.read(SocketInputStream.java:129)
at java.io.BufferedInputStream.fill(BufferedInputStream.java:218)
at java.io.BufferedInputStream.read1(BufferedInputStream.java:258)
at java.io.BufferedInputStream.read(BufferedInputStream.java:317)
at sun.net.www.http.HttpClient.parseHTTPHeader(HttpClient.java:687)
at sun.net.www.http.HttpClient.parseHTTP(HttpClient.java:632)
at sun.net.www.protocol.http.HttpURLConnection.getInputStream(HttpURLConnection.java:1000)
at java.net.HttpURLConnection.getResponseCode(HttpURLConnection.java:373)
at org.apache.cxf.transport.http.HTTPConduit$WrappedOutputStream.handleResponse(HTTPConduit.java:1900)
at org.apache.cxf.transport.http.HTTPConduit$WrappedOutputStream.close(HTTPConduit.java:1828)
at org.apache.cxf.transport.AbstractConduit.close(AbstractConduit.java:66)
at org.apache.cxf.transport.http.HTTPConduit.close(HTTPConduit.java:590)
at org.apache.cxf.interceptor.MessageSenderInterceptor$MessageSenderEndingInterceptor.handleMessage(MessageSenderInterceptor.java:62)
... 31 more

admin 2011-11-14 12:47:11.0

@sorty,

You can use <b>HTTPConduit</b> and <b>HTTPClientPolicy</b> and need to set <b>ConnectionTimeout</b> and <b>ReceiveTimeout</b> when invoking the service, please see the below code

import org.apache.cxf.endpoint.Client;
import org.apache.cxf.frontend.ClientProxy;
import org.apache.cxf.interceptor.LoggingInInterceptor;
import org.apache.cxf.interceptor.LoggingOutInterceptor;
import org.apache.cxf.jaxws.JaxWsProxyFactoryBean;
import org.apache.cxf.transport.http.HTTPConduit;
import org.apache.cxf.transports.http.configuration.HTTPClientPolicy;

import com.student.ChangeStudentDetails;
import com.student.Student;

// How to handle <b>java.net.SocketTimeoutException: Read timed out exception</b>

public final class StudentClient {

public static void main(String args[]) throws Exception {

JaxWsProxyFactoryBean factory = new JaxWsProxyFactoryBean();
long timeout = 10000L;

factory.setServiceClass(ChangeStudentDetails.class);
factory.setAddress(http://localhost:8080/CXFTutorial/ChangeStudent);
factory.getInInterceptors().add(new LoggingInInterceptor());
factory.getOutInterceptors().add(new LoggingOutInterceptor());
ChangeStudentDetails ChangeStudentService = (ChangeStudentDetails) factory.create();

Client client = ClientProxy.getClient(ChangeStudentService);
if (client != null) {
HTTPConduit conduit = (HTTPConduit) client.getConduit();
HTTPClientPolicy policy = new HTTPClientPolicy();
policy.setConnectionTimeout(timeout);
policy.setReceiveTimeout(timeout);
conduit.setClient(policy);
}

Student student = new Student();
student.setName(Rockey);
Student changeName = ChangeStudentService.changeName(student);
System.out.println(Server said: + changeName.getName());
System.exit(0);
}
}

Note; Here we are using CXF's JaxWsProxyFactoryBean, if you need to set timeout in JAX-WS way, you can set
request timeout on request context property. See the code below

java.util.Map<string, object=""> requestContext =((javax.xml.ws.BindingProvider) port).getRequestContext();
requestContext.put(com.sun.xml.internal.ws.request.timeout, new Long(600000));</string,>

Required Libraries

Create CXF Client

Output

Related Posts