HttpStatus JSP Tag Library https://github.com/ethauvin/httpstatus

301 404 bean code codes http jsp library rfc2616 rfc7231 status tag

Find a file

Erik C. Thauvin d0770a76f6 Upgraded to bld 1.7.2		2023-08-20 16:47:57 -07:00
.circleci	Update config.yml	2023-08-17 13:14:00 -07:00
.github/workflows	Fixed COVERAGE_SDK	2023-08-12 18:24:45 -07:00
.idea	Upgraded to bld 1.7.2	2023-08-20 16:47:57 -07:00
.vscode	Upgraded to RIFE2 1.7.0	2023-05-12 15:40:44 -07:00
config	Moved from Gradle to bld	2023-05-10 00:21:31 -07:00
lib/bld	Upgraded to bld 1.7.2	2023-08-20 16:47:57 -07:00
src	Fix copyright	2023-08-19 00:57:31 -07:00
.github_changelog_generator	Moved to Jakarta EE. Closes #7	2022-08-27 18:14:54 -07:00
.gitignore	Moved from Gradle to bld	2023-05-10 00:21:31 -07:00
bld	Moved from Gradle to bld	2023-05-10 00:21:31 -07:00
bld.bat	Moved from Gradle to bld	2023-05-10 00:21:31 -07:00
CHANGELOG.md	Moved to Jakarta EE. Closes #7	2022-08-27 18:14:54 -07:00
LICENSE.txt	Moved from Gradle to bld	2023-05-10 00:21:31 -07:00
pom.xml	Added SonarCloud badge	2023-08-12 13:55:34 -07:00
README.md	Fix snapshot badge	2023-08-19 00:57:54 -07:00
sonar-project.properties	Revert "Testing sonar with less options"	2023-08-12 21:37:59 -07:00

README.md

HttpStatus JSP Tag Library

A simple JSP Tag Library to display the code, reason, cause and/or message for HTTP status codes in JSP error pages.

For example:

<%@ page isErrorPage="true" %>
<%@ taglib prefix="hs" uri="http://erik.thauvin.net/taglibs/httpstatus" %>
<html><head>
<title><hs:code/> <hs:reason default="Server Error"/></title>
</head>
<h1><hs:reason default="Server Error"/></h1>
Cause: <pre><hs:cause default="Unable to complete your request."/></pre>
Message: <pre><hs:message default="A server error has occured."/></pre>
...

<%@ page isErrorPage="true" import="net.thauvin.erik.httpstatus.Reasons" %>
<%= Reasons.getReasonPhrase(pageContext.getErrorData().getStatusCode()) %>

would display on a 501 status code:

Not Implemented

Usage with Gradle or Maven

Include the following in your build.gradle file:

repositories {
    mavenCentral()
}

dependencies {
    implementation 'net.thauvin.erik.httpstatus:httpstatus:1.0.5'
}

or as a Maven artifact:

<dependency>
    <groupId>net.thauvin.erik.httpstatus</groupId>
    <artifactId>httpstatus</artifactId>
    <version>1.0.5</version>
</dependency>

hs:cause

The <hs:cause/> tag displays the cause of current HTTP status code, if any. A shorthand for:

<%= pageContext.getErrorData().getThrowable().getCause().getLocalizedMessage() %>

Optional attributes are:

Attribute	Description
`default`	The fallback value to output, if no cause is
`escapeXml`	Converts <, >, &, ', " to their corresponding entity codes. Value is `true` by default.

hs:code

The <hs:code/> tag displays the current HTTP status code, if any. A shorthand for:

<%= pageContext.getErrorData().getStatusCode() %>

hs:message

The <hs:message/> tag displays the current error message, if any. A shorthand for:

<%= request.getAttribute("javax.servlet.error.message") %>

Optional attributes are:

Attribute	Description
`default`	The fallback value to output, if no error message is available.
`escapeXml`	Converts <, >, &, ', " to their corresponding entity codes. Value is `true` by default.

hs:reason

The <hs:reason/> tag displays the reason for a HTTP status code, if any. Optional attributes are:

Attribute	Description
`default`	The fallback value to output, if no reason is available.
`code`	The HTTP status error code. If not specified the current status code is used.
`escapeXml`	Converts <, >, &, ', " to their corresponding entity codes. Value is `true` by default.

StatusCode Bean

The StatusCode bean can be used to check the class of the status code error. For example, using the JSTL:

<%@ taglib prefix="hs" uri="http://erik.thauvin.net/taglibs/httpstatus" %>
<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %>

<jsp:useBean id="statusCode" class="net.thauvin.erik.httpstatus.StatusCode"/>
<c:set target="${statusCode}" property="code"><hs:code/></c:set>
<c:choose>
    <c:when test="${statusCode.isClientError()}">
        An error occurred on your side. (<hs:reason/>)
    </c:when>
    <c:otherwise>
        An error occurred on our side. (<hs:message/>)
    </c:otherwise>
</c:choose>

or in a Servlet:

import net.thauvin.erik.httpstatus.StatusCode;

// ---

StatusCode statusCode = new StatusCode((Integer) request.getAttribute("javax.servlet.error.status_code"));
if (statusCode.isError()) {
    if (statusCode.isServerError()) {
        String reason = statusCode.getReason();
    } else {
        // ...
    }
}

The StatusCode bean methods are:

Method	Description
`getReason`	Returns the reason for the status code (eg: `Internal Server Error`)
`isClientError`	Checks if the status code is a client error.
`isError`	Checks if the status code is a server or client error.
`isInfo`	Checks if the status code is informational.
`isRedirect`	Checks if the status code is a redirect.
`isServerError`	Checks if the status code is a server error.
`isSuccess`	Checks if the status code is a success. (`OK`)
`isValid`	Checks if the status code is valid.

Reasons

The reasons are defined in a ResourceBundle properties as follows:

Status Code	Reason
`100`	Continue
`101`	Switching Protocols
`102`	Processing
`103`	Early Hints
`200`	OK
`201`	Created
`202`	Accepted
`203`	Non-Authoritative Information
`204`	No Content
`205`	Reset Content
`206`	Partial Content
`207`	Multi-Status
`208`	Already Reported
`218`	This is fine
`226`	IM Used
`300`	Multiple Choices
`301`	Moved Permanently
`302`	Found/Moved Temporarily
`303`	See Other
`304`	Not Modified
`305`	Use Proxy
`306`	Switch Proxy
`307`	Temporary Redirect
`308`	Permanent Redirect
`400`	Bad Request
`401`	Unauthorized
`402`	Payment Required
`403`	Forbidden
`404`	Not Found
`405`	Method Not Allowed
`406`	Not Acceptable
`407`	Proxy Authentication Required
`408`	Request Timeout
`409`	Conflict
`410`	Gone
`411`	Length Required
`412`	Precondition Failed
`413`	Request Entity/Payload Too Large
`414`	Request-URI Too Long
`415`	Unsupported Media Type
`416`	Requested Range Not Satisfiable
`417`	Expectation Failed
`418`	I'm A Teapot
`419`	Insufficient Space on Resource
`420`	Method Failure
`421`	Misdirected Request
`422`	Unprocessable Entity
`423`	Locked
`424`	Failed Dependency
`426`	Upgrade Required
`428`	Precondition Required
`429`	Too Many Requests
`430`	Request Header Fields Too Large
`431`	Request Header Fields Too Large
`440`	Login Timeout
`444`	No Response
`449`	Retry With
`450`	Blocked by Windows Parental Controls
`451`	Unavailable For Legal Reasons
`460`	Client Closed Connection Before Load Balancer Idle Timeout
`463`	X-Forwarded-For Header with More than 30 IP Addresses
`494`	Request Header Too Large
`495`	SSL Certificate Error
`496`	No SSL Certificate
`497`	HTTP Request Sent to HTTPS Port
`498`	Token Expired/Invalid
`499`	Client Closed Request
`500`	Internal Server Error
`501`	Not Implemented
`502`	Bad Gateway
`503`	Service Unavailable
`504`	Gateway Timeout
`505`	HTTP Version Not Supported
`506`	Variant Also Negotiates
`507`	Insufficient Storage
`508`	Loop Detected
`509`	Bandwidth Limit Exceeded
`510`	Not Extended
`511`	Network Authentication Required
`520`	Unknown Error
`521`	Web Server Is Down
`522`	Origin Connection Time-out
`523`	Origin Is Unreachable
`524`	A Timeout Occurred
`525`	SSL Handshake Failed
`526`	Invalid SSL Certificate
`527`	Railgun Error
`529`	Site is overloaded
`530`	Site is frozen
`598`	Network Read Timeout Error
`599`	Network Connect Timeout Error

Command Line Usage

You can query the reason phrase for status codes as follows:

$ java -jar httpstatus-1.1.0.jar 404 500
404: Not Found
500: Internal Server Error

If no status code is specified, all will be printed:

$ java -jar httpstatus-1.1.0.jar
100: Continue
101: Switching Protocols
102: Processing
103: Early Hints
200: OK
201: Created
202: Accepted
203: Non-Authoritative Information
204: No Content
205: Reset Content
206: Partial Content
207: Multi-Status
208: Already Reported
226: IM Used
...