org.restexpress.route.RouteDeclaration Maven / Gradle / Ivy

Go to download
/*
    Copyright 2011, 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 org.restexpress.route;

import java.util.ArrayList;
import java.util.List;

import org.restexpress.domain.metadata.RouteMetadata;
import org.restexpress.exception.NoRoutesDefinedException;
import org.restexpress.route.parameterized.ParameterizedRouteBuilder;
import org.restexpress.route.regex.RegexRouteBuilder;
import org.restexpress.settings.RouteDefaults;
import org.restexpress.util.Callback;

/**
 * @author toddf
 * @since Jan 13, 2011
 */
public class RouteDeclaration
{
	// SECTION: INSTANCE VARIABLES

	private List routeBuilders;
	List routeMetadata = new ArrayList();

	
	public RouteDeclaration()
	{
		super();
		this.routeBuilders = new ArrayList();
	}


	// SECTION: URL MAPPING

	/**
	 * Map a parameterized URL pattern to a controller.
	 * 
	 * @param uri a string specifying a URL pattern to match.
	 * @param controller a pojo which contains implementations of the service methods (e.g. create(), read(), update(), delete()).
	 */
	public ParameterizedRouteBuilder uri(String uri, Object controller, RouteDefaults defaults)
	{
		ParameterizedRouteBuilder builder = new ParameterizedRouteBuilder(uri, controller, defaults);
		routeBuilders.add(builder);
		return builder;
	}

	/**
	 * Map a Regex pattern to a controller.
	 * 
	 * @param regex a string specifying a regex pattern to match.
	 * @param controller a pojo which contains implementations of service methods (e.g. create(), read(), update(), delete()).
	 */
	public RegexRouteBuilder regex(String regex, Object controller, RouteDefaults defaults)
	{
		RegexRouteBuilder builder = new RegexRouteBuilder(regex, controller, defaults);
		routeBuilders.add(builder);
		return builder;
	}
	
	
	// SECTION: UTILITY - FACTORY

	/**
	 * Generate a RouteMapping (utilized by RouteResolver) from the declared routes.
	 * 
	 * @throws NoRoutesDefinedException if there are no defined routes for the server.
	 */
	public RouteMapping createRouteMapping(RouteDefaults defaults)
	{
		if (routeBuilders.isEmpty()) throw new NoRoutesDefinedException("No routes defined for server");

		final RouteMapping results = new RouteMapping();

		iterateRouteBuilders(new Callback()
		{
			@Override
            public void process(RouteBuilder builder)
            {
	    		routeMetadata.add(builder.asMetadata());

	    		for (Route route : builder.build())
				{
					results.addRoute(route);
				}
            }
		});

		return results;
	}

	
	// SECTION: CONSOLE
	
	public void iterateRouteBuilders(Callback callback)
	{
		for (RouteBuilder builder : routeBuilders)
		{
			callback.process(builder);
		}
	}

	/**
     * @return
     */
    public List getMetadata()
    {
    	return routeMetadata;
    }
}