| <?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>DefaultSessionStorageEvaluator.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 :: Jar Bundle</a> > <a href="../index.html" class="el_bundle">shiro-core</a> > <a href="index.source.html" class="el_package">org.apache.shiro.mgt</a> > <span class="el_source">DefaultSessionStorageEvaluator.java</span></div><h1>DefaultSessionStorageEvaluator.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.mgt; |
| |
| import org.apache.shiro.subject.Subject; |
| |
| /** |
| * A Default {@code SessionStorageEvaluator} that provides reasonable control over if and how Sessions may be used for |
| * storing Subject state. See the {@link #isSessionStorageEnabled(org.apache.shiro.subject.Subject)} |
| * method for exact behavior. |
| * |
| * @since 1.2 |
| */ |
| <span class="fc" id="L30">public class DefaultSessionStorageEvaluator implements SessionStorageEvaluator {</span> |
| |
| /** |
| * Global policy determining if Subject sessions may be used to persist Subject state if the Subject's Session |
| * does not yet exist. |
| */ |
| <span class="fc" id="L36"> private boolean sessionStorageEnabled = true;</span> |
| |
| /** |
| * This implementation functions as follows: |
| * <ul> |
| * <li>If the specified Subject already has an existing {@code Session} (typically because an application developer |
| * has called {@code subject.getSession()} already), Shiro will use that existing session to store subject state.</li> |
| * <li>If a Subject does not yet have a Session, this implementation checks the |
| * {@link #isSessionStorageEnabled() sessionStorageEnabled} property: |
| * <ul> |
| * <li>If {@code sessionStorageEnabled} is true (the default setting), a new session may be created to persist |
| * Subject state if necessary.</li> |
| * <li>If {@code sessionStorageEnabled} is {@code false}, a new session will <em>not</em> be created to persist |
| * session state.</li> |
| * </ul></li> |
| * </ul> |
| * Most applications use Sessions and are OK with the default {@code true} setting for {@code sessionStorageEnabled}. |
| * <p/> |
| * However, if your application is a purely 100% stateless application that never uses sessions, |
| * you will want to set {@code sessionStorageEnabled} to {@code false}. Realize that a {@code false} value will |
| * ensure that any subject login only retains the authenticated identity for the duration of a request. Any other |
| * requests, invocations or messages will not be authenticated. |
| * |
| * @param subject the {@code Subject} for which session state persistence may be enabled |
| * @return the value of {@link #isSessionStorageEnabled()} and ignores the {@code Subject} argument. |
| */ |
| public boolean isSessionStorageEnabled(Subject subject) { |
| <span class="pc bpc" id="L63" title="1 of 6 branches missed."> return (subject != null && subject.getSession(false) != null) || isSessionStorageEnabled();</span> |
| } |
| |
| /** |
| * Returns {@code true} if any Subject's {@code Session} may be used to persist that {@code Subject}'s state, |
| * {@code false} otherwise. The default value is {@code true}. |
| * <p/> |
| * <b>N.B.</b> This is a global configuration setting; setting this value to {@code false} will disable sessions |
| * to persist Subject state for all Subjects that do not already have a Session. It should typically only be set |
| * to {@code false} for 100% stateless applications (e.g. when sessions aren't used or when remote clients |
| * authenticate on every request). |
| * |
| * @return {@code true} if any Subject's {@code Session} may be used to persist that {@code Subject}'s state, |
| * {@code false} otherwise. |
| */ |
| public boolean isSessionStorageEnabled() { |
| <span class="fc" id="L79"> return sessionStorageEnabled;</span> |
| } |
| |
| /** |
| * Sets if any Subject's {@code Session} may be used to persist that {@code Subject}'s state. The |
| * default value is {@code true}. |
| * <p/> |
| * <b>N.B.</b> This is a global configuration setting; setting this value to {@code false} will disable sessions |
| * to persist Subject state for all Subjects that do not already have a Session. It should typically only be set |
| * to {@code false} for 100% stateless applications (e.g. when sessions aren't used or when remote clients |
| * authenticate on every request). |
| * |
| * @param sessionStorageEnabled if any Subject's {@code Session} may be used to persist that {@code Subject}'s state. |
| */ |
| public void setSessionStorageEnabled(boolean sessionStorageEnabled) { |
| <span class="fc" id="L94"> this.sessionStorageEnabled = sessionStorageEnabled;</span> |
| <span class="fc" id="L95"> }</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> |
