| <?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>ServletContextSupport.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.servlet</a> > <span class="el_source">ServletContextSupport.java</span></div><h1>ServletContextSupport.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.servlet; |
| |
| import javax.servlet.ServletContext; |
| |
| /** |
| * Base implementation for any components that need to access the web application's {@link ServletContext ServletContext}. |
| * |
| * @since 0.2 |
| */ |
| <span class="fc" id="L28">public class ServletContextSupport {</span> |
| |
| //TODO - complete JavaDoc |
| <span class="fc" id="L31"> private ServletContext servletContext = null;</span> |
| |
| public ServletContext getServletContext() { |
| <span class="fc" id="L34"> return servletContext;</span> |
| } |
| |
| public void setServletContext(ServletContext servletContext) { |
| <span class="fc" id="L38"> this.servletContext = servletContext;</span> |
| <span class="fc" id="L39"> }</span> |
| |
| @SuppressWarnings({"UnusedDeclaration"}) |
| protected String getContextInitParam(String paramName) { |
| <span class="nc" id="L43"> return getServletContext().getInitParameter(paramName);</span> |
| } |
| |
| private ServletContext getRequiredServletContext() { |
| <span class="nc" id="L47"> ServletContext servletContext = getServletContext();</span> |
| <span class="nc bnc" id="L48" title="All 2 branches missed."> if (servletContext == null) {</span> |
| <span class="nc" id="L49"> String msg = "ServletContext property must be set via the setServletContext method.";</span> |
| <span class="nc" id="L50"> throw new IllegalStateException(msg);</span> |
| } |
| <span class="nc" id="L52"> return servletContext;</span> |
| } |
| |
| @SuppressWarnings({"UnusedDeclaration"}) |
| protected void setContextAttribute(String key, Object value) { |
| <span class="nc bnc" id="L57" title="All 2 branches missed."> if (value == null) {</span> |
| <span class="nc" id="L58"> removeContextAttribute(key);</span> |
| } else { |
| <span class="nc" id="L60"> getRequiredServletContext().setAttribute(key, value);</span> |
| } |
| <span class="nc" id="L62"> }</span> |
| |
| @SuppressWarnings({"UnusedDeclaration"}) |
| protected Object getContextAttribute(String key) { |
| <span class="nc" id="L66"> return getRequiredServletContext().getAttribute(key);</span> |
| } |
| |
| protected void removeContextAttribute(String key) { |
| <span class="nc" id="L70"> getRequiredServletContext().removeAttribute(key);</span> |
| <span class="nc" id="L71"> }</span> |
| |
| /** |
| * It is highly recommended not to override this method directly, and instead override the |
| * {@link #toStringBuilder() toStringBuilder()} method, a better-performing alternative. |
| * |
| * @return the String representation of this instance. |
| */ |
| @Override |
| public String toString() { |
| <span class="fc" id="L81"> return toStringBuilder().toString();</span> |
| } |
| |
| /** |
| * Same concept as {@link #toString() toString()}, but returns a {@link StringBuilder} instance instead. |
| * |
| * @return a StringBuilder instance to use for appending String data that will eventually be returned from a |
| * {@code toString()} invocation. |
| */ |
| protected StringBuilder toStringBuilder() { |
| <span class="fc" id="L91"> return new StringBuilder(super.toString());</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> |
