org.keycloak.models.GroupModel Maven / Gradle / Ivy
/*
* Copyright 2016 Red Hat, Inc. and/or its affiliates
* and other contributors as indicated by the @author tags.
*
* 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 org.keycloak.models;
import org.keycloak.provider.ProviderEvent;
import java.util.Comparator;
import java.util.List;
import java.util.Map;
import java.util.stream.Stream;
/**
* @author Bill Burke
* @version $Revision: 1 $
*/
public interface GroupModel extends RoleMapperModel {
interface GroupRemovedEvent extends ProviderEvent {
RealmModel getRealm();
GroupModel getGroup();
KeycloakSession getKeycloakSession();
}
interface GroupPathChangeEvent extends ProviderEvent {
RealmModel getRealm();
String getNewPath();
String getPreviousPath();
KeycloakSession getKeycloakSession();
}
Comparator COMPARE_BY_NAME = Comparator.comparing(GroupModel::getName);
String getId();
String getName();
void setName(String name);
/**
* Set single value of specified attribute. Remove all other existing values
*
* @param name
* @param value
*/
void setSingleAttribute(String name, String value);
void setAttribute(String name, List values);
void removeAttribute(String name);
/**
* @param name
* @return null if there is not any value of specified attribute or first value otherwise. Don't throw exception if there are more values of the attribute
*/
String getFirstAttribute(String name);
/**
* Returns group attributes that match the given name as a stream.
* @param name {@code String} Name of the attribute to be used as a filter.
* @return Stream of all attribute values or empty stream if there are not any values. Never return {@code null}.
*/
Stream getAttributeStream(String name);
Map> getAttributes();
GroupModel getParent();
String getParentId();
/**
* Returns all sub groups for the parent group as a stream.
* The stream is sorted by the group name.
*
* @return Stream of {@link GroupModel}. Never returns {@code null}.
*/
Stream getSubGroupsStream();
/**
* Returns all sub groups for the parent group matching the fuzzy search as a stream, paginated.
* Stream is sorted by the group name.
*
* @param search searched string. If empty or {@code null} all subgroups are returned.
* @return Stream of {@link GroupModel}. Never returns {@code null}.
*/
default Stream getSubGroupsStream(String search, Integer firstResult, Integer maxResults) {
return getSubGroupsStream(search, false, firstResult, maxResults);
}
/**
* Returns all sub groups for the parent group as a stream, paginated.
*
* @param firstResult First result to return. Ignored if negative or {@code null}.
* @param maxResults Maximum number of results to return. Ignored if negative or {@code null}.
* @return
*/
default Stream getSubGroupsStream(Integer firstResult, Integer maxResults) {
return getSubGroupsStream(null, firstResult, maxResults);
}
/**
* Returns all subgroups for the parent group matching the search as a stream, paginated.
* Stream is sorted by the group name.
*
* @param search search string. If empty or {@code null} all subgroups are returned.
* @param exact toggles fuzzy searching
* @param firstResult First result to return. Ignored if negative or {@code null}.
* @param maxResults Maximum number of results to return. Ignored if negative or {@code null}.
* @return Stream of {@link GroupModel}. Never returns {@code null}.
*/
default Stream getSubGroupsStream(String search, Boolean exact, Integer firstResult, Integer maxResults) {
Stream allSubgorupsGroups = getSubGroupsStream().filter(group -> {
if (search == null || search.isEmpty()) return true;
if (Boolean.TRUE.equals(exact)) {
return group.getName().equals(search);
} else {
return group.getName().toLowerCase().contains(search.toLowerCase());
}
});
// Copied over from StreamsUtil from server-spi-private which is not available here
if (firstResult != null && firstResult > 0) {
allSubgorupsGroups = allSubgorupsGroups.skip(firstResult);
}
if (maxResults != null && maxResults >= 0) {
allSubgorupsGroups = allSubgorupsGroups.limit(maxResults);
}
return allSubgorupsGroups;
}
/**
* Returns the number of groups contained beneath this group.
*
* @return The number of groups beneath this group. Never returns {@code null}.
*/
default Long getSubGroupsCount() {
return getSubGroupsStream().count();
}
/**
* You must also call addChild on the parent group, addChild on RealmModel if there is no parent group
*
* @param group
*/
void setParent(GroupModel group);
/**
* Automatically calls setParent() on the subGroup
*
* @param subGroup
*/
void addChild(GroupModel subGroup);
/**
* Automatically calls setParent() on the subGroup
*
* @param subGroup
*/
void removeChild(GroupModel subGroup);
}