Module com.erudika.para.core
Package com.erudika.para.core.rest

Interface CustomResourceHandler

public interface CustomResourceHandler
A custom API resource handler. Handles custom resources.
Author:
Alex Bogdanovski [[email protected]]

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getRelativePath()
    The relative path of the custom resource.
    javax.ws.rs.core.Response
    handleDelete(javax.ws.rs.container.ContainerRequestContext ctx)
    This method is called when a DELETE request to be handled.
    javax.ws.rs.core.Response
    handleGet(javax.ws.rs.container.ContainerRequestContext ctx)
    This method is called when a GET request to be handled.
    javax.ws.rs.core.Response
    handlePatch(javax.ws.rs.container.ContainerRequestContext ctx)
    This method is called when a PATCH request to be handled.
    javax.ws.rs.core.Response
    handlePost(javax.ws.rs.container.ContainerRequestContext ctx)
    This method is called when a POST request to be handled.
    javax.ws.rs.core.Response
    handlePut(javax.ws.rs.container.ContainerRequestContext ctx)
    This method is called when a PUT request to be handled.

  • Method Details

    • getRelativePath

      String getRelativePath()
      The relative path of the custom resource.
      Returns:
      any string (Jersey path parameters are allowed)

    • handleGet

      javax.ws.rs.core.Response handleGet(javax.ws.rs.container.ContainerRequestContext ctx)
      This method is called when a GET request to be handled.
      Parameters:
      ctx - the context object - contains all the details of the request and context
      Returns:
      a response

    • handlePost

      javax.ws.rs.core.Response handlePost(javax.ws.rs.container.ContainerRequestContext ctx)
      This method is called when a POST request to be handled.
      Parameters:
      ctx - the context object - contains all the details of the request and context
      Returns:
      a response

    • handlePatch

      javax.ws.rs.core.Response handlePatch(javax.ws.rs.container.ContainerRequestContext ctx)
      This method is called when a PATCH request to be handled.
      Parameters:
      ctx - the context object - contains all the details of the request and context
      Returns:
      a response

    • handlePut

      javax.ws.rs.core.Response handlePut(javax.ws.rs.container.ContainerRequestContext ctx)
      This method is called when a PUT request to be handled.
      Parameters:
      ctx - the context object - contains all the details of the request and context
      Returns:
      a response

    • handleDelete

      javax.ws.rs.core.Response handleDelete(javax.ws.rs.container.ContainerRequestContext ctx)
      This method is called when a DELETE request to be handled.
      Parameters:
      ctx - the context object - contains all the details of the request and context
      Returns:
      a response