Package dev.voidframework.web.http

Class Result

java.lang.Object
dev.voidframework.web.http.Result
public final class Result extends Object
An HTTP result.
Since:
1.0.0

  • Constructor Details

    • Result

      public Result()
      Build an empty new instance. This constructor is useful during deserialize process
      Since:
      1.1.0

  • Method Details

    • badRequest

      public static Result badRequest()
      Bad request (400).
      Returns:
      A result
      Since:
      1.2.0

    • badRequest

      public static Result badRequest(String content)
      Bad request (400).
      Parameters:
      content - The content
      Returns:
      A result
      Since:
      1.0.0

    • badRequest

      public static Result badRequest(String content, String contentType)
      Bad request (400).
      Parameters:
      content - The content
      contentType - The content type
      Returns:
      A result
      Since:
      1.7.0

    • badRequest

      public static Result badRequest(String content, String contentType, Charset charset)
      Bad request (400).
      Parameters:
      content - The content
      contentType - The content type
      charset - The content charset
      Returns:
      A result
      Since:
      1.5.0

    • badRequest

      public static Result badRequest(byte[] content, String contentType)
      Bad request (400).
      Parameters:
      content - The content
      contentType - The content type
      Returns:
      A result
      Since:
      1.0.0

    • badRequest

      public static Result badRequest(byte[] content, String contentType, Charset charset)
      Bad request (400).
      Parameters:
      content - The content
      contentType - The content type
      charset - The content charset
      Returns:
      A result
      Since:
      1.5.0

    • badRequest

      public static Result badRequest(com.fasterxml.jackson.databind.JsonNode content)
      Bad request (400).
      Parameters:
      content - The JSON content
      Returns:
      A result
      Since:
      1.0.0

    • badRequest

      public static Result badRequest(TemplateResult templateResult)
      Bad request (400).
      Parameters:
      templateResult - The template to render
      Returns:
      A result
      Since:
      1.0.0

    • created

      public static Result created()
      Created (201).
      Returns:
      A result
      Since:
      1.2.0

    • created

      public static Result created(String content)
      Created (201).
      Parameters:
      content - The content
      Returns:
      A result
      Since:
      1.0.0

    • created

      public static Result created(String content, String contentType)
      Created (201).
      Parameters:
      content - The content
      contentType - The content type
      Returns:
      A result
      Since:
      1.5.0

    • created

      public static Result created(String content, String contentType, Charset charset)
      Created (201).
      Parameters:
      content - The content
      contentType - The content type
      charset - The content charset
      Returns:
      A result
      Since:
      1.5.0

    • created

      public static Result created(byte[] content, String contentType)
      Created (201).
      Parameters:
      content - The content
      contentType - The content type
      Returns:
      A result
      Since:
      1.0.0

    • created

      public static Result created(byte[] content, String contentType, Charset charset)
      Created (201).
      Parameters:
      content - The content
      contentType - The content type
      charset - The content charset
      Returns:
      A result
      Since:
      1.5.0

    • created

      public static Result created(com.fasterxml.jackson.databind.JsonNode content)
      Created (201).
      Parameters:
      content - The JSON content
      Returns:
      A result
      Since:
      1.0.0

    • created

      public static Result created(TemplateResult templateResult)
      Created (201).
      Parameters:
      templateResult - The template to render
      Returns:
      A result
      Since:
      1.0.0

    • forbidden

      public static Result forbidden()
      Forbidden (403).
      Returns:
      A result
      Since:
      1.2.0

    • forbidden

      public static Result forbidden(String content)
      Forbidden (403).
      Parameters:
      content - The content
      Returns:
      A result
      Since:
      1.0.0

    • forbidden

      public static Result forbidden(String content, String contentType)
      Forbidden (403).
      Parameters:
      content - The content
      contentType - The content type
      Returns:
      A result
      Since:
      1.5.0

    • forbidden

      public static Result forbidden(String content, String contentType, Charset charset)
      Forbidden (403).
      Parameters:
      content - The content
      contentType - The content type
      charset - The content charset
      Returns:
      A result
      Since:
      1.5.0

    • forbidden

      public static Result forbidden(byte[] content, String contentType)
      Forbidden (403).
      Parameters:
      content - The content
      contentType - The content type
      Returns:
      A result
      Since:
      1.0.0

    • forbidden

      public static Result forbidden(byte[] content, String contentType, Charset charset)
      Forbidden (403).
      Parameters:
      content - The content
      contentType - The content type
      charset - The content charset
      Returns:
      A result
      Since:
      1.5.0

    • forbidden

      public static Result forbidden(com.fasterxml.jackson.databind.JsonNode content)
      Forbidden (403).
      Parameters:
      content - The JSON content
      Returns:
      A result
      Since:
      1.0.0

    • forbidden

      public static Result forbidden(TemplateResult templateResult)
      Forbidden (403).
      Parameters:
      templateResult - The template to render
      Returns:
      A result
      Since:
      1.0.0

    • internalServerError

      public static Result internalServerError()
      Internal Server Error (500).
      Returns:
      A result
      Since:
      1.2.0

    • internalServerError

      public static Result internalServerError(String content)
      Internal Server Error (500).
      Parameters:
      content - The content
      Returns:
      A result
      Since:
      1.0.0

    • internalServerError

      public static Result internalServerError(String content, String contentType)
      Internal Server Error (500).
      Parameters:
      content - The content
      contentType - The content type
      Returns:
      A result
      Since:
      1.5.0

    • internalServerError

      public static Result internalServerError(String content, String contentType, Charset charset)
      Internal Server Error (500).
      Parameters:
      content - The content
      contentType - The content type
      charset - The content charset
      Returns:
      A result
      Since:
      1.5.0

    • internalServerError

      public static Result internalServerError(byte[] content, String contentType)
      Internal Server Error (500).
      Parameters:
      content - The content
      contentType - The content type
      Returns:
      A result
      Since:
      1.0.0

    • internalServerError

      public static Result internalServerError(byte[] content, String contentType, Charset charset)
      Internal Server Error (500).
      Parameters:
      content - The content
      contentType - The content type
      charset - The content charset
      Returns:
      A result
      Since:
      1.5.0

    • internalServerError

      public static Result internalServerError(com.fasterxml.jackson.databind.JsonNode content)
      Internal Server Error (500).
      Parameters:
      content - The JSON content
      Returns:
      A result
      Since:
      1.0.0

    • internalServerError

      public static Result internalServerError(TemplateResult templateResult)
      Internal Server Error (500).
      Parameters:
      templateResult - The template to render
      Returns:
      A result
      Since:
      1.0.0

    • noContent

      public static Result noContent()
      No Content (204).
      Returns:
      A result
      Since:
      1.0.0

    • notFound

      public static Result notFound()
      Not Found (404).
      Returns:
      A result
      Since:
      1.2.0

    • notFound

      public static Result notFound(String content)
      Not Found (404).
      Parameters:
      content - The content
      Returns:
      A result
      Since:
      1.0.0

    • notFound

      public static Result notFound(String content, String contentType)
      Not Found (404).
      Parameters:
      content - The content
      contentType - The content type
      Returns:
      A result
      Since:
      1.5.0

    • notFound

      public static Result notFound(String content, String contentType, Charset charset)
      Not Found (404).
      Parameters:
      content - The content
      contentType - The content type
      charset - The content charset
      Returns:
      A result
      Since:
      1.5.0

    • notFound

      public static Result notFound(byte[] content, String contentType)
      Not Found (404).
      Parameters:
      content - The content
      contentType - The content type
      Returns:
      A result
      Since:
      1.0.0

    • notFound

      public static Result notFound(byte[] content, String contentType, Charset charset)
      Not Found (404).
      Parameters:
      content - The content
      contentType - The content type
      charset - The content charset
      Returns:
      A result
      Since:
      1.5.0

    • notFound

      public static Result notFound(com.fasterxml.jackson.databind.JsonNode content)
      Not Found (404).
      Parameters:
      content - The JSON content
      Returns:
      A result
      Since:
      1.0.0

    • notFound

      public static Result notFound(TemplateResult templateResult)
      Not Found (404).
      Parameters:
      templateResult - The template to render
      Returns:
      A result
      Since:
      1.0.0

    • notImplemented

      public static Result notImplemented()
      Not Implemented (501).
      Returns:
      A result
      Since:
      1.2.0

    • notImplemented

      public static Result notImplemented(String content)
      Not Implemented (501).
      Parameters:
      content - The content
      Returns:
      A result
      Since:
      1.0.0

    • notImplemented

      public static Result notImplemented(String content, String contentType)
      Not Implemented (501).
      Parameters:
      content - The content
      contentType - The content type
      Returns:
      A result
      Since:
      1.5.0

    • notImplemented

      public static Result notImplemented(String content, String contentType, Charset charset)
      Not Implemented (501).
      Parameters:
      content - The content
      contentType - The content type
      charset - The content charset
      Returns:
      A result
      Since:
      1.5.0

    • notImplemented

      public static Result notImplemented(byte[] content, String contentType)
      Not Implemented (501).
      Parameters:
      content - The content
      contentType - The content type
      Returns:
      A result
      Since:
      1.0.0

    • notImplemented

      public static Result notImplemented(byte[] content, String contentType, Charset charset)
      Not Implemented (501).
      Parameters:
      content - The content
      contentType - The content type
      charset - The content charset
      Returns:
      A result
      Since:
      1.5.0

    • notImplemented

      public static Result notImplemented(com.fasterxml.jackson.databind.JsonNode content)
      Not Implemented (501).
      Parameters:
      content - The JSON content
      Returns:
      A result
      Since:
      1.0.0

    • notImplemented

      public static Result notImplemented(TemplateResult templateResult)
      Not Implemented (501).
      Parameters:
      templateResult - The template to render
      Returns:
      A result
      Since:
      1.0.0

    • ok

      public static Result ok()
      Ok (200).
      Returns:
      A result
      Since:
      1.2.0

    • ok

      public static Result ok(String content)
      Ok (200).
      Parameters:
      content - The content
      Returns:
      A result
      Since:
      1.0.0

    • ok

      public static Result ok(String content, String contentType)
      Ok (200).
      Parameters:
      content - The content
      contentType - The content type
      Returns:
      A result
      Since:
      1.5.0

    • ok

      public static Result ok(String content, String contentType, Charset charset)
      Ok (200).
      Parameters:
      content - The content
      contentType - The content type
      charset - The content charset
      Returns:
      A result
      Since:
      1.5.0

    • ok

      public static Result ok(byte[] content, String contentType)
      Ok (200).
      Parameters:
      content - The content
      contentType - The content type
      Returns:
      A result
      Since:
      1.0.0

    • ok

      public static Result ok(byte[] content, String contentType, Charset charset)
      Ok (200).
      Parameters:
      content - The content
      contentType - The content type
      charset - The content charset
      Returns:
      A result
      Since:
      1.5.0

    • ok

      public static Result ok(InputStream content, String contentType)
      Ok (200).
      Parameters:
      content - The input stream content
      contentType - The content type
      Returns:
      A result
      Since:
      1.0.0

    • ok

      public static Result ok(com.fasterxml.jackson.databind.JsonNode content)
      Ok (200).
      Parameters:
      content - The JSON content
      Returns:
      A result
      Since:
      1.0.0

    • ok

      public static Result ok(TemplateResult templateResult)
      Ok (200).
      Parameters:
      templateResult - The template to render
      Returns:
      A result
      Since:
      1.0.0

    • redirectMovedPermanently

      public static Result redirectMovedPermanently(String uri)
      Moved Permanently (301). GET methods unchanged. Others may or may not be changed to GET.
      Parameters:
      uri - The URL to redirect to
      Returns:
      A result
      Since:
      1.3.0

    • redirectPermanentRedirect

      public static Result redirectPermanentRedirect(String uri)
      Permanent Redirect (308). Method and body not changed.
      Parameters:
      uri - The URL to redirect to
      Returns:
      A result
      Since:
      1.3.0

    • redirectFound

      public static Result redirectFound(String uri)
      Found (302). GET methods unchanged. Others may or may not be changed to GET.
      Parameters:
      uri - The URL to redirect to
      Returns:
      A result
      Since:
      1.3.0

    • redirectSeeOther

      public static Result redirectSeeOther(String uri)
      See other (303). GET methods unchanged. Others changed to GET.
      Parameters:
      uri - The URL to redirect to
      Returns:
      A result
      Since:
      1.3.0

    • redirectTemporaryRedirect

      public static Result redirectTemporaryRedirect(String uri)
      See other (307). Method and body not changed.
      Parameters:
      uri - The URL to redirect to
      Returns:
      A result
      Since:
      1.3.0

    • withCookie

      public Result withCookie(Cookie cookie)
      Assigns a new cookie.
      Parameters:
      cookie - The cookie to assign
      Returns:
      The current result
      Since:
      1.0.0

    • withoutCookie

      public Result withoutCookie(Cookie cookie)
      Removes a cookie.
      Parameters:
      cookie - The cookie to remove
      Returns:
      The current result
      Since:
      1.0.0

    • withoutCookie

      public Result withoutCookie(String cookieName)
      Removes a cookie.
      Parameters:
      cookieName - Name of the cookie to remove
      Returns:
      The current result
      Since:
      1.0.0

    • withHeader

      public Result withHeader(String headerName, String value)
      Assigns a new header.
      Parameters:
      headerName - Name of the header
      value - Value to assign
      Returns:
      The current result
      Since:
      1.0.0

    • withHeaders

      public Result withHeaders(Map<String,String> headerMap)
      Assigns a multiple headers.
      Parameters:
      headerMap - headers to assign
      Returns:
      The current result
      Since:
      1.2.0

    • withoutHeader

      public Result withoutHeader(String headerName)
      Removes a header.
      Parameters:
      headerName - Name of the header to remove
      Returns:
      The current result
      Since:
      1.0.0

    • getCookies

      public Map<String,Cookie> getCookies()
      Gets all cookies.
      Returns:
      All cookies
      Since:
      1.0.0

    • getHeaders

      public Map<String,String> getHeaders()
      Gets all headers.
      Returns:
      All headers
      Since:
      1.0.0

    • getHttpCode

      public int getHttpCode()
      Gets the HTTP return code.
      Returns:
      The HTTP return code
      Since:
      1.0.0

    • getContentType

      public String getContentType()
      Gets the content type.
      Returns:
      The content type
      Since:
      1.0.0

    • getResultProcessor

      public ResultProcessor getResultProcessor()
      Returns the result processor.
      Returns:
      The result processor
      Since:
      1.0.0