colesico.framework.router.Router Maven / Gradle / Ivy
/*
* Copyright © 2014-2020 Vladlen V. Larionov and others as noted.
*
* 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 colesico.framework.router;
import colesico.framework.http.HttpMethod;
import java.util.List;
import java.util.Map;
/**
* Router API
*
* Router allows to bind any action to given route and perform it
*/
public interface Router {
/**
* Returns route parts associated with given handler
*
* @param targetClass service class or custom action class
* @param targetMethod service method name or custom action method name
* @param httpMethod http request method
* @param parameters route parameters
*/
List getSlicedRoute(Class targetClass, String targetMethod, HttpMethod httpMethod, Map parameters);
/**
* Resolve action from request uri and http method.
* Returns resolution bean for tuning the processing of the request based on the
* values of the attributes as well as the subsequent call of the tele-method -
* the request handler
*
* @param requestUri request url part from hostname(port) to query string (before '?' char)
* @throws UnknownRouteException if request uri not match any route
*/
ActionResolution resolveAction(HttpMethod requestMethod, String requestUri);
/**
* Calls handler associated with (e.g. service method or custom handler)
*/
void performAction(ActionResolution resolution);
}