Route.java

/*
 * Copyright (c) 2013-2014 the original author or authors
 *
 * 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 io.werval.api.routes;

import java.util.Map;
import java.util.Set;

import io.werval.api.http.Method;
import io.werval.api.http.QueryString;
import io.werval.api.http.RequestHeader;

/**
 * Route.
 * <p>
 * HTTP RequestHeader satisfiedBy.
 *
 * @has 1 method 1 Method
 * @has 1 controller-type 1 Class
 * @has 1 controller-method 1 java.lang.reflect.Method
 */
public interface Route
{
    /**
     * @return HTTP Method
     */
    Method httpMethod();

    /**
     * @return Path
     */
    String path();

    /**
     * @return Controller type
     */
    Class<?> controllerType();

    /**
     * @return Controller method
     */
    java.lang.reflect.Method controllerMethod();

    /**
     * @return Controller method name
     */
    String controllerMethodName();

    /**
     * @param requestHeader Request header
     *
     * @return TRUE if the Route is satisfied by the given request header, otherwise return FALSE
     */
    boolean satisfiedBy( RequestHeader requestHeader );

    /**
     * @return Set of modifiers
     */
    Set<String> modifiers();

    /**
     * Bind route parameters from path and query string to a Map<String,Object>.
     *
     * @param parameterBinders Parameter binders
     * @param path             Path
     * @param queryString      Query String
     *
     * @return Map of bound parameters
     */
    Map<String, Object> bindParameters( ParameterBinders parameterBinders, String path, QueryString queryString );

    /**
     * Unbind route URI (path and query string) from parameters values Map.
     *
     * @param parameterBinders Parameter binders
     * @param parameters       Parameters values Map
     *
     * @return String representation to a URI of this route with the given parameters values
     */
    String unbindParameters( ParameterBinders parameterBinders, Map<String, Object> parameters );
}