io.micronaut.web.router.UriRoute Maven / Gradle / Ivy
/*
* Copyright 2017-2020 original 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
*
* https://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.micronaut.web.router;
import io.micronaut.core.annotation.Nullable;
import io.micronaut.http.HttpMethod;
import io.micronaut.http.HttpRequest;
import io.micronaut.http.MediaType;
import io.micronaut.http.uri.UriMatchTemplate;
import java.net.URI;
import java.util.function.Predicate;
/**
* Represents a {@link Route} that matches a {@link URI}.
*
* @author Graeme Rocher
* @since 1.0
*/
public interface UriRoute extends Route, Comparable {
@Override
UriRouteInfo toRouteInfo();
/**
* Defines routes nested within this route.
*
* @param nested The nested routes
* @return This route
*/
@Override
UriRoute nest(Runnable nested);
/**
* @return The HTTP method for this route
*/
HttpMethod getHttpMethod();
/**
* @return The {@link UriMatchTemplate} used to match URIs
*/
UriMatchTemplate getUriMatchTemplate();
@Override
UriRoute consumes(MediaType... mediaType);
@Override
UriRoute produces(MediaType... mediaType);
@Override
UriRoute consumesAll();
@Override
UriRoute where(Predicate> condition);
@Override
UriRoute body(String argument);
/**
* The exposed port that the route applies to.
*
* @param port The port
* @return The route
*/
UriRoute exposedPort(int port);
/**
* @return The port the route listens to, or null if the default port
*/
@Nullable
Integer getPort();
/**
*
* @return The http method. Is equal to {@link #getHttpMethod()} value for standard http methods.
*/
default String getHttpMethodName() {
return getHttpMethod().name();
}
}