blob: e39a02fb79364bf19f9e3a465bb8336c4b4f8af0 [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=""><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>VelocitySecureScreen.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 Turbine</a> &gt; <a href="index.source.html" class="el_package">org.apache.turbine.modules.screens</a> &gt; <span class="el_source">VelocitySecureScreen.java</span></div><h1>VelocitySecureScreen.java</h1><pre class="source lang-java linenums">package org.apache.turbine.modules.screens;
/*
* 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.
*/
import org.apache.turbine.pipeline.PipelineData;
import org.apache.velocity.context.Context;
/**
* VelocitySecureScreen
*
* Always performs a Security Check that you've defined before
* executing the doBuildTemplate(). You should extend this class and
* add the specific security check needed. If you have a number of
* screens that need to perform the same check, you could make a base
* screen by extending this class and implementing the isAuthorized().
* Then each screen that needs to perform the same check could extend
* your base screen.
*
* @author &lt;a href=&quot;mailto:mbryson@mont.mindspring.com&quot;&gt;Dave Bryson&lt;/a&gt;
* @author &lt;a href=&quot;mailto:peter@courcoux.biz&quot;&gt;Peter Courcoux&lt;/a&gt;
* @version $Id$
*/
<span class="nc" id="L41">public abstract class VelocitySecureScreen</span>
extends VelocityScreen
{
/**
* Implement this to add information to the context.
*
* @param pipelineData Turbine information.
* @param context Context for web pages.
* @throws Exception a generic exception.
*/
@Override
protected abstract void doBuildTemplate(PipelineData pipelineData,
Context context)
throws Exception;
/**
* This method overrides the method in VelocityScreen to
* perform a security check first.
*
* @param pipelineData Turbine information.
* @throws Exception a generic exception.
*/
@Override
protected void doBuildTemplate(PipelineData pipelineData)
throws Exception
{
<span class="nc bnc" id="L67" title="All 2 branches missed."> if (isAuthorized(pipelineData))</span>
{
<span class="nc" id="L69"> doBuildTemplate(pipelineData, velocity.getContext(pipelineData));</span>
}
<span class="nc" id="L71"> }</span>
/**
* Implement this method to perform the security check needed.
* You should set the template in this method that you want the
* user to be sent to if they're unauthorized. See the
* VelocitySecurityCheck utility.
*
* @param pipelineData Turbine information.
* @return True if the user is authorized to access the screen.
* @throws Exception a generic exception.
*/
protected abstract boolean isAuthorized(PipelineData pipelineData)
throws Exception;
}
</pre><div class="footer"><span class="right">Created with <a href="http://www.jacoco.org/jacoco">JaCoCo</a> 0.8.12.202403310830</span></div></body></html>