SecureHeadersConfig (Uberfire Servlet Security 1.0.0.CR1 API)

Skip navigation links

Uberfire Servlet Security 1.0.0.CR1

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- org.uberfire.ext.security.server.SecureHeadersConfig

```
public class SecureHeadersConfig
extends Object
```
HTTP headers related to security For example: HSTS and Clickjacking mitigation support
Note: This implementation has been borrowed from Aerogear Security.

Constructor Summary

Constructors
Constructor and Description

SecureHeadersConfig(javax.servlet.FilterConfig config)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getFrameOptions()` Allows a secure web page from host B to declare that its content (for example a button, links, text, etc.) must not be displayed in a frame ( or ) of another page (e.g.</div> </td> </tr> <tr id="i1" class="rowColor"> <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/uberfire/ext/security/server/SecureHeadersConfig.html#getLocation--">getLocation</a></span>()</code> <div class="block">Retrieve the Location header</div> </td> </tr> <tr id="i2" class="altColor"> <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/uberfire/ext/security/server/SecureHeadersConfig.html#getMaxAge--">getMaxAge</a></span>()</code> <div class="block">Specifies the number of seconds, after the reception of the STS header field</div> </td> </tr> <tr id="i3" class="rowColor"> <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/uberfire/ext/security/server/SecureHeadersConfig.html#getXssOptions--">getXssOptions</a></span>()</code> </td> </tr> <tr id="i4" class="altColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/uberfire/ext/security/server/SecureHeadersConfig.html#hasFrameOptions--">hasFrameOptions</a></span>()</code> <div class="block">Verify if "x-frame-options" is present</div> </td> </tr> <tr id="i5" class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/uberfire/ext/security/server/SecureHeadersConfig.html#hasLocation--">hasLocation</a></span>()</code> <div class="block">Verify if the option "Location" is present</div> </td> </tr> <tr id="i6" class="altColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/uberfire/ext/security/server/SecureHeadersConfig.html#hasMaxAge--">hasMaxAge</a></span>()</code> <div class="block">Verify if the option "max-age" is present</div> </td> </tr> <tr id="i7" class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/uberfire/ext/security/server/SecureHeadersConfig.html#hasXSSOptions--">hasXSSOptions</a></span>()</code> <div class="block">Verify if "x-xss-protection" is present</div> </td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> <!-- --> </a> <h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> <code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> </ul> </li> </ul> </li> </ul> </div> <div class="details"> <ul class="blockList"> <li class="blockList"> <!-- ========= CONSTRUCTOR DETAIL ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor.detail"> <!-- --> </a> <h3>Constructor Detail</h3> <a name="SecureHeadersConfig-javax.servlet.FilterConfig-"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>SecureHeadersConfig</h4> <pre>public SecureHeadersConfig(javax.servlet.FilterConfig config)</pre> </li> </ul> </li> </ul> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> <li class="blockList"><a name="method.detail"> <!-- --> </a> <h3>Method Detail</h3> <a name="getMaxAge--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getMaxAge</h4> <pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getMaxAge()</pre> <div class="block">Specifies the number of seconds, after the reception of the STS header field</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>max-age directive</dd> <dt><span class="seeLabel">See Also:</span></dt> <dd><a href="https://tools.ietf.org/html/rfc6797#section-6.1.1">The max-age Directive</a></dd> </dl> </li> </ul> <a name="getLocation--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getLocation</h4> <pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getLocation()</pre> <div class="block">Retrieve the Location header</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>Location header field value</dd> <dt><span class="seeLabel">See Also:</span></dt> <dd><a href="https://tools.ietf.org/html/rfc6797#section-7.2">HTTP Request Type</a></dd> </dl> </li> </ul> <a name="getFrameOptions--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getFrameOptions</h4> <pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getFrameOptions()</pre> <div class="block">Allows a secure web page from host B to declare that its content (for example a button, links, text, etc.) must not be displayed in a frame (<frame> or <iframe>) of another page (e.g. from host A). In principle this is done by a policy declared in the HTTP header and enforced by conforming browser implementations</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>X-Frame-Options HTTP header field</dd> <dt><span class="seeLabel">See Also:</span></dt> <dd><a href="https://tools.ietf.org/html/draft-ietf-websec-x-frame-options-02#section-1"> X-Frame-Options</a></dd> </dl> </li> </ul> <a name="hasMaxAge--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>hasMaxAge</h4> <pre>public boolean hasMaxAge()</pre> <div class="block">Verify if the option "max-age" is present</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>boolean</dd> </dl> </li> </ul> <a name="hasLocation--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>hasLocation</h4> <pre>public boolean hasLocation()</pre> <div class="block">Verify if the option "Location" is present</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>boolean</dd> </dl> </li> </ul> <a name="hasFrameOptions--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>hasFrameOptions</h4> <pre>public boolean hasFrameOptions()</pre> <div class="block">Verify if "x-frame-options" is present</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>boolean</dd> </dl> </li> </ul> <a name="hasXSSOptions--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>hasXSSOptions</h4> <pre>public boolean hasXSSOptions()</pre> <div class="block">Verify if "x-xss-protection" is present</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>boolean</dd> </dl> </li> </ul> <a name="getXssOptions--"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>getXssOptions</h4> <pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getXssOptions()</pre> </li> </ul> </li> </ul> </li> </ul> </div> </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= START OF BOTTOM NAVBAR ====== --> <div class="bottomNav"><a name="navbar.bottom"> <!-- --> </a> <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> <a name="navbar.bottom.firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="../../../../../overview-summary.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="class-use/SecureHeadersConfig.html">Use</a></li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../../../index-all.html">Index</a></li> <li><a href="../../../../../help-doc.html">Help</a></li> </ul> <div class="aboutLanguage"><b>Uberfire Servlet Security 1.0.0.CR1</b></div> </div> <div class="subNav"> <ul class="navList"> <li><a href="../../../../../org/uberfire/ext/security/server/LoginRedirectServlet.html" title="class in org.uberfire.ext.security.server"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../../../org/uberfire/ext/security/server/SecureHeadersFilter.html" title="class in org.uberfire.ext.security.server"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/uberfire/ext/security/server/SecureHeadersConfig.html" target="_top">Frames</a></li> <li><a href="SecureHeadersConfig.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_bottom"> <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- allClassesLink = document.getElementById("allclasses_navbar_bottom"); if(window==top) { allClassesLink.style.display = "block"; } else { allClassesLink.style.display = "none"; } //--> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li>Nested \| </li> <li>Field \| </li> <li><a href="#constructor.summary">Constr</a> \| </li> <li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field \| </li> <li><a href="#constructor.detail">Constr</a> \| </li> <li><a href="#method.detail">Method</a></li> </ul> </div> <a name="skip.navbar.bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> <p class="legalCopy"><small>Copyright © 2012–2017 <a href="http://www.jboss.org/">JBoss by Red Hat</a>. All rights reserved.</small></p> </body> </html>