SessionGoals.java

Go to the documentation of this file.

/*
 * Turró i Cutiller Foundation. License notice.
 * Copyright (C) 2022 Lluis Turró Cutiller <http://www.turro.org/>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
package org.turro.web.funnel;
 
import java.util.ArrayList;
import java.util.List;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.turro.elephant.context.AbstractSessionObject;
import org.turro.elephant.context.IConstructor;
 
public class SessionGoals extends AbstractSessionObject<SessionGoals> {
 
  public List<String> goals() {
    return goals;
  }
  
  public List<String> goals(List<String> newGoals) {
    goals.clear();
    goals.addAll(newGoals);
    return goals;
  }
  
  /* Factory */
  
  public static String key() {
    return "web-goals";
  }
  
  public static SessionGoals get() {
    return AbstractSessionObject.get(key(), () -> new SessionGoals());
  }
 
  public static SessionGoals get(HttpServletRequest request, HttpServletResponse response) {
    return AbstractSessionObject.get(request, response, key(), () -> new SessionGoals());
  }
 
  public static SessionGoals get(IConstructor constructor) {
    return AbstractSessionObject.get(constructor, key(), () -> new SessionGoals());
  }
  
  public static void remove() {
    AbstractSessionObject.remove(key());
  }
 
  public static void remove(HttpServletRequest request, HttpServletResponse response) {
    AbstractSessionObject.remove(request, response, key());
  }
 
  public static void remove(IConstructor constructor) {
    AbstractSessionObject.remove(constructor, key());
  }
  
  private final List<String> goals;
  
  private SessionGoals() {
    this.goals = new ArrayList<>();
  }
 
}