AbstractConstraint


1   /*
2    * Copyright (c) 1998-2006 Caucho Technology -- all rights reserved
3    *
4    * This file is part of Resin(R) Open Source
5    *
6    * Each copy or derived work must preserve the copyright notice and this
7    * notice unmodified.
8    *
9    * Resin Open Source is free software; you can redistribute it and/or modify
10   * it under the terms of the GNU General Public License as published by
11   * the Free Software Foundation; either version 2 of the License, or
12   * (at your option) any later version.
13   *
14   * Resin Open Source is distributed in the hope that it will be useful,
15   * but WITHOUT ANY WARRANTY; without even the implied warranty of
16   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, or any warranty
17   * of NON-INFRINGEMENT.  See the GNU General Public License for more
18   * details.
19   *
20   * You should have received a copy of the GNU General Public License
21   * along with Resin Open Source; if not, write to the
22   *   Free SoftwareFoundation, Inc.
23   *   59 Temple Place, Suite 330
24   *   Boston, MA 02111-1307  USA
25   *
26   * @author Scott Ferguson
27   */
28  
29  package com.caucho.server.security;
30  
31  import javax.servlet.ServletContext  ;
32  import javax.servlet.ServletException  ;
33  import javax.servlet.http.HttpServletRequest  ;
34  import javax.servlet.http.HttpServletResponse  ;
35  import java.io.IOException  ;
36  
37  abstract public class AbstractConstraint {
38    /**
39     * Returns true if the constraint requires authentication.
40     */
41    public boolean needsAuthentication()
42    {
43      return false;
44    }
45    
46    /**
47     * Returns true if any cache needs to be private.
48     */
49    public boolean isPrivateCache()
50    {
51      return true;
52    }
53    
54    /**
55     * Returns true if the user is authorized for the resource.
56     *
57     * <p>isAuthorized must provide the response if the user is not
58     * authorized.  Typically this will just call sendError.
59     *
60     * <p>isAuthorized will be called after all the other filters, but
61     * before the servlet.service().
62     *
63     * @param request the servlet request
64     * @param response the servlet response
65     *
66     * @return true if the request is authorized.
67     */
68    abstract public boolean isAuthorized(HttpServletRequest   request,
69                                         HttpServletResponse   response,
70                                         ServletContext   application)
71      throws ServletException  , IOException  ;
72  
73    /**
74     * converts the sub constraints to an array.
75     */
76    protected AbstractConstraint []toArray()
77    {
78      return new AbstractConstraint[] { this };
79    }
80  }
81
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags