| <?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>AuthenticationFilter.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> > <a href="../index.html" class="el_bundle">shiro-web</a> > <a href="index.source.html" class="el_package">org.apache.shiro.web.filter.authc</a> > <span class="el_source">AuthenticationFilter.java</span></div><h1>AuthenticationFilter.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 |
| * "License"); 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 |
| * "AS IS" 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.web.filter.authc; |
| |
| import org.apache.shiro.subject.Subject; |
| import org.apache.shiro.web.filter.AccessControlFilter; |
| import org.apache.shiro.web.util.WebUtils; |
| |
| import javax.servlet.ServletRequest; |
| import javax.servlet.ServletResponse; |
| |
| /** |
| * Base class for all Filters that require the current user to be authenticated. This class encapsulates the |
| * logic of checking whether a user is already authenticated in the system while subclasses are required to perform |
| * specific logic for unauthenticated requests. |
| * |
| * @since 0.9 |
| */ |
| <span class="fc" id="L35">public abstract class AuthenticationFilter extends AccessControlFilter {</span> |
| |
| //TODO - complete JavaDoc |
| |
| public static final String DEFAULT_SUCCESS_URL = "/"; |
| |
| <span class="fc" id="L41"> private String successUrl = DEFAULT_SUCCESS_URL;</span> |
| |
| /** |
| * Returns the success url to use as the default location a user is sent after logging in. Typically a redirect |
| * after login will redirect to the originally request URL; this property is provided mainly as a fallback in case |
| * the original request URL is not available or not specified. |
| * <p/> |
| * The default value is {@link #DEFAULT_SUCCESS_URL}. |
| * |
| * @return the success url to use as the default location a user is sent after logging in. |
| */ |
| public String getSuccessUrl() { |
| <span class="fc" id="L53"> return successUrl;</span> |
| } |
| |
| /** |
| * Sets the default/fallback success url to use as the default location a user is sent after logging in. Typically |
| * a redirect after login will redirect to the originally request URL; this property is provided mainly as a |
| * fallback in case the original request URL is not available or not specified. |
| * <p/> |
| * The default value is {@link #DEFAULT_SUCCESS_URL}. |
| * |
| * @param successUrl the success URL to redirect the user to after a successful login. |
| */ |
| public void setSuccessUrl(String successUrl) { |
| <span class="fc" id="L66"> this.successUrl = successUrl;</span> |
| <span class="fc" id="L67"> }</span> |
| |
| |
| /** |
| * Determines whether the current subject is authenticated. |
| * <p/> |
| * The default implementation {@link #getSubject(javax.servlet.ServletRequest, javax.servlet.ServletResponse) acquires} |
| * the currently executing Subject and then returns |
| * {@link org.apache.shiro.subject.Subject#isAuthenticated() subject.isAuthenticated()}; |
| * |
| * @return true if the subject is authenticated; false if the subject is unauthenticated |
| */ |
| protected boolean isAccessAllowed(ServletRequest request, ServletResponse response, Object mappedValue) { |
| <span class="fc" id="L80"> Subject subject = getSubject(request, response);</span> |
| <span class="fc" id="L81"> return subject.isAuthenticated();</span> |
| } |
| |
| /** |
| * Redirects to user to the previously attempted URL after a successful login. This implementation simply calls |
| * <code>{@link org.apache.shiro.web.util.WebUtils WebUtils}.{@link WebUtils#redirectToSavedRequest(javax.servlet.ServletRequest, javax.servlet.ServletResponse, String) redirectToSavedRequest}</code> |
| * using the {@link #getSuccessUrl() successUrl} as the {@code fallbackUrl} argument to that call. |
| * |
| * @param request the incoming request |
| * @param response the outgoing response |
| * @throws Exception if there is a problem redirecting. |
| */ |
| protected void issueSuccessRedirect(ServletRequest request, ServletResponse response) throws Exception { |
| <span class="fc" id="L94"> WebUtils.redirectToSavedRequest(request, response, getSuccessUrl());</span> |
| <span class="fc" id="L95"> }</span> |
| |
| } |
| </pre><div class="footer"><span class="right">Created with <a href="http://www.jacoco.org/jacoco">JaCoCo</a> 0.8.3.201901230119</span></div></body></html> |
