erik/HttpStatus
erik/HttpStatus
1
1
Fork 0
Code Issues Pull requests Releases Activity
HttpStatus/docs
History
Erik C. Thauvin 22819033ea Moved README.html to docs.
2017-06-07 15:56:26 -07:00
..
github-pandoc.css Moved README.html to docs. 2017-06-07 15:56:26 -07:00
README.html Moved README.html to docs. 2017-06-07 15:56:26 -07:00

README.html 

<!DOCTYPE html>
<html>
<head>
  <meta charset="utf-8">
  <meta name="generator" content="pandoc">
  <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
  <title></title>
  <style type="text/css">code{white-space: pre;}</style>
  <style type="text/css">
div.sourceCode { overflow-x: auto; }
table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode {
  margin: 0; padding: 0; vertical-align: baseline; border: none; }
table.sourceCode { width: 100%; line-height: 100%; }
td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; }
td.sourceCode { padding-left: 5px; }
code > span.kw { color: #007020; font-weight: bold; } /* Keyword */
code > span.dt { color: #902000; } /* DataType */
code > span.dv { color: #40a070; } /* DecVal */
code > span.bn { color: #40a070; } /* BaseN */
code > span.fl { color: #40a070; } /* Float */
code > span.ch { color: #4070a0; } /* Char */
code > span.st { color: #4070a0; } /* String */
code > span.co { color: #60a0b0; font-style: italic; } /* Comment */
code > span.ot { color: #007020; } /* Other */
code > span.al { color: #ff0000; font-weight: bold; } /* Alert */
code > span.fu { color: #06287e; } /* Function */
code > span.er { color: #ff0000; font-weight: bold; } /* Error */
code > span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */
code > span.cn { color: #880000; } /* Constant */
code > span.sc { color: #4070a0; } /* SpecialChar */
code > span.vs { color: #4070a0; } /* VerbatimString */
code > span.ss { color: #bb6688; } /* SpecialString */
code > span.im { } /* Import */
code > span.va { color: #19177c; } /* Variable */
code > span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
code > span.op { color: #666666; } /* Operator */
code > span.bu { } /* BuiltIn */
code > span.ex { } /* Extension */
code > span.pp { color: #bc7a00; } /* Preprocessor */
code > span.at { color: #7d9029; } /* Attribute */
code > span.do { color: #ba2121; font-style: italic; } /* Documentation */
code > span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
code > span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */
code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */
  </style>
  <link rel="stylesheet" href="github-pandoc.css">
  <!--[if lt IE 9]>
    <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
  <![endif]-->
</head>
<body>
<h1 id="httpstatus-jsp-tag-library">HttpStatus JSP Tag Library</h1>
<p><a href="http://opensource.org/licenses/BSD-3-Clause"><img src="https://img.shields.io/badge/license-BSD%203--Clause-blue.svg?style=flat-square" alt="License (3-Clause BSD)" /></a> <a href="https://github.com/ethauvin/httpstatus/releases/latest"><img src="http://github-release-version.herokuapp.com/github/ethauvin/httpstatus/release.svg?style=flat" alt="release" /></a> <a href="https://www.versioneye.com/user/projects/56a6947a1b78fd002d00018a"><img src="https://www.versioneye.com/user/projects/56a6947a1b78fd002d00018a/badge.svg?style=flat" alt="Dependency Status" /></a> <a href="https://maven-badges.herokuapp.com/maven-central/net.thauvin.erik.httpstatus/httpstatus"><img src="https://maven-badges.herokuapp.com/maven-central/net.thauvin.erik.httpstatus/httpstatus/badge.svg" alt="Maven Central" /></a> <a href="https://bintray.com/ethauvin/maven/HttpStatus/_latestVersion"><img src="https://api.bintray.com/packages/ethauvin/maven/HttpStatus/images/download.svg" alt="Download" /></a> <a href="https://travis-ci.org/ethauvin/HttpStatus"><img src="https://travis-ci.org/ethauvin/HttpStatus.svg?branch=master" alt="Build Status" /></a> <a href="https://ci.appveyor.com/project/ethauvin/httpstatus"><img src="https://ci.appveyor.com/api/projects/status/w5j4kul3w2rkigxb?svg=true" alt="Build status" /></a> <a href="https://circleci.com/gh/ethauvin/HttpStatus/tree/master"><img src="https://circleci.com/gh/ethauvin/HttpStatus/tree/master.svg?style=shield" alt="CircleCI" /></a></p>
<p>A simple <a href="http://www.oracle.com/technetwork/java/javaee/jsp/index.html">JSP</a> Tag Library to display the <a href="#hscode">code</a>, <a href="#hsreason">reason</a> and/or <a href="#hscode">cause</a> for <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html">HTTP status codes</a> in JSP error pages.</p>
<hr />
<p>For example:</p>
<div class="sourceCode"><pre class="sourceCode jsp"><code class="sourceCode jsp">&lt;%@ page<span class="ot"> isErrorPage</span>=<span class="st">&quot;true&quot;</span><span class="ot"> </span>%&gt;
&lt;%@ taglib<span class="ot"> prefix</span>=<span class="st">&quot;hs&quot;</span><span class="ot"> uri</span>=<span class="st">&quot;http://erik.thauvin.net/taglibs/httpstatus&quot;</span><span class="ot"> </span>%&gt;
&lt;html&gt;&lt;head&gt;
&lt;title&gt;<span class="kw">&lt;hs:code/&gt;</span> <span class="kw">&lt;hs:reason</span><span class="ot"> default</span>=<span class="dt">&quot;Server Error&quot;</span><span class="kw">/&gt;</span>&lt;/title&gt;
&lt;/head&gt;
&lt;h1&gt;<span class="kw">&lt;hs:reason</span><span class="ot"> default</span>=<span class="dt">&quot;Server Error&quot;</span><span class="kw">/&gt;</span>&lt;/h1&gt;
Cause: &lt;pre&gt;<span class="kw">&lt;hs:cause</span><span class="ot"> default</span>=<span class="dt">&quot;Unable to complete your request.&quot;</span><span class="kw">/&gt;</span>&lt;/pre&gt;
...</code></pre></div>
<p>or</p>
<div class="sourceCode"><pre class="sourceCode jsp"><code class="sourceCode jsp">&lt;%@ page<span class="ot"> isErrorPage</span>=<span class="st">&quot;true&quot;</span><span class="ot"> import</span>=<span class="st">&quot;net.thauvin.erik.httpstatus.Reasons&quot;</span><span class="ot"> </span>%&gt;
&lt;%= Reasons.getReasonPhrase(pageContext.getErrorData().getStatusCode()) %&gt;</code></pre></div>
<p>would display on a <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2">501 status code</a>:</p>
<pre><code>Not Implemented</code></pre>
<hr />
<h2 id="hscause">hs:cause</h2>
<p>The <code>&lt;hs:cause/&gt;</code> tag displays the cause of current HTTP status code, if any. A shorthand for:</p>
<div class="sourceCode"><pre class="sourceCode jsp"><code class="sourceCode jsp">&lt;%= pageContext.getErrorData().getThrowable().getCause().getLocalizedMessage() %&gt;</code></pre></div>
<p>Optional attributes are:</p>
<table>
<colgroup>
<col style="width: 11%" />
<col style="width: 88%" />
</colgroup>
<thead>
<tr class="header">
<th>Attribute</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td><code>default</code></td>
<td>The fallback value to output, if no cause is available.</td>
</tr>
<tr class="even">
<td><code>escapeXml</code></td>
<td>Converts &lt;, &gt;, &amp;, ', &quot; to their corresponding <a href="http://dev.w3.org/html5/html-author/charref">entity codes</a>. Value is <code>true</code> by default.</td>
</tr>
</tbody>
</table>
<h2 id="hscode">hs:code</h2>
<p>The <code>&lt;hs:code/&gt;</code> tag displays the current HTTP status code, if any. A shorthand for:</p>
<div class="sourceCode"><pre class="sourceCode jsp"><code class="sourceCode jsp">&lt;%= pageContext.getErrorData().getStatusCode() %&gt;</code></pre></div>
<h2 id="hsreason">hs:reason</h2>
<p>The <code>&lt;hs:reason/&gt;</code> tag displays the reason for a HTTP status code, if any. Optional attributes are:</p>
<table>
<colgroup>
<col style="width: 11%" />
<col style="width: 88%" />
</colgroup>
<thead>
<tr class="header">
<th>Attribute</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td><code>code</code></td>
<td>The HTTP status error code. If not specified the current status code is used.</td>
</tr>
<tr class="even">
<td><code>default</code></td>
<td>The fallback value to output, if no reason is available.</td>
</tr>
<tr class="odd">
<td><code>escapeXml</code></td>
<td>Converts &lt;, &gt;, &amp;, ', &quot; to their corresponding <a href="http://dev.w3.org/html5/html-author/charref">entity codes</a>. Value is <code>true</code> by default.</td>
</tr>
</tbody>
</table>
<p>The reasons are defined in a <a href="http://docs.oracle.com/javase/8/docs/api/java/util/ResourceBundle.html">ResourceBundle</a> properties as follows:</p>
<table>
<thead>
<tr class="header">
<th>Status Code</th>
<th>Reason</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td><code>100</code></td>
<td>Continue</td>
</tr>
<tr class="even">
<td><code>101</code></td>
<td>Switching Protocols</td>
</tr>
<tr class="odd">
<td><code>102</code></td>
<td>Processing</td>
</tr>
<tr class="even">
<td><code>200</code></td>
<td>OK</td>
</tr>
<tr class="odd">
<td><code>201</code></td>
<td>Created</td>
</tr>
<tr class="even">
<td><code>202</code></td>
<td>Accepted</td>
</tr>
<tr class="odd">
<td><code>203</code></td>
<td>Non-Authoritative Information</td>
</tr>
<tr class="even">
<td><code>204</code></td>
<td>No Content</td>
</tr>
<tr class="odd">
<td><code>205</code></td>
<td>Reset Content</td>
</tr>
<tr class="even">
<td><code>206</code></td>
<td>Partial Content</td>
</tr>
<tr class="odd">
<td><code>207</code></td>
<td>Multi-Status</td>
</tr>
<tr class="even">
<td><code>208</code></td>
<td>Already Reported</td>
</tr>
<tr class="odd">
<td><code>226</code></td>
<td>IM Used</td>
</tr>
<tr class="even">
<td><code>300</code></td>
<td>Multiple Choices</td>
</tr>
<tr class="odd">
<td><code>301</code></td>
<td>Moved Permanently</td>
</tr>
<tr class="even">
<td><code>302</code></td>
<td>Moved Temporarily</td>
</tr>
<tr class="odd">
<td><code>303</code></td>
<td>See Other</td>
</tr>
<tr class="even">
<td><code>304</code></td>
<td>Not Modified</td>
</tr>
<tr class="odd">
<td><code>305</code></td>
<td>Use Proxy</td>
</tr>
<tr class="even">
<td><code>306</code></td>
<td>Switch Proxy</td>
</tr>
<tr class="odd">
<td><code>307</code></td>
<td>Temporary Redirect</td>
</tr>
<tr class="even">
<td><code>308</code></td>
<td>Permanent Redirect</td>
</tr>
<tr class="odd">
<td><code>400</code></td>
<td>Bad Request</td>
</tr>
<tr class="even">
<td><code>401</code></td>
<td>Unauthorized</td>
</tr>
<tr class="odd">
<td><code>402</code></td>
<td>Payment Required</td>
</tr>
<tr class="even">
<td><code>403</code></td>
<td>Forbidden</td>
</tr>
<tr class="odd">
<td><code>404</code></td>
<td>Not Found</td>
</tr>
<tr class="even">
<td><code>405</code></td>
<td>Method Not Allowed</td>
</tr>
<tr class="odd">
<td><code>406</code></td>
<td>Not Acceptable</td>
</tr>
<tr class="even">
<td><code>407</code></td>
<td>Proxy Authentication Required</td>
</tr>
<tr class="odd">
<td><code>408</code></td>
<td>Request Timeout</td>
</tr>
<tr class="even">
<td><code>409</code></td>
<td>Conflict</td>
</tr>
<tr class="odd">
<td><code>410</code></td>
<td>Gone</td>
</tr>
<tr class="even">
<td><code>411</code></td>
<td>Length Required</td>
</tr>
<tr class="odd">
<td><code>412</code></td>
<td>Precondition Failed</td>
</tr>
<tr class="even">
<td><code>413</code></td>
<td>Request Entity Too Large</td>
</tr>
<tr class="odd">
<td><code>414</code></td>
<td>Request-URI Too Long</td>
</tr>
<tr class="even">
<td><code>415</code></td>
<td>Unsupported Media Type</td>
</tr>
<tr class="odd">
<td><code>416</code></td>
<td>Requested Range Not Satisfiable</td>
</tr>
<tr class="even">
<td><code>417</code></td>
<td>Expectation Failed</td>
</tr>
<tr class="odd">
<td><code>418</code></td>
<td>I'm A Teapot</td>
</tr>
<tr class="even">
<td><code>419</code></td>
<td>Insufficient Space on Resource</td>
</tr>
<tr class="odd">
<td><code>420</code></td>
<td>Method Failure</td>
</tr>
<tr class="even">
<td><code>421</code></td>
<td>Misdirected Request</td>
</tr>
<tr class="odd">
<td><code>422</code></td>
<td>Unprocessable Entity</td>
</tr>
<tr class="even">
<td><code>423</code></td>
<td>Locked</td>
</tr>
<tr class="odd">
<td><code>424</code></td>
<td>Failed Dependency</td>
</tr>
<tr class="even">
<td><code>426</code></td>
<td>Upgrade Required</td>
</tr>
<tr class="odd">
<td><code>428</code></td>
<td>Precondition Required</td>
</tr>
<tr class="even">
<td><code>429</code></td>
<td>Too Many Requests</td>
</tr>
<tr class="odd">
<td><code>431</code></td>
<td>Request Header Fields Too Large</td>
</tr>
<tr class="even">
<td><code>440</code></td>
<td>Login Timeout</td>
</tr>
<tr class="odd">
<td><code>444</code></td>
<td>No Response</td>
</tr>
<tr class="even">
<td><code>449</code></td>
<td>Retry With</td>
</tr>
<tr class="odd">
<td><code>450</code></td>
<td>Blocked by Windows Parental Controls</td>
</tr>
<tr class="even">
<td><code>451</code></td>
<td>Unavailable For Legal Reasons</td>
</tr>
<tr class="odd">
<td><code>494</code></td>
<td>Request Header Too Large</td>
</tr>
<tr class="even">
<td><code>495</code></td>
<td>Cert Error</td>
</tr>
<tr class="odd">
<td><code>496</code></td>
<td>No Cert</td>
</tr>
<tr class="even">
<td><code>497</code></td>
<td>HTTP to HTTPS</td>
</tr>
<tr class="odd">
<td><code>498</code></td>
<td>Token Expired/Invalid</td>
</tr>
<tr class="even">
<td><code>499</code></td>
<td>Client Closed Request</td>
</tr>
<tr class="odd">
<td><code>500</code></td>
<td>Internal Server Error</td>
</tr>
<tr class="even">
<td><code>501</code></td>
<td>Not Implemented</td>
</tr>
<tr class="odd">
<td><code>502</code></td>
<td>Bad Gateway</td>
</tr>
<tr class="even">
<td><code>503</code></td>
<td>Service Unavailable</td>
</tr>
<tr class="odd">
<td><code>504</code></td>
<td>Gateway Timeout</td>
</tr>
<tr class="even">
<td><code>505</code></td>
<td>HTTP Version Not Supported</td>
</tr>
<tr class="odd">
<td><code>506</code></td>
<td>Variant Also Negotiates</td>
</tr>
<tr class="even">
<td><code>507</code></td>
<td>Insufficient Storage</td>
</tr>
<tr class="odd">
<td><code>508</code></td>
<td>Loop Detected</td>
</tr>
<tr class="even">
<td><code>509</code></td>
<td>Bandwidth Limit Exceeded</td>
</tr>
<tr class="odd">
<td><code>510</code></td>
<td>Not Extended</td>
</tr>
<tr class="even">
<td><code>511</code></td>
<td>Network Authentication Required</td>
</tr>
<tr class="odd">
<td><code>520</code></td>
<td>Unknown Error</td>
</tr>
<tr class="even">
<td><code>522</code></td>
<td>Origin Connection Time-out</td>
</tr>
<tr class="odd">
<td><code>598</code></td>
<td>Network Read Timeout Error</td>
</tr>
<tr class="even">
<td><code>599</code></td>
<td>Network Connect Timeout Error</td>
</tr>
</tbody>
</table>
<hr />
<h2 id="usage-with-gradle-or-maven">Usage with <a href="https://gradle.org/">Gradle</a> or <a href="http://maven.apache.org/">Maven</a></h2>
<p>Include the following in your <code>build.gradle</code> file:</p>
<pre class="gradle"><code>dependencies {
    compile &#39;net.thauvin.erik.httpstatus:httpstatus:1.0.3&#39;
}</code></pre>
<p>or as a Maven artifact:</p>
<div class="sourceCode"><pre class="sourceCode xml"><code class="sourceCode xml"><span class="kw">&lt;dependency&gt;</span>
    <span class="kw">&lt;groupId&gt;</span>net.thauvin.erik.httpstatus<span class="kw">&lt;/groupId&gt;</span>
    <span class="kw">&lt;artifactId&gt;</span>httpstatus<span class="kw">&lt;/artifactId&gt;</span>
    <span class="kw">&lt;version&gt;</span>1.0.3<span class="kw">&lt;/version&gt;</span>
<span class="kw">&lt;/dependency&gt;</span></code></pre></div>
</body>
</html>