Package io.undertow.server.handlers.builder

Interface HandlerBuilder

All Known Implementing Classes:
AccessControlListHandler.Builder, AccessLogHandler.Builder, AllowedMethodsHandler.Builder, BlockingHandler.Builder, ByteRangeHandler.Builder, CanonicalPathHandler.Builder, DisableCacheHandler.Builder, DisallowedMethodsHandler.Builder, EagerFormParsingHandler.Builder, ForwardedHandler.Builder, HttpContinueAcceptingHandler.Builder, HttpTraceHandler.Builder, IPAddressAccessControlHandler.Builder, JDBCLogHandler.Builder, JvmRouteHandler.Builder, LearningPushHandler.Builder, LocalNameResolvingHandler.Builder, PathSeparatorHandler.Builder, PeerNameResolvingHandler.Builder, PredicatesHandler.DoneHandlerBuilder, PredicatesHandler.RestartHandlerBuilder, ProxyPeerAddressHandler.Builder, RedirectHandler.Builder, RequestDumpingHandler.Builder, RequestLimitingHandler.Builder, ResourceHandler.Builder, ResponseCodeHandlerBuilder, ResponseRateLimitingHandler.Builder, RewriteHandlerBuilder, SameSiteCookieHandler.Builder, SecureCookieHandler.Builder, SetAttributeHandler.Builder, SetAttributeHandler.ClearBuilder, SetHeaderHandler.Builder, SSLHeaderHandler.Builder, StoredResponseHandler.Builder, StuckThreadDetectionHandler.Builder, URLDecodingHandler.Builder
public interface HandlerBuilder
Interface that provides a way of providing a textual representation of a handler.
Author:
Stuart Douglas

  • Method Details

    • name

      String name()
      The string representation of the handler name.
      Returns:
      The handler name

    • parameters

      Map<String,Class<?>> parameters()
      Returns a map of parameters and their types.

    • requiredParameters

      Set<String> requiredParameters()
      Returns:
      The required parameters

    • defaultParameter

      String defaultParameter()
      Returns:
      The default parameter name, or null if it does not have a default parameter

    • build

      HandlerWrapper build(Map<String,Object> config)
      Creates the handler
      Parameters:
      config - The handler config
      Returns:
      The new predicate