| /* |
| * 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.nifi.registry.security.authorization; |
| |
| import org.apache.nifi.registry.security.authorization.exception.AuthorizationAccessException; |
| import org.apache.nifi.registry.security.exception.SecurityProviderCreationException; |
| import org.apache.nifi.registry.security.exception.SecurityProviderDestructionException; |
| |
| import java.util.Set; |
| |
| /** |
| * Provides access to Users and Groups. |
| * |
| * NOTE: Extensions will be called often and frequently. Because of this, if the underlying implementation needs to |
| * make remote calls or expensive calculations those should probably be done asynchronously and/or cache the results. |
| * |
| * Additionally, extensions need to be thread safe. |
| */ |
| public interface UserGroupProvider { |
| |
| /** |
| * Retrieves all users. Must be non null |
| * |
| * @return a list of users |
| * @throws AuthorizationAccessException if there was an unexpected error performing the operation |
| */ |
| Set<User> getUsers() throws AuthorizationAccessException; |
| |
| /** |
| * Retrieves the user with the given identifier. |
| * |
| * @param identifier the id of the user to retrieve |
| * @return the user with the given id, or null if no matching user was found |
| * @throws AuthorizationAccessException if there was an unexpected error performing the operation |
| */ |
| User getUser(String identifier) throws AuthorizationAccessException; |
| |
| /** |
| * Retrieves the user with the given identity. |
| * |
| * @param identity the identity of the user to retrieve |
| * @return the user with the given identity, or null if no matching user was found |
| * @throws AuthorizationAccessException if there was an unexpected error performing the operation |
| */ |
| User getUserByIdentity(String identity) throws AuthorizationAccessException; |
| |
| /** |
| * Retrieves all groups. Must be non null |
| * |
| * @return a list of groups |
| * @throws AuthorizationAccessException if there was an unexpected error performing the operation |
| */ |
| Set<Group> getGroups() throws AuthorizationAccessException; |
| |
| /** |
| * Retrieves a Group by id. |
| * |
| * @param identifier the identifier of the Group to retrieve |
| * @return the Group with the given identifier, or null if no matching group was found |
| * @throws AuthorizationAccessException if there was an unexpected error performing the operation |
| */ |
| Group getGroup(String identifier) throws AuthorizationAccessException; |
| |
| /** |
| * Gets a user and their groups. Must be non null. If the user is not known the UserAndGroups.getUser() and |
| * UserAndGroups.getGroups() should return null |
| * |
| * @return the UserAndGroups for the specified identity |
| * @throws AuthorizationAccessException if there was an unexpected error performing the operation |
| */ |
| UserAndGroups getUserAndGroups(String identity) throws AuthorizationAccessException; |
| |
| /** |
| * Called immediately after instance creation for implementers to perform additional setup |
| * |
| * @param initializationContext in which to initialize |
| */ |
| void initialize(UserGroupProviderInitializationContext initializationContext) throws SecurityProviderCreationException; |
| |
| /** |
| * Called to configure the Authorizer. |
| * |
| * @param configurationContext at the time of configuration |
| * @throws SecurityProviderCreationException for any issues configuring the provider |
| */ |
| void onConfigured(AuthorizerConfigurationContext configurationContext) throws SecurityProviderCreationException; |
| |
| /** |
| * Called immediately before instance destruction for implementers to release resources. |
| * |
| * @throws SecurityProviderDestructionException If pre-destruction fails. |
| */ |
| void preDestruction() throws SecurityProviderDestructionException; |
| } |