Method Detail

• public void addController(java.lang.String path, java.lang.Class<? extends Controller> controllerClass)

  Register a controller

  Parameters:

  path - The controller path e.g. /photos

  controllerClass - A class containing controller actions

• public FilterRegistration addFilter(RequestFilter filter)

  Add a diego.web.Router.RequestFilter

  Parameters:

  filter - The filter to add. It will default to filtering all requests. By default, it will filter all requests. Use diego.web.Router.FilterRegistration#setUrlPattern(String) to change this.

  Returns:

  An instance of diego.web.Router.FilterRegistration for configuration

• public FilterRegistration addFilter(java.lang.String pathTemplate, RequestFilter filter)

  Add a diego.web.Router.RequestFilter

  Parameters:

  pathTemplate - The URI pattern to intercept

  filter - A class that implements the diego.web.Router.RequestFilter interface.

  Returns:

  An instance of diego.web.Router.FilterRegistration for configuration

• public FilterRegistration addFilter(java.lang.Class<? extends RequestFilter> filter)

  Add a diego.web.Router.RequestFilter

  Parameters:

  filter - A class that implements the diego.web.Router.RequestFilter interface. By default, it will filter all requests. Use diego.web.Router.FilterRegistration#setUrlPattern(String) to change this.

  Returns:

  An instance of diego.web.Router.FilterRegistration for configuration

• public Registration addInterceptor(Interceptor interceptor)

  Register an interceptor. If you wish to only apply it to certain URI's, be sure to call Registration#addUrlPattern(String)#addUrlPattern(String).

  Parameters:

  interceptor - A request interceptor

  Returns:

  The interceptor's associated registration

• public Registration addInterceptor(java.lang.String urlPattern, Interceptor interceptor)

  Register an interceptor for a given URI pattern e.g. /secure/*

  Parameters:

  urlPattern - The URI pattern

  interceptor - The interceptor

  Returns:

  The interceptor's associated registration

• public Registration addInterceptor(java.lang.Class<? extends Interceptor> interceptorClass)

  Register an interceptor using its class name. The interceptor will be created using the dependency injection tooling.

  Parameters:

  interceptorClass - A class representing an Interceptor

  Returns:

  The interceptor's associated registration

• public void addWebSocketEndpoint(java.lang.String path, java.lang.Class<?> webSocketClass)

  Set up a WebSocket endpoint. See WebSocket Endpoints

  This endpoint will be accessible from /@ws/{pathsSpec}

  Parameters:

  path - The path to the endpoint e.g. "/chat"

  webSocketClass - A class that extends the jakarta.websocket.Endpoint class.

• public StaticResourceHandler serve(java.lang.String pathSpec, java.nio.file.Path dir)

  Serve files from a local directory

  Parameters:

  pathSpec - The servlet mapping path. For example "assets/*"

  dir - The directory on disk

  Returns:

  A StaticResourceHandler for further configuration.