gov/nasa/worldwind/wms/Request.java

   1 /*
   2 Copyright (C) 2001, 2006 United States Government
   3 as represented by the Administrator of the
   4 National Aeronautics and Space Administration.
   5 All Rights Reserved.
   6 */
   7 package gov.nasa.worldwind.wms;
   8
   9 import gov.nasa.worldwind.util.Logging;
  10
  11 import java.net.*;
  12 import java.util.*;
  13
  14 /**
  15  * @author tag
  16  * @version $Id: Request.java 2471 2007-07-31 21:50:57Z tgaskins $
  17  */
  18 public abstract class Request
  19 {
  20     private URI uri = null;
  21
  22     // Use a TreeMap to hold the query params so that they'll always be attached to the
  23     // URL query string in the same order. This allows a simple string comparison to
  24     // determine whether two url strings address the same document.
  25     private TreeMap<String, String> queryParams = new TreeMap<String, String>();
  26
  27     public Request()
  28     {
  29         this.initialize();
  30     }
  31
  32     public Request(URI uri) throws URISyntaxException
  33     {
  34         if (uri != null)
  35         {
  36             try
  37             {
  38                 this.setUri(uri);
  39             }
  40             catch (URISyntaxException e)
  41             {
  42                 Logging.logger().fine(Logging.getMessage("generic.URIInvalid", uri.toString()));
  43                 throw e;
  44             }
  45         }
  46
  47         this.initialize();
  48     }
  49
  50     public Request(Request sourceRequest) throws URISyntaxException
  51     {
  52         sourceRequest.copyParamsTo(this);
  53         this.setUri(sourceRequest.getUri());
  54     }
  55
  56     protected void initialize()
  57     {
  58         this.queryParams.put("SERVICE", "WMS");
  59         this.queryParams.put("EXCEPTIONS", "application/vnd.ogc.se_xml");
  60     }
  61
  62     private void copyParamsTo(Request destinationRequest)
  63     {
  64         for (Map.Entry<String, String> entry : this.queryParams.entrySet())
  65         {
  66             destinationRequest.setParam((String) ((Map.Entry) entry).getKey(), (String) ((Map.Entry) entry).getValue());
  67         }
  68     }
  69
  70     protected void setUri(URI uri) throws URISyntaxException
  71     {
  72         try
  73         {
  74             this.uri = new URI(uri.getScheme(), uri.getUserInfo(), uri.getHost(), uri.getPort(), uri.getPath(),
  75                 this.buildQueryString(), null);
  76         }
  77         catch (URISyntaxException e)
  78         {
  79             String message = Logging.getMessage("generic.URIInvalid", uri.toString());
  80             Logging.logger().fine(message);
  81             throw e;
  82         }
  83     }
  84
  85     public String getRequestName()
  86     {
  87         return this.getParam("REQUEST");
  88     }
  89
  90     public String getVersion()
  91     {
  92         return this.getParam("VERSION");
  93     }
  94
  95     public void setVersion(String version)
  96     {
  97         this.setParam("VERSION", version);
  98     }
  99
 100     public void setParam(String key, String value)
 101     {
 102         if (key != null)
 103             this.queryParams.put(key, value);
 104     }
 105
 106     public String getParam(String key)
 107     {
 108         return key != null ? this.queryParams.get(key) : null;
 109     }
 110
 111     public URI getUri() throws URISyntaxException
 112     {
 113         if (this.uri == null)
 114             return null;
 115
 116         try
 117         {
 118             return new URI(this.uri.getScheme(), this.uri.getUserInfo(), this.uri.getHost(), this.uri.getPort(),
 119                 uri.getPath(), this.buildQueryString(), null);
 120         }
 121         catch (URISyntaxException e)
 122         {
 123             String message = Logging.getMessage("generic.URIInvalid", uri.toString());
 124             Logging.logger().fine(message);
 125             throw e;
 126         }
 127     }
 128
 129     private String buildQueryString()
 130     {
 131         StringBuffer queryString = new StringBuffer();
 132
 133         for (Map.Entry<String, String> entry : this.queryParams.entrySet())
 134         {
 135             if (((Map.Entry) entry).getKey() != null && ((Map.Entry) entry).getValue() != null)
 136             {
 137                 queryString.append(((Map.Entry) entry).getKey());
 138                 queryString.append("=");
 139                 queryString.append(((Map.Entry) entry).getValue());
 140                 queryString.append("&");
 141             }
 142         }
 143
 144         return queryString.toString();
 145     }
 146
 147     public String toString()
 148     {
 149         String errorMessage = "Error converting wms-request URI to string.";
 150         try
 151         {
 152             java.net.URI fullUri = this.getUri();
 153             return fullUri != null ? fullUri.toString() : errorMessage;
 154         }
 155         catch (URISyntaxException e)
 156         {
 157             return errorMessage;
 158         }
 159     }
 160 }