wamblee.org Git - utils/blob - wicket/components/src/main/java/org/wamblee/wicket/page/ExpireBehavior.java

   1 /*
   2  * Copyright 2005-2010 the original author or authors.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 package org.wamblee.wicket.page;
  17
  18 import java.util.logging.Logger;
  19
  20 import org.apache.wicket.markup.html.WebPage;
  21
  22 /**
  23  * Bahevior that will expire a page when the page is disabled. Implementations
  24  * should implemnet
  25  *
  26  * @author Erik Brakkee
  27  *
  28  */
  29 public abstract class ExpireBehavior extends AbstractPageBehavior {
  30     private static final Logger LOGGER = Logger.getLogger(ExpireBehavior.class
  31         .getName());
  32
  33     /**
  34      * Constructs the behavior.
  35      */
  36     public ExpireBehavior() {
  37         super();
  38     }
  39
  40     @Override
  41     public void onDetach(WebPage aPage) {
  42         if (isExpired(aPage)) {
  43             aPage.getPageMap().remove(aPage);
  44         }
  45     }
  46
  47     /**
  48      * Must be implemented to determine if a page is expired.
  49      *
  50      * @param aPage
  51      *            Page to check. If a behavior instance is only used on one page
  52      *            then this argument is always that page so it can bne ignored
  53      *            in that case.
  54      * @return
  55      */
  56     protected abstract boolean isExpired(WebPage aPage);
  57
  58 }