Index (avaje-http-api 2.1-SNAPSHOT API)

A B C D E F G H I L M O P Q R S T V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

APPLICATION_ATOM_XML - Static variable in interface io.avaje.http.api.MediaType: A String constant representing "application/atom+xml" media type.
APPLICATION_FORM_URLENCODED - Static variable in interface io.avaje.http.api.MediaType: A String constant representing "application/x-www-form-urlencoded" media type.
APPLICATION_JSON - Static variable in interface io.avaje.http.api.MediaType: A String constant representing "application/json" media type.
APPLICATION_JSON_PATCH_JSON - Static variable in interface io.avaje.http.api.MediaType: String representation of "application/json-patch+json" media type..
APPLICATION_OCTET_STREAM - Static variable in interface io.avaje.http.api.MediaType: A String constant representing "application/octet-stream" media type.
APPLICATION_PDF - Static variable in interface io.avaje.http.api.MediaType: String representation of "application/pdf" media type.
APPLICATION_SVG_XML - Static variable in interface io.avaje.http.api.MediaType: A String constant representing "application/svg+xml" media type.
APPLICATION_XHTML_XML - Static variable in interface io.avaje.http.api.MediaType: A String constant representing "application/xhtml+xml" media type.
APPLICATION_XML - Static variable in interface io.avaje.http.api.MediaType: A String constant representing "application/xml" media type.
asBigDecimal(String) - Static method in class io.avaje.http.api.PathTypeConversion: Convert to BigDecimal (not nullable).
asBigInteger(String) - Static method in class io.avaje.http.api.PathTypeConversion: Convert to BigInteger (not nullable).
asBool(String) - Static method in class io.avaje.http.api.PathTypeConversion: Convert to boolean.
asBoolean(String) - Static method in class io.avaje.http.api.PathTypeConversion: Convert to boolean.
asDouble(String) - Static method in class io.avaje.http.api.PathTypeConversion: Convert to double.
asEnum(Class<T>, String) - Static method in class io.avaje.http.api.PathTypeConversion: Convert to enum.
asFloat(String) - Static method in class io.avaje.http.api.PathTypeConversion: Convert to float.
asInstant(String) - Static method in class io.avaje.http.api.PathTypeConversion: Convert to Instant (not nullable).
asInt(String) - Static method in class io.avaje.http.api.PathTypeConversion: Convert to int.
asInteger(String) - Static method in class io.avaje.http.api.PathTypeConversion: Convert to Integer (not nullable).
asLocalDate(String) - Static method in class io.avaje.http.api.PathTypeConversion: Convert to LocalDate (not nullable).
asLocalDateTime(String) - Static method in class io.avaje.http.api.PathTypeConversion: Convert to LocalDateTime (not nullable).
asLocalTime(String) - Static method in class io.avaje.http.api.PathTypeConversion: Convert to LocalTime (not nullable).
asLong(String) - Static method in class io.avaje.http.api.PathTypeConversion: Convert to long.
asOffsetDateTime(String) - Static method in class io.avaje.http.api.PathTypeConversion: Convert to OffsetDateTime (not nullable).
asUUID(String) - Static method in class io.avaje.http.api.PathTypeConversion: Convert to UUID (not nullable).

B

BeanParam - Annotation Type in io.avaje.http.api: A parameter that is a bean containing query parameters, headers and cookies.
BodyString - Annotation Type in io.avaje.http.api: Marks a controller string method parameter to be a string body.

C

callWith(ServerContext, Callable<T>) - Method in interface io.avaje.http.api.context.RequestContextResolver: Wraps the execution of the given callable in request context processing.
callWith(ServerContext, Callable<T>) - Method in class io.avaje.http.api.context.ThreadLocalRequestContextResolver
checkNull(String, String) - Static method in class io.avaje.http.api.PathTypeConversion: Check for null for a required property throwing RequiredArgumentException if the value is null.
chronoUnit() - Element in annotation type io.avaje.http.api.RequestTimeout: Unit of time of the timeout value
Client - Annotation Type in io.avaje.http.api: Marker annotation for client.
Client.Import - Annotation Type in io.avaje.http.api: Specify @Client.Import on a package or class to refer to the client interface we want to generate.
Consumes - Annotation Type in io.avaje.http.api: Specify endpoint request media type for the generated OpenAPI json.
Controller - Annotation Type in io.avaje.http.api: Marker annotation for controllers.
Cookie - Annotation Type in io.avaje.http.api: A parameter that is a cookie value.
currentRequest() - Method in interface io.avaje.http.api.context.RequestContextResolver: Retrieve the current server context.
currentRequest() - Method in class io.avaje.http.api.context.ThreadLocalRequestContextResolver

D

Default - Annotation Type in io.avaje.http.api: Define a default value for a form parameter or query parameter.
Delete - Annotation Type in io.avaje.http.api: Marks a method that handles HTTP DELETE requests.
description() - Element in annotation type io.avaje.http.api.OpenAPIResponse: The description of the return value.

E

Example - Search tag in annotation type io.avaje.http.api.BeanParam: Section
Example - Search tag in annotation type io.avaje.http.api.Default: Section
Example - Search tag in annotation type io.avaje.http.api.Get: Section
Example 1 - Search tag in annotation type io.avaje.http.api.Form: Section
Example 2 - Search tag in annotation type io.avaje.http.api.Form: Section
Example - Multiple path parameters - Search tag in annotation type io.avaje.http.api.Get: Section
ExceptionHandler - Annotation Type in io.avaje.http.api: Annotation for handling exceptions in controller classes and/or handler methods.

F

field - Variable in class io.avaje.http.api.ValidationException.Violation
Filter - Annotation Type in io.avaje.http.api: Marks a method as a Filter
Form - Annotation Type in io.avaje.http.api: A parameter that is a bean containing form parameters.
FormParam - Annotation Type in io.avaje.http.api: Marks a method parameter to be a form parameter.

G

generate() - Element in annotation type io.avaje.http.api.Client: Flag to set whether to generate a Client Implementation.
Generated - Annotation Type in io.avaje.http.api: Marker for generated code.
Get - Annotation Type in io.avaje.http.api: Marks a method that handles HTTP GET requests.
getErrors() - Method in exception class io.avaje.http.api.ValidationException: Return the errors typically as a map of field to error message.
getField() - Method in class io.avaje.http.api.ValidationException.Violation: Return the field for this error message.
getMessage() - Method in class io.avaje.http.api.ValidationException.Violation: Return the error message.
getPath() - Method in class io.avaje.http.api.ValidationException.Violation: Return the path of this error message.
getProperty() - Method in exception class io.avaje.http.api.RequiredArgumentException: Return the name of the property that is required.
getStatus() - Method in exception class io.avaje.http.api.ValidationException: Return the suggested HTTP status to use in the response.
groups() - Element in annotation type io.avaje.http.api.Valid: Validation groups to use

H

Header - Annotation Type in io.avaje.http.api: A parameter that is a header value.
HttpMethod - Annotation Type in io.avaje.http.api: Base for Http verb based annotations.

I

Ignore - Annotation Type in io.avaje.http.api: Mark a field on a BeanParam/FormParam class as not a request parameter of any kind.
IMAGE_GIF - Static variable in interface io.avaje.http.api.MediaType: String representation of "image/gif" media type.
IMAGE_JPEG - Static variable in interface io.avaje.http.api.MediaType: String representation of "image/jpeg" media type.
IMAGE_PNG - Static variable in interface io.avaje.http.api.MediaType: String representation of "image/png" media type.
InstrumentServerContext - Annotation Type in io.avaje.http.api: Marks a controller method to be instrumented with RequestContextResolver.
InvalidPathArgumentException - Exception Class in io.avaje.http.api: Exception for all invalid path type conversions - numbers, uuid, date time types etc.
InvalidPathArgumentException(Exception) - Constructor for exception class io.avaje.http.api.InvalidPathArgumentException: Construct with an exception.
InvalidPathArgumentException(String) - Constructor for exception class io.avaje.http.api.InvalidPathArgumentException: Construct with a message.
InvalidPathArgumentException(String, Exception) - Constructor for exception class io.avaje.http.api.InvalidPathArgumentException: Construct with message and exception.
InvalidTypeArgumentException - Exception Class in io.avaje.http.api: Exception for all invalid path type conversions - numbers, uuid, date time types etc.
InvalidTypeArgumentException(Exception) - Constructor for exception class io.avaje.http.api.InvalidTypeArgumentException: Construct with an exception.
InvalidTypeArgumentException(String) - Constructor for exception class io.avaje.http.api.InvalidTypeArgumentException: Construct with a message.
InvalidTypeArgumentException(String, Exception) - Constructor for exception class io.avaje.http.api.InvalidTypeArgumentException: Construct with a message and exception.
io.avaje.http.api - module io.avaje.http.api
io.avaje.http.api - package io.avaje.http.api: Provides annotations to support Controllers for web frameworks that are route based (like Sparkjava, Javlin etc).
io.avaje.http.api.context - package io.avaje.http.api.context
io.avaje.http.api.spi - package io.avaje.http.api.spi

L

list(Function<String, T>, List<String>) - Static method in class io.avaje.http.api.PathTypeConversion

M

matrix(String) - Method in class io.avaje.http.api.PathSegment: Return a metric value for the given key.
MatrixParam - Annotation Type in io.avaje.http.api: Marks a method parameter to be a matrix parameter.
MediaType - Interface in io.avaje.http.api: Common media types used by controllers.
message - Variable in class io.avaje.http.api.ValidationException.Violation
MetaData - Annotation Type in io.avaje.http.api.spi: For internal use, holds metadata on generated client interfaces for use by code generation (Java annotation processing).
MULTIPART_FORM_DATA - Static variable in interface io.avaje.http.api.MediaType: A String constant representing "multipart/form-data" media type.
MULTIPART_MIXED - Static variable in interface io.avaje.http.api.MediaType: String representation of "multipart/mixed" media type.
MULTIPART_RELATED - Static variable in interface io.avaje.http.api.MediaType: String representation of "multipart/related" media type.

O

of(String) - Static method in class io.avaje.http.api.PathSegment: Create with a given value that may contain matrix parameters.
OpenAPIResponse - Annotation Type in io.avaje.http.api: Specify endpoint response status code/description/type.
OpenAPIResponses - Annotation Type in io.avaje.http.api: Container for repeatable OpenAPIResponse annotation

P

Patch - Annotation Type in io.avaje.http.api: Marks a method that handles HTTP PATCH requests.
path - Variable in class io.avaje.http.api.ValidationException.Violation
Path - Annotation Type in io.avaje.http.api: Specify the path mapping request to a controller.
PathSegment - Class in io.avaje.http.api: A path segment that can simple like value like chair or contain matrix parameter values using semi-colon delimitation like chair;vendor=ikea;size=small.
PathSegment(String) - Constructor for class io.avaje.http.api.PathSegment: Create with a given value that may contain matric parameters.
PathTypeConversion - Class in io.avaje.http.api: Helper type conversion methods.
Post - Annotation Type in io.avaje.http.api: Marks a method that handles HTTP POST requests.
Produces - Annotation Type in io.avaje.http.api: Specify endpoint response media type.
Put - Annotation Type in io.avaje.http.api: Marks a method that handles HTTP PUT requests.

Q

QueryParam - Annotation Type in io.avaje.http.api: Marks a method parameter to be a query parameter.

R

request() - Method in class io.avaje.http.api.context.ServerContext: Retrieve the current server request.
RequestContextResolver - Interface in io.avaje.http.api.context: The holder for the current request context that is bound to instrumented threads.
RequestTimeout - Annotation Type in io.avaje.http.api: Overrides global request timeout for this endpoint.
RequiredArgumentException - Exception Class in io.avaje.http.api: Exception for parameters that are required.
RequiredArgumentException(Exception) - Constructor for exception class io.avaje.http.api.RequiredArgumentException: Construct with an exception.
RequiredArgumentException(String, Exception) - Constructor for exception class io.avaje.http.api.RequiredArgumentException: Construct with a message and exception.
RequiredArgumentException(String, String) - Constructor for exception class io.avaje.http.api.RequiredArgumentException: Construct with a message and property.
resolveLocale(String, Collection<Locale>) - Method in interface io.avaje.http.api.Validator
response() - Method in class io.avaje.http.api.context.ServerContext: Retrieve the current server response.
responseCode() - Element in annotation type io.avaje.http.api.OpenAPIResponse: the http status code of this response
runWith(ServerContext, Runnable) - Method in interface io.avaje.http.api.context.RequestContextResolver: Wraps the execution of the given runnable in request context processing.
runWith(ServerContext, Runnable) - Method in class io.avaje.http.api.context.ThreadLocalRequestContextResolver

S

SERVER_SENT_EVENTS - Static variable in interface io.avaje.http.api.MediaType: String representation of Server sent events media type.
ServerContext - Class in io.avaje.http.api.context: Holder for the Server Request/Response instances.
ServerContext(Object, Object) - Constructor for class io.avaje.http.api.context.ServerContext
set(Function<String, T>, List<String>) - Static method in class io.avaje.http.api.PathTypeConversion
setProperty(String) - Method in exception class io.avaje.http.api.RequiredArgumentException: Set the name of the required property.
statusCode() - Element in annotation type io.avaje.http.api.ExceptionHandler: The response status code to use.
statusCode() - Element in annotation type io.avaje.http.api.Produces: The status code of the route when successful.
supplyWith(ServerContext, Supplier<T>) - Method in interface io.avaje.http.api.context.RequestContextResolver: Wraps the execution of the given supplier in request context processing.
supplyWith(ServerContext, Supplier<T>) - Method in class io.avaje.http.api.context.ThreadLocalRequestContextResolver

T

TEXT_HTML - Static variable in interface io.avaje.http.api.MediaType: A String constant representing "text/html" media type.
TEXT_PLAIN - Static variable in interface io.avaje.http.api.MediaType: A String constant representing "text/plain" media type.
TEXT_XML - Static variable in interface io.avaje.http.api.MediaType: A String constant representing "text/xml" media type.
ThreadLocalRequestContextResolver - Class in io.avaje.http.api.context
ThreadLocalRequestContextResolver() - Constructor for class io.avaje.http.api.context.ThreadLocalRequestContextResolver
toBigDecimal(String) - Static method in class io.avaje.http.api.PathTypeConversion: Convert to BigDecimal (allowing nulls).
toBigInteger(String) - Static method in class io.avaje.http.api.PathTypeConversion: Convert to BigInteger (allowing nulls).
toBoolean(String) - Static method in class io.avaje.http.api.PathTypeConversion: Convert to Boolean (allowing nulls).
toDouble(String) - Static method in class io.avaje.http.api.PathTypeConversion: Convert to Double (allowing nulls).
toFloat(String) - Static method in class io.avaje.http.api.PathTypeConversion: Convert to Float (allowing nulls).
toInstant(String) - Static method in class io.avaje.http.api.PathTypeConversion: Convert to Instant (allowing nulls).
toInteger(String) - Static method in class io.avaje.http.api.PathTypeConversion: Convert to Integer (allowing nulls).
toLocalDate(String) - Static method in class io.avaje.http.api.PathTypeConversion: Convert to LocalDate (allowing nulls).
toLocalDateTime(String) - Static method in class io.avaje.http.api.PathTypeConversion: Convert to LocalDateTime (allowing nulls).
toLocalTime(String) - Static method in class io.avaje.http.api.PathTypeConversion: Convert to LocalTime (allowing nulls).
toLong(String) - Static method in class io.avaje.http.api.PathTypeConversion: Convert to Long (allowing nulls).
toOffsetDateTime(String) - Static method in class io.avaje.http.api.PathTypeConversion: Convert to OffsetDateTime (allowing nulls).
toUUID(String) - Static method in class io.avaje.http.api.PathTypeConversion: Convert to UUID (allowing nulls).
type() - Element in annotation type io.avaje.http.api.OpenAPIResponse: The concrete type that that this endpoint returns.
types() - Element in annotation type io.avaje.http.api.Client.Import: Client interface types that we want to generate HTTP clients for.

V

val() - Method in class io.avaje.http.api.PathSegment: Return the main segment value.
Valid - Annotation Type in io.avaje.http.api: Add @Valid annotation on a controller/method/BeanParam that we want bean validation to be included for.
validate(Object, String, Class<?>...) - Method in interface io.avaje.http.api.Validator: Validate the bean throwing an exception if the bean fails validation.
ValidationException - Exception Class in io.avaje.http.api: Exception used with Validator.
ValidationException(int, String) - Constructor for exception class io.avaje.http.api.ValidationException: Create with a status and message.
ValidationException(int, String, Throwable, List<ValidationException.Violation>) - Constructor for exception class io.avaje.http.api.ValidationException: Create with a status message and errors.
ValidationException(int, String, List<ValidationException.Violation>) - Constructor for exception class io.avaje.http.api.ValidationException: Create with a status message and errors.
ValidationException(String) - Constructor for exception class io.avaje.http.api.ValidationException: Create with a message.
ValidationException.Violation - Class in io.avaje.http.api: Error details including the field, error message and path
Validator - Interface in io.avaje.http.api: Validator for form beans or request beans.
value() - Element in annotation type io.avaje.http.api.Client: Specify the path mapping request to the controller.
value() - Element in annotation type io.avaje.http.api.Consumes: Specify request media type.
value() - Element in annotation type io.avaje.http.api.Controller: Specify the path mapping request to the controller.
value() - Element in annotation type io.avaje.http.api.Cookie: The name of the cookie.
value() - Element in annotation type io.avaje.http.api.Default: The default values.
value() - Element in annotation type io.avaje.http.api.Delete: Specify the path.
value() - Element in annotation type io.avaje.http.api.ExceptionHandler: Exception handled by the annotated method.
value() - Element in annotation type io.avaje.http.api.FormParam: The name of the form parameter.
value() - Element in annotation type io.avaje.http.api.Generated: The name of the code generator.
value() - Element in annotation type io.avaje.http.api.Get: Specify the path.
value() - Element in annotation type io.avaje.http.api.Header: The name of the header.
value() - Element in annotation type io.avaje.http.api.HttpMethod
value() - Element in annotation type io.avaje.http.api.MatrixParam: The name of the matrix parameter.
value() - Element in annotation type io.avaje.http.api.OpenAPIResponses
value() - Element in annotation type io.avaje.http.api.Patch: Specify the path.
value() - Element in annotation type io.avaje.http.api.Path
value() - Element in annotation type io.avaje.http.api.Post: Specify the path.
value() - Element in annotation type io.avaje.http.api.Produces: Specify response media type.
value() - Element in annotation type io.avaje.http.api.Put: Specify the path.
value() - Element in annotation type io.avaje.http.api.QueryParam: The name of the query parameter.
value() - Element in annotation type io.avaje.http.api.RequestTimeout: How long the timeout should be
value() - Element in annotation type io.avaje.http.api.spi.MetaData: The generated HttpClient interfaces.
Violation() - Constructor for class io.avaje.http.api.ValidationException.Violation: Default constructor just to help Jackson if it is used.
Violation(String, String, String) - Constructor for class io.avaje.http.api.ValidationException.Violation: Create with path, field and message

W

withDefault(String, String) - Static method in class io.avaje.http.api.PathTypeConversion: Return the value if non-null and otherwise the default value.
withDefault(List<String>, List<String>) - Static method in class io.avaje.http.api.PathTypeConversion

A B C D E F G H I L M O P Q R S T V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form