JAX-WS client what s the correct path to access the local WSDL

Question

The problem is I need to build a web service client from a file I m been provided  I ve stored this file on the local file system and  while I keep the WSDL file in the correct file system folder  everything is fine  When I deploy it to a server or remove the WSDL from the file system folder the proxy can t find the WSDL and rises an error  I ve searched the web and I ve found the following posts yet I m not been able to make it work  JAX-WS Loading WSDL from jar http   www java net forum topic glassfish metro-and-jaxb client-jar-cant-find-local-wsdl-0 http   blog vinodsingh com 2008 12 locally-packaged-wsdl html  I m using NetBeans 6 1  this is a legacy application I ve to update with this new web service client   Below is the JAX-WS proxy class         WebServiceClient name    SOAService   targetNamespace    http   soaservice eci ibm com    wsdlLocation    file  C  local path to wsdl SOAService wsdl   public class SOAService     extends Service        private final static URL SOASERVICE WSDL LOCATION      private final static Logger logger   Logger getLogger com ibm eci soaservice SOAService class getName          static           URL url   null          try               URL baseUrl              baseUrl   com ibm eci soaservice SOAService class getResource                   url   new URL baseUrl   file  C  local path to wsdl SOAService wsdl              catch  MalformedURLException e                logger warning  Failed to create URL for the wsdl Location   file  C  local path to wsdl SOAService wsdl   retrying as a local file                logger warning e getMessage                       SOASERVICE WSDL LOCATION   url             public SOAService URL wsdlLocation  QName serviceName            super wsdlLocation  serviceName              public SOAService             super SOASERVICE WSDL LOCATION  new QName  http   soaservice eci ibm com     SOAService                            return            returns SOAServiceSoap              WebEndpoint name    SOAServiceSOAP       public SOAServiceSoap getSOAServiceSOAP             return super getPort new QName  http   soaservice eci ibm com     SOAServiceSOAP    SOAServiceSoap class                          param features            A list of   link javax xml ws WebServiceFeature  to configure on the proxy   Supported features not in the  lt code gt features lt  code gt  parameter will have their default values          return            returns SOAServiceSoap              WebEndpoint name    SOAServiceSOAP       public SOAServiceSoap getSOAServiceSOAP WebServiceFeature    features            return super getPort new QName  http   soaservice eci ibm com     SOAServiceSOAP    SOAServiceSoap class  features               This is my code to use the proxy       WebServiceClient annotation   SOAService class getAnnotation WebServiceClient class         trying to replicate proxy settings    URL baseUrl   com ibm eci soaservice SOAService class getResource       note   proxy uses        URL url   new URL baseUrl    WEB-INF wsdl client SOAService wsdl         URL wsdlUrl   this getClass   getResource   META-INF wsdl SOAService wsdl        SOAService serviceObj   new SOAService url  new QName annotation targetNamespace    annotation name         proxy   serviceObj getSOAServiceSOAP          baseUrl        classes com ibm eci soaservice      URL url   new URL baseUrl               wsdl SOAService wsdl        proxy   new SOAService   getSOAServiceSOAP           updating service endpoint     Map lt String  Object gt  ctxt     BindingProvider proxy   getRequestContext       ctxt put JAXWSProperties HTTP CLIENT STREAMING CHUNK SIZE  8192      ctxt put BindingProvider ENDPOINT ADDRESS PROPERTY  WebServiceUrl     NetBeans put a copy of the WSDL in web-inf wsdl client SOAService  so I don t want to add it to META-INF too  Service classes are in WEB-INF classes com ibm eci soaservice  and baseurl variable contains the filesystem full path to it  c  path to the project    soaservice    The above code raises the error      javax xml ws WebServiceException  Failed to access the WSDL at  file  WEB-INF wsdl client SOAService wsdl  It failed with              WEB-INF wsdl client SOAService wsdl  cannot find the path      So  first of all  shall I update the wsdllocation of the proxy class  Then how do I tell the SOAService class in WEB-INF classes com ibm eci soaservice to search for the WSDL in  WEB-INF wsdl client SOAService wsdl   EDITED  I ve found this other link - http   jianmingli com wp  cat 41  which say to put the WSDL into the classpath  I m ashamed to ask  how do I put it into the web application classpath

User · Accepted Answer

The best option is to use jax-ws-catalog.xml

When you compile the local WSDL file , override the WSDL location and set it to something like

http://localhost/wsdl/SOAService.wsdl

Don't worry this is only a URI and not a URL , meaning you don't have to have the WSDL available at that address.
You can do this by passing the wsdllocation option to the wsdl to java compiler.

Doing so will change your proxy code from

static {
    URL url = null;
    try {
        URL baseUrl;
        baseUrl = com.ibm.eci.soaservice.SOAService.class.getResource(".");
        url = new URL(baseUrl, "file:/C:/local/path/to/wsdl/SOAService.wsdl");
    } catch (MalformedURLException e) {
        logger.warning("Failed to create URL for the wsdl Location: 'file:/C:/local/path/to/wsdl/SOAService.wsdl', retrying as a local file");
        logger.warning(e.getMessage());
    }
    SOASERVICE_WSDL_LOCATION = url;
}

to

static {
    URL url = null;
    try {
        URL baseUrl;
        baseUrl = com.ibm.eci.soaservice.SOAService.class.getResource(".");
        url = new URL(baseUrl, "http://localhost/wsdl/SOAService.wsdl");
    } catch (MalformedURLException e) {
        logger.warning("Failed to create URL for the wsdl Location: 'http://localhost/wsdl/SOAService.wsdl', retrying as a local file");
        logger.warning(e.getMessage());
    }
    SOASERVICE_WSDL_LOCATION = url;
}

Notice file:// changed to http:// in the URL constructor.

Now comes in jax-ws-catalog.xml. Without jax-ws-catalog.xml jax-ws will indeed try to load the WSDL from the location

http://localhost/wsdl/SOAService.wsdl

and fail, as no such WSDL will be available.

But with jax-ws-catalog.xml you can redirect jax-ws to a locally packaged WSDL whenever it tries to access the WSDL @

http://localhost/wsdl/SOAService.wsdl

.

Here's jax-ws-catalog.xml

<catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog" prefer="system">
        <system systemId="http://localhost/wsdl/SOAService.wsdl"
                uri="wsdl/SOAService.wsdl"/>
    </catalog>

What you are doing is telling jax-ws that when ever it needs to load WSDL from

http://localhost/wsdl/SOAService.wsdl

, it should load it from local path wsdl/SOAService.wsdl.

Now where should you put wsdl/SOAService.wsdl and jax-ws-catalog.xml ? That's the million dollar question isn't it ?
It should be in the META-INF directory of your application jar.

so something like this

ABCD.jar  
|__ META-INF    
    |__ jax-ws-catalog.xml  
    |__ wsdl  
        |__ SOAService.wsdl

This way you don't even have to override the URL in your client that access the proxy. The WSDL is picked up from within your JAR, and you avoid having to have hard-coded filesystem paths in your code.

More info on jax-ws-catalog.xml http://jax-ws.java.net/nonav/2.1.2m1/docs/catalog-support.html

Hope that helps

User · Answer

For those of you using Spring  you can simply reference any classpath-resource using the classpath-protocol  So in case of the wsdlLocation  this becomes    lt wsdlLocation gt classpath META-INF webservice wsdl lt  wsdlLocation gt    Note that is not standard Java behavior  See also  http   docs spring io spring docs current spring-framework-reference html resources html

User · Answer

Had the exact same problem that is described herein  No matter what I did  following the above examples  to change the location of my WSDL file  in our case from a web server   it was still referencing the original location embedded within the source tree of the server process   After MANY hours trying to debug this  I noticed that the Exception was always being thrown from the exact same line  in my case 41   Finally this morning  I decided to just send my source client code to our trade partner so they can at least understand how the code looks  but perhaps build their own  To my shock and horror I found a bunch of class files mixed in with my  java files within my client source tree  How bizarre   I suspect these were a byproduct of the JAX-WS client builder tool   Once I zapped those silly  class files and performed a complete clean and rebuild of the client code  everything works perfectly   Redonculous    YMMV  Andrew

User · Answer

Thanks a ton for Bhaskar Karambelkar s answer which explains in detail and fixed my issue  But also I would like to re phrase the answer in three simple steps for someone who is in a hurry to fix    Make your wsdl local location reference as wsdlLocation   http   localhost wsdl yourwsdlname wsdl  Create a META-INF folder right under the src  Put your wsdl file s in a folder under META-INF  say META-INF wsdl Create an xml file jax-ws-catalog xml under META-INF as below   lt catalog xmlns  urn oasis names tc entity xmlns xml catalog      prefer  system  gt       lt system systemId  http   localhost wsdl yourwsdlname wsdl  uri  wsdl yourwsdlname wsdl    gt   lt  catalog gt    Now package your jar  No more reference to the local directory  it s all packaged and referenced within

User · Answer

One other approach that we have taken successfully is to generate the WS client proxy code using wsimport  from Ant  as an Ant task  and specify the wsdlLocation attribute    lt wsimport debug  true  keep  true  verbose  false  target  2 1  sourcedestdir    generated client   wsdl    src   wsdl file   wsdlLocation    wsdl file   gt   lt  wsimport gt    Since we run this for a project w  multiple WSDLs  the script resolves the   wsdl file  value dynamically which is set up to be  META-INF wsdl YourWebServiceName wsdl relative to the JavaSource location  or  src  depending on how you have your project set up    During the build proess  the WSDL and XSDs files are copied to this location and packaged in the JAR file    similar to the solution described by Bhasakar above   MyApp jar    META-INF       wsdl          YourWebServiceName wsdl          YourWebServiceName schema1 xsd          YourWebServiceName schmea2 xsd   Note  make sure the WSDL files are using relative refrerences to any imported XSDs and not http URLs      lt types gt       lt xsd schema gt         lt xsd import namespace  http   valueobject common services xyz com   schemaLocation  YourWebService schema1 xsd   gt       lt  xsd schema gt       lt xsd schema gt         lt xsd import namespace  http   exceptions util xyz com   schemaLocation  YourWebService schema2 xsd   gt       lt  xsd schema gt     lt  types gt    In the generated code  we find this          This class was generated by the JAX-WS RI     JAX-WS RI 2 2-b05-    Generated source version  2 1          WebServiceClient name    YourService   targetNamespace    http   test webservice services xyz com    wsdlLocation     META-INF wsdl YourService wsdl   public class YourService Service     extends Service        private final static URL YOURWEBSERVICE WSDL LOCATION      private final static WebServiceException YOURWEBSERVICE EXCEPTION      private final static QName YOURWEBSERVICE QNAME   new QName  http   test webservice services xyz com     YourService         static           YOURWEBSERVICE WSDL LOCATION   com xyz services webservice test YourService Service class getResource   META-INF wsdl YourService wsdl            WebServiceException e   null          if  YOURWEBSERVICE WSDL LOCATION    null                e   new WebServiceException  Cannot find   META-INF wsdl YourService wsdl  wsdl  Place the resource correctly in the classpath                       YOURWEBSERVICE EXCEPTION   e             public YourService Service             super   getWsdlLocation    YOURWEBSERVICE QNAME              public YourService Service URL wsdlLocation  QName serviceName            super wsdlLocation  serviceName                                  return            returns YourService              WebEndpoint name    YourServicePort       public YourService getYourServicePort             return super getPort new QName  http   test webservice services xyz com     YourServicePort    YourService class                                  param features            A list of   link javax xml ws WebServiceFeature  to configure on the proxy   Supported features not in the  lt code gt features lt  code gt  parameter will have their default values          return            returns YourService              WebEndpoint name    YourServicePort       public YourService getYourServicePort WebServiceFeature    features            return super getPort new QName  http   test webservice services xyz com     YourServicePort    YourService class  features              private static URL   getWsdlLocation             if  YOURWEBSERVICE EXCEPTION   null                throw YOURWEBSERVICE EXCEPTION                    return YOURWEBSERVICE WSDL LOCATION             Perhaps this might help too   It s just a different approach that does not use the  catalog  approach

User · Answer

For those who are still coming for solution here  the easiest solution would be to use  lt wsdlLocation gt   without changing any code  Working steps are given below    Put your wsdl to resource directory like   src main resource In pom file  add both wsdlDirectory and wsdlLocation don t miss   at the beginning of wsdlLocation   like below  While wsdlDirectory is used to generate code and wsdlLocation is used at runtime to create dynamic proxy    lt wsdlDirectory gt src main resources mydir lt  wsdlDirectory gt   lt wsdlLocation gt  mydir my wsdl lt  wsdlLocation gt   Then in your java code with no-arg constructor    MyPort myPort   new MyPortService   getMyPort     For completeness  I am providing here full code generation part  with fluent api in generated code    lt plugin gt   lt groupId gt org codehaus mojo lt  groupId gt   lt artifactId gt jaxws-maven-plugin lt  artifactId gt   lt version gt 2 5 lt  version gt    lt dependencies gt       lt dependency gt           lt groupId gt org jvnet jaxb2 commons lt  groupId gt           lt artifactId gt jaxb2-fluent-api lt  artifactId gt           lt version gt 3 0 lt  version gt       lt  dependency gt       lt dependency gt           lt groupId gt com sun xml ws lt  groupId gt           lt artifactId gt jaxws-tools lt  artifactId gt           lt version gt 2 3 0 lt  version gt       lt  dependency gt   lt  dependencies gt    lt executions gt       lt execution gt           lt id gt wsdl-to-java-generator lt  id gt           lt goals gt               lt goal gt wsimport lt  goal gt           lt  goals gt           lt configuration gt               lt xjcArgs gt                   lt xjcArg gt -Xfluent-api lt  xjcArg gt               lt  xjcArgs gt               lt keep gt true lt  keep gt               lt wsdlDirectory gt src main resources package lt  wsdlDirectory gt               lt wsdlLocation gt  package my wsdl lt  wsdlLocation gt               lt sourceDestDir gt   project build directory  generated-sources annotations jaxb lt  sourceDestDir gt               lt packageName gt full package here lt  packageName gt           lt  configuration gt       lt  execution gt   lt  executions gt

[java] JAX-WS client : what's the correct path to access the local WSDL?

Examples related to java

Examples related to netbeans

Examples related to client

Examples related to jax-ws