/* 
    P/P   *  Method: net.sourceforge.pebble.web.action.ViewHelpAction__static_init
          */
     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.web.action;
    33  
    34  import net.sourceforge.pebble.web.view.View;
    35  import net.sourceforge.pebble.web.view.impl.HelpPageView;
    36  import net.sourceforge.pebble.Constants;
    37  
         /* 
    P/P   *  Method: void net.sourceforge.pebble.web.action.ViewHelpAction()
          */
    38  import javax.servlet.ServletException;
    39  import javax.servlet.http.HttpServletRequest;
    40  import javax.servlet.http.HttpServletResponse;
    41  
    42  /**
    43   * Finds a particular blog entry via a story name, ready to be displayed.
    44   *
    45   * @author    Simon Brown
    46   */
    47  public class ViewHelpAction extends SecureAction {
    48  
    49    /**
    50     * Peforms the processing associated with this action.
    51     *
    52     * @param request  the HttpServletRequest instance
    53     * @param response the HttpServletResponse instance
    54     * @return the name of the next view
    55     */
    56    public View process(HttpServletRequest request, HttpServletResponse response) throws ServletException {
             /* 
    P/P       *  Method: View process(HttpServletRequest, HttpServletResponse)
              * 
              *  Preconditions:
              *    request != null
              * 
              *  Presumptions:
              *    javax.servlet.http.HttpServletRequest:getParameter(...)@57 != null
              * 
              *  Postconditions:
              *    return_value == &new HelpPageView(process#1)
              *    new HelpPageView(process#1) num objects == 1
              * 
              *  Test Vectors:
              *    java.lang.String:matches(...)@58: {1}, {0}
              */
    57      String name = request.getParameter("name");
    58      if (!name.matches("\\w*")) {
    59        name = "index";
    60      }
    61  
    62      return new HelpPageView(name);
    63    }
    64  
    65    /**
    66     * Gets a list of all roles that are allowed to access this action.
    67     *
    68     * @return  an array of Strings representing role names
    69     * @param request
    70     */
    71    public String[] getRoles(HttpServletRequest request) {
             /* 
    P/P       *  Method: String[] getRoles(HttpServletRequest)
              * 
              *  Presumptions:
              *    init'ed(net.sourceforge.pebble.Constants.BLOG_ADMIN_ROLE)
              *    init'ed(net.sourceforge.pebble.Constants.BLOG_CONTRIBUTOR_ROLE)
              *    init'ed(net.sourceforge.pebble.Constants.BLOG_OWNER_ROLE)
              *    init'ed(net.sourceforge.pebble.Constants.BLOG_PUBLISHER_ROLE)
              * 
              *  Postconditions:
              *    return_value == &new String[](getRoles#1)
              *    new String[](getRoles#1) num objects == 1
              *    return_value.length == 4
              *    return_value[0] == net.sourceforge.pebble.Constants.BLOG_OWNER_ROLE
              *    (soft) init'ed(return_value[0])
              *    return_value[1] == net.sourceforge.pebble.Constants.BLOG_PUBLISHER_ROLE
              *    (soft) init'ed(return_value[1])
              *    return_value[2] == net.sourceforge.pebble.Constants.BLOG_CONTRIBUTOR_ROLE
              *    (soft) init'ed(return_value[2])
              *    return_value[3] == net.sourceforge.pebble.Constants.BLOG_ADMIN_ROLE
              *    ...
              */
    72      return new String[]{
    73          Constants.BLOG_OWNER_ROLE,
    74          Constants.BLOG_PUBLISHER_ROLE,
    75          Constants.BLOG_CONTRIBUTOR_ROLE,
    76          Constants.BLOG_ADMIN_ROLE
    77        };
    78    }
    79  
    80  }