Package com.codingchili.core.protocol
package com.codingchili.core.protocol
Contains annotations and tools for building API's in a
CoreHandler.-
Interface SummaryInterfaceDescriptionHandles the mapping of routes to roles.Protocol exception handler.RequestHandler<Request>Functional interface used for routes in a handler.Identifies a role with a name and an access level.
-
Class SummaryClassDescriptionTemplate for generating valid OpenAPI 3 definitions, see https://apidevtools.org/swagger-parser/online/Protocol<RequestType>Maps packet data to authorizer and manages authentication status for authorizer.Contains protocol mappings and descriptions.Basic form of a request response.Helper methods for creating response messages.Add custom roles to the rolemap, must be done before initializing protocols.Route<T>Models a route in the Protocol.Serializes objects to JSON or YAML and back.Maps roles to routes.See io.vertx.core.json.jackson.DatabindCodec for all available de/serializers.
-
Enum Class SummaryEnum ClassDescriptionList of the available response statuses.Extend this interface to provide more role types.
-
Annotation Interfaces SummaryAnnotation InterfaceDescriptionAlternate way of specifying a handlers listening address.Indicates that the annotated method does not require authentication.An annotation that indicates that the annotated method should be picked up by protocols when calling
Protocol.annotated(Receiver).Used to sed the data transfer object for a protocol, used for documentation purposes.Annotation that can add a description to handlers and routes in a handler.Sets the default access level on a handler.An annotation that indicates that the annotated method should be picked up by protocols when callingProtocol.annotated(Receiver).