Class FaviconHandler

  • All Implemented Interfaces:
    Handler<RoutingContext>, io.vertx.lang.rx.RxDelegate, PlatformHandler

    public class FaviconHandler
    extends Object
    implements io.vertx.lang.rx.RxDelegate, PlatformHandler, Handler<RoutingContext>
    A handler that serves favicons.

    If no file system path is specified it will attempt to serve a resource called `favicon.ico` from the classpath.

    NOTE: This class has been automatically generated from the original non RX-ified interface using Vert.x codegen.

    • Field Detail

      • __TYPE_ARG

        public static final io.vertx.lang.rx.TypeArg<FaviconHandler> __TYPE_ARG
      • DEFAULT_MAX_AGE_SECONDS

        public static final long DEFAULT_MAX_AGE_SECONDS
        The default max age in seconds as set in the cache-control header
        See Also:
        Constant Field Values
    • Constructor Detail

      • FaviconHandler

        public FaviconHandler​(Object delegate)
    • Method Detail

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object
      • create

        public static FaviconHandler create​(Vertx vertx)
        Create a handler with defaults
        Parameters:
        vertx -
        Returns:
        the handler
      • create

        public static FaviconHandler create​(Vertx vertx,
                                            String path)
        Create a handler attempting to load favicon file from the specified path
        Parameters:
        vertx -
        path - the path
        Returns:
        the handler
      • create

        public static FaviconHandler create​(Vertx vertx,
                                            String path,
                                            long maxAgeSeconds)
        Create a handler attempting to load favicon file from the specified path, and with the specified max cache time
        Parameters:
        vertx -
        path - the path
        maxAgeSeconds - max how long the file will be cached by browser, in seconds
        Returns:
        the handler
      • create

        public static FaviconHandler create​(Vertx vertx,
                                            long maxAgeSeconds)
        Create a handler with the specified max cache time
        Parameters:
        vertx -
        maxAgeSeconds - max how long the file will be cached by browser, in seconds
        Returns:
        the handler