01: /**
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * 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: */package org.apache.geronimo.console.gbean;
17:
18: /**
19: * Interface for a GBean that describes a context forward (that is, a
20: * certain URL pattern in the console should be forwarded to a similar URL in
21: * one of the portlet web applications without requiring a separate login).
22: *
23: * This is managed by a single servlet in the portal web app (say, mapped to
24: * /forwards/*). Therefore each ContextForward must specify three pieces of
25: * information -- the prefix under the portal servlet that should be forwarded,
26: * the context to forward to, and the path to forward to within the context.
27: * For example, if it specified "myimages/", "myportlet", and "images" then a
28: * request to /console/forwards/myimages/foo.png would be forwarded to
29: * /myportlet/images/foo.png
30: *
31: * @version $Rev: 476061 $ $Date: 2006-11-16 22:36:50 -0800 (Thu, 16 Nov 2006) $
32: */
33: public interface ContextForward {
34: /**
35: * Gets the prefix for the portal servlet's path that should be forwarded
36: * according to this definition. This is "myimages/" in the example above.
37: */
38: String getPortalPathPrefix();
39:
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: }
|