JAX-WS - Adding SOAP Headers

Question

I am trying to create a standalone client to consume some web services  I must add my username and password to the SOAP Header   I tried adding the credentials as follows   OTSWebSvcsService service   new OTSWebSvcsService    OTSWebSvcs port   service getOTSWebSvcs     BindingProvider prov    BindingProvider port  prov getRequestContext   put BindingProvider USERNAME PROPERTY   myusername    prov getRequestContext   put BindingProvider PASSWORD PROPERTY   mypassword           When I call a method on the service I get the following exception   com ibm wsspi wssecurity SoapSecurityException  WSEC5048E  One of  SOAP Header  elements required    What am I doing wrong   How would I add these properties to the SOAP Header    Edited   I was using JAX-WS 2 1 included in JDK6   I am now using JAX-WS 2 2   I now get the following exception   com ibm wsspi wssecurity SoapSecurityException  WSEC5509E  A security token whose type is  http   docs oasis-open org wss 2004 01 oasis-200401-wss-username-token-profile-1 0 UsernameToken  is required    How do I go about creating this token

User · Accepted Answer

Not 100  sure as the question is missing some details but if you are using JAX-WS RI  then have a look at Adding SOAP headers when sending requests      The portable way of doing this is that   you create a SOAPHandler and mess   with SAAJ  but the RI provides a   better way of doing this       When you create a proxy or dispatch   object  they implement   BindingProvider interface  When you   use the JAX-WS RI  you can downcast to   WSBindingProvider which defines a   few more methods provided only by the   JAX-WS RI       This interface lets you set an   arbitrary number of Header object    each representing a SOAP header  You   can implement it on your own if you   want  but most likely you d use one of   the factory methods defined on   Headers class to create one    import com sun xml ws developer WSBindingProvider   HelloPort port   helloService getHelloPort        or something like that    WSBindingProvider bp    WSBindingProvider port   bp setOutboundHeader       simple string value as a header  like  lt simpleHeader gt stringValue lt  simpleHeader gt    Headers create new QName  simpleHeader    stringValue         create a header from JAXB object   Headers create jaxbContext myJaxbObject        Update your code accordingly and try again  And if you re not using JAX-WS RI  please update your question and provide more context information   Update  It appears that the web service you want to call is secured with WS-Security UsernameTokens  This is a bit different from your initial question  Anyway  to configure your client to send usernames and passwords  I suggest to check the great post Implementing the WS-Security UsernameToken Profile for Metro-based web services  jump to step 4   Using NetBeans for this step might ease things a lot

User · Answer

I m adding this answer because none of the others worked for me   I had to add a Header Handler to the Proxy   import java util Set  import java util TreeSet   import javax xml namespace QName  import javax xml soap SOAPElement  import javax xml soap SOAPEnvelope  import javax xml soap SOAPFactory  import javax xml soap SOAPHeader  import javax xml ws handler MessageContext  import javax xml ws handler soap SOAPHandler  import javax xml ws handler soap SOAPMessageContext   public class SOAPHeaderHandler implements SOAPHandler lt SOAPMessageContext gt         private final String authenticatedToken       public SOAPHeaderHandler String authenticatedToken            this authenticatedToken   authenticatedToken             public boolean handleMessage SOAPMessageContext context            Boolean outboundProperty                    Boolean  context get MessageContext MESSAGE OUTBOUND PROPERTY           if  outboundProperty booleanValue                  try                   SOAPEnvelope envelope   context getMessage   getSOAPPart   getEnvelope                    SOAPFactory factory   SOAPFactory newInstance                    String prefix    urn                   String uri    urn xxxx                   SOAPElement securityElem                           factory createElement  Element   prefix  uri                   SOAPElement tokenElem                           factory createElement  Element2   prefix  uri                   tokenElem addTextNode authenticatedToken                   securityElem addChildElement tokenElem                   SOAPHeader header   envelope addHeader                    header addChildElement securityElem                 catch  Exception e                    e printStackTrace                            else                  inbound                   return true             public Set lt QName gt  getHeaders             return new TreeSet               public boolean handleFault SOAPMessageContext context            return false             public void close MessageContext context                         In the proxy  I just add the Handler   BindingProvider bp   BindingProvider basicHttpBindingAuthentication  bp getBinding   getHandlerChain   add new SOAPHeaderHandler authenticatedToken    bp getBinding   getHandlerChain   add new SOAPLoggingHandler

User · Answer

you can add the username and password to the SOAP Header  BindingProvider prov    BindingProvider port  prov getRequestContext   put BindingProvider ENDPOINT ADDRESS PROPERTY                   your end point     Map lt String  List lt String gt  gt  headers   new HashMap lt String  List lt String gt  gt     prov getRequestContext   put BindingProvider USERNAME PROPERTY   myusername    prov getRequestContext   put BindingProvider PASSWORD PROPERTY   mypassword    prov getRequestContext   put MessageContext HTTP REQUEST HEADERS  headers

User · Answer

The best option  for my of course  is do it yourserfl  It means you can modify programattly all parts of the SOAP message  Binding binding   prov getBinding       List lt Handler gt  handlerChain   binding getHandlerChain        handlerChain add  new ModifyMessageHandler          binding setHandlerChain  handlerChain       And the ModifyMessageHandler source could be    Override public boolean handleMessage  SOAPMessageContext context         SOAPMessage msg   context getMessage         try                SOAPEnvelope envelope   msg getSOAPPart   getEnvelope            SOAPHeader header   envelope addHeader            SOAPElement ele   header addChildElement  new QName   http   uri    name of header               ele addTextNode   value of header             ele   header addChildElement  new QName   http   uri    name of header               ele addTextNode   value of header             ele   header addChildElement  new QName   http   uri    name of header               ele addTextNode   value of header            I hope this helps you

User · Answer

In jaxws-rt-2 2 10-ources jar  com sun xml ws transport http client HttpTransportPipe java   public Packet process Packet request            Map lt String  List lt String gt  gt  userHeaders    Map lt String  List lt String gt  gt   request invocationProperties get MessageContext HTTP REQUEST HEADERS           if  userHeaders    null                reqHeaders putAll userHeaders     So  Map lt String  List lt String gt  gt  from requestContext with key MessageContext HTTP REQUEST HEADERS will be copied to SOAP headers  Sample of Application Authentication with JAX-WS via headers  BindingProvider USERNAME PROPERTY and BindingProvider PASSWORD PROPERTY keys are processed special way in HttpTransportPipe addBasicAuth    adding standard basic authorization Authorization header   See also Message Context in JAX-WS

User · Answer

I struggled with all the answers here  starting with Pascal s solution  which is getting harder with the Java compiler not binding against rt jar by default any more  and using internal classes makes it specific to that runtime implementation     The answer from edubriguenti brought me close  The way the handler is hooked up in the final bit of code didn t work for me  though - it was never called   I ended up using a variation of his handler class  but wired it into the javax xml ws Service instance like this    Service service   Service create url  qname   service setHandlerResolver          portInfo - gt  Collections singletonList new SOAPHeaderHandler handlerArgs

User · Answer

Adding an object to header we use the examples used here yet i will complete   ObjectFactory objectFactory   new ObjectFactory            CabeceraCR cabeceraCR  objectFactory createCabeceraCR            cabeceraCR setUsuario  quot xxxxx quot            cabeceraCR setClave  quot xxxxx quot     With object factory we create the object asked to pass on the header  The to add to the header   WSBindingProvider bp    WSBindingProvider wsXXXXXXSoap          bp setOutboundHeaders                     Sets a simple string value as a header                 Headers create jaxbContext objectFactory createCabeceraCR cabeceraCR                       We used the WSBindingProvider to add the header  The object will have some error if used directly so we use the method objectFactory createCabeceraCR cabeceraCR   This method will create a JAXBElement like this on the object Factory    XmlElementDecl namespace    quot http   www creditreport ec  quot   name    quot CabeceraCR quot       public JAXBElement lt CabeceraCR gt  createCabeceraCR CabeceraCR value            return new JAXBElement lt CabeceraCR gt   CabeceraCR QNAME  CabeceraCR class  null  value          And the jaxbContext we obtained like this    jaxbContext    JAXBRIContext  JAXBContext newInstance CabeceraCR class getPackage   getName      This will add the object to the header

User · Answer

Data can be transferred in SOAP header  JaxWS  by using  WebParam header   true     WebMethod operationName    SendRequest   action    http   abcd ru     Oneway public void sendRequest       WebParam name    Message   targetNamespace    http   abcd ru    partName    Message       Data message       WebParam name    ServiceHeader   targetNamespace    http   abcd ru    header   true  partName    ServiceHeader       Header serviceHeader     If you want to generate a client with SOAP Headers  you need to use -XadditionalHeaders   wsimport -keep -Xnocompile -XadditionalHeaders -Xdebug http   12 34 56 78 8080 TestHeaders somewsdl wsdl -d  home evgeny DEVELOPMENT JAVA gen   If don t need  Oneway web service  you can use Holder    WebMethod operationName    SendRequest   action    http   abcd ru    public void sendRequest       WebParam name    Message   targetNamespace    http   abcd ru    partName    Message       Data message       WebParam name    ServiceHeader   targetNamespace    http   abcd ru    header   true  partName    ServiceHeader       Holder lt Header gt  serviceHeader

User · Answer

Also  if you re using Maven to build your project  you ll need to add the following dependency        lt dependency gt           lt groupId gt com sun xml ws lt  groupId gt           lt artifactId gt jaxws-rt lt  artifactId gt           lt version gt  currentversion  version gt       lt  dependency gt    This provides you with the class com sun xml ws developer WSBindingProvider   Link  https   mvnrepository com artifact com sun xml ws jaxws-rt

User · Answer

Use maven and the plugin jaxws-maven-plugin  this will generate a web service client  Make sure you are setting the xadditionalHeaders to true  This will generate methods with header inputs

[java] JAX-WS - Adding SOAP Headers

Examples related to java

Examples related to web-services

Examples related to soap

Examples related to jax-ws

Examples related to ws-security