com.netflix.spinnaker.fiat.permissions.PermissionsRepository Maven / Gradle / Ivy
/*
* Copyright 2016 Google, Inc.
*
* Licensed 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 com.netflix.spinnaker.fiat.permissions;
import com.netflix.spinnaker.fiat.model.UserPermission;
import com.netflix.spinnaker.fiat.model.resources.Role;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
/**
* A PermissionsRepository is responsible for persisting UserPermission objects under a user ID key.
*
* TODO(ttomsu): This may be too general, and will need to be optimized for individual resource
* type reads.
*/
public interface PermissionsRepository {
/**
* Adds the specified permission to the repository, overwriting anything under the same id.
*
* @param permission
* @return This PermissionRepository
*/
PermissionsRepository put(UserPermission permission);
/**
* Adds all the specified permissions to the repository, overwriting anything currently there.
*
* @param permissions
* @return This PermissionRepository
*/
void putAllById(Map permissions);
/**
* Gets the UserPermission from the repository, if available. Returns an empty Optional if not
* found.
*
* @param id
* @return The UserPermission wrapped in an Optional.
*/
Optional get(String id);
/** Gets all Roles in the repository keyed by user ID. */
Map> getAllById();
/**
* Gets a map of all users and their Roles from the repository where the user has at least one of
* the specified named roles. Because this method is usually used in conjunction with
* updating/syncing the users in question, the returned map will also contain the unrestricted
* user. If anyRoles is null, returns the same result as getAllById() (which includes the
* unrestricted user). If anyRoles is empty, this is an indication to sync only the
* anonymous/unrestricted user. When this is the case, this method returns a map with a single
* entry for the unrestricted user.
*
* @param anyRoles
* @return
*/
Map> getAllByRoles(List anyRoles);
/**
* Delete the specified user permission.
*
* @param id
*/
void remove(String id);
}