All Classes Interface Summary Class Summary Enum Summary Exception Summary Annotation Types Summary
| Class |
Description |
| Accepted |
HTTP Status Code for Accepted
To send this in the response, either pass an instance (with optional custom message) to
Request.send(HttpError) or throw it out of an Irked controller handler. |
| App |
Example Irked verticle
|
| AuthorizationToken |
Base class for RFC 7235 authentication/authorization tokens
|
| AuthorizationToken.TokenTypes |
|
| BadGateway |
HTTP Status Code for Bad Gateway
To send this in the response, either pass an instance (with optional custom message) to
Request.send(HttpError) or throw it out of an Irked controller handler. |
| BadRequest |
HTTP Status Code for Bad Request
To send this in the response, either pass an instance (with optional custom message) to
Request.send(HttpError) or throw it out of an Irked controller handler. |
| BasicAuthorizationToken |
Implementation of the standard RFC 7617 Bearer authentication scheme token
This implementation parses the token and makes the user name and password available through the API.
|
| BearerAuthorizationToken |
Implementation of the standard RFC 6750 Bearer authentication scheme token
No additional parsing is done on the bearer token and the user is expected to implement
their own verification on the token value that can be retrieved from the AuthorizationToken.getToken() method. |
| Blocking |
Annotation to label a route as "blocking"
i.e.
|
| Conflict |
HTTP Status Code for Conflict
To send this in the response, either pass an instance (with optional custom message) to
Request.send(HttpError) or throw it out of an Irked controller handler. |
| Connect |
Annotation to configure a route to handle CONNECT requests.
|
| ConnectSpecs |
Repeatable container for @Connect
|
| Consumes |
Annotation to configure Route.consumes()
|
| ConsumesSpecs |
Repeatable container for @Consumes
|
| Continue |
HTTP Status Code for Continue
To send this in the response, either pass an instance (with optional custom message) to
Request.send(HttpError) or throw it out of an Irked controller handler. |
| Controller |
|
| Controller.MessageHandler |
|
| Controller.RawVertxHandler |
|
| Controller.WebHandler |
|
| Created |
HTTP Status Code for Created
To send this in the response, either pass an instance (with optional custom message) to
Request.send(HttpError) or throw it out of an Irked controller handler. |
| Delete |
Annotation to configure a route to handle DELETE requests
Set the value to configure for a specific (possibly wild-card) path, or leave empty to handle all
DELETE requests.
|
| Deletes |
Repeatable container for @Delete
|
| DigestAuthenticate |
|
| DigestAuthorizationToken |
Implementation of the standard RFC 7616 Digest authentication scheme token
Complete implementation of token validation and data access is provided, depending on the
specified digest algorithm being available from the JVM cryptography provider.
|
| Endpoint |
Annotation to configure a route to handle all HTTP requests
Set the value to configure for a specific (possibly wild-card) path, or leave empty to handle all
requests.
|
| Endpoints |
Repeatable container for @Endpoint
|
| ExampleAPIv1 |
|
| ExampleAPIv2 |
|
| ExpectationFailed |
HTTP Status Code for Expectation Failed
To send this in the response, either pass an instance (with optional custom message) to
Request.send(HttpError) or throw it out of an Irked controller handler. |
| FailedDependency |
HTTP Status Code for Failed Dependency
To send this in the response, either pass an instance (with optional custom message) to
Request.send(HttpError) or throw it out of an Irked controller handler. |
| Forbidden |
HTTP Status Code for Forbidden
To send this in the response, either pass an instance (with optional custom message) to
Request.send(HttpError) or throw it out of an Irked controller handler. |
| Found |
HTTP Status Code for Found
To send this in the response, either pass an instance (with optional custom message) to
Request.send(HttpError) or throw it out of an Irked controller handler. |
| GatewayTimeout |
HTTP Status Code for Gateway Time-out
To send this in the response, either pass an instance (with optional custom message) to
Request.send(HttpError) or throw it out of an Irked controller handler. |
| Get |
Annotation to configure a route to handle GET requests
Set the value to configure for a specific (possibly wild-card) path, or leave empty to handle all
GET requests.
|
| Gets |
Repeatable container for @Get
|
| Gone |
HTTP Status Code for Gone
To send this in the response, either pass an instance (with optional custom message) to
Request.send(HttpError) or throw it out of an Irked controller handler. |
| Head |
Annotation to configure a route to handle HEAD requests
Set the value to configure for a specific (possibly wild-card) path, or leave empty to handle all
HEAD requests.
|
| Heads |
Repeatable container for @Head
|
| HOBAAuthorizationToken |
Implementation of the standard RFC 7486 Mututal authentication scheme token
The token parameters are available from the ParameterEncodedAuthorizationToken.getParameter(String)
method, though currently no validation is performed to make sure that all required fields are present. |
| HttpError |
Top class representing HTTP response headers in Irked.
|
| HttpStatuses |
|
| HTTPVersionNotSupported |
HTTP Status Code for HTTP Version Not Supported
To send this in the response, either pass an instance (with optional custom message) to
Request.send(HttpError) or throw it out of an Irked controller handler. |
| Imateapot |
HTTP Status Code for I'm a teapot
To send this in the response, either pass an instance (with optional custom message) to
Request.send(HttpError) or throw it out of an Irked controller handler. |
| IMUsed |
HTTP Status Code for IM Used
To send this in the response, either pass an instance (with optional custom message) to
Request.send(HttpError) or throw it out of an Irked controller handler. |
| InsufficientStorage |
HTTP Status Code for Insufficient Storage
To send this in the response, either pass an instance (with optional custom message) to
Request.send(HttpError) or throw it out of an Irked controller handler. |
| InternalServerError |
HTTP Status Code for Internal Server Error
To send this in the response, either pass an instance (with optional custom message) to
Request.send(HttpError) or throw it out of an Irked controller handler. |
| InvalidRouteConfiguration |
|
| Irked |
Helper for creating Irked routers
|
| JsonDecodingExceptionFormatter |
|
| LengthRequired |
HTTP Status Code for Length Required
To send this in the response, either pass an instance (with optional custom message) to
Request.send(HttpError) or throw it out of an Irked controller handler. |
| Locked |
HTTP Status Code for Locked
To send this in the response, either pass an instance (with optional custom message) to
Request.send(HttpError) or throw it out of an Irked controller handler. |
| MethodNotAllowed |
HTTP Status Code for Method Not Allowed
To send this in the response, either pass an instance (with optional custom message) to
Request.send(HttpError) or throw it out of an Irked controller handler. |
| MissingBodyException |
|
| MovedPermanently |
HTTP Status Code for Moved Permanently
To send this in the response, either pass an instance (with optional custom message) to
Request.send(HttpError) or throw it out of an Irked controller handler. |
| MultipleChoices |
HTTP Status Code for Multiple Choices
To send this in the response, either pass an instance (with optional custom message) to
Request.send(HttpError) or throw it out of an Irked controller handler. |
| MultiStatus |
HTTP Status Code for Multi-Status
To send this in the response, either pass an instance (with optional custom message) to
Request.send(HttpError) or throw it out of an Irked controller handler. |
| MutualAuthorizationToken |
Implementation of the standard RFC 8120 Mututal authentication scheme token
The token parameters are available from the ParameterEncodedAuthorizationToken.getParameter(String)
method, though currently no validation is performed to make sure that all required fields are present. |
| Name |
A name annotation useful for dynamic parameter passing.
|
| NegotiateAuthorizationToken |
Implementation of the standard RFC 4559 Negotiate authentication scheme token
This implementation does not decode the GSS API data and it is available as plain text
from the AuthorizationToken.getToken() method. |
| NetworkAuthenticationRequired |
HTTP Status Code for Network Authentication Required
To send this in the response, either pass an instance (with optional custom message) to
Request.send(HttpError) or throw it out of an Irked controller handler. |
| NoContent |
HTTP Status Code for No Content
To send this in the response, either pass an instance (with optional custom message) to
Request.send(HttpError) or throw it out of an Irked controller handler. |
| NonAuthoritativeInformation |
HTTP Status Code for Non-Authoritative Information
To send this in the response, either pass an instance (with optional custom message) to
Request.send(HttpError) or throw it out of an Irked controller handler. |
| NotAcceptable |
HTTP Status Code for Not Acceptable
To send this in the response, either pass an instance (with optional custom message) to
Request.send(HttpError) or throw it out of an Irked controller handler. |
| NotFound |
HTTP Status Code for Not Found
To send this in the response, either pass an instance (with optional custom message) to
Request.send(HttpError) or throw it out of an Irked controller handler. |
| NotImplemented |
HTTP Status Code for Not Implemented
To send this in the response, either pass an instance (with optional custom message) to
Request.send(HttpError) or throw it out of an Irked controller handler. |
| NotModified |
HTTP Status Code for Not Modified
To send this in the response, either pass an instance (with optional custom message) to
Request.send(HttpError) or throw it out of an Irked controller handler. |
| NullAuthorizationToken |
|
| OAuthAuthorizationToken |
Implementation of the standard RFC 5849 OAuth authentication scheme token.
|
| OK |
HTTP Status Code for OK
To send this in the response, either pass an instance (with optional custom message) to
Request.send(HttpError) or throw it out of an Irked controller handler. |
| OnFail |
Annotation to configure a route to handle requests that have failed
|
| OnFailures |
Repeatable container for @OnFail
|
| Options |
Annotation to configure a route to handle OPTIONS requests
|
| Order |
Annotation to configure an explicit "order" for method handlers.
|
| ParameterEncodedAuthorizationToken |
Base implementation for authentication schemes where the value is a white-space separated list
of parameters in the format key=value or key="long value"
|
| PartialContent |
HTTP Status Code for Partial Content
To send this in the response, either pass an instance (with optional custom message) to
Request.send(HttpError) or throw it out of an Irked controller handler. |
| Patch |
Annotation to configure a route to handle PATCH requests
Set the value to configure for a specific (possibly wild-card) path, or leave empty to handle all
PATCH requests.
|
| Patches |
Repeatable container for @Patch
|
| PayloadTooLarge |
HTTP Status Code for Payload Too Large
To send this in the response, either pass an instance (with optional custom message) to
Request.send(HttpError) or throw it out of an Irked controller handler. |
| PaymentRequired |
HTTP Status Code for Payment Required
To send this in the response, either pass an instance (with optional custom message) to
Request.send(HttpError) or throw it out of an Irked controller handler. |
| PermanentRedirect |
|
| PermanentRedirect |
HTTP Status Code for Permanent Redirect
To send this in the response, either pass an instance (with optional custom message) to
Request.send(HttpError) or throw it out of an Irked controller handler. |
| Post |
Annotation to configure a route to handle POST requests
Set the value to configure for a specific (possibly wild-card) path, or leave empty to handle all
POST requests.
|
| Posts |
Repeatable container for @Post
|
| PreconditionFailed |
HTTP Status Code for Precondition Failed
To send this in the response, either pass an instance (with optional custom message) to
Request.send(HttpError) or throw it out of an Irked controller handler. |
| PreconditionRequired |
HTTP Status Code for Precondition Required
To send this in the response, either pass an instance (with optional custom message) to
Request.send(HttpError) or throw it out of an Irked controller handler. |
| Processing |
HTTP Status Code for Processing
To send this in the response, either pass an instance (with optional custom message) to
Request.send(HttpError) or throw it out of an Irked controller handler. |
| ProxyAuthenticationRequired |
HTTP Status Code for Proxy Authentication Required
To send this in the response, either pass an instance (with optional custom message) to
Request.send(HttpError) or throw it out of an Irked controller handler. |
| Put |
Annotation to configure a route to handle PUT requests
Set the value to configure for a specific (possibly wild-card) path, or leave empty to handle all
PUT requests.
|
| Puts |
Repeatable container for @Put
|
| RangeNotSatisfiable |
HTTP Status Code for Range Not Satisfiable
To send this in the response, either pass an instance (with optional custom message) to
Request.send(HttpError) or throw it out of an Irked controller handler. |
| Redirect |
|
| Request |
Request handling wrapper which adds some useful routines for
API writers.
|
| RequestHeaderFieldsTooLarge |
HTTP Status Code for Request Header Fields Too Large
To send this in the response, either pass an instance (with optional custom message) to
Request.send(HttpError) or throw it out of an Irked controller handler. |
| RequestTimeout |
HTTP Status Code for Request Timeout
To send this in the response, either pass an instance (with optional custom message) to
Request.send(HttpError) or throw it out of an Irked controller handler. |
| RequestWrapper |
|
| ResetContent |
HTTP Status Code for Reset Content
To send this in the response, either pass an instance (with optional custom message) to
Request.send(HttpError) or throw it out of an Irked controller handler. |
| RouteConfiguration |
Internal implementation that handles parsing route annotations and setting up the router.
|
| RouteConfigurationField |
An implementation of RouteConfiguration used to configure Vert.x-web for Controller fields |
| RouteConfigurationMethod |
An implementation of RouteConfiguration used to configure Vert.x-web for Controller methods |
| RouteImplHelper |
A helper to access the results of the Vert.x route parser, for use in Irked support for dynamic runtime parameter
configuration for controller methods, to circumvent Vert.x limits on access to the immutable RouteState.
|
| Router |
|
| RouteSpec |
|
| SeeOther |
HTTP Status Code for See Other
To send this in the response, either pass an instance (with optional custom message) to
Request.send(HttpError) or throw it out of an Irked controller handler. |
| Service |
|
| ServiceUnavailable |
HTTP Status Code for Service Unavailable
To send this in the response, either pass an instance (with optional custom message) to
Request.send(HttpError) or throw it out of an Irked controller handler. |
| SimpleAuthrizationToken |
Implementation of a non-standard authentication scheme where a single opaque token is provided
without an authencation scheme name
|
| StatusClassGenerator |
Generator for the HTTP exceptions, because I can't be bothered to write them
manually.
|
| SwitchingProtocols |
HTTP Status Code for Switching Protocols
To send this in the response, either pass an instance (with optional custom message) to
Request.send(HttpError) or throw it out of an Irked controller handler. |
| TemporaryRedirect |
HTTP Status Code for Temporary Redirect
To send this in the response, either pass an instance (with optional custom message) to
Request.send(HttpError) or throw it out of an Irked controller handler. |
| Timeout |
Annotation that will add a TimeoutHandler to the configured route, causing that route
to fail with a 503 server error if no response was written after the specified timeout.
|
| TooManyRequests |
HTTP Status Code for Too Many Requests
To send this in the response, either pass an instance (with optional custom message) to
Request.send(HttpError) or throw it out of an Irked controller handler. |
| Unauthorized |
HTTP Status Code for Unauthorized
To send this in the response, either pass an instance (with optional custom message) to
Request.send(HttpError) or throw it out of an Irked controller handler. |
| UnavailableForLegalReasons |
HTTP Status Code for Unavailable For Legal Reasons
To send this in the response, either pass an instance (with optional custom message) to
Request.send(HttpError) or throw it out of an Irked controller handler. |
| UnprocessableEntity |
HTTP Status Code for Unprocessable Entity
To send this in the response, either pass an instance (with optional custom message) to
Request.send(HttpError) or throw it out of an Irked controller handler. |
| UnsupportedMediaType |
HTTP Status Code for Unsupported Media Type
To send this in the response, either pass an instance (with optional custom message) to
Request.send(HttpError) or throw it out of an Irked controller handler. |
| UpgradeRequired |
HTTP Status Code for Upgrade Required
To send this in the response, either pass an instance (with optional custom message) to
Request.send(HttpError) or throw it out of an Irked controller handler. |
| URITooLong |
HTTP Status Code for URI Too Long
To send this in the response, either pass an instance (with optional custom message) to
Request.send(HttpError) or throw it out of an Irked controller handler. |
| UseProxy |
HTTP Status Code for Use Proxy
To send this in the response, either pass an instance (with optional custom message) to
Request.send(HttpError) or throw it out of an Irked controller handler. |
| VariantAlsoNegotiates |
HTTP Status Code for Variant Also Negotiates
To send this in the response, either pass an instance (with optional custom message) to
Request.send(HttpError) or throw it out of an Irked controller handler. |
| WebSocket |
Annotation to configure a route to handle websocket requests
Set the value to configure for a specific (possibly wild-card) path, or leave empty to handle all
websocket requests.
|
| WebSocketConnection |
|
| WebSocketMessage |
|
| WebSockets |
Repeatable container for @WebSocket
|
| WebSocketUpgradeRequestWrapper |
|