org.opencastproject.security.api.RoleDirectoryService Maven / Gradle / Ivy
/*
* Licensed to The Apereo Foundation under one or more contributor license
* agreements. See the NOTICE file distributed with this work for additional
* information regarding copyright ownership.
*
*
* The Apereo Foundation licenses this file to you under the Educational
* Community 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://opensource.org/licenses/ecl2.txt
*
* 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.opencastproject.security.api;
import java.util.List;
/**
* A marker interface for the federation of all {@link RoleProvider}s.
*/
public interface RoleDirectoryService {
/**
* Return the found roles as a list.
*
* @param query
* the query. Use the wildcards "_" to match any single character and "%" to match an arbitrary number of
* characters (including zero characters).
* @param offset
* the offset.
* @param limit
* the limit. 0 means no limit
* @return a list of roles
* @throws IllegalArgumentException
* if the query is null
*/
List findRoles(String query, Role.Target target, int offset, int limit);
}