TransportRequestContext.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.  */

  21. package org.openspcoop2.utils.transport;

  23. import java.util.List;
  24. import java.util.Map;
  25. import java.util.Set;
  26. import java.util.stream.Collectors;

  28. import org.openspcoop2.utils.LoggerWrapperFactory;
  29. import org.openspcoop2.utils.UtilsException;
  30. import org.openspcoop2.utils.transport.http.HttpConstants;
  31. import org.slf4j.Logger;

  33. /**
  34.  * RequestContext
  35.  *
  36.  * @author Poli Andrea (apoli@link.it)
  37.  * @author $Author$
  38.  * @version $Rev$, $Date$
  39.  */


  42. public class TransportRequestContext implements java.io.Serializable {


  45.     /**
  46.      * 
  47.      */
  48.     private static final long serialVersionUID = 1L;
  49.         
  50.     /* ---- Coppie nome/valori di invocazione form-based --- */
  51.     protected Map<String, List<String>> parameters;
  52.     /* ---- Coppie nome/valori di invocazione inserite nell'header del trasporto --- */
  53.     protected Map<String, List<String>> headers;
  54.     /* ---- Coppie nome/valori dei cookie --- */
  55.     protected Map<String, String> cookiesValue;
  56.     protected Map<String, Integer> cookiesMaxAge;
  57.     
  58.     protected Credential credential = null;
  59.     
  60.     protected String webContext = null; // es. openspcoop2
  61.     protected String requestURI = null;
  62.     
  63.     protected String requestType = null; // GET/POST/...
  64.     
  65.     protected String source = null; // location es. https://ip:socketPort
  66.     
  67.     protected String protocolName = null; // identificativo del protocollo
  68.     protected String protocolWebContext = null; // webcontext utilizzato per indirizzare il protocollo, ad esempio verra' assegnato api per trasparente.
  69.     
  70.     protected String function = null;
  71.     protected String functionParameters = null;
  72.     protected String interfaceName = null; // Nome PD o PA
  73.     
  74.     protected Logger log = null;
  75.     
  76.     public TransportRequestContext() throws UtilsException{
  77.         this(null);
  78.     }
  79.     public TransportRequestContext(Logger log) throws UtilsException{
  80.         if(log==null) {
  81.             this.log = LoggerWrapperFactory.getLogger(TransportRequestContext.class);
  82.         }
  83.         else {
  84.             this.log = log;
  85.         }
  86.     }
  87.     
  88.     
  89.     public Credential getCredential() {
  90.         return this.credential;
  91.     }
  92.     public String getWebContext() {
  93.         return this.webContext;
  94.     }
  95.     public String getRequestURI() {
  96.         return this.requestURI;
  97.     }
  98.     public String getSource() {
  99.         return this.source;
  100.     }
  101.     public String getProtocolName() {
  102.         return this.protocolName;
  103.     }
  104.     public String getProtocolWebContext() {
  105.         return this.protocolWebContext;
  106.     }
  107.     public String getFunction() {
  108.         return this.function;
  109.     }
  110.     public String getFunctionParameters() {
  111.         return this.functionParameters;
  112.     }
  113.     public String getRequestType() {
  114.         return this.requestType;
  115.     }
  116.     public String getInterfaceName() {
  117.         return this.interfaceName;
  118.     }
  119.         
  120.     @Deprecated
  121.     public Map<String, String> getParametersFormBased(){
  122.         return TransportUtils.convertToMapSingleValue(this.parameters);
  123.     }
  124.     public Map<String, List<String>> getParameters(){
  125.         return this.parameters;
  126.     }
  127.     
  128.     @Deprecated
  129.     public String getParameterFormBased(String name){
  130.         if(this.parameters==null){
  131.             return null;
  132.         }
  133.         return TransportUtils.getObjectAsString(this.parameters, name);
  134.     }
  135.     public String getParameter_compactMultipleValues(String name){
  136.         if(this.parameters==null){
  137.             return null;
  138.         }
  139.         return TransportUtils.getObjectAsString(this.parameters, name);
  140.     }
  141.     public String getParameterFirstValue(String name){
  142.         List<String> l = getParameterValues(name);
  143.         if(l!=null && !l.isEmpty()) {
  144.             return l.get(0);
  145.         }
  146.         return null;
  147.     }
  148.     public List<String> getParameterValues(String name){
  149.         if(this.parameters==null){
  150.             return null;
  151.         }
  152.         return TransportUtils.getRawObject(this.parameters, name);
  153.     }
  154.     
  155.     @Deprecated
  156.     public Object removeParameterFormBased(String name){
  157.         if(this.parameters==null){
  158.             return null;
  159.         }
  160.         return TransportUtils.removeObjectAsString(this.parameters, name);
  161.     }
  162.     public String removeParameter_compactMultipleValues(String name){
  163.         if(this.parameters==null){
  164.             return null;
  165.         }
  166.         return TransportUtils.removeObjectAsString(this.parameters, name);
  167.     }
  168.     public List<String> removeParameter(String name){
  169.         if(this.parameters==null){
  170.             return null;
  171.         }
  172.         return TransportUtils.removeRawObject(this.parameters, name);
  173.     }
  174.     
  175.     @Deprecated
  176.     public Map<String, String> getParametersTrasporto() {
  177.         return TransportUtils.convertToMapSingleValue(this.headers);
  178.     }
  179.     public Map<String, List<String>> getHeaders(){
  180.         return this.headers;
  181.     }
  182.     
  183.     @Deprecated
  184.     public String getParameterTrasporto(String name){
  185.         if(this.headers==null){
  186.             return null;
  187.         }
  188.         return TransportUtils.getObjectAsString(this.headers, name);
  189.     }
  190.     public String getHeader_compactMultipleValues(String name){
  191.         if(this.headers==null){
  192.             return null;
  193.         }
  194.         return TransportUtils.getObjectAsString(this.headers, name);
  195.     }
  196.     public String getHeaderFirstValue(String name){
  197.         List<String> l = getHeaderValues(name);
  198.         if(l!=null && !l.isEmpty()) {
  199.             return l.get(0);
  200.         }
  201.         return null;
  202.     }
  203.     public List<String> getHeaderValues(String name){
  204.         if(this.headers==null){
  205.             return null;
  206.         }
  207.         return TransportUtils.getRawObject(this.headers, name);
  208.     }
  209.     
  210.     @Deprecated
  211.     public Object removeParameterTrasporto(String name){
  212.         if(this.headers==null){
  213.             return null;
  214.         }
  215.         return TransportUtils.removeObjectAsString(this.headers, name);
  216.     }
  217.     public String removeHeader_compactMultipleValues(String name){
  218.         if(this.headers==null){
  219.             return null;
  220.         }
  221.         return TransportUtils.removeObjectAsString(this.headers, name);
  222.     }
  223.     public List<String> removeHeader(String name){
  224.         if(this.headers==null){
  225.             return null;
  226.         }
  227.         return TransportUtils.removeRawObject(this.headers, name);
  228.     }
  229.     
  230.     
  231.     public Set<String> getCookies(){
  232.         return this.cookiesValue.keySet();
  233.     }
  234.     public Map<String, String> getCookiesValue() {
  235.         return this.cookiesValue;
  236.     }
  237.     public String getCookieValue(String name){
  238.         if(this.cookiesValue==null){
  239.             return null;
  240.         }
  241.         return TransportUtils.getRawObject(this.cookiesValue, name);
  242.     }
  243.     public Map<String, Integer> getCookiesMaxAge() {
  244.         return this.cookiesMaxAge;
  245.     }
  246.     public Integer getCookieMaxAge(String name){
  247.         if(this.cookiesMaxAge==null){
  248.             return null;
  249.         }
  250.         return TransportUtils.getRawObject(this.cookiesMaxAge, name);
  251.     }
  252.     
  253.     public String getContentType(){
  254.         if(this.headers!=null){
  255.             return this.getHeaderFirstValue(HttpConstants.CONTENT_TYPE);
  256.         }
  257.         return null;
  258.     }
  259.     public String getContentType(boolean returnMsgErroreIfNotFound) throws Exception{

  261.         if(this.headers!=null && 
  262.                 TransportUtils.containsKey(this.headers, HttpConstants.CONTENT_TYPE)
  263.             ){
  264.             String ct = this.getHeaderFirstValue(HttpConstants.CONTENT_TYPE);
  265.             if(ct==null){
  266.                 if(returnMsgErroreIfNotFound)
  267.                     return HttpConstants.CONTENT_TYPE_NON_VALORIZZATO;
  268.                 else
  269.                     return null;
  270.             }
  271.             return ct;
  272.         }
  273.         
  274.         if(returnMsgErroreIfNotFound)
  275.             return HttpConstants.CONTENT_TYPE_NON_PRESENTE;
  276.         else
  277.             return null;
  278.     }


  281.     
  282.     
  283.     /**
  284.      * Ritorna l'url di invocazione 
  285.      *
  286.      * @return url di invocazione 
  287.      */
  288.     public String getUrlInvocazione_formBased() {
  289.         if(this.requestURI==null){
  290.             return null;
  291.         }
  292.         return TransportUtils.buildUrlWithParameters(this.parameters, this.requestURI, this.log);
  293.     }
  294.     public String getUrlInvocazioneWithParameters() {
  295.         return this.getUrlInvocazione_formBased();
  296.     }
  297.     public String getUrlInvocazioneWithoutParameters() {
  298.         return this.requestURI;
  299.     }

  301.     @Deprecated
  302.     public void setParametersFormBased(Map<String, String> parametersFormBased) {
  303.         this.parameters = TransportUtils.convertToMapListValues(parametersFormBased);
  304.     }
  305.     public void setParameters(Map<String, List<String>> parametersFormBased) {
  306.         this.parameters = parametersFormBased;
  307.     }

  309.     @Deprecated
  310.     public void setParametersTrasporto(Map<String, String> parametersTrasporto) {
  311.         this.headers = TransportUtils.convertToMapListValues(parametersTrasporto);
  312.     }
  313.     public void setHeaders(Map<String, List<String>> parametersFormBased) {
  314.         this.headers = parametersFormBased;
  315.     }

  317.     public void setCredentials(Credential credentials) {
  318.         this.credential = credentials;
  319.     }   
  320.     
  321.     public void setWebContext(String webContext) {
  322.         this.webContext = webContext;
  323.     }

  325.     public void setRequestURI(String requestURI) {
  326.         this.requestURI = requestURI;
  327.     }

  329.     public void setSource(String source) {
  330.         this.source = source;
  331.     }
  332.     
  333.     public void setProtocol(String protocolName,String protocolWebContext) {
  334.         this.protocolName = protocolName;
  335.         this.protocolWebContext = protocolWebContext;
  336.     }

  338.     public void setFunction(String function) {
  339.         this.function = function;
  340.     }

  342.     public void setFunctionParameters(String functionParameters) {
  343.         this.functionParameters = functionParameters;
  344.     }
  345.     
  346.     public void setRequestType(String requestType) {
  347.         this.requestType = requestType;
  348.     }
  349.     
  350.     public void setInterfaceName(String interfaceName) {
  351.         this.interfaceName = interfaceName;
  352.     }
  353.     
  354.     
  355.     @Override
  356.     public String toString() {
  357.         return this.toString("");
  358.     }
  359.     public String toString(String prefix) {
  360.         StringBuilder sb = new StringBuilder();
  361.         sb.append(prefix).append("DatiRichiesta");
  362.         if(this.webContext!=null) {
  363.             sb.append("\n").append(prefix).append("webContext: ").append(this.webContext);
  364.         }
  365.         if(this.requestURI!=null) {
  366.             sb.append("\n").append(prefix).append("requestURI: ").append(this.requestURI);
  367.         }
  368.         if(this.requestType!=null) {
  369.             sb.append("\n").append(prefix).append("requestType: ").append(this.requestType);
  370.         }
  371.         if(this.source!=null) {
  372.             sb.append("\n").append(prefix).append("source: ").append(this.source);
  373.         }
  374.         if(this.protocolName!=null) {
  375.             sb.append("\n").append(prefix).append("protocolName: ").append(this.protocolName);
  376.         }
  377.         if(this.protocolWebContext!=null) {
  378.             sb.append("\n").append(prefix).append("protocolWebContext: ").append(this.protocolWebContext);
  379.         }
  380.         if(this.function!=null) {
  381.             sb.append("\n").append(prefix).append("function: ").append(this.function);
  382.         }
  383.         if(this.functionParameters!=null) {
  384.             sb.append("\n").append(prefix).append("functionParameters: ").append(this.functionParameters);
  385.         }
  386.         if(this.interfaceName!=null) {
  387.             sb.append("\n").append(prefix).append("interfaceName: ").append(this.interfaceName);
  388.         }
  389.         if(this.credential!=null) {
  390.             sb.append("\n").append(prefix).append("credential: ").append(this.credential);
  391.         }
  392.         if(this.parameters!=null && !this.parameters.isEmpty()) {
  393.             sb.append("\n").append(prefix).append("parameters: ").append(this.convertWithStream(this.parameters));
  394.         }
  395.         if(this.headers!=null && !this.headers.isEmpty()) {
  396.             sb.append("\n").append(prefix).append("headers: ").append(this.convertWithStream(this.headers));
  397.         }
  398.         if(this.cookiesValue!=null && !this.cookiesValue.isEmpty()) {
  399.             sb.append("\n").append(prefix).append("cookiesValue: ").append(this.convertWithStream(this.cookiesValue));
  400.         }
  401.         if(this.cookiesMaxAge!=null && !this.cookiesMaxAge.isEmpty()) {
  402.             sb.append("\n").append(prefix).append("cookiesMaxAge: ").append(this.convertWithStream(this.cookiesMaxAge));
  403.         }
  404.         return sb.toString();
  405.     }
  406.     
  407.     private String convertWithStream(Map<?, ?> map) {
  408.         String mapAsString = map.keySet().stream()
  409.           .map(key -> key + "=" + map.get(key))
  410.           .collect(Collectors.joining(", ", "{", "}"));
  411.         return mapAsString;
  412.     }
  413.     
  414.     

  416. }
Created with JaCoCo 0.8.8.202204050719