com.strategicgains.restexpress.route.Action Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of RestExpress Show documentation

Internet scale, high-performance RESTful Services in Java

There is a newer version: 0.11.3

/*
    Copyright 2010, Strategic Gains, Inc.

	Licensed under the Apache License, Version 2.0 (the "License");
	you may not use this file except in compliance with the License.
	You may obtain a copy of the License at

		http://www.apache.org/licenses/LICENSE-2.0

	Unless required by applicable law or agreed to in writing, software
	distributed under the License is distributed on an "AS IS" BASIS,
	WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	See the License for the specific language governing permissions and
	limitations under the License.
*/
package com.strategicgains.restexpress.route;

import java.util.Collection;
import java.util.Map.Entry;

import com.strategicgains.restexpress.Request;
import com.strategicgains.restexpress.Response;
import com.strategicgains.restexpress.url.UrlMatch;

/**
 * @author toddf
 * @since July 30, 2010
 */
public class Action
{
	private Route route;
	private UrlMatch match;
	
	public Action(Route route, UrlMatch match)
	{
		super();
		this.route = route;
		this.match = match;
	}

	public Route getRoute()
	{
		return route;
	}
	
	/**
	 * Returns whether the underlying Route should serialize the response.
	 * 
	 * @return
	 */
	public boolean shouldSerializeResponse()
	{
		return getRoute().shouldSerializeResponse();
	}
    
	/**
	 * Invokes the underlying Route, returning the result of the call, if any.
	 * 
	 * @param request
	 * @param response
	 * @return
	 */
    public Object invoke(Request request, Response response)
    {
    	return getRoute().invoke(request, response);
    }

    /**
     * Retrieves the parameters from the URL match.  These are used as Request headers
     * before invocation of the route.
     * 
     * @return a Collection of Map Entry name/value pairs to be used for headers.
     */
    public Collection> getParameters()
    {
    	return match.parameterSet();
    }
    
    public String getParameter(String key)
    {
    	return match.get(key);
    }
}