1 /*
2 * Licensed to The Apereo Foundation under one or more contributor license
3 * agreements. See the NOTICE file distributed with this work for additional
4 * information regarding copyright ownership.
5 *
6 *
7 * The Apereo Foundation licenses this file to you under the Educational
8 * Community License, Version 2.0 (the "License"); you may not use this file
9 * except in compliance with the License. You may obtain a copy of the License
10 * at:
11 *
12 * http://opensource.org/licenses/ecl2.txt
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
17 * License for the specific language governing permissions and limitations under
18 * the License.
19 *
20 */
21
22 package org.opencastproject.authorization.xacml.manager.api;
23
24 import org.opencastproject.security.api.AccessControlList;
25 import org.opencastproject.util.NotFoundException;
26
27 import java.util.List;
28 import java.util.Optional;
29
30 /**
31 * ACL service API for managing ACLs.
32 */
33 public interface AclService {
34
35 /**
36 * Return all ACLs of this organization.
37 */
38 List<ManagedAcl> getAcls();
39
40 /**
41 * Return an ACL of an organization by its ID.
42 *
43 * @return <code>some</code> if the ACL could be found, <code>none</code> if the ACL with the given ID does not exist.
44 */
45 Optional<ManagedAcl> getAcl(long id);
46
47 /**
48 * Return an ACL of an organization by its name.
49 *
50 * @return <code>some</code> if the ACL could be found,
51 * <code>none</code> if the ACL with the given name does not exist.
52 */
53 Optional<ManagedAcl> getAcl(String name);
54
55 /**
56 * Update an existing ACL.
57 *
58 * @return true on a successful update, false if no ACL exists with the given ID.
59 */
60 boolean updateAcl(ManagedAcl acl);
61
62 /**
63 * Create a new ACL.
64 *
65 * @return <code>some</code> if the new ACL could be created successfully, <code>none</code> if an ACL with the same
66 * name already exists
67 */
68 Optional<ManagedAcl> createAcl(AccessControlList acl, String name);
69
70 /**
71 * Delete an ACL by its ID.
72 *
73 * @return <code>true</code> if the ACL existed and could be deleted successfully, <code>false</code> if the ACL can't
74 * be deleted because it still has active references on it.
75 * @throws NotFoundException
76 * if the managed acl could not be found
77 * @throws AclServiceException
78 * if exception occurred
79 */
80 boolean deleteAcl(long id) throws AclServiceException, NotFoundException;
81 }