| <?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>SessionTool.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> > <a href="index.source.html" class="el_package">org.apache.turbine.services.session</a> > <span class="el_source">SessionTool.java</span></div><h1>SessionTool.java</h1><pre class="source lang-java linenums">package org.apache.turbine.services.session; |
| |
| |
| /* |
| * 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. |
| */ |
| |
| |
| import java.util.Collection; |
| |
| import jakarta.servlet.http.HttpSession; |
| |
| import org.apache.turbine.annotation.TurbineService; |
| import org.apache.turbine.om.security.User; |
| import org.apache.turbine.services.pull.ApplicationTool; |
| |
| /** |
| * A pull tool for accessing the SessionService from a velocity template. |
| * |
| * @author <a href="mailto:quintonm@bellsouth.net">Quinton McCombs</a> |
| * @version $Id$ |
| */ |
| <span class="nc" id="L38">public class SessionTool</span> |
| implements ApplicationTool |
| { |
| /** |
| * The session service. |
| */ |
| @TurbineService |
| private SessionService sessionService; |
| |
| @Override |
| public void init(Object o) |
| { |
| // empty |
| <span class="nc" id="L51"> }</span> |
| |
| @Override |
| public void refresh() |
| { |
| // empty |
| <span class="nc" id="L57"> }</span> |
| |
| /** |
| * Gets a list of the active sessions |
| * |
| * @return List of HttpSession objects |
| */ |
| public Collection<HttpSession> getActiveSessions() |
| { |
| <span class="nc" id="L66"> return sessionService.getActiveSessions();</span> |
| } |
| |
| /** |
| * Adds a session to the current list. This method should only be |
| * called by the listener. |
| * |
| * @param session Session to add |
| */ |
| public void addSession(HttpSession session) |
| { |
| <span class="nc" id="L77"> sessionService.addSession(session);</span> |
| <span class="nc" id="L78"> }</span> |
| |
| /** |
| * Removes a session from the current list. This method should only be |
| * called by the listener. |
| * |
| * @param session Session to remove |
| */ |
| public void removeSession(HttpSession session) |
| { |
| <span class="nc" id="L88"> sessionService.removeSession(session);</span> |
| <span class="nc" id="L89"> }</span> |
| |
| /** |
| * Determines if a given user is currently logged in. The actual |
| * implementation of the User object must implement the equals() |
| * method. By default, Torque based objects (liek TurbineUser) |
| * have an implementation of equals() that will compare the |
| * result of getPrimaryKey(). |
| * |
| * @param user User to check for |
| * @return true if the user is logged in on one of the |
| * active sessions. |
| */ |
| public boolean isUserLoggedIn(User user) |
| { |
| <span class="nc" id="L104"> return sessionService.isUserLoggedIn(user);</span> |
| } |
| |
| /** |
| * Gets a collection of all user objects representing the users currently |
| * logged in. This will exclude any instances of anonymous user that |
| * Turbine will use before the user actually logs on. |
| * |
| * @return collection of org.apache.turbine.om.security.User objects |
| */ |
| public Collection<User> getActiveUsers() |
| { |
| <span class="nc" id="L116"> return sessionService.getActiveUsers();</span> |
| } |
| |
| /** |
| * Gets the User object of the the specified HttpSession. |
| * |
| * @param session the session |
| * @return the user from the session |
| */ |
| public User getUserFromSession(HttpSession session) |
| { |
| <span class="nc" id="L127"> return sessionService.getUserFromSession(session);</span> |
| } |
| |
| /** |
| * Get a collection of all session on which the given user |
| * is logged in. |
| * |
| * @param user the user |
| * @return Collection of HtttSession objects |
| */ |
| public Collection<HttpSession> getSessionsForUser(User user) |
| { |
| <span class="nc" id="L139"> return sessionService.getSessionsForUser(user);</span> |
| } |
| } |
| </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> |
