ratpack.handling.ByContentSpec Maven / Gradle / Ivy
/*
* Copyright 2013 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 ratpack.handling;
import ratpack.func.NoArgAction;
/**
* A specification of how to respond to a request, based on the requested content type (i.e. the request's Accept header).
*
* If there is no type registered, or if the client does not accept any of the given types, by default a {@code 406} will be issued with {@link Context#clientError(int)}.
* If you want a different behavior, use {@link #noMatch}.
*
* @see Context#byContent(ratpack.func.Action)
* @see RFC 7231: Accept
* @see RFC 7231: 406 Not Acceptable
*/
public interface ByContentSpec {
/**
* Specifies that the given handler should be used if the client wants content of the given MIME type.
* This only supports fully-specified content types (no "*" wildcards).
*
* @param mimeType The MIME type to register for
* @param handler The handler to invoke if the content type matches
* @return this
*/
ByContentSpec type(String mimeType, NoArgAction handler);
/**
* Specifies that the given handler should be used if the client wants content of the given MIME type.
* This only supports fully-specified content types (no "*" wildcards).
*
* @param mimeType The MIME type to register for
* @param handler The handler to invoke if the content type matches
* @return this
*/
ByContentSpec type(String mimeType, Handler handler);
/**
* Specifies that the given handler should be used if the client wants content of type "text/plain".
*
* @param handler The handler to invoke if the content type matches
* @return this
*/
ByContentSpec plainText(NoArgAction handler);
/**
* Specifies that the given handler should be used if the client wants content of type "text/plain".
*
* @param handler The handler to invoke if the content type matches
* @return this
*/
ByContentSpec plainText(Handler handler);
/**
* Specifies that the given handler should be used if the client wants content of type "text/html".
*
* @param handler The handler to invoke if the content type matches
* @return this
*/
ByContentSpec html(NoArgAction handler);
/**
* Specifies that the given handler should be used if the client wants content of type "text/html".
*
* @param handler The handler to invoke if the content type matches
* @return this
*/
ByContentSpec html(Handler handler);
/**
* Specifies that the given handler should be used if the client wants content of type "application/json".
*
* @param handler The handler to invoke if the content type matches
* @return this
*/
ByContentSpec json(NoArgAction handler);
/**
* Specifies that the given handler should be used if the client wants content of type "application/json".
*
* @param handler The handler to invoke if the content type matches
* @return this
*/
ByContentSpec json(Handler handler);
/**
* Specifies that the given handler should be used if the client wants content of type "application/xml".
*
* @param handler The handler to invoke if the content type matches
* @return this
*/
ByContentSpec xml(NoArgAction handler);
/**
* Specifies that the given handler should be used if the client wants content of type "application/xml".
*
* @param handler The handler to invoke if the content type matches
* @return this
*/
ByContentSpec xml(Handler handler);
/**
* Specifies that the given handler should be used if the client's requested content type cannot be matched with any of the other handlers.
*
* @param handler The handler to invoke if the content type doesn't match
* @return this
*/
ByContentSpec noMatch(NoArgAction handler);
/**
* Specifies that the given handler should be used if the client's requested content type cannot be matched with any of the other handlers.
*
* @param handler The handler to invoke if the content type doesn't match
* @return this
*/
ByContentSpec noMatch(Handler handler);
/**
* Specifies that the handler for the specified content type should be used if the client's requested content type cannot be matched with any of the other handlers.
* Effectively, this treats the request as if the user requested the specified MIME type.
*
* @param mimeType The MIME type to use as a fallback if the requested type can't be matched
* @return this
*/
ByContentSpec noMatch(String mimeType);
}