All Downloads are FREE. Search and download functionalities are using the official Maven repository.

jodd.madvoc.MadvocRouter Maven / Gradle / Ivy

// Copyright (c) 2003-present, Jodd Team (http://jodd.org)
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, 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.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS 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 COPYRIGHT HOLDER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, 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.

package jodd.madvoc;

import jodd.madvoc.component.ActionMethodParser;
import jodd.madvoc.component.ActionsManager;
import jodd.madvoc.component.FiltersManager;
import jodd.madvoc.component.InterceptorsManager;
import jodd.madvoc.component.MadvocComponentLifecycle;
import jodd.madvoc.config.ActionDefinition;
import jodd.madvoc.config.ActionRuntime;
import jodd.madvoc.filter.ActionFilter;
import jodd.madvoc.interceptor.ActionInterceptor;
import jodd.madvoc.result.ActionResult;
import jodd.madvoc.result.ServletDispatcherActionResult;
import jodd.petite.meta.PetiteInject;
import jodd.util.ArraysUtil;

import java.lang.reflect.Method;
import java.util.function.Consumer;

/**
 * Madvoc configurator for manual configuration.
 */
public abstract class MadvocRouter implements MadvocComponentLifecycle.Start {

	/**
	 * Creates new instance of {@link MadvocRouter}.
	 * Created instance is NOT wired with dependencies!
	 */
	public static MadvocRouter create() {
		return new MadvocRouter() {
			@Override
			public void start() {
			}
		};
	}

	@PetiteInject
	protected ActionsManager actionsManager;

	@PetiteInject
	protected ActionMethodParser actionMethodParser;

	@PetiteInject
	protected FiltersManager filtersManager;

	@PetiteInject
	protected InterceptorsManager interceptorsManager;


	// ---------------------------------------------------------------- wrappers

	/**
	 * Configures an interceptor.
	 */
	@SuppressWarnings("unchecked")
	public  MadvocRouter interceptor(final Class actionInterceptorClass) {
		interceptorsManager.resolve(actionInterceptorClass);
		return this;
	}

	/**
	 * Configures an interceptor.
	 */
	@SuppressWarnings("unchecked")
	public  MadvocRouter interceptor(final Class actionInterceptorClass, final Consumer interceptorConsumer) {
		T interceptor = (T) interceptorsManager.resolve(actionInterceptorClass);
		interceptorConsumer.accept(interceptor);
		return this;
	}

	/**
	 * Returns action filter instance for further configuration.
	 */
	@SuppressWarnings("unchecked")
	public  MadvocRouter filter(final Class actionFilterClass) {
		filtersManager.resolve(actionFilterClass);
		return this;
	}

	@SuppressWarnings("unchecked")
	public  MadvocRouter filter(final Class actionFilterClass, final Consumer filterConsumer) {
		T filter = (T) filtersManager.resolve(actionFilterClass);
		filterConsumer.accept(filter);
		return this;
	}

	// ---------------------------------------------------------------- actions

	/**
	 * Starts with action registration i.e. route binding.
	 */
	public ActionBuilder route() {
		return new ActionBuilder();
	}

	/**
	 * Maps a GET path.
	 */
	public ActionBuilder get(final String path) {
		return new ActionBuilder().path(path).httpMethod("GET");
	}
	/**
	 * Maps a POST path.
	 */
	public ActionBuilder post(final String path) {
		return new ActionBuilder().path(path).httpMethod("POST");
	}
	/**
	 * Maps a PUT path.
	 */
	public ActionBuilder put(final String path) {
		return new ActionBuilder().path(path).httpMethod("PUT");
	}
	/**
	 * Maps a DELETE path.
	 */
	public ActionBuilder delete(final String path) {
		return new ActionBuilder().path(path).httpMethod("DELETE");
	}
	/**
	 * Maps an OPTION path.
	 */
	public ActionBuilder options(final String path) {
		return new ActionBuilder().path(path).httpMethod("OPTIONS");
	}

	public class ActionBuilder {
		ActionHandler actionHandler;
		String method;
		String actionPath;
		Class actionClass;
		Class actionResult;
		Method actionClassMethod;
		String actionMethodString;
		String alias;
		String resultBasePath;
		Class[] actionFilters;
		Class[] actionInterceptors;
		boolean async;
		boolean auth;

		/**
		 * Defines action path.
		 */
		public ActionBuilder path(final String path) {
			this.actionPath = path;
			return this;
		}

		/**
		 * Defines HTTP method.
		 */
		public ActionBuilder httpMethod(final String method) {
			this.method = method;
			return this;
		}

		/**
		 * Defines HTTP method name and action path.
		 * @see #path(String)
		 */
		public ActionBuilder path(final String method, final String path) {
			this.method = method;
			return path(path);
		}

		/**
		 * Defines action class and method to map.
		 */
		public ActionBuilder mapTo(final Class actionClass, final Method actionMethod) {
			this.actionClass = actionClass;
			this.actionClassMethod = actionMethod;
			this.actionMethodString = null;
			return this;
		}

		/**
		 * Defines action method. It must be declared in action class.
		 */
		public ActionBuilder mapTo(final Method actionMethod) {
			this.actionClass = actionMethod.getDeclaringClass();
			this.actionClassMethod = actionMethod;
			this.actionMethodString = null;
			return this;
		}

		/**
		 * Defines action class and method to map.
		 */
		public ActionBuilder mapTo(final Class actionClass, final String actionMethodName) {
			this.actionClass = actionClass;
			this.actionClassMethod = null;
			this.actionMethodString = actionMethodName;
			return this;
		}

		public ActionBuilder mapTo(final ActionHandler actionHandler) {
			this.actionHandler = actionHandler;
			return this;
		}

		/**
		 * Appends list of interceptors to the list of action interceptors.
		 */
		public ActionBuilder interceptBy(final Class... interceptors) {
			if (actionInterceptors == null) {
				actionInterceptors = interceptors;
			}
			else {
				actionInterceptors = ArraysUtil.join(actionInterceptors, interceptors);
			}
			return this;
		}
		/**
		 * Appends single interceptor to the list of action interceptors.
		 */
		public ActionBuilder interceptBy(final Class interceptor) {
			if (actionInterceptors == null) {
				actionInterceptors = new Class[]{interceptor};
			}
			else {
				actionInterceptors = ArraysUtil.append(actionInterceptors, interceptor);
			}
			return this;
		}

		/**
		 * Appends list of filter to the list of action filters.
		 */
		public ActionBuilder filterBy(final Class... filters) {
			if (actionFilters == null) {
				actionFilters = filters;
			}
			else {
				actionFilters = ArraysUtil.join(actionFilters, filters);
			}
			return this;
		}
		/**
		 * Appends single filter to the list of action filters.
		 */
		public ActionBuilder filterBy(final Class filter) {
			if (actionFilters == null) {
				actionFilters = new Class[]{filter};
			}
			else {
				actionFilters = ArraysUtil.append(actionFilters, filter);
			}
			return this;
		}

		/**
		 * Defines path alias.
		 */
		public ActionBuilder alias(final String aliasPath) {
			this.alias = aliasPath;
			return this;
		}

		/**
		 * Defines action result for this action.
		 */
		public ActionBuilder renderWith(final Class actionResult) {
			this.actionResult = actionResult;
			return this;
		}

		/**
		 * Defines async execution flag.
		 */
		public ActionBuilder async(final boolean async) {
			this.async = async;
			return this;
		}

		public ActionBuilder auth(final boolean auth) {
			this.auth = auth;
			return this;
		}

		/**
		 * Defines result base path.
		 */
		public ActionBuilder resultBase(final String resultBasePath) {
			this.resultBasePath = resultBasePath;
			return this;
		}

		/**
		 * Binds and finalize action runtime configuration.
		 */
		public MadvocRouter bind() {
			if (actionMethodString != null) {
				actionClassMethod = actionsManager.resolveActionMethod(actionClass, actionMethodString);
			}

			final ActionFilter[] actionFilterInstances = filtersManager.resolveAll(actionFilters);

			final ActionInterceptor[] actionInterceptorInstances = interceptorsManager.resolveAll(actionInterceptors);

			final ActionDefinition actionDefinition;
			if (resultBasePath != null) {
				actionDefinition = new ActionDefinition(actionPath, method, resultBasePath);
			}
			else {
				actionDefinition = new ActionDefinition(actionPath, method);
			}

			final ActionRuntime actionRuntime =
				actionMethodParser.createActionRuntime(
					actionHandler,
					actionClass,
					actionClassMethod,
					actionResult,
					ServletDispatcherActionResult.class,
					actionFilterInstances,
					actionInterceptorInstances,
					actionDefinition,
					async,
					auth
				);

			actionsManager.registerActionRuntime(actionRuntime);

			if (alias != null) {
				actionsManager.registerPathAlias(alias, actionPath);
			}

			return MadvocRouter.this;
		}

		/**
		 * Returns true when minimum configuration is provided.
		 * If so, you can call {@link #bind()} to complete the binding.
		 * This indicates that action path etc is already set in the line.
		 */
		public boolean isSet() {
			return actionPath != null && actionMethodString != null;
		}
	}

}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy