+++ /dev/null
-/*
- * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
- *
- * This program and the accompanying materials are made available under the
- * terms of the Eclipse Public License v1.0 which accompanies this distribution,
- * and is available at http://www.eclipse.org/legal/epl-v10.html
- */
-
-package org.opendaylight.controller.usermanager;
-
-import java.util.List;
-import java.util.Map;
-import java.util.Set;
-
-import org.opendaylight.controller.sal.authorization.AuthResultEnum;
-import org.opendaylight.controller.sal.authorization.UserLevel;
-import org.opendaylight.controller.sal.utils.Status;
-import org.springframework.security.core.userdetails.UserDetailsService;
-import org.springframework.security.web.context.SecurityContextRepository;
-
-/**
- * The Interface which describes the methods exposed by User Manager.
- */
-public interface IUserManager extends UserDetailsService {
-
- /**
- * Returns the list of roles associated to the passed user name
- *
- * @param userName
- * @return the role associated to the user name
- */
- public List<String> getUserRoles(String userName);
-
- /**
- * Authenticate user with AAA server and return authentication and
- * authorization info
- *
- * @param username
- * the username
- * @param password
- * the password
- * @return {@link org.opendaylight.controller.sal.authorization.AuthResultEnum}
- * authentication result
- */
- public AuthResultEnum authenticate(String username, String password);
-
- /**
- * Add/remove AAA server
- *
- * @param configObject
- * {@link org.opendaylight.controller.usermanager.internal.ServerConfig}
- * Server Configuration
- * @return {@link org.opendaylight.controller.sal.utils.Status}
- * status of this action
- */
- public Status addAAAServer(ServerConfig configObject);
-
- /**
- * Remove AAA server
- *
- * @param configObject
- * refer to
- * {@link org.opendaylight.controller.usermanager.internal.ServerConfig}
- * Server Configuration
- * @return {@link org.opendaylight.controller.sal.utils.Status}
- * status of this action
- */
- public Status removeAAAServer(ServerConfig configObject);
-
- /**
- * Add a local user
- *
- * @param configObject
- * {@link org.opendaylight.controller.usermanager.internal.UserConfig}
- * User Configuration
- * @return refer to {@link org.opendaylight.controller.sal.utils.Status}
- * status code
- */
- public Status addLocalUser(UserConfig configObject);
-
- /**
- * Modify a local user
- *
- * @param configObject
- * {@link org.opendaylight.controller.usermanager.internal.UserConfig}
- * The new User Configuration
- * @return refer to {@link org.opendaylight.controller.sal.utils.Status}
- * status code
- */
- public Status modifyLocalUser(UserConfig configObject);
-
- /**
- * Remove a local user
- *
- * @param configObject
- * {@link org.opendaylight.controller.usermanager.internal.UserConfig}
- * UserConfig
- * @return {@link org.opendaylight.controller.sal.utils.Status}
- * status of this action
- */
- public Status removeLocalUser(UserConfig configObject);
-
- /**
- * Remove a local user
- *
- * @param userName
- * the user name
- * @return {@link org.opendaylight.controller.sal.utils.Status}
- * status of this action
- */
- public Status removeLocalUser(String userName);
-
- /**
- * Add the authorization information for a user that gets authenticated
- * remotely
- *
- * @param AAAconf
- * {@link org.opendaylight.controller.usermanager.internal.AuthorizationConfig}
- * Authorization Resources
- * @return {@link org.opendaylight.controller.sal.utils.Status}
- * status of this action
- */
- public Status addAuthInfo(AuthorizationConfig AAAconf);
-
- /**
- * Remove the authorization information for a user that gets authenticated
- * remotely
- *
- * @param AAAconf
- * {@link org.opendaylight.controller.usermanager.internal.AuthorizationConfig}
- * Authorization Resource
- * @return {@link org.opendaylight.controller.sal.utils.Status}
- * status of this action
- */
- public Status removeAuthInfo(AuthorizationConfig AAAconf);
-
- /**
- * Return the list of authorization resources
- *
- * @return {@link org.opendaylight.controller.usermanager.internal.AuthorizationConfig}
- * List of Authorization Resource
- */
- public List<AuthorizationConfig> getAuthorizationList();
-
- /**
- * Returns a list of AAA Providers.
- *
- * @return Set of provider names.
- */
- public Set<String> getAAAProviderNames();
-
- /**
- * Change the current password for a locally configured user
- *
- * @param user
- * the username
- * @param curPasssword
- * the current password
- * @param newPassword
- * the new password
- * @return {@link org.opendaylight.controller.sal.utils.Status}
- * status of this action
- */
- public Status changeLocalUserPassword(String user, String curPassword,
- String newPassword);
-
- /**
- * Return a list of AAA servers currently configured
- *
- * @return {@link org.opendaylight.controller.usermanager.internal.ServerConfig}
- * List of ServerConfig
- */
- public List<ServerConfig> getAAAServerList();
-
- /**
- * Return a list of local users
- *
- * @return {@link org.opendaylight.controller.usermanager.internal.UserConfig}
- * List of UserConfig
- */
- public List<UserConfig> getLocalUserList();
-
- /**
- * Save the local users to disk
- *
- * @return {@link org.opendaylight.controller.sal.utils.Status}
- * status of this action
- */
- public Status saveLocalUserList();
-
- /**
- * Save the AAA server configurations to disk
- *
- * @return {@link org.opendaylight.controller.sal.utils.Status}
- * status of this action
- */
- public Status saveAAAServerList();
-
- /**
- * Save the Authorization configurations to disk
- *
- * @return {@link org.opendaylight.controller.sal.utils.Status}
- * status code
- */
- public Status saveAuthorizationList();
-
- /**
- * Remove user profile when user logs out
- *
- * @param username
- * the user name
- */
- public void userLogout(String username);
-
- /**
- * Remove user profile when user times out
- *
- * @param username
- * the user name
- */
- public void userTimedOut(String username);
-
- /**
- * Get the list of users currently logged in
- *
- * @return the list of users along with their administrative roles
- */
- public Map<String, List<String>> getUserLoggedIn();
-
- /**
- * Get date and time user was successfully authenticated
- *
- * @param user
- * @return Date in String format
- */
- public String getAccessDate(String user);
-
- /**
- * Returns the highest user level for the passed user name. It checks the roles
- * assigned to this user and checks against the well known Controller user
- * roles to determines the highest user level associated with the user
- *
- * @param userName
- * the user name
- * @return {@link org.opendaylight.controller.sal.authorization.UserLevel}
- * the highest user level for this user
- */
- public UserLevel getUserLevel(String userName);
-
- /**
- * Returns the list of user level for the passed user name. It checks the roles
- * assigned to this user and checks against the well known Controller user
- * roles to determines the corresponding list of user level associated with the user
- *
- * @param userName
- * the user name
- * @return
- * the list of user level for this user
- */
- public List<UserLevel> getUserLevels(String userName);
-
- /**
- * Returns the Security Context
- *
- * @returns {@link org.springframework.security.web.context.SecurityContextRepository}
- * Security Context
- */
- public SecurityContextRepository getSecurityContextRepo();
-
- /**
- * Returns the Session Manager Interface Handler
- *
- * @return {@link org.opendaylight.controller.usermanager.ISessionManager}
- * session manager interface handler
- */
- public ISessionManager getSessionManager();
-
- /**
- * Checks if the specified role belongs to any application. Usually an
- * application will call this function when configuring a role, to check if
- * that role is already being used by another application.
- *
- * @param role
- * The role to check
- * @return true if the specified role belongs to any application or if the
- * role is a well-known controller role, false otherwise.
- */
- public boolean isRoleInUse(String role);
-
- /* non-Javadoc
- * Returns the password for a given user
- *
- * @param username
- * the user name
- * @return password for the username
- */
- public String getPassword(String username);
-
-}
Code Review / controller.git / blobdiff