blob: 89db92ca82360dc60e88a0baa88072aac3476a79 [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml" lang="en"><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"/><link rel="stylesheet" href="../../jacoco-resources/report.css" type="text/css"/><link rel="shortcut icon" href="../../jacoco-resources/report.gif" type="image/gif"/><title>GuestAnnotationHandler.java</title><link rel="stylesheet" href="../../jacoco-resources/prettify.css" type="text/css"/><script type="text/javascript" src="../../jacoco-resources/prettify.js"></script></head><body onload="window['PR_TAB_WIDTH']=4;prettyPrint()"><div class="breadcrumb" id="breadcrumb"><span class="info"><a href="../../jacoco-sessions.html" class="el_session">Sessions</a></span><a href="../../index.html" class="el_report">Apache Shiro :: Test Coverage</a> &gt; <a href="../index.html" class="el_bundle">shiro-core</a> &gt; <a href="index.source.html" class="el_package">org.apache.shiro.authz.aop</a> &gt; <span class="el_source">GuestAnnotationHandler.java</span></div><h1>GuestAnnotationHandler.java</h1><pre class="source lang-java linenums">/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* &quot;License&quot;); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.shiro.authz.aop;
import java.lang.annotation.Annotation;
import org.apache.shiro.authz.AuthorizationException;
import org.apache.shiro.authz.UnauthenticatedException;
import org.apache.shiro.authz.annotation.RequiresGuest;
/**
* Checks to see if a @{@link org.apache.shiro.authz.annotation.RequiresGuest RequiresGuest} annotation
* is declared, and if so, ensures the calling &lt;code&gt;Subject&lt;/code&gt; does &lt;em&gt;not&lt;/em&gt;
* have an {@link org.apache.shiro.subject.Subject#getPrincipal() identity} before invoking the method.
* &lt;p&gt;
* This annotation essentially ensures that &lt;code&gt;subject.{@link org.apache.shiro.subject.Subject#getPrincipal() getPrincipal()} == null&lt;/code&gt;.
*
* @since 0.9.0
*/
public class GuestAnnotationHandler extends AuthorizingAnnotationHandler {
/**
* Default no-argument constructor that ensures this interceptor looks for
*
* {@link org.apache.shiro.authz.annotation.RequiresGuest RequiresGuest} annotations in a method
* declaration.
*/
public GuestAnnotationHandler() {
<span class="fc" id="L46"> super(RequiresGuest.class);</span>
<span class="fc" id="L47"> }</span>
/**
* Ensures that the calling &lt;code&gt;Subject&lt;/code&gt; is NOT a &lt;em&gt;user&lt;/em&gt;, that is, they do not
* have an {@link org.apache.shiro.subject.Subject#getPrincipal() identity} before continuing. If they are
* a user ({@link org.apache.shiro.subject.Subject#getPrincipal() Subject.getPrincipal()} != null), an
* &lt;code&gt;AuthorizingException&lt;/code&gt; will be thrown indicating that execution is not allowed to continue.
*
* @param a the annotation to check for one or more roles
* @throws org.apache.shiro.authz.AuthorizationException
* if the calling &lt;code&gt;Subject&lt;/code&gt; is not a &amp;quot;guest&amp;quot;.
*/
public void assertAuthorized(Annotation a) throws AuthorizationException {
<span class="pc bpc" id="L60" title="1 of 4 branches missed."> if (a instanceof RequiresGuest &amp;&amp; getSubject().getPrincipal() != null) {</span>
<span class="fc" id="L61"> throw new UnauthenticatedException(&quot;Attempting to perform a guest-only operation. The current Subject is &quot; +</span>
&quot;not a guest (they have been authenticated or remembered from a previous login). Access &quot; +
&quot;denied.&quot;);
}
<span class="fc" id="L65"> }</span>
}
</pre><div class="footer"><span class="right">Created with <a href="http://www.eclemma.org/jacoco">JaCoCo</a> 0.7.7.201606060606</span></div></body></html>