View Javadoc

1   /*
2    * $Id: Authorizator.java 124 2004-11-01 18:09:40Z josem $
3    *
4    * Tarsis
5    * Copyright (C) 2002 Talika Open Source Group
6    *
7    * This program is free software; you can redistribute it and/or modify
8    * it under the terms of the GNU General Public License as published by
9    * the Free Software Foundation; either version 2 of the License, or
10   * (at your option) any later version.
11   *
12   * This program is distributed in the hope that it will be useful,
13   * but WITHOUT ANY WARRANTY; without even the implied warranty of
14   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15   * GNU General Public License for more details.
16   *
17   * You should have received a copy of the GNU General Public License
18   * along with this program; if not, write to the Free Software
19   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
20   *
21   */
22  
23  package org.talika.tarsis.security;
24  
25  import org.talika.tarsis.command.Command;
26  
27  /**
28   * Interface that defines an authorizator component in Tarsis MVC Framework.<br>
29   * <br>
30   * Authorizator component is responsible of manage authorizations. It checks if a
31   * given <code>User</code> has authorization to access a given <code>Command</code>.
32   *
33   * @author  Jose M. Palomar
34   * @version $Revision: 124 $
35   */
36  public interface Authorizator {
37  
38      /**
39       * Checks if <code>User</code> has authorizations to access <code>Command</code>.
40       * If not throws a <code>ForbiddenAccessException</code>.
41       *
42       * @param user User user to be checked.
43       * @param command Command command to be checked.
44       * @throws ForbiddenAccessException if <code>User</code> has not authorization.
45       */
46      void authorize(User user, Command command)
47      throws ForbiddenAccessException;
48  
49      /**
50       * Returns <code>true</code> if <code>Command</code> has access restrited.
51       *
52       * @param command Command command to be checked.
53       * @return boolean <code>true</code> if <code>Command</code> has access restrited.
54       */
55      boolean isRestricted(Command command);
56  
57  }
58