Changeset 6887 for ComponentRegistry

Timestamp:

01/08/16 08:27:10 (8 years ago)

Author:

Twan Goosen

Message:

New context parameters and method for determining public application URL
refs #844

Location:

ComponentRegistry/branches/ComponentRegistry-2.0/ComponentRegistry

Files:

• pom.xml (modified) (4 diffs)
• src/main/java/clarin/cmdi/componentregistry/rest/ComponentRegistryRestService.java (modified) (2 diffs)
• src/main/java/clarin/cmdi/componentregistry/rest/IComponentRegistryRestService.java (modified) (1 diff)
• src/main/webapp/META-INF/context.xml (modified) (1 diff)

ComponentRegistry/branches/ComponentRegistry-2.0/ComponentRegistry/pom.xml

@@ -24 +24 @@
         <!-- Properties to configure ComponentRegistry override on commandline 
         with -D or change here -->
-        <serviceRootUrl>http://localhost:8080/${project.artifactId}</serviceRootUrl>
+        <serviceUrlBase>http://localhost:8080</serviceUrlBase>
+        <serviceUrlPath>/${project.artifactId}</serviceUrlPath>
         <!-- Will be inserted in context.xml -->
         <webXmlPath>src/main/webapp/WEB-INF/web-test.xml</webXmlPath>
@@ -345 +346 @@
                 <logging.level>debug</logging.level>
                 <logging.appender>CONSOLE</logging.appender>
-                <serviceRootUrl>http://localhost:8080/ComponentRegistry</serviceRootUrl>
+                <serviceUrlBase>http://localhost:8080</serviceUrlBase>
+                <serviceUrlPath>/ComponentRegistry</serviceUrlPath>
                 <!-- Will be inserted in context.xml -->
                 <shibLI>http://lux16.mpi.nl/Shibboleth.sso/Login</shibLI>
@@ -358 +360 @@
             <id>lux16</id>
             <properties>
-                <serviceRootUrl>http://lux16.mpi.nl/ds/ComponentRegistry</serviceRootUrl>
+                <serviceUrlBase>http://lux16.mpi.nl</serviceUrlBase>
+                <serviceUrlPath>/ds/ComponentRegistry</serviceUrlPath>
                 <!-- Will be inserted in context.xml -->
                 <shibLI>https://lux16.mpi.nl/Shibboleth.sso/Login</shibLI>
@@ -372 +375 @@
             <properties>
                 <logging.level>warn</logging.level>
-                <serviceRootUrl>http://catalog.clarin.eu/ds/ComponentRegistry</serviceRootUrl>
+                <serviceRootUrl></serviceRootUrl>
+                <serviceUrlBase>http://catalog.clarin.eu</serviceUrlBase>
+                <serviceUrlPath>/ds/ComponentRegistry</serviceUrlPath>
                 <!-- Will be inserted in context.xml -->
                 <shibLI>https://catalog.clarin.eu/Shibboleth.sso/Login</shibLI>

ComponentRegistry/branches/ComponentRegistry-2.0/ComponentRegistry/src/main/java/clarin/cmdi/componentregistry/rest/ComponentRegistryRestService.java

@@ -1616 +1616 @@
     /**
      *
-     * @return The application's base URI as configured in the
-     * {@link #APPLICATION_BASE_URL_PARAM} context parameter. If correctly
-     * configured, it should look something like
+     * @return The application's base URI as defined by the following context
+     * parameters:
+     *
+     * {@link APPLICATION_URL_BASE_PARAM},
+     *     {@link APPLICATION_URL_PATH_PARAM},
+     *     {@link APPLICATION_URL_PROTOCOL_HEADER_PARAM}, and
+     * {@link APPLICATION_URL_HOST_HEADER_PARAM}
+     *
+     * If correctly configured, it should look something like
      * "http://catalog.clarin.eu/ds/ComponentRegistry". <em>Be aware that this
      * can also be null if configured incorrectly!</em>
-     *
-     * @see #APPLICATION_BASE_URL_PARAM
      */
-    private String getApplicationBaseURI() {
-        return servletContext.getInitParameter(APPLICATION_BASE_URL_PARAM);
+    private synchronized String getApplicationBaseURI() {
+        //TODO: Move logic to separate class so that it can also be used in the conig.jsp
+        final String path = servletContext.getInitParameter(APPLICATION_URL_PATH_PARAM);
+        if (path != null) {
+            final String protocolHeader = servletContext.getInitParameter(APPLICATION_URL_PROTOCOL_HEADER_PARAM);
+            final String hostHeader = servletContext.getInitParameter(APPLICATION_URL_HOST_HEADER_PARAM);
+            if (protocolHeader != null && hostHeader != null) {
+
+                return String.format("%s://%s%s",
+                        request.getHeader(protocolHeader),
+                        request.getHeader(hostHeader),
+                        request.getHeader(path)
+                );
+            } else {
+                final String base = servletContext.getInitParameter(APPLICATION_URL_BASE_PARAM);
+                return base + path;
+            }
+        }
+        LOG.error("Application URI could not be determined. Information available:\n"
+                + " {}: {}\n {}: {}\n {}: {}\n {}: {}",
+                APPLICATION_URL_PATH_PARAM, servletContext.getInitParameter(APPLICATION_URL_PATH_PARAM),
+                APPLICATION_URL_BASE_PARAM, servletContext.getInitParameter(APPLICATION_URL_BASE_PARAM),
+                APPLICATION_URL_PROTOCOL_HEADER_PARAM, servletContext.getInitParameter(APPLICATION_URL_PROTOCOL_HEADER_PARAM),
+                APPLICATION_URL_HOST_HEADER_PARAM, servletContext.getInitParameter(APPLICATION_URL_HOST_HEADER_PARAM)
+        );
+        throw new RuntimeException("Cannot determine application path");
     }
 
@@ -1996 +2024 @@
         }
     }
-    
+
 }

ComponentRegistry/branches/ComponentRegistry-2.0/ComponentRegistry/src/main/java/clarin/cmdi/componentregistry/rest/IComponentRegistryRestService.java

@@ -38 +38 @@
 public interface IComponentRegistryRestService {
 
-    public static final String APPLICATION_BASE_URL_PARAM = "eu.clarin.cmdi.componentregistry.serviceRootUrl";
+    public static final String APPLICATION_URL_BASE_PARAM = "eu.clarin.cmdi.componentregistry.serviceUrlBase";
+    public static final String APPLICATION_URL_PATH_PARAM = "eu.clarin.cmdi.componentregistry.serviceUrlPath";
+    public static final String APPLICATION_URL_PROTOCOL_HEADER_PARAM = "eu.clarin.cmdi.componentregistry.serviceUrlProtocolHeader";
+    public static final String APPLICATION_URL_HOST_HEADER_PARAM = "eu.clarin.cmdi.componentregistry.serviceUrlHostHeader";
     public static final String DATA_FORM_FIELD = "data";
     public static final String NAME_FORM_FIELD = "name";

ComponentRegistry/branches/ComponentRegistry-2.0/ComponentRegistry/src/main/webapp/META-INF/context.xml

@@ -41 +41 @@
         the '/rest/registry' part will be added by the application.
     -->
-  <Parameter name="eu.clarin.cmdi.componentregistry.serviceRootUrl" value="${serviceRootUrl}"/>
+  <Parameter name="eu.clarin.cmdi.componentregistry.serviceUrlBase" value="${serviceUrlBase}"/>
+  <Parameter name="eu.clarin.cmdi.componentregistry.serviceUrlPath" value="${serviceUrlPath}"/>
+
+ <!--
+  <Parameter name="eu.clarin.cmdi.componentregistry.serviceUrlProtocolHeader" value="${serviceUrlProtocolHeader}"/>
+  <Parameter name="eu.clarin.cmdi.componentregistry.serviceUrlHostHeader" value="${serviceUrlHostHeader}"/>
+ -->
+  
   <!--
         Location that gets redirected to from /documentation.jsp, which in turn is linked to