Class CorsHandler

java.lang.Object
io.vertx.rxjava3.ext.web.handler.CorsHandler
All Implemented Interfaces:
Handler<RoutingContext>, io.vertx.lang.rx.RxDelegate, SecurityPolicyHandler
public class CorsHandler extends Object implements io.vertx.lang.rx.RxDelegate, SecurityPolicyHandler, Handler<RoutingContext>
A handler which implements server side http://www.w3.org/TR/cors/[CORS] support for Vert.x-Web.

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

  • Field Details

    • __TYPE_ARG

      public static final io.vertx.lang.rx.TypeArg<CorsHandler> __TYPE_ARG

  • Constructor Details

    • CorsHandler

      public CorsHandler(CorsHandler delegate)

    • CorsHandler

      public CorsHandler(Object delegate)

  • Method Details

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • getDelegate

      public CorsHandler getDelegate()
      Specified by:
      getDelegate in interface io.vertx.lang.rx.RxDelegate
      Specified by:
      getDelegate in interface SecurityPolicyHandler

    • handle

      public void handle(RoutingContext event)
      Something has happened, so handle it.
      Specified by:
      handle in interface Handler<RoutingContext>
      Specified by:
      handle in interface SecurityPolicyHandler
      Parameters:
      event - the event to handle

    • create

      public static CorsHandler create()
      Create a empty CORS handler that allows * origin.
      Returns:
      the handler

    • addOrigin

      public CorsHandler addOrigin(String origin)
      Add an origin to the list of allowed Origins. An origin follows rfc6454#section-7 and is expected to have the format: "://" [ ":" ]
      Parameters:
      origin - the well formatted static origin
      Returns:
      self

    • addOriginsWithRegex

      public CorsHandler addOriginsWithRegex(List<String> origins)
      Set the list of allowed regex origins. A regex origin is a pattern that should match the format "://" [ ":" ].
      Parameters:
      origins - the well formatted regex origin list
      Returns:
      self

    • addOriginWithRegex

      public CorsHandler addOriginWithRegex(String origin)
      Add a regex origin to the list of allowed Origins. A regex origin is a pattern that should match the format "://" [ ":" ].
      Parameters:
      origin - the well formatted static origin
      Returns:
      self

    • addOrigins

      public CorsHandler addOrigins(List<String> origins)
      Set the list of allowed origins. An origin follows rfc6454#section-7 and is expected to have the format: "://" [ ":" ]
      Parameters:
      origins - the well formatted static origin list
      Returns:
      self

    • allowedMethod

      public CorsHandler allowedMethod(HttpMethod method)
      Add an allowed method
      Parameters:
      method - the method to add
      Returns:
      a reference to this, so the API can be used fluently

    • allowedMethods

      public CorsHandler allowedMethods(Set<HttpMethod> methods)
      Add a set of allowed methods
      Parameters:
      methods - the methods to add
      Returns:
      a reference to this, so the API can be used fluently

    • allowedHeader

      public CorsHandler allowedHeader(String headerName)
      Add an allowed header
      Parameters:
      headerName - the allowed header name
      Returns:
      a reference to this, so the API can be used fluently

    • allowedHeaders

      public CorsHandler allowedHeaders(Set<String> headerNames)
      Add a set of allowed headers
      Parameters:
      headerNames - the allowed header names
      Returns:
      a reference to this, so the API can be used fluently

    • exposedHeader

      public CorsHandler exposedHeader(String headerName)
      Add an exposed header
      Parameters:
      headerName - the exposed header name
      Returns:
      a reference to this, so the API can be used fluently

    • exposedHeaders

      public CorsHandler exposedHeaders(Set<String> headerNames)
      Add a set of exposed headers
      Parameters:
      headerNames - the exposed header names
      Returns:
      a reference to this, so the API can be used fluently

    • allowCredentials

      public CorsHandler allowCredentials(boolean allow)
      Set whether credentials are allowed. Note that user agents will block requests that use a wildcard as origin and include credentials. From the MDN documentation you can read:
      Important note: when responding to a credentialed request, server must specify a domain, and cannot use wild carding.
      Parameters:
      allow - true if allowed
      Returns:
      a reference to this, so the API can be used fluently

    • maxAgeSeconds

      public CorsHandler maxAgeSeconds(int maxAgeSeconds)
      Set how long the browser should cache the information
      Parameters:
      maxAgeSeconds - max age in seconds
      Returns:
      a reference to this, so the API can be used fluently

    • allowPrivateNetwork

      public CorsHandler allowPrivateNetwork(boolean allow)
      Set whether access from public to private networks are allowed. Defaults to false
      Parameters:
      allow - true if allowed
      Returns:
      a reference to this, so the API can be used fluently

    • newInstance

      public static CorsHandler newInstance(CorsHandler arg)