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.layout.impl;
018:
019: import java.util.ArrayList;
020: import java.util.Map;
021:
022: import org.apache.commons.logging.Log;
023: import org.apache.commons.logging.LogFactory;
024: import org.apache.jetspeed.ajax.AJAXException;
025: import org.apache.jetspeed.ajax.AjaxAction;
026: import org.apache.jetspeed.ajax.AjaxBuilder;
027: import org.apache.jetspeed.decoration.DecorationValve;
028: import org.apache.jetspeed.layout.PortletActionSecurityBehavior;
029: import org.apache.jetspeed.om.page.ContentFragment;
030: import org.apache.jetspeed.om.page.ContentPage;
031: import org.apache.jetspeed.om.page.Fragment;
032: import org.apache.jetspeed.page.PageManager;
033: import org.apache.jetspeed.request.RequestContext;
034:
035: /**
036: * Get Portlet Actions retrieves the current set of valid actions for one or more portlet windows
037: *
038: * AJAX Parameters:
039: * id = the fragment id of the portlet for which to retrieve the action list
040: * multiple id parameters are supported
041: * page = (implied in the URL)
042: *
043: * @author <a href="mailto:taylor@apache.org">David Sean Taylor</a>
044: * @version $Id: $
045: */
046: public class GetPortletActionsAction extends BasePortletAction
047: implements AjaxAction, AjaxBuilder, Constants {
048: protected static final Log log = LogFactory
049: .getLog(GetPortletActionsAction.class);
050: protected String action;
051: private DecorationValve decorationValve;
052:
053: public GetPortletActionsAction(String template,
054: String errorTemplate, String action,
055: DecorationValve decorationValve) throws AJAXException {
056: this (template, errorTemplate, action, decorationValve, null,
057: null);
058: }
059:
060: public GetPortletActionsAction(String template,
061: String errorTemplate, String action,
062: DecorationValve decorationValve, PageManager pageManager,
063: PortletActionSecurityBehavior securityBehavior)
064: throws AJAXException {
065: super (template, errorTemplate, pageManager, securityBehavior);
066: this .action = action;
067: this .decorationValve = decorationValve;
068: }
069:
070: public boolean runBatch(RequestContext requestContext, Map resultMap)
071: throws AJAXException {
072: return runAction(requestContext, resultMap, true);
073: }
074:
075: public boolean run(RequestContext requestContext, Map resultMap)
076: throws AJAXException {
077: return runAction(requestContext, resultMap, false);
078: }
079:
080: public boolean runAction(RequestContext requestContext,
081: Map resultMap, boolean batch) {
082: boolean success = true;
083: String status = "success";
084: try {
085: resultMap.put(ACTION, action);
086:
087: ContentPage page = requestContext.getPage();
088:
089: // Get the necessary parameters off of the request
090: ArrayList getActionsForFragments = new ArrayList();
091: String[] portletIds = requestContext.getRequest()
092: .getParameterValues(PORTLETID);
093: if (portletIds != null && portletIds.length > 0) {
094: for (int i = 0; i < portletIds.length; i++) {
095: String portletId = portletIds[i];
096: ContentFragment fragment = (ContentFragment) page
097: .getFragmentById(portletId);
098: if (fragment == null) {
099: throw new Exception(
100: "fragment not found for specified portlet id: "
101: + portletId);
102: }
103: getActionsForFragments.add(fragment);
104: }
105: getActionsForFragments.add(page
106: .getRootContentFragment());
107: }
108:
109: // Run the Decoration valve to get actions
110: decorationValve.initFragments(requestContext, true,
111: getActionsForFragments);
112:
113: if (getActionsForFragments.size() > 0) {
114: Fragment rootFragment = (Fragment) getActionsForFragments
115: .remove(getActionsForFragments.size() - 1);
116: resultMap.put(PAGE, rootFragment);
117: }
118:
119: resultMap.put(PORTLETS, getActionsForFragments);
120:
121: resultMap.put(STATUS, status);
122: } catch (Exception e) {
123: // Log the exception
124: log.error("exception while getting actions for a fragment",
125: e);
126: resultMap.put(REASON, e.toString());
127: // Return a failure indicator
128: success = false;
129: }
130:
131: return success;
132: }
133: }
|