WSAddressingUtilities.java

  1. /*
  2.  * GovWay - A customizable API Gateway 
  3.  * https://govway.org
  4.  * 
  5.  * Copyright (c) 2005-2025 Link.it srl (https://link.it). 
  6.  * 
  7.  * This program is free software: you can redistribute it and/or modify
  8.  * it under the terms of the GNU General Public License version 3, as published by
  9.  * the Free Software Foundation.
  10.  *
  11.  * This program is distributed in the hope that it will be useful,
  12.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14.  * GNU General Public License for more details.
  15.  *
  16.  * You should have received a copy of the GNU General Public License
  17.  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18.  *
  19.  */



  23. package org.openspcoop2.message.soap.wsaddressing;

  25. import java.util.HashMap;

  27. import javax.xml.namespace.QName;
  28. import javax.xml.soap.SOAPHeader;
  29. import javax.xml.soap.SOAPHeaderElement;

  31. import org.apache.commons.lang.StringUtils;
  32. import org.openspcoop2.message.OpenSPCoop2MessageFactory;
  33. import org.openspcoop2.message.OpenSPCoop2SoapMessage;
  34. import org.openspcoop2.message.exception.MessageException;
  35. import org.openspcoop2.message.soap.SoapUtils;
  36. import org.openspcoop2.message.xml.ValidatoreXSD;
  37. import org.slf4j.Logger;


  40. /**
  41.  * Classe contenenti utilities per le integrazioni.
  42.  *
  43.  * @author Poli Andrea (apoli@link.it)
  44.  * @author $Author$
  45.  * @version $Rev$, $Date$
  46.  */
  47. public class WSAddressingUtilities {

  49.     private Logger log;
  50.     public WSAddressingUtilities(Logger log) {
  51.         this.log = log;
  52.     }
  53.     
  54.     
  55.     
  56.     
  57.     // ***** BUILD *****
  58.     
  59.     public WSAddressingHeader build(OpenSPCoop2SoapMessage msg,String actor,  
  60.             WSAddressingValue values) throws MessageException {
  61.         return this.build(msg, actor, false, values);
  62.     }
  63.     public WSAddressingHeader build(OpenSPCoop2SoapMessage msg,String actor, boolean mustUnderstand, 
  64.             WSAddressingValue values) throws MessageException {
  65.         WSAddressingHeader hdr = new WSAddressingHeader();
  66.         if(!StringUtils.isEmpty(values.getTo())) {
  67.             hdr.setTo(buildWSATo(msg, actor, mustUnderstand, values.getTo()));
  68.         }
  69.         if(!StringUtils.isEmpty(values.getFrom())) {
  70.             hdr.setFrom(buildWSAFrom(msg, actor, mustUnderstand, values.getFrom()));
  71.         }
  72.         if(!StringUtils.isEmpty(values.getAction())) {
  73.             hdr.setAction(buildWSAAction(msg, actor, mustUnderstand, values.getAction()));
  74.         }
  75.         if(!StringUtils.isEmpty(values.getId())) {
  76.             hdr.setId(buildWSAID(msg, actor, mustUnderstand, values.getId()));
  77.         }
  78.         if(!StringUtils.isEmpty(values.getRelatesTo())) {
  79.             hdr.setRelatesTo(buildWSARelatesTo(msg, actor, mustUnderstand, values.getRelatesTo()));
  80.         }
  81.         if(!StringUtils.isEmpty(values.getReplyTo())) {
  82.             hdr.setReplyTo(buildWSAReplyTo(msg, actor, mustUnderstand, values.getReplyTo()));
  83.         }
  84.         if(!StringUtils.isEmpty(values.getFaultTo())) {
  85.             hdr.setFaultTo(buildWSAFaultTo(msg, actor, mustUnderstand, values.getFaultTo()));
  86.         }
  87.         return hdr;
  88.     }
  89.     
  90.     public void addHeader(WSAddressingHeader headerWSAddressing, OpenSPCoop2SoapMessage msg) throws MessageException{
  91.         
  92.         try {
  93.         
  94.             if(headerWSAddressing!=null && msg!=null) {
  95.                 
  96.                 SOAPHeader header = msg.getSOAPHeader();
  97.                 if(header==null){
  98.                     header = msg.getSOAPPart().getEnvelope().addHeader();
  99.                 }
  100.                 
  101.                 if(headerWSAddressing.getTo()!=null) {
  102.                     msg.addHeaderElement(header, headerWSAddressing.getTo());
  103.                 }
  104.                 if(headerWSAddressing.getFrom()!=null) {
  105.                     msg.addHeaderElement(header, headerWSAddressing.getFrom());
  106.                 }
  107.                 if(headerWSAddressing.getAction()!=null) {
  108.                     msg.addHeaderElement(header, headerWSAddressing.getAction());
  109.                 }
  110.                 if(headerWSAddressing.getId()!=null) {
  111.                     msg.addHeaderElement(header, headerWSAddressing.getId());
  112.                 }
  113.                 if(headerWSAddressing.getRelatesTo()!=null) {
  114.                     msg.addHeaderElement(header, headerWSAddressing.getRelatesTo());
  115.                 }
  116.                 if(headerWSAddressing.getReplyTo()!=null) {
  117.                     msg.addHeaderElement(header, headerWSAddressing.getReplyTo());
  118.                 }
  119.                 if(headerWSAddressing.getFaultTo()!=null) {
  120.                     msg.addHeaderElement(header, headerWSAddressing.getFaultTo());
  121.                 }
  122.             }
  123.             
  124.         }catch(Exception e) {
  125.             throw new MessageException(e.getMessage(),e);
  126.         }
  127.         
  128.     }
  129.     
  130.     
  131.     
  132.     // ***** BUILD STATIC UTILS *****
  133.     
  134.     private static final boolean BUILD_VALUE_AS_EPR = true;
  135.     private static final boolean BUILD_VALUE_RAW = false;
  136.     
  137.     public static SOAPHeaderElement buildWSATo(OpenSPCoop2SoapMessage msg,String actor,boolean mustUnderstand, String value) throws MessageException{
  138.         QName name =  new QName(Costanti.WSA_NAMESPACE,Costanti.WSA_SOAP_HEADER_TO,Costanti.WSA_PREFIX);
  139.         SOAPHeaderElement header = WSAddressingUtilities.buildHeaderElement(msg,name,
  140.                 value,actor,mustUnderstand, BUILD_VALUE_RAW);
  141.         return header;
  142.     }
  143.     
  144.     public static SOAPHeaderElement buildWSAFrom(OpenSPCoop2SoapMessage msg,String actor,boolean mustUnderstand, String value) throws MessageException{
  145.         QName name =  new QName(Costanti.WSA_NAMESPACE,Costanti.WSA_SOAP_HEADER_FROM,Costanti.WSA_PREFIX);
  146.         SOAPHeaderElement header = WSAddressingUtilities.buildHeaderElement(msg,name,
  147.                 value,actor,mustUnderstand, BUILD_VALUE_AS_EPR);
  148.         return header;
  149.     }
  150.     
  151.     public static SOAPHeaderElement buildWSAAction(OpenSPCoop2SoapMessage msg,String actor,boolean mustUnderstand, String value) throws MessageException{
  152.         QName name =  new QName(Costanti.WSA_NAMESPACE,Costanti.WSA_SOAP_HEADER_ACTION,Costanti.WSA_PREFIX);
  153.         SOAPHeaderElement header = WSAddressingUtilities.buildHeaderElement(msg,name,
  154.                 value,actor,mustUnderstand, BUILD_VALUE_RAW);
  155.         return header;
  156.     }
  157.     
  158.     public static SOAPHeaderElement buildWSAID(OpenSPCoop2SoapMessage msg,String actor,boolean mustUnderstand, String value) throws MessageException{
  159.         QName name =  new QName(Costanti.WSA_NAMESPACE,Costanti.WSA_SOAP_HEADER_ID,Costanti.WSA_PREFIX);
  160.         SOAPHeaderElement header = WSAddressingUtilities.buildHeaderElement(msg,name,
  161.                 value,actor,mustUnderstand, BUILD_VALUE_RAW);
  162.         return header;
  163.     }
  164.     
  165.     public static SOAPHeaderElement buildWSARelatesTo(OpenSPCoop2SoapMessage msg,String actor, boolean mustUnderstand, String value) throws MessageException{
  166.         QName name =  new QName(Costanti.WSA_NAMESPACE,Costanti.WSA_SOAP_HEADER_RELATES_TO,Costanti.WSA_PREFIX);
  167.         SOAPHeaderElement header = WSAddressingUtilities.buildHeaderElement(msg,name,
  168.                 value,actor,mustUnderstand, BUILD_VALUE_RAW);
  169.         return header;
  170.     }
  171.     
  172.     public static SOAPHeaderElement buildWSAReplyTo(OpenSPCoop2SoapMessage msg,String actor,boolean mustUnderstand, String value) throws MessageException{
  173.         QName name =  new QName(Costanti.WSA_NAMESPACE,Costanti.WSA_SOAP_HEADER_REPLY_TO,Costanti.WSA_PREFIX);
  174.         SOAPHeaderElement header = WSAddressingUtilities.buildHeaderElement(msg,name,
  175.                 value,actor,mustUnderstand, BUILD_VALUE_AS_EPR);
  176.         return header;
  177.     }
  178.     
  179.     public static SOAPHeaderElement buildWSAFaultTo(OpenSPCoop2SoapMessage msg,String actor,boolean mustUnderstand, String value) throws MessageException{
  180.         QName name =  new QName(Costanti.WSA_NAMESPACE,Costanti.WSA_SOAP_HEADER_FAULT_TO,Costanti.WSA_PREFIX);
  181.         SOAPHeaderElement header = WSAddressingUtilities.buildHeaderElement(msg,name,
  182.                 value,actor,mustUnderstand, BUILD_VALUE_AS_EPR);
  183.         return header;
  184.     }
  185.         
  186.     private static SOAPHeaderElement buildHeaderElement(OpenSPCoop2SoapMessage msg,QName name,String value,String actor,boolean mustUnderstand, boolean epr) throws MessageException{
  187.         
  188.         try {
  189.         
  190.             SOAPHeader hdr = msg.getSOAPHeader();
  191.             if(hdr==null){
  192.                 hdr = msg.getSOAPPart().getEnvelope().addHeader(); 
  193.             }
  194.             SOAPHeaderElement element = msg.newSOAPHeaderElement(hdr, name); 
  195.             if(actor!=null) {
  196.                 element.setActor(actor);
  197.             }
  198.             element.setMustUnderstand(mustUnderstand);
  199.             
  200.             if(epr==false){
  201.                 element.setValue(value);
  202.             }
  203.             else{
  204.                 QName nameAddressEPR =  new QName(Costanti.WSA_NAMESPACE,Costanti.WSA_SOAP_HEADER_EPR_ADDRESS,Costanti.WSA_PREFIX);
  205.                 element.addChildElement(nameAddressEPR).setValue(value);
  206.             }
  207.             return element;
  208.             
  209.         }catch(Exception e) {
  210.             throw new MessageException(e.getMessage(),e);
  211.         }
  212.         
  213.     }
  214.     

  216.     
  217.     
  218.     
  219.     
  220.     // ***** VALIDATE *****
  221.     
  222.     private static HashMap<String, ValidatoreXSD> _validatoreXSDMap = new HashMap<>();
  223.     private static synchronized void _initValidatore(OpenSPCoop2MessageFactory messageFactory, Logger log){
  224.         String key = messageFactory.getClass().getName();
  225.         if(!_validatoreXSDMap.containsKey(key)){
  226.             try{
  227.                 ValidatoreXSD val = new ValidatoreXSD(messageFactory, log,WSAddressingUtilities.class.getResourceAsStream("/ws-addr.xsd"));
  228.                 _validatoreXSDMap.put(key, val);
  229.             }catch(Exception e){
  230.                 log.error("ws-addr.xsd, errore durante la costruzione del validatore xsd: "+e.getMessage(),e);
  231.             }
  232.         }
  233.     }
  234.     public ValidatoreXSD getValidatoreXSD(OpenSPCoop2MessageFactory messageFactory){
  235.         String key = messageFactory.getClass().getName();
  236.         if(!_validatoreXSDMap.containsKey(key)){
  237.             _initValidatore(messageFactory, this.log);
  238.         }
  239.         return _validatoreXSDMap.get(key);
  240.     }
  241.     
  242.     
  243.     public void validate(OpenSPCoop2SoapMessage message, WSAddressingHeader header) throws MessageException {
  244.         this.log.debug("Validazione XSD...");
  245.         _validaElementoWSA(getValidatoreXSD(message.getFactory()),header.getTo(),message);
  246.         _validaElementoWSA(getValidatoreXSD(message.getFactory()),header.getFrom(),message);
  247.         _validaElementoWSA(getValidatoreXSD(message.getFactory()),header.getAction(),message);
  248.         _validaElementoWSA(getValidatoreXSD(message.getFactory()),header.getId(),message);
  249.         _validaElementoWSA(getValidatoreXSD(message.getFactory()),header.getRelatesTo(),message);
  250.         _validaElementoWSA(getValidatoreXSD(message.getFactory()),header.getReplyTo(),message);
  251.         _validaElementoWSA(getValidatoreXSD(message.getFactory()),header.getFaultTo(),message);
  252.         this.log.debug("Validazione XSD effettuate");
  253.     }
  254.     
  255.     private void _validaElementoWSA(ValidatoreXSD validatoreXSD,SOAPHeaderElement headerElement,OpenSPCoop2SoapMessage msg) throws MessageException{
  256.         if(headerElement!=null){
  257.             try {
  258.                 this.log.debug("Validazione XSD ["+headerElement.getLocalName()+"]...");
  259.                 // validazione XSD
  260.                 if(validatoreXSD==null)
  261.                     throw new Exception("Validatore XSD non istanziato");
  262.                 validatoreXSD.valida(new java.io.ByteArrayInputStream(msg.getAsByte(headerElement, false)));
  263.             }catch(Exception e) {
  264.                 throw new MessageException(e.getMessage(),e);
  265.             }
  266.         }
  267.     }
  268.     
  269.     
  270.     
  271.     
  272.     
  273.     
  274.     // ***** READ *****
  275.     
  276.     public WSAddressingHeader read(OpenSPCoop2SoapMessage message, String actor) throws MessageException{
  277.         return this.read(message, actor, false);
  278.     }
  279.     public WSAddressingHeader read(OpenSPCoop2SoapMessage message, String actor, boolean validate) throws MessageException{
  280.         SOAPHeader header = null;
  281.         try{
  282.             header = message.getSOAPHeader();
  283.         }catch(Exception e){
  284.             throw new MessageException(e.getMessage(),e);
  285.         }
  286.         return this.read(message, header, actor, validate);
  287.     }
  288.     public WSAddressingHeader read(OpenSPCoop2SoapMessage message, SOAPHeader header, String actor) throws MessageException{
  289.         return this.read(message, header, actor, false);
  290.     }
  291.     public WSAddressingHeader read(OpenSPCoop2SoapMessage message, SOAPHeader header, String actor, boolean validate) throws MessageException{
  292.         try{

  294.             if(header==null){
  295.                 return null;
  296.             }
  297.             
  298.             SOAPHeaderElement wsaTO = null; 
  299.             SOAPHeaderElement wsaFROM = null; 
  300.             SOAPHeaderElement wsaAction = null; 
  301.             SOAPHeaderElement wsaID = null; 
  302.             SOAPHeaderElement wsaRelatesTo = null; 
  303.             SOAPHeaderElement wsaReplyTo = null; 
  304.             SOAPHeaderElement wsaFaultTo = null; 
  305.             
  306.             java.util.Iterator<?> it = header.examineAllHeaderElements();
  307.             while( it.hasNext()  ){
  308.                 // Test Header Element
  309.                 SOAPHeaderElement headerElement = (SOAPHeaderElement) it.next();
  310.                 
  311.                 //Controllo Namespace
  312.                 String namespace = headerElement.getNamespaceURI();
  313.                 String actorCheck = SoapUtils.getSoapActor(headerElement, message.getMessageType());
  314.                 
  315.                 boolean actorCompatible = false;
  316.                 if(actor==null) {
  317.                     actorCompatible = (actorCheck==null);
  318.                 }
  319.                 else {
  320.                     actorCompatible = actor.equals(actorCheck);
  321.                 }
  322.                 
  323.                 if(actorCompatible && Costanti.WSA_NAMESPACE.equals(namespace)){
  324.                     
  325.                     if(Costanti.WSA_SOAP_HEADER_TO.equals(headerElement.getLocalName())){
  326.                         wsaTO = headerElement;
  327.                     }
  328.                     else if(Costanti.WSA_SOAP_HEADER_FROM.equals(headerElement.getLocalName())){
  329.                         wsaFROM = headerElement;
  330.                     }
  331.                     else if(Costanti.WSA_SOAP_HEADER_ACTION.equals(headerElement.getLocalName())){
  332.                         wsaAction = headerElement;
  333.                     }
  334.                     else if(Costanti.WSA_SOAP_HEADER_ID.equals(headerElement.getLocalName())){
  335.                         wsaID = headerElement;
  336.                     }
  337.                     else if(Costanti.WSA_SOAP_HEADER_RELATES_TO.equals(headerElement.getLocalName())){
  338.                         wsaRelatesTo = headerElement;
  339.                     }
  340.                     else if(Costanti.WSA_SOAP_HEADER_REPLY_TO.equals(headerElement.getLocalName())){
  341.                         wsaReplyTo = headerElement;
  342.                     }
  343.                     else if(Costanti.WSA_SOAP_HEADER_FAULT_TO.equals(headerElement.getLocalName())){
  344.                         wsaFaultTo = headerElement;
  345.                     }
  346.                 }
  347.                 
  348.             }
  349.             
  350.             WSAddressingHeader wsaHeader = new WSAddressingHeader();
  351.             wsaHeader.setTo(wsaTO);
  352.             wsaHeader.setFrom(wsaFROM);
  353.             wsaHeader.setAction(wsaAction);
  354.             wsaHeader.setId(wsaID);
  355.             wsaHeader.setRelatesTo(wsaRelatesTo);
  356.             wsaHeader.setReplyTo(wsaReplyTo);
  357.             wsaHeader.setFaultTo(wsaFaultTo);
  358.             
  359.             if(validate) {
  360.                 this.validate(message, wsaHeader);
  361.             }
  362.             
  363.             return wsaHeader;
  364.             
  365.         }catch(Exception e){
  366.             throw new MessageException(e.getMessage(),e);
  367.         }
  368.     }
  369.         
  370.     
  371.     
  372.     
  373.     // ***** DELETE *****
  374.     
  375.     public void delete(OpenSPCoop2SoapMessage message,String actor) throws MessageException{

  377.         try{

  379.             SOAPHeader header = message.getSOAPHeader();
  380.             if(header==null){
  381.                 return;
  382.             }
  383.             
  384.             SOAPHeaderElement wsaTO = null; 
  385.             SOAPHeaderElement wsaFROM = null; 
  386.             SOAPHeaderElement wsaAction = null; 
  387.             SOAPHeaderElement wsaID = null; 
  388.             SOAPHeaderElement wsaRelatesTo = null; 
  389.             SOAPHeaderElement wsaReplyTo = null; 
  390.             SOAPHeaderElement wsaFaultTo = null; 
  391.             
  392.             java.util.Iterator<?> it = header.examineAllHeaderElements();
  393.             while( it.hasNext()  ){
  394.                 // Test Header Element
  395.                 SOAPHeaderElement headerElement = (SOAPHeaderElement) it.next();
  396.                 
  397.                 //Controllo Namespace
  398.                 String namespace = headerElement.getNamespaceURI();
  399.                 String actorCheck = SoapUtils.getSoapActor(headerElement, message.getMessageType());
  400.                 
  401.                 boolean actorCompatible = false;
  402.                 if(actor==null) {
  403.                     actorCompatible = (actorCheck==null);
  404.                 }
  405.                 else {
  406.                     actorCompatible = actor.equals(actorCheck);
  407.                 }
  408.                 
  409.                 if(actorCompatible && Costanti.WSA_NAMESPACE.equals(namespace)){
  410.                     if(Costanti.WSA_SOAP_HEADER_TO.equals(headerElement.getLocalName())){
  411.                         wsaTO = headerElement;
  412.                     }
  413.                     else if(Costanti.WSA_SOAP_HEADER_FROM.equals(headerElement.getLocalName())){
  414.                         wsaFROM = headerElement;
  415.                     }
  416.                     else if(Costanti.WSA_SOAP_HEADER_ACTION.equals(headerElement.getLocalName())){
  417.                         wsaAction = headerElement;
  418.                     }
  419.                     else if(Costanti.WSA_SOAP_HEADER_ID.equals(headerElement.getLocalName())){
  420.                         wsaID = headerElement;
  421.                     }
  422.                     else if(Costanti.WSA_SOAP_HEADER_RELATES_TO.equals(headerElement.getLocalName())){
  423.                         wsaRelatesTo = headerElement;
  424.                     }
  425.                     else if(Costanti.WSA_SOAP_HEADER_REPLY_TO.equals(headerElement.getLocalName())){
  426.                         wsaReplyTo = headerElement;
  427.                     }
  428.                     else if(Costanti.WSA_SOAP_HEADER_FAULT_TO.equals(headerElement.getLocalName())){
  429.                         wsaFaultTo = headerElement;
  430.                     }
  431.                 }
  432.                 
  433.                 
  434.             }
  435.             if(wsaTO==null && wsaFROM==null  &&  wsaAction==null && wsaID==null  &&  wsaRelatesTo==null &&  wsaReplyTo==null &&  wsaFaultTo==null){
  436.                 return;
  437.             }
  438.             
  439.             // delete
  440.             if(wsaTO!=null){
  441.                 header.removeChild(wsaTO);
  442.             }
  443.             if(wsaFROM!=null){
  444.                 header.removeChild(wsaFROM);
  445.             }
  446.             if(wsaAction!=null){
  447.                 header.removeChild(wsaAction);
  448.             }
  449.             if(wsaID!=null){
  450.                 header.removeChild(wsaID);
  451.             }   
  452.             if(wsaRelatesTo!=null){
  453.                 header.removeChild(wsaRelatesTo);
  454.             }
  455.             if(wsaReplyTo!=null){
  456.                 header.removeChild(wsaReplyTo);
  457.             }
  458.             if(wsaFaultTo!=null){
  459.                 header.removeChild(wsaFaultTo);
  460.             }
  461.         
  462.         }catch(Exception e){
  463.             throw new MessageException(e.getMessage(),e);
  464.         }
  465.     }
  466. }
Created with JaCoCo 0.8.8.202204050719