Package eu.cloudnetservice.driver.network.http

Interface HttpComponent<T extends HttpComponent<T>>

Type Parameters:
T - the generic type of the component implementing this class.
All Superinterfaces:
AutoCloseable
All Known Subinterfaces:
HttpServer
All Known Implementing Classes:
NettyHttpServer
public interface HttpComponent<T extends HttpComponent<T>> extends AutoCloseable
Represents any http component, providing an abstract layer for registering listeners to it.
Since:
4.0
See Also:

  • Method Details

    • sslEnabled

      boolean sslEnabled()
      Gets whether this component has ssl enabled or not.
      Returns:
      whether this component has ssl enabled or not.

    • annotationParser

      @NonNull @NonNull HttpAnnotationParser<T> annotationParser()
      Get a http annotation parser which is associated with this component and can therefore be used to register annotated handlers to this component.
      Returns:
      the associated http annotation parser instance.

    • registerHandler

      @NonNull T registerHandler(@NonNull @NonNull String path, @NonNull @NonNull HttpHandler... handlers)
      Registers the given handlers to this component. The given handlers will get called when a request matches the given path. Equivalent to component.registerHandler(path, HttpHandler.PRIORITY_NORMAL, handlers).
      Parameters:
      path - the path to register the handler to.
      handlers - the handlers to register.
      Returns:
      the same component instance as used to call the method, for chaining.
      Throws:
      NullPointerException - if either the given path or handlers are null.

    • registerHandler

      @NonNull T registerHandler(@NonNull @NonNull String path, int priority, @NonNull @NonNull HttpHandler... handlers)
      Registers the given handlers to this component. The given handlers will get called when a request matches the given path. Equivalent to component.registerHandler(path, null, priority, handlers).
      Parameters:
      path - the path to register the handler to.
      priority - the priority of the given handlers.
      handlers - the handlers to register.
      Returns:
      the same component instance as used to call the method, for chaining.
      Throws:
      NullPointerException - if either the given path or handlers are null.

    • registerHandler

      @NonNull T registerHandler(@NonNull @NonNull String path, @Nullable @Nullable Integer port, int priority, @NonNull @NonNull HttpHandler... handlers)
      Registers the given handlers to this component. The given handlers will get called when a request matches the given path and (if provided) gets called on the same port as set here. The path may contain the following placeholders:
      • *: Represents a wildcard character which matches anything provided in the path.
      • {name}: Represents a path parameter you want to retrieve when handling the request.
      Parameters:
      path - the path to register the handler to.
      port - the port on which the handlers should get called, null represents all ports.
      priority - the priority of the given handlers.
      handlers - the handlers to register.
      Returns:
      the same component instance as used to call the method, for chaining.
      Throws:
      NullPointerException - if either the given path or handlers are null.

    • removeHandler

      @NonNull T removeHandler(@NonNull @NonNull HttpHandler handler)
      Unregisters the given handler from this component if it was registered previously.
      Parameters:
      handler - the handler to unregister.
      Returns:
      the same component instance as used to call the method, for chaining.
      Throws:
      NullPointerException - if the given handler is null.

    • removeHandler

      @NonNull T removeHandler(@NonNull @NonNull ClassLoader classLoader)
      Removes all registered handlers from this component whose classes were loaded by the given class loader.
      Parameters:
      classLoader - the loader of the handler classes to unregister.
      Returns:
      the same component instance as used to call the method, for chaining.
      Throws:
      NullPointerException - if the given class loader is null.

    • httpHandlers

      @NonNull @NonNull Collection<HttpHandler> httpHandlers()
      Get all handlers which were registered to this component.
      Returns:
      all handlers which were registered to this component.

    • clearHandlers

      @NonNull T clearHandlers()
      Removes all handlers which were previously registered to this component.
      Returns:
      the same component instance as used to call the method, for chaining.