SOAPEncoder: Add support to modify soap message manually (#1503)

* Add support to modify soap message manually

This small extension adds the possibility to manually set soap headers.
An example is given in the javadoc.

* Increment copyright year

* Fix code formatting

* Increment copyright year

* Increment copyright year

* Fix formatting

* Improve implementation

Co-authored-by: Marvin Froeder <velo@users.noreply.github.com>

Author: Laess3r

soap/src/main/java/feign/soap/SOAPDecoder.java

@@ -1,5 +1,5 @@
 /**
- * Copyright 2012-2020 The Feign Authors
+ * Copyright 2012-2021 The Feign Authors
  *
  * <p>Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file
  * except in compliance with the License. You may obtain a copy of the License at

soap/src/main/java/feign/soap/SOAPEncoder.java

@@ -1,5 +1,5 @@
 /**
- * Copyright 2012-2020 The Feign Authors
+ * Copyright 2012-2021 The Feign Authors
  *
  * <p>Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file
  * except in compliance with the License. You may obtain a copy of the License at
@@ -121,6 +121,9 @@ public void encode(Object object, Type bodyType, RequestTemplate template) {
           SOAPMessage.WRITE_XML_DECLARATION, Boolean.toString(writeXmlDeclaration));
       soapMessage.setProperty(SOAPMessage.CHARACTER_SET_ENCODING, charsetEncoding.displayName());
       soapMessage.getSOAPBody().addDocument(document);
+
+      soapMessage = modifySOAPMessage(soapMessage);
+
       ByteArrayOutputStream bos = new ByteArrayOutputStream();
       if (formattedOutput) {
         Transformer t = TransformerFactory.newInstance().newTransformer();
@@ -141,6 +144,30 @@ public void encode(Object object, Type bodyType, RequestTemplate template) {
     }
   }
 
+  /**
+   * Override this in order to modify the SOAP message object before it's finally encoded. <br>
+   * This might be useful to add SOAP Headers, which are not supported by this SOAPEncoder directly.
+   * <br>
+   * This is an example of how to add a security header: <code>
+   *   protected SOAPMessage modifySOAPMessage(SOAPMessage soapMessage) throws SOAPException {
+   *     SOAPFactory soapFactory = SOAPFactory.newInstance();
+   *     String uri = "http://schemas.xmlsoap.org/ws/2002/12/secext";
+   *     String prefix = "wss";
+   *     SOAPElement security = soapFactory.createElement("Security", prefix, uri);
+   *     SOAPElement usernameToken = soapFactory.createElement("UsernameToken", prefix, uri);
+   *     usernameToken.addChildElement("Username", prefix, uri).setValue("test");
+   *     usernameToken.addChildElement("Password", prefix, uri).setValue("test");
+   *     security.addChildElement(usernameToken);
+   *     soapMessage.getSOAPHeader().addChildElement(security);
+   *     return soapMessage;
+   *   }
+   * </code>
+   */
+  protected SOAPMessage modifySOAPMessage(SOAPMessage soapMessage) throws SOAPException {
+    // Intentionally blank
+    return soapMessage;
+  }
+
   /** Creates instances of {@link SOAPEncoder}. */
   public static class Builder {
 

soap/src/main/java/feign/soap/SOAPErrorDecoder.java

@@ -1,5 +1,5 @@
 /**
- * Copyright 2012-2020 The Feign Authors
+ * Copyright 2012-2021 The Feign Authors
  *
  * <p>Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file
  * except in compliance with the License. You may obtain a copy of the License at

soap/src/test/java/feign/soap/SOAPCodecTest.java

@@ -1,5 +1,5 @@
 /**
- * Copyright 2012-2020 The Feign Authors
+ * Copyright 2012-2021 The Feign Authors
  *
  * <p>Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file
  * except in compliance with the License. You may obtain a copy of the License at

soap/src/test/java/feign/soap/SOAPFaultDecoderTest.java

@@ -1,5 +1,5 @@
 /**
- * Copyright 2012-2020 The Feign Authors
+ * Copyright 2012-2021 The Feign Authors
  *
  * <p>Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file
  * except in compliance with the License. You may obtain a copy of the License at

soap/src/test/java/feign/soap/package-info.java

@@ -1,5 +1,5 @@
 /**
- * Copyright 2012-2020 The Feign Authors
+ * Copyright 2012-2021 The Feign Authors
  *
  * <p>Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file
  * except in compliance with the License. You may obtain a copy of the License at