Class ResourceApiVersionRoutingFilter

  • All Implemented Interfaces:
    org.forgerock.http.Filter, Filter

    public class ResourceApiVersionRoutingFilter
    extends org.forgerock.http.routing.ResourceApiVersionRoutingFilter
    implements Filter
    API Version routing filter which creates a ApiVersionRouterContext which contains the default routing behaviour when the Accept-API-Version header is set on the request. In addition also sets the Warning and Content-API-Version headers on the response.
    • Method Detail

      • filterAction

        public Promise<ActionResponse,​ResourceException> filterAction​(org.forgerock.services.context.Context context,
                                                                            ActionRequest request,
                                                                            RequestHandler next)
        Description copied from interface: Filter
        Filters an action request.
        Specified by:
        filterAction in interface Filter
        Parameters:
        context - The filter chain context.
        request - The action request.
        next - A request handler representing the remainder of the filter chain.
        Returns:
        A Promise containing the result of the operation.
      • filterCreate

        public Promise<ResourceResponse,​ResourceException> filterCreate​(org.forgerock.services.context.Context context,
                                                                              CreateRequest request,
                                                                              RequestHandler next)
        Description copied from interface: Filter
        Filters a create request.
        Specified by:
        filterCreate in interface Filter
        Parameters:
        context - The filter chain context.
        request - The create request.
        next - A request handler representing the remainder of the filter chain.
        Returns:
        A Promise containing the result of the operation.
      • filterDelete

        public Promise<ResourceResponse,​ResourceException> filterDelete​(org.forgerock.services.context.Context context,
                                                                              DeleteRequest request,
                                                                              RequestHandler next)
        Description copied from interface: Filter
        Filters a delete request.
        Specified by:
        filterDelete in interface Filter
        Parameters:
        context - The filter chain context.
        request - The delete request.
        next - A request handler representing the remainder of the filter chain.
        Returns:
        A Promise containing the result of the operation.
      • filterPatch

        public Promise<ResourceResponse,​ResourceException> filterPatch​(org.forgerock.services.context.Context context,
                                                                             PatchRequest request,
                                                                             RequestHandler next)
        Description copied from interface: Filter
        Filters a patch request.
        Specified by:
        filterPatch in interface Filter
        Parameters:
        context - The filter chain context.
        request - The patch request.
        next - A request handler representing the remainder of the filter chain.
        Returns:
        A Promise containing the result of the operation.
      • filterQuery

        public Promise<QueryResponse,​ResourceException> filterQuery​(org.forgerock.services.context.Context context,
                                                                          QueryRequest request,
                                                                          QueryResourceHandler handler,
                                                                          RequestHandler next)
        Description copied from interface: Filter
        Filters a query request.

        Implementations which return results directly rather than forwarding the request should invoke QueryResourceHandler.handleResource(ResourceResponse) for each resource which matches the query criteria. Once all matching resources have been returned implementations are required to return either a QueryResponse if the query has completed successfully, or ResourceException if the query did not complete successfully (even if some matching resources were returned).

        Specified by:
        filterQuery in interface Filter
        Parameters:
        context - The filter chain context.
        request - The query request.
        handler - The resource handler.
        next - A request handler representing the remainder of the filter chain.
        Returns:
        A Promise containing the result of the operation.
      • filterRead

        public Promise<ResourceResponse,​ResourceException> filterRead​(org.forgerock.services.context.Context context,
                                                                            ReadRequest request,
                                                                            RequestHandler next)
        Description copied from interface: Filter
        Filters a read request.
        Specified by:
        filterRead in interface Filter
        Parameters:
        context - The filter chain context.
        request - The read request.
        next - A request handler representing the remainder of the filter chain.
        Returns:
        A Promise containing the result of the operation.
      • filterUpdate

        public Promise<ResourceResponse,​ResourceException> filterUpdate​(org.forgerock.services.context.Context context,
                                                                              UpdateRequest request,
                                                                              RequestHandler next)
        Description copied from interface: Filter
        Filters an update request.
        Specified by:
        filterUpdate in interface Filter
        Parameters:
        context - The filter chain context.
        request - The update request.
        next - A request handler representing the remainder of the filter chain.
        Returns:
        A Promise containing the result of the operation.