io.micronaut.web.router.ResourceRoute 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.http.HttpMethod;
import io.micronaut.http.HttpRequest;
import io.micronaut.http.MediaType;
import java.util.function.Predicate;
/**
* A resource route is a composite route to a REST endpoint.
*
* @author Graeme Rocher
* @since 1.0
*/
public interface ResourceRoute extends Route {
/**
* Accept the given media type.
*
* @param mediaTypes The media types
* @return This route
*/
@Override
ResourceRoute consumes(MediaType... mediaTypes);
/**
* Nest more routes within this {@link ResourceRoute}.
*
* @param nested The nested routes
* @return This resource route
*/
@Override
ResourceRoute nest(Runnable nested);
/**
* Whether the route is read-only.
*
* @param readOnly True if this resource route should be read-only
* @return A new {@link ResourceRoute}
*/
ResourceRoute readOnly(boolean readOnly);
/**
* Exclude a particular HTTP method from this resource route.
*
* @param methods The methods to exclude
* @return The resource route
*/
ResourceRoute exclude(HttpMethod... methods);
@Override
ResourceRoute where(Predicate> condition);
@Override
ResourceRoute produces(MediaType... mediaType);
}