Moving to root below branch label

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@2005 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261

source/java/org/alfresco/web/app/servlet/ExternalAccessServlet.java

@@ -0,0 +1,130 @@
+/*
+ * Copyright (C) 2005 Alfresco, Inc.
+ *
+ * Licensed under the Mozilla Public License version 1.1 
+ * with a permitted attribution clause. You may obtain a
+ * copy of the License at
+ *
+ *   http://www.alfresco.org/legal/license.txt
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the
+ * License.
+ */
+package org.alfresco.web.app.servlet;
+
+import java.io.IOException;
+import java.text.MessageFormat;
+import java.util.StringTokenizer;
+
+import javax.servlet.ServletException;
+import javax.servlet.http.HttpServlet;
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+
+import org.alfresco.web.bean.LoginBean;
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
+
+/**
+ * Servlet allowing external URL access to various global JSF views in the Web Client.
+ * <p>
+ * The servlet accepts a well formed URL that can easily be generated from a Content or Space NodeRef.
+ * The URL also specifies the JSF "outcome" to be executed which provides the correct JSF View to be
+ * displayed. The JSF "outcome" must equate to a global navigation rule or it will not be displayed.
+ * Servlet URL is of the form:
+ * <p>
+ * <code>http://&lt;server&gt;/alfresco/navigate/&lt;outcome&gt;[/&lt;workspace&gt;/&lt;store&gt;/&lt;nodeId&gt;]</code> or <br/>
+ * <code>http://&lt;server&gt;/alfresco/navigate/&lt;outcome&gt;[/webdav/&lt;path/to/node&gt;]</code>
+ * </p>
+ * 
+ * @author Kevin Roast
+ */
+public class ExternalAccessServlet extends HttpServlet
+{
+   private static final long serialVersionUID = -4118907921337237802L;
+   
+   private static Log logger = LogFactory.getLog(ExternalAccessServlet.class);
+   
+   
+   /**
+    * @see javax.servlet.http.HttpServlet#service(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
+    */
+   protected void service(HttpServletRequest req, HttpServletResponse res)
+      throws ServletException, IOException
+   {
+      boolean alreadyAuthenticated = AuthenticationHelper.authenticate(getServletContext(), req, res);
+      
+      // The URL contains multiple parts
+      // /alfresco/navigate/<outcome>
+      String uri = req.getRequestURI();
+      
+      if (logger.isDebugEnabled())
+         logger.debug("Processing URL: " + uri);
+      
+      StringTokenizer t = new StringTokenizer(uri, "/");
+      int count = t.countTokens();
+      if (count < 3)
+      {
+         throw new IllegalArgumentException("Externally addressable URL did not contain all required args: " + uri); 
+      }
+      t.nextToken();    // skip web app name
+      t.nextToken();    // skip servlet name
+      
+      String outcome = t.nextToken();
+      
+      // get rest of the tokens
+      String[] tokens = new String[count - 3];
+      for (int i=0; i<count - 3; i++)
+      {
+         tokens[i] = t.nextToken();
+      }
+      
+      // set the session variable so the login bean knows which outcome to use
+      req.getSession().setAttribute(LoginBean.LOGIN_OUTCOME_KEY, outcome);
+      
+      // set the args if any
+      req.getSession().setAttribute(LoginBean.LOGIN_OUTCOME_ARGS, tokens);
+      
+      if (alreadyAuthenticated)
+      {
+         // clear the User object from the Session - this will force a relogin
+         // we do this so the outcome from the login page can then be changed
+         req.getSession().removeAttribute(AuthenticationHelper.AUTHENTICATION_USER);
+         
+         if (logger.isDebugEnabled())
+           logger.debug("Removing User session - will redirect via login page...");
+         
+         // redirect to root URL will force the login page to appear via the Authentication Filter
+         res.sendRedirect(req.getContextPath());
+      }
+   }
+   
+   /**
+    * Generate a URL to the External Access Servlet.
+    * Allows access to JSF views (via an "outcome" ID) from external URLs.
+    * 
+    * @param outcome
+    * @param args
+    * 
+    * @return URL
+    */
+   public final static String generateExternalURL(String outcome, String args)
+   {
+      if (args == null)
+      {
+         return MessageFormat.format(EXTERNAL_URL, new Object[] {outcome} );
+      }
+      else
+      {
+         return MessageFormat.format(EXTERNAL_URL_ARGS, new Object[] {outcome, args} );
+      }
+   }
+   
+   // example: http://<server>/alfresco/navigate/<outcome>[/<workspace>/<store>/<nodeId>]
+   private static final String EXTERNAL_URL  = "/navigate/{0}";
+   private static final String EXTERNAL_URL_ARGS  = "/navigate/{0}/{1}";
+}