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.security.api;
23
24 import org.opencastproject.util.NotFoundException;
25
26 import java.net.URL;
27 import java.util.List;
28
29 /**
30 * Manages organizations.
31 */
32 public interface OrganizationDirectoryService {
33
34 /**
35 * Gets an organization by its identifier.
36 *
37 * @param id
38 * the identifier
39 * @return the organization with this identifier
40 */
41 Organization getOrganization(String id) throws NotFoundException;
42
43 /**
44 * Gets an organization by request URL.
45 *
46 * @param url
47 * a request URL
48 * @return the organization that is mapped to this URL
49 */
50 Organization getOrganization(URL url) throws NotFoundException;
51
52 /**
53 * Gets all registered organizations.
54 *
55 * @return the organizations
56 */
57 List<Organization> getOrganizations();
58
59 /**
60 * Adds <code>listener</code> to the list of organization listeners.
61 *
62 * @param listener
63 * the organization listener
64 */
65 void addOrganizationDirectoryListener(OrganizationDirectoryListener listener);
66
67 /**
68 * Removes <code>listener</code> from the list of organization listeners.
69 *
70 * @param listener
71 * the organization listener
72 */
73 void removeOrganizationDirectoryListener(OrganizationDirectoryListener listener);
74
75 }