org.apache.sling.jackrabbit.usermanager

Interface CreateGroup

public interface CreateGroup

The CreateGroup service api.

This interface is not intended to be implemented by bundles. It is implemented by this bundle and may be used by client bundles.

Since:

2.2.0

Method Summary

Modifier and Type	Method and Description
default org.apache.jackrabbit.api.security.user.Group	createGroup(javax.jcr.Session jcrSession, java.util.Map<java.lang.String,?> properties, java.util.List<Modification> changes) Create a new group for the repository.
org.apache.jackrabbit.api.security.user.Group	createGroup(javax.jcr.Session jcrSession, java.lang.String name, java.util.Map<java.lang.String,?> properties, java.util.List<Modification> changes) Create a new group for the repository

Method Detail

createGroup

org.apache.jackrabbit.api.security.user.Group createGroup(javax.jcr.Session jcrSession,
                                                          java.lang.String name,
                                                          java.util.Map<java.lang.String,?> properties,
                                                          java.util.List<Modification> changes)
                                                   throws javax.jcr.RepositoryException

Create a new group for the repository

Parameters:

jcrSession - the JCR session of the user creating the group

name - The name of the new group. If null or empty, the name is calculated from the supplied properties (per SLING-10902).

properties - Extra properties to update on the group. The entry values should be either a String or String[] (optional)

changes - The list of changes for this operation (optional)

Returns:

the group that was created

Throws:

javax.jcr.RepositoryException - if group can't be created

createGroup

default org.apache.jackrabbit.api.security.user.Group createGroup(javax.jcr.Session jcrSession,
                                                                  java.util.Map<java.lang.String,?> properties,
                                                                  java.util.List<Modification> changes)
                                                           throws javax.jcr.RepositoryException

Create a new group for the repository. The name is calculated from the supplied properties (per SLING-10902).

Parameters:

jcrSession - the JCR session of the user creating the group

properties - Extra properties to update on the group. The entry values should be either a String or String[] (optional)

changes - The list of changes for this operation (optional)

Returns:

the group that was created

Throws:

javax.jcr.RepositoryException - if group can't be created