/* * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. */ package org.apache.smscserver.smsclet; /** * * User manager interface. * * @author hceylan */ public interface UserManager { /** * Authenticate user * * @param authentication * The {@link Authentication} that proves the users identity * @return the authenticated account. * @throws AuthenticationFailedException * @throws SmscException * when the UserManager can't fulfill the request. */ User authenticate(Authentication authentication) throws AuthenticationFailedException, SmscException; /** * Delete the user from the system. * * @param username * The name of the {@link User} to delete * * @throws SmscException * when the UserManager can't fulfill the request. * @throws UnsupportedOperationException * if UserManager in read-only mode */ void delete(String username) throws SmscException; /** * Check if the user exists. * * @param username * the name of the user to check. * @return true if the user exist, false otherwise. * @throws SmscException */ boolean doesExist(String username) throws SmscException; /** * Get admin user name * * @return the admin user name * @throws SmscException * when the UserManager can't fulfill the request. */ String getAdminName() throws SmscException; /** * Get all user names in the system. * * @throws SmscException * when the UserManager can't fulfill the request. * @return an array of username strings, note that the result should never be null, if there is no users the result * is an empty array. */ String[] getAllUserNames() throws SmscException; /** * Get user by name. * * @param username * the name to search for. * @throws SmscException * when the UserManager can't fulfill the request. * @return the user with the specified name, or null if a such user does not exist. */ User getUserByName(String username) throws SmscException; /** * Check if the user is admin. * * @param username * The name of the {@link User} to check * @return true if user with this bind is administrator * @throws SmscException * when the UserManager can't fulfill the request. */ boolean isAdmin(String username) throws SmscException; /** * Save user. If a new user, create it else update the existing user. * * @param user * the Uset to save * @throws SmscException * when the UserManager can't fulfill the request. * @throws UnsupportedOperationException * if UserManager in read-only mode */ void save(User user) throws SmscException; /** * Sets the server context * * @param context * the server context * @throws NullPointerException * if the context is null * @throws IllegalStateException * if the context is already been assigned */ void setContext(SmscletContext serverContext); }