001: /*
002: * Licensed to the Apache Software Foundation (ASF) under one or more
003: * contributor license agreements. See the NOTICE file distributed with
004: * this work for additional information regarding copyright ownership.
005: * The ASF licenses this file to You under the Apache License, Version 2.0
006: * (the "License"); you may not use this file except in compliance with
007: * the License. You may obtain a copy of the License at
008: *
009: * http://www.apache.org/licenses/LICENSE-2.0
010: *
011: * Unless required by applicable law or agreed to in writing, software
012: * distributed under the License is distributed on an "AS IS" BASIS,
013: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014: * See the License for the specific language governing permissions and
015: * limitations under the License.
016: */
017: package org.apache.jetspeed.desktop;
018:
019: import org.apache.jetspeed.headerresource.HeaderResourceFactory;
020: import org.apache.jetspeed.request.RequestContext;
021:
022: /**
023: * Jetspeed Desktop
024: *
025: * @author <a href="mailto:taylor@apache.org">David Sean Taylor</a>
026: * @version $Id: $
027: */
028: public interface JetspeedDesktop {
029: String DESKTOP_ENABLED_REQUEST_ATTRIBUTE = "desktop.enabled";
030:
031: String DESKTOP_ENCODER_REQUEST_PARAMETER = "encoder";
032: String DESKTOP_ENCODER_REQUEST_PARAMETER_VALUE = "desktop";
033:
034: String DESKTOP_AJAX_REQUEST_PARAMETER = "jsdajax";
035: String DESKTOP_REQUEST_NOT_AJAX_PARAMETER = "org.apache.jetspeed.desktop.request.not.ajax";
036:
037: String DEFAULT_DESKTOP_PIPELINE_PATH = "/desktop";
038: String DEFAULT_DESKTOP_ACTION_PIPELINE_PATH = "/action";
039: String DEFAULT_DESKTOP_RENDER_PIPELINE_PATH = "/render";
040: String DEFAULT_DESKTOP_CONFIGURE_PIPELINE_PATH = "/dtconfigure";
041:
042: /**
043: * Render a desktop theme.
044: *
045: * @param request
046: */
047: void render(RequestContext request);
048:
049: /**
050: * Indicates whether /desktop is enabled for the current portal request.
051: * Located here due to range of jetspeed components which need this information and
052: * already have a DecorationFactory reference.
053: *
054: * @param requestContext current portal request.
055: *
056: * @return true if /desktop is enabled for the current portal request, otherwise false
057: */
058: boolean isDesktopEnabled(RequestContext requestContext);
059:
060: /**
061: * Retrieve the header resource factory
062: *
063: * @return header resource factory
064: */
065: HeaderResourceFactory getHeaderResourceFactory();
066:
067: /**
068: * Desktop servlet path ( e.g. /desktop )
069: *
070: * @return portal base url
071: */
072: public String getDesktopServletPath();
073:
074: /**
075: * Portal base url ( e.g. http://localhost:8080/jetspeed )
076: *
077: * @return portal base url
078: */
079: public String getPortalBaseUrl(RequestContext requestContext);
080:
081: /**
082: * Portal base url ( e.g. http://localhost:8080/jetspeed )
083: *
084: * @return portal base url
085: */
086: public String getPortalBaseUrl(RequestContext requestContext,
087: boolean encode);
088:
089: /**
090: * Portal base url with relativePath argument appended ( e.g. http://localhost:8080/jetspeed/javascript/dojo/ )
091: *
092: * @return portal base url with relativePath argument appended
093: */
094: public String getPortalResourceUrl(RequestContext requestContext,
095: String relativePath);
096:
097: /**
098: * Portal base url with relativePath argument appended ( e.g. http://localhost:8080/jetspeed/javascript/dojo/ )
099: *
100: * @return portal base url with relativePath argument appended
101: */
102: public String getPortalResourceUrl(RequestContext requestContext,
103: String relativePath, boolean encode);
104:
105: /**
106: * Portal base servlet url ( e.g. http://localhost:8080/jetspeed/desktop/ )
107: *
108: * @return portal base servlet url
109: */
110: public String getPortalUrl(RequestContext requestContext);
111:
112: /**
113: * Portal base servlet url ( e.g. http://localhost:8080/jetspeed/desktop/ )
114: *
115: * @return portal base servlet url
116: */
117: public String getPortalUrl(RequestContext requestContext,
118: boolean encode);
119:
120: /**
121: * Portal base servlet url with relativePath argument appended ( e.g. http://localhost:8080/jetspeed/desktop/default-page.psml )
122: *
123: * @return portal base servlet url with relativePath argument appended
124: */
125: public String getPortalUrl(RequestContext requestContext,
126: String relativePath);
127:
128: /**
129: * Portal base servlet url with relativePath argument appended ( e.g. http://localhost:8080/jetspeed/desktop/default-page.psml )
130: *
131: * @return portal base servlet url with relativePath argument appended
132: */
133: public String getPortalUrl(RequestContext requestContext,
134: String relativePath, boolean encode);
135:
136: }
|