/*
============================================================================
The Apache Software License, Version 1.1
============================================================================
Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved.
Redistribution and use in source and binary forms, with or without modifica-
tion, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
3. The end-user documentation included with the redistribution, if any, must
include the following acknowledgment: "This product includes software
developed by the Apache Software Foundation (http://www.apache.org/)."
Alternately, this acknowledgment may appear in the software itself, if
and wherever such third-party acknowledgments normally appear.
4. The names "Apache Cocoon" and "Apache Software Foundation" must not be
used to endorse or promote products derived from this software without
prior written permission. For written permission, please contact
apache@apache.org.
5. Products derived from this software may not be called "Apache", nor may
"Apache" appear in their name, without prior written permission of the
Apache Software Foundation.
THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLU-
DING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
This software consists of voluntary contributions made by many individuals
on behalf of the Apache Software Foundation and was originally created by
Stefano Mazzocchi <stefano@apache.org>. For more information on the Apache
Software Foundation, please see <http://www.apache.org/>.
*/
package org.apache.cocoon.components.modules.input;
import org.apache.cocoon.environment.ObjectModelHelper;
import org.apache.cocoon.environment.Request;
import org.apache.cocoon.environment.portlet.PortletEnvironment;
import org.apache.cocoon.environment.portlet.PortletObjectModelHelper;
import org.apache.cocoon.util.NetUtils;
import org.apache.avalon.framework.configuration.Configuration;
import org.apache.avalon.framework.configuration.ConfigurationException;
import org.apache.avalon.framework.thread.ThreadSafe;
import javax.portlet.PortletURL;
import javax.portlet.RenderResponse;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
/**
* Input module to be used in together with
* {@link org.apache.cocoon.transformation.LinkRewriterTransformer}
* in JSR-168 (Portlet) environment. Allows creation of render, action, and
* resource URLs using syntax:
* <ul>
* <li><code>portlet:action:<path></code> for action URL;
* <li><code>portlet:render:<path></code> for render URL;
* <li><code>portlet:resource:<path></code> for resource URL;
* </ul>
*
* Outside of portlet environment, prefixes (<code>portlet:action:</code>,
* <code>portlet:render:</code>, <code>portlet:resource:</code>) are omitted.
*
* @author <a href="mailto:vgritsenko@apache.org">Vadim Gritsenko</a>
* @version CVS $Id: PortletURLModule.java,v 1.3 2003/12/03 17:26:26 vgritsenko Exp $
*/
public class PortletURLModule extends AbstractInputModule implements ThreadSafe {
public static final String NAME_RENDER = "render";
public static final String NAME_RESOURCE = "resource";
public static final String NAME_ACTION = "action";
private static final String PREFIX_RENDER = NAME_RENDER + ":";
private static final String PREFIX_RESOURCE = NAME_RESOURCE + ":";
private static final String PREFIX_ACTION = NAME_ACTION + ":";
private static final List returnNames;
static {
List tmp = new ArrayList();
tmp.add(NAME_RENDER);
tmp.add(NAME_RESOURCE);
tmp.add(NAME_ACTION);
returnNames = tmp;
}
public Iterator getAttributeNames(Configuration modeConf, Map objectModel) throws ConfigurationException {
return PortletURLModule.returnNames.iterator();
}
public Object getAttribute(String name, Configuration modeConf, Map objectModel) throws ConfigurationException {
if (name == null) {
throw new NullPointerException("Attribute name is null");
}
Request request = ObjectModelHelper.getRequest(objectModel);
RenderResponse renderResponse = PortletObjectModelHelper.getRenderResponse(objectModel);
if (renderResponse != null) {
PortletURL url = null;
if (name.startsWith(PREFIX_RENDER)) {
url = renderResponse.createRenderURL();
name = name.substring(PREFIX_RENDER.length());
if (name.length() > 0 && name.charAt(0) == '/') {
name = name.substring(1);
}
} else if (name.startsWith(PREFIX_RESOURCE)) {
name = name.substring(PREFIX_RESOURCE.length());
if (name.length() == 0 || name.charAt(0) != '/') {
String uri = request.getContextPath() + "/" + request.getServletPath();
name = NetUtils.absolutize(uri, name);
}
return renderResponse.encodeURL(name);
} else if (name.startsWith(PREFIX_ACTION)) {
url = renderResponse.createActionURL();
name = name.substring(PREFIX_ACTION.length());
if (name.length() > 0 && name.charAt(0) == '/') {
name = name.substring(1);
}
} else {
throw new IllegalArgumentException("Invalid attribute name '" + name + "' for '" + getClass().getName() + "'");
}
Map parameters = new HashMap(7);
name = NetUtils.deparameterize(name, parameters);
if (name.length() > 0) {
parameters.put(PortletEnvironment.PARAMETER_PATH_INFO, name);
}
for (Iterator i = parameters.keySet().iterator(); i.hasNext();) {
String param = (String) i.next();
Object values = parameters.get(param);
if (values instanceof String) {
url.setParameter(param, (String) values);
} else {
url.setParameter(param, (String[]) values);
}
}
return url.toString();
} else {
if (name.startsWith(PREFIX_RENDER)) {
return name.substring(PREFIX_RENDER.length());
} else if (name.startsWith(PREFIX_RESOURCE)) {
return name.substring(PREFIX_RESOURCE.length());
} else if (name.startsWith(PREFIX_ACTION)) {
return name.substring(PREFIX_ACTION.length());
} else {
throw new IllegalArgumentException("Invalid attribute name '" + name + "' for '" + getClass().getName() + "'");
}
}
}
public Object[] getAttributeValues(String name, Configuration modeConf, Map objectModel) throws ConfigurationException {
Object result = getAttribute(name, modeConf, objectModel);
if (result != null) {
return new Object[]{result};
}
return null;
}
}