/*
* JBoss, a division of Red Hat
* Copyright 2010, Red Hat Middleware, LLC, and individual
* contributors as indicated by the @authors tag. See the
* copyright.txt in the distribution for a full listing of
* individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.gatein.wsrp.consumer.handlers;
import org.gatein.common.util.ParameterValidation;
import org.gatein.pc.api.PortletInvokerException;
import org.gatein.pc.api.StateString;
import org.gatein.pc.api.invocation.ActionInvocation;
import org.gatein.pc.api.invocation.response.ErrorResponse;
import org.gatein.pc.api.invocation.response.HTTPRedirectionResponse;
import org.gatein.pc.api.invocation.response.PortletInvocationResponse;
import org.gatein.pc.api.spi.InstanceContext;
import org.gatein.pc.api.spi.RequestContext;
import org.gatein.pc.api.state.AccessMode;
import org.gatein.wsrp.WSRPTypeFactory;
import org.gatein.wsrp.WSRPUtils;
import org.gatein.wsrp.api.extensions.ExtensionAccess;
import org.gatein.wsrp.consumer.WSRPConsumerImpl;
import org.gatein.wsrp.consumer.handlers.MultiPartUtil.MultiPartResult;
import org.oasis.wsrp.v2.BlockingInteractionResponse;
import org.oasis.wsrp.v2.Extension;
import org.oasis.wsrp.v2.InteractionParams;
import org.oasis.wsrp.v2.NamedString;
import org.oasis.wsrp.v2.PerformBlockingInteraction;
import org.oasis.wsrp.v2.PortletContext;
import org.oasis.wsrp.v2.RuntimeContext;
import org.oasis.wsrp.v2.UpdateResponse;
import javax.xml.ws.Holder;
import java.io.IOException;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
/**
* @author <a href="mailto:chris.laprun@jboss.com">Chris Laprun</a>
* @version $Revision: 13121 $
* @since 2.4 (May 31, 2006)
*/
public class ActionHandler extends NavigationalStateUpdatingHandler<ActionInvocation, PerformBlockingInteraction, BlockingInteractionResponse>
{
public ActionHandler(WSRPConsumerImpl consumer)
{
super(consumer);
}
/*@Override
protected void updateUserContext(PerformBlockingInteraction performBlockingInteraction, UserContext userContext)
{
performBlockingInteraction.setUserContext(userContext);
}
@Override
protected void updateRegistrationContext(PerformBlockingInteraction performBlockingInteraction) throws PortletInvokerException
{
performBlockingInteraction.setRegistrationContext(consumer.getRegistrationContext());
}*/
@Override
protected RuntimeContext getRuntimeContextFrom(PerformBlockingInteraction performBlockingInteraction)
{
return performBlockingInteraction.getRuntimeContext();
}
@Override
protected BlockingInteractionResponse performRequest(PerformBlockingInteraction interaction) throws Exception
{
Holder<UpdateResponse> updateResponseHolder = new Holder<UpdateResponse>();
Holder<String> redirectURL = new Holder<String>();
// invocation
if (debug)
{
log.debug("performBlockingInteraction on '" + interaction.getPortletContext().getPortletHandle() + "'");
}
final Holder<List<Extension>> extensions = new Holder<List<Extension>>();
consumer.getMarkupService().performBlockingInteraction(interaction.getRegistrationContext(),
interaction.getPortletContext(), interaction.getRuntimeContext(), interaction.getUserContext(),
interaction.getMarkupParams(), interaction.getInteractionParams(), updateResponseHolder, redirectURL,
extensions);
// construct response
final BlockingInteractionResponse response;
if (redirectURL.value != null)
{
response = WSRPTypeFactory.createBlockingInteractionResponse(redirectURL.value);
}
else
{
response = WSRPTypeFactory.createBlockingInteractionResponse(updateResponseHolder.value);
}
if (ParameterValidation.existsAndIsNotEmpty(extensions.value) && !WSRPUtils.isSingletonListWithNullOrEmptyElement(extensions.value))
{
response.getExtensions().addAll(extensions.value);
}
return response;
}
protected PerformBlockingInteraction prepareRequest(RequestPrecursor<ActionInvocation> requestPrecursor, ActionInvocation invocation)
{
if (!(invocation instanceof ActionInvocation))
{
throw new IllegalArgumentException("ActionHandler can only handle ActionInvocations!");
}
ActionInvocation actionInvocation = invocation;
PortletContext portletContext = requestPrecursor.getPortletContext();
if (debug)
{
log.debug("Consumer about to attempt action on portlet '" + portletContext.getPortletHandle() + "'");
}
// access mode
InstanceContext instanceContext = invocation.getInstanceContext();
ParameterValidation.throwIllegalArgExceptionIfNull(instanceContext, "instance context");
AccessMode accessMode = instanceContext.getAccessMode();
ParameterValidation.throwIllegalArgExceptionIfNull(accessMode, "access mode");
if (debug)
{
log.debug("Portlet is requesting " + accessMode + " access mode");
}
InteractionParams interactionParams = WSRPTypeFactory.createInteractionParams(WSRPUtils.getStateChangeFromAccessMode(accessMode));
interactionParams.getExtensions().addAll(ExtensionAccess.getConsumerExtensionAccessor().getRequestExtensionsFor(InteractionParams.class));
// interaction state
StateString interactionState = actionInvocation.getInteractionState();
if (interactionState != null)
{
String state = interactionState.getStringValue();
if (!StateString.JBPNS_PREFIX.equals(state)) // fix-me: see JBPORTAL-900
{
interactionParams.setInteractionState(state);
}
}
// check for multi-part
try
{
MultiPartResult multiPartResult = MultiPartUtil.getMultiPartContent(invocation.getRequestContext());
if (multiPartResult != null)
{
interactionParams.getFormParameters().addAll(multiPartResult.getFormParameters());
interactionParams.getUploadContexts().addAll(multiPartResult.getUploadContexts());
}
// Also check for form parameters from the Invocation
Map<String, String[]> params = actionInvocation.getForm();
if (params != null && !params.isEmpty())
{
int capacity = params.size();
List<NamedString> formParameters = new ArrayList<NamedString>(capacity);
for (Map.Entry param : params.entrySet())
{
String name = (String)param.getKey();
String[] values = (String[])param.getValue();
NamedString formParameter;
for (String value : values)
{
formParameter = WSRPTypeFactory.createNamedString(name, value);
formParameters.add(formParameter);
}
}
interactionParams.getFormParameters().addAll(formParameters);
}
}
catch (Exception e)
{
log.debug("Couldn't create UploadContext", e);
}
// todo: need to deal with GET method in forms
if (trace)
{
log.trace(WSRPUtils.toString(interactionParams));
}
// Create the blocking action request
return WSRPTypeFactory.createPerformBlockingInteraction(requestPrecursor.getRegistrationContext(), portletContext,
requestPrecursor.getRuntimeContext(), requestPrecursor.getUserContext(), requestPrecursor.getMarkupParams(), interactionParams);
}
protected PortletInvocationResponse processResponse(BlockingInteractionResponse response, ActionInvocation invocation, RequestPrecursor<ActionInvocation> requestPrecursor) throws PortletInvokerException
{
String redirectURL = response.getRedirectURL();
UpdateResponse updateResponse = response.getUpdateResponse();
if (redirectURL != null && updateResponse != null)
{
return new ErrorResponse(new IllegalArgumentException("Producer error: response cannot both redirect and update state."));
}
if (redirectURL == null && updateResponse == null)
{
return new ErrorResponse(new IllegalArgumentException("Producer error: response must redirect or update state."));
}
if (redirectURL != null)
{
return new HTTPRedirectionResponse(redirectURL); // do we need to process URLs?
}
else
{
// updateResponse.getMarkupContext(); // ignore bundled markup for now.
return processUpdateResponse(invocation, requestPrecursor, updateResponse, response);
}
}
@Override
protected List<Extension> getExtensionsFrom(BlockingInteractionResponse blockingInteractionResponse)
{
return blockingInteractionResponse.getExtensions();
}
/**
* @author <a href="mailto:chris.laprun@jboss.com">Chris Laprun</a>
* @version $Revision: 10198 $
* @since 2.6
*/
public static class RequestContextWrapper implements org.apache.commons.fileupload.RequestContext
{
private RequestContext requestContext;
public RequestContextWrapper(RequestContext requestContext)
{
this.requestContext = requestContext;
}
public String getCharacterEncoding()
{
return requestContext.getCharacterEncoding();
}
public String getContentType()
{
return requestContext.getContentType();
}
public int getContentLength()
{
return requestContext.getContentLength();
}
public InputStream getInputStream() throws IOException
{
return requestContext.getInputStream();
}
}
}