XFrameHandler (Vert.x Stack - Docs 4.5.11 API)

java.lang.Object
- io.vertx.rxjava.ext.web.handler.XFrameHandler

All Implemented Interfaces:

Handler<RoutingContext>, SecurityPolicyHandler
```
public class XFrameHandler
extends Object
implements SecurityPolicyHandler, Handler<RoutingContext>
```
The X-Frame-Options HTTP response header can be used to indicate whether or not a browser should be allowed to render a page in a , </code>, <code><embed></code> or <code><object></code>. Sites can use this to avoid click-jacking attacks, by ensuring that their content is not embedded into other sites. The added security is provided only if the user accessing the document is using a browser that supports <code>X-Frame-Options</code>. <p/> NOTE: This class has been automatically generated from the <a href="../../../../../../io/vertx/ext/web/handler/XFrameHandler.html" title="interface in io.vertx.ext.web.handler"><code>original</code></a> non RX-ified interface using Vert.x codegen.</div> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList">  <ul class="blockList"> <li class="blockList"><a name="field.summary">  </a> <h3>Field Summary</h3> <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> <caption><span>Fields</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Field and Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>static io.vertx.lang.rx.TypeArg<<a href="../../../../../../io/vertx/rxjava/ext/web/handler/XFrameHandler.html" title="class in io.vertx.rxjava.ext.web.handler">XFrameHandler</a>></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../io/vertx/rxjava/ext/web/handler/XFrameHandler.html#Z:Z__TYPE_ARG">__TYPE_ARG</a></span></code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/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="../../../../../../io/vertx/rxjava/ext/web/handler/XFrameHandler.html#DENY">DENY</a></span></code> <div class="block">The page cannot be displayed in a frame, regardless of the site attempting to do so.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/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="../../../../../../io/vertx/rxjava/ext/web/handler/XFrameHandler.html#SAMEORIGIN">SAMEORIGIN</a></span></code> <div class="block">The page can only be displayed in a frame on the same origin as the page itself.</div> </td> </tr> </table> </li> </ul>  <ul class="blockList"> <li class="blockList"><a name="constructor.summary">  </a> <h3>Constructor Summary</h3> <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> <caption><span>Constructors</span><span class="tabEnd"> </span></caption> <tr> <th class="colOne" scope="col">Constructor and Description</th> </tr> <tr class="altColor"> <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../io/vertx/rxjava/ext/web/handler/XFrameHandler.html#XFrameHandler-java.lang.Object-">XFrameHandler</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> delegate)</code> </td> </tr> <tr class="rowColor"> <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../io/vertx/rxjava/ext/web/handler/XFrameHandler.html#XFrameHandler-io.vertx.ext.web.handler.XFrameHandler-">XFrameHandler</a></span>(<a href="../../../../../../io/vertx/ext/web/handler/XFrameHandler.html" title="interface in io.vertx.ext.web.handler">XFrameHandler</a> delegate)</code> </td> </tr> </table> </li> </ul>  <ul class="blockList"> <li class="blockList"><a name="method.summary">  </a> <h3>Method Summary</h3> <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Method and Description</th> </tr> <tr id="i0" class="altColor"> <td class="colFirst"><code>static <a href="../../../../../../io/vertx/rxjava/ext/web/handler/XFrameHandler.html" title="class in io.vertx.rxjava.ext.web.handler">XFrameHandler</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../io/vertx/rxjava/ext/web/handler/XFrameHandler.html#create-java.lang.String-">create</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> action)</code> <div class="block">Creates a new handler that will add the <code>X-FRAME-OPTIONS</code> header to the current response.</div> </td> </tr> <tr id="i1" class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../io/vertx/rxjava/ext/web/handler/XFrameHandler.html#equals-java.lang.Object-">equals</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> o)</code> </td> </tr> <tr id="i2" class="altColor"> <td class="colFirst"><code><a href="../../../../../../io/vertx/ext/web/handler/XFrameHandler.html" title="interface in io.vertx.ext.web.handler">XFrameHandler</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../io/vertx/rxjava/ext/web/handler/XFrameHandler.html#getDelegate--">getDelegate</a></span>()</code> </td> </tr> <tr id="i3" class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../io/vertx/rxjava/ext/web/handler/XFrameHandler.html#handle-io.vertx.rxjava.ext.web.RoutingContext-">handle</a></span>(<a href="../../../../../../io/vertx/rxjava/ext/web/RoutingContext.html" title="class in io.vertx.rxjava.ext.web">RoutingContext</a> event)</code> <div class="block">Something has happened, so handle it.</div> </td> </tr> <tr id="i4" class="altColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../io/vertx/rxjava/ext/web/handler/XFrameHandler.html#hashCode--">hashCode</a></span>()</code> </td> </tr> <tr id="i5" class="rowColor"> <td class="colFirst"><code>static <a href="../../../../../../io/vertx/rxjava/ext/web/handler/XFrameHandler.html" title="class in io.vertx.rxjava.ext.web.handler">XFrameHandler</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../io/vertx/rxjava/ext/web/handler/XFrameHandler.html#newInstance-io.vertx.ext.web.handler.XFrameHandler-">newInstance</a></span>(<a href="../../../../../../io/vertx/ext/web/handler/XFrameHandler.html" title="interface in io.vertx.ext.web.handler">XFrameHandler</a> arg)</code> </td> </tr> <tr id="i6" class="altColor"> <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/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="../../../../../../io/vertx/rxjava/ext/web/handler/XFrameHandler.html#toString--">toString</a></span>()</code> </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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> </ul> <ul class="blockList"> <li class="blockList"><a name="methods.inherited.from.class.io.vertx.rxjava.ext.web.handler.SecurityPolicyHandler">  </a> <h3>Methods inherited from interface io.vertx.rxjava.ext.web.handler.<a href="../../../../../../io/vertx/rxjava/ext/web/handler/SecurityPolicyHandler.html" title="interface in io.vertx.rxjava.ext.web.handler">SecurityPolicyHandler</a></h3> <code><a href="../../../../../../io/vertx/rxjava/ext/web/handler/SecurityPolicyHandler.html#newInstance-io.vertx.ext.web.handler.SecurityPolicyHandler-">newInstance</a></code></li> </ul> </li> </ul> </li> </ul> </div> <div class="details"> <ul class="blockList"> <li class="blockList">  <ul class="blockList"> <li class="blockList"><a name="field.detail">  </a> <h3>Field Detail</h3> <a name="Z:Z__TYPE_ARG">  </a> <ul class="blockList"> <li class="blockList"> <h4>__TYPE_ARG</h4> <pre>public static final io.vertx.lang.rx.TypeArg<<a href="../../../../../../io/vertx/rxjava/ext/web/handler/XFrameHandler.html" title="class in io.vertx.rxjava.ext.web.handler">XFrameHandler</a>> __TYPE_ARG</pre> </li> </ul> <a name="DENY">  </a> <ul class="blockList"> <li class="blockList"> <h4>DENY</h4> <pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> DENY</pre> <div class="block">The page cannot be displayed in a frame, regardless of the site attempting to do so.</div> <dl> <dt><span class="seeLabel">See Also:</span></dt> <dd><a href="../../../../../../constant-values.html#io.vertx.rxjava.ext.web.handler.XFrameHandler.DENY">Constant Field Values</a></dd> </dl> </li> </ul> <a name="SAMEORIGIN">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>SAMEORIGIN</h4> <pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> SAMEORIGIN</pre> <div class="block">The page can only be displayed in a frame on the same origin as the page itself. The spec leaves it up to browser vendors to decide whether this option applies to the top level, the parent, or the whole chain, although it is argued that the option is not very useful unless all ancestors are also in the same origin.</div> <dl> <dt><span class="seeLabel">See Also:</span></dt> <dd><a href="../../../../../../constant-values.html#io.vertx.rxjava.ext.web.handler.XFrameHandler.SAMEORIGIN">Constant Field Values</a></dd> </dl> </li> </ul> </li> </ul>  <ul class="blockList"> <li class="blockList"><a name="constructor.detail">  </a> <h3>Constructor Detail</h3> <a name="XFrameHandler-io.vertx.ext.web.handler.XFrameHandler-">  </a> <ul class="blockList"> <li class="blockList"> <h4>XFrameHandler</h4> <pre>public XFrameHandler(<a href="../../../../../../io/vertx/ext/web/handler/XFrameHandler.html" title="interface in io.vertx.ext.web.handler">XFrameHandler</a> delegate)</pre> </li> </ul> <a name="XFrameHandler-java.lang.Object-">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>XFrameHandler</h4> <pre>public XFrameHandler(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> delegate)</pre> </li> </ul> </li> </ul>  <ul class="blockList"> <li class="blockList"><a name="method.detail">  </a> <h3>Method Detail</h3> <a name="toString--">  </a> <ul class="blockList"> <li class="blockList"> <h4>toString</h4> <pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> toString()</pre> <dl> <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code> in class <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> </dl> </li> </ul> <a name="equals-java.lang.Object-">  </a> <ul class="blockList"> <li class="blockList"> <h4>equals</h4> <pre>public boolean equals(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> o)</pre> <dl> <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a></code> in class <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> </dl> </li> </ul> <a name="hashCode--">  </a> <ul class="blockList"> <li class="blockList"> <h4>hashCode</h4> <pre>public int hashCode()</pre> <dl> <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a></code> in class <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> </dl> </li> </ul> <a name="getDelegate--">  </a> <ul class="blockList"> <li class="blockList"> <h4>getDelegate</h4> <pre>public <a href="../../../../../../io/vertx/ext/web/handler/XFrameHandler.html" title="interface in io.vertx.ext.web.handler">XFrameHandler</a> getDelegate()</pre> <dl> <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> <dd><code><a href="../../../../../../io/vertx/rxjava/ext/web/handler/SecurityPolicyHandler.html#getDelegate--">getDelegate</a></code> in interface <code><a href="../../../../../../io/vertx/rxjava/ext/web/handler/SecurityPolicyHandler.html" title="interface in io.vertx.rxjava.ext.web.handler">SecurityPolicyHandler</a></code></dd> </dl> </li> </ul> <a name="handle-io.vertx.rxjava.ext.web.RoutingContext-">  </a> <ul class="blockList"> <li class="blockList"> <h4>handle</h4> <pre>public void handle(<a href="../../../../../../io/vertx/rxjava/ext/web/RoutingContext.html" title="class in io.vertx.rxjava.ext.web">RoutingContext</a> event)</pre> <div class="block">Something has happened, so handle it.</div> <dl> <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> <dd><code><a href="../../../../../../io/vertx/core/Handler.html#handle-E-">handle</a></code> in interface <code><a href="../../../../../../io/vertx/core/Handler.html" title="interface in io.vertx.core">Handler</a><<a href="../../../../../../io/vertx/rxjava/ext/web/RoutingContext.html" title="class in io.vertx.rxjava.ext.web">RoutingContext</a>></code></dd> <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> <dd><code><a href="../../../../../../io/vertx/rxjava/ext/web/handler/SecurityPolicyHandler.html#handle-io.vertx.rxjava.ext.web.RoutingContext-">handle</a></code> in interface <code><a href="../../../../../../io/vertx/rxjava/ext/web/handler/SecurityPolicyHandler.html" title="interface in io.vertx.rxjava.ext.web.handler">SecurityPolicyHandler</a></code></dd> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>event</code> - the event to handle</dd> </dl> </li> </ul> <a name="create-java.lang.String-">  </a> <ul class="blockList"> <li class="blockList"> <h4>create</h4> <pre>public static <a href="../../../../../../io/vertx/rxjava/ext/web/handler/XFrameHandler.html" title="class in io.vertx.rxjava.ext.web.handler">XFrameHandler</a> create(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> action)</pre> <div class="block">Creates a new handler that will add the <code>X-FRAME-OPTIONS</code> header to the current response.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>action</code> - a string value either <code>DENY</code> or <code>SAMEORIGIN</code>.</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>the handler</dd> </dl> </li> </ul> <a name="newInstance-io.vertx.ext.web.handler.XFrameHandler-">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>newInstance</h4> <pre>public static <a href="../../../../../../io/vertx/rxjava/ext/web/handler/XFrameHandler.html" title="class in io.vertx.rxjava.ext.web.handler">XFrameHandler</a> newInstance(<a href="../../../../../../io/vertx/ext/web/handler/XFrameHandler.html" title="interface in io.vertx.ext.web.handler">XFrameHandler</a> arg)</pre> </li> </ul> </li> </ul> </li> </ul> </div> </div>   <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/XFrameHandler.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> <div class="subNav"> <ul class="navList"> <li><a href="../../../../../../io/vertx/rxjava/ext/web/handler/WebAuthnHandler.html" title="class in io.vertx.rxjava.ext.web.handler"><span class="typeNameLink">Prev Class</span></a></li> <li>Next Class</li> </ul> <ul class="navList"> <li><a href="../../../../../../index.html?io/vertx/rxjava/ext/web/handler/XFrameHandler.html" target="_top">Frames</a></li> <li><a href="XFrameHandler.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"> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> <li><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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>  <p class="legalCopy"><small>Copyright © 2024 Eclipse. All rights reserved.</small></p> </body> </html>

Class XFrameHandler