ContextForward


1   /**
2    *  Licensed to the Apache Software Foundation (ASF) under one or more
3    *  contributor license agreements.  See the NOTICE file distributed with
4    *  this work for additional information regarding copyright ownership.
5    *  The ASF licenses this file to You under the Apache License, Version 2.0
6    *  (the "License"); you may not use this file except in compliance with
7    *  the License.  You may obtain a copy of the License at
8    *
9    *     http://www.apache.org/licenses/LICENSE-2.0
10   *
11   *  Unless required by applicable law or agreed to in writing, software
12   *  distributed under the License is distributed on an "AS IS" BASIS,
13   *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   *  See the License for the specific language governing permissions and
15   *  limitations under the License.
16   */
17  package org.apache.geronimo.console.gbean;
18  
19  /**
20   * Interface for a GBean that describes a context forward (that is, a
21   * certain URL pattern in the console should be forwarded to a similar URL in
22   * one of the portlet web applications without requiring a separate login).
23   *
24   * This is managed by a single servlet in the portal web app (say, mapped to
25   * /forwards/*).  Therefore each ContextForward must specify three pieces of
26   * information -- the prefix under the portal servlet that should be forwarded,
27   * the context to forward to, and the path to forward to within the context.
28   * For example, if it specified "myimages/", "myportlet", and "images" then a
29   * request to /console/forwards/myimages/foo.png would be forwarded to
30   * /myportlet/images/foo.png
31   *
32   * @version $Rev: 476061 $ $Date: 2006-11-17 01:36:50 -0500 (Fri, 17 Nov 2006) $
33   */
34  public interface ContextForward {
35      /**
36       * Gets the prefix for the portal servlet's path that should be forwarded
37       * according to this definition.  This is "myimages/" in the example above.
38       */
39      String   getPortalPathPrefix();
40      /**
41       * Gets the context root that this request should forward to ("myportlet"
42       * in the example above).
43       */
44      String   getPortletContextPath();
45  
46      /**
47       * Gets the servlet path that this request should forward to in the
48       * destination context.  Any data after the servlet path and portal path
49       * prefix in the original URL will be appended to the portlet context
50       * path and servlet path to construct the destination URL.
51       */
52      String   getPortletServletPath();
53  }
54
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags