1 /** 2 * This file Copyright (c) 2003-2011 Magnolia International 3 * Ltd. (http://www.magnolia-cms.com). All rights reserved. 4 * 5 * 6 * This file is dual-licensed under both the Magnolia 7 * Network Agreement and the GNU General Public License. 8 * You may elect to use one or the other of these licenses. 9 * 10 * This file is distributed in the hope that it will be 11 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the 12 * implied warranty of MERCHANTABILITY or FITNESS FOR A 13 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT. 14 * Redistribution, except as permitted by whichever of the GPL 15 * or MNA you select, is prohibited. 16 * 17 * 1. For the GPL license (GPL), you can redistribute and/or 18 * modify this file under the terms of the GNU General 19 * Public License, Version 3, as published by the Free Software 20 * Foundation. You should have received a copy of the GNU 21 * General Public License, Version 3 along with this program; 22 * if not, write to the Free Software Foundation, Inc., 51 23 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 24 * 25 * 2. For the Magnolia Network Agreement (MNA), this file 26 * and the accompanying materials are made available under the 27 * terms of the MNA which accompanies this distribution, and 28 * is available at http://www.magnolia-cms.com/mna.html 29 * 30 * Any modifications to this file must keep this entire header 31 * intact. 32 * 33 */ 34 package info.magnolia.cms.security; 35 36 import info.magnolia.cms.security.auth.callback.CredentialsCallbackHandler; 37 import info.magnolia.cms.security.auth.login.LoginResult; 38 import info.magnolia.objectfactory.Components; 39 40 /** 41 * Entry point to get the various managers like {@link UserManager}, {@link GroupManager} and {@link RoleManager}. 42 * @author gjoseph 43 * @version $Revision: $ ($Author: $) 44 */ 45 public interface SecuritySupport { 46 47 /** 48 * Returns a generic UserManager, either for a default realm, or an implementation which delegates to other UserManager instances. 49 */ 50 UserManager getUserManager(); 51 52 /** 53 * Returns a UserManager for the given realm. 54 */ 55 UserManager getUserManager(String realmName); 56 57 GroupManager getGroupManager(); 58 59 RoleManager getRoleManager(); 60 61 /** 62 * Performs an authentication using the {@link CredentialsCallbackHandler} to retriev the user name and password. 63 */ 64 LoginResult authenticate(CredentialsCallbackHandler callbackHandler, String jaasModuleName); 65 66 /** 67 * Factory to retrieve the singleton instance. 68 */ 69 public final static class Factory { 70 public static SecuritySupport getInstance() { 71 return Components.getSingleton(SecuritySupport.class); 72 } 73 } 74 }