1  /*
     2   * Copyright (c) 2003-2006, Simon Brown
     3   * All rights reserved.
     4   *
     5   * Redistribution and use in source and binary forms, with or without
     6   * modification, are permitted provided that the following conditions are met:
     7   *
     8   *   - Redistributions of source code must retain the above copyright
     9   *     notice, this list of conditions and the following disclaimer.
    10   *
    11   *   - Redistributions in binary form must reproduce the above copyright
    12   *     notice, this list of conditions and the following disclaimer in
    13   *     the documentation and/or other materials provided with the
    14   *     distribution.
    15   *
    16   *   - Neither the name of Pebble nor the names of its contributors may
    17   *     be used to endorse or promote products derived from this software
    18   *     without specific prior written permission.
    19   *
    20   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
    21   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    22   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    23   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
    24   * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
    25   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
    26   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
    27   * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
    28   * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
    29   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
    30   * POSSIBILITY OF SUCH DAMAGE.
    31   */
    32  package net.sourceforge.pebble.api.confirmation;
    33  
         /* 
    P/P   *  Method: net.sourceforge.pebble.api.confirmation.ConfirmationStrategy__static_init
          */
    34  import javax.servlet.http.HttpServletRequest;
    35  
    36  /**
    37   * Represents an abstraction of the various ways that confirmations can happen.
    38   *
    39   * @author    Simon Brown
    40   */
    41  public interface ConfirmationStrategy {
    42  
    43    /**
    44     * Called before showing the confirmation page.
    45     *
    46     * @param request   the HttpServletRequest used in the confirmation
    47     */
    48    public void setupConfirmation(HttpServletRequest request);
    49  
    50    /**
    51     * Gets the URI of the confirmation page.
    52     *
    53     * @return  a URI, relative to the web application root.
    54     */
    55    public String getUri();
    56  
    57    /**
    58     * Called to determine whether confirmation was successful.
    59     *
    60     * @param request   the HttpServletRequest used in the confirmation
    61     * @return  true if the confirmation was successful, false otherwise
    62     */
    63    public boolean isConfirmed(HttpServletRequest request);
    64  
    65  }