com.enonic.xp.security.SecurityService Maven / Gradle / Ivy
package com.enonic.xp.security;
import java.util.List;
import java.util.Optional;
import com.enonic.xp.annotation.PublicApi;
import com.enonic.xp.security.acl.IdProviderAccessControlList;
import com.enonic.xp.security.auth.AuthenticationInfo;
import com.enonic.xp.security.auth.AuthenticationToken;
@PublicApi
public interface SecurityService
{
IdProviders getIdProviders();
IdProvider getIdProvider( IdProviderKey idProviderKey );
IdProviderAccessControlList getIdProviderPermissions( IdProviderKey idProviderKey );
IdProviderAccessControlList getDefaultIdProviderPermissions();
IdProvider createIdProvider( CreateIdProviderParams createIdProviderParams );
IdProvider updateIdProvider( UpdateIdProviderParams updateIdProviderParams );
Principals findPrincipals( IdProviderKey useStore, List types, String query );
AuthenticationInfo authenticate( AuthenticationToken token );
User setPassword( PrincipalKey key, String password );
/**
* Creates a user on the specified id provider.
*
* @param createUserParams details of the user to be created
* @return the user created
* @throws PrincipalAlreadyExistsException if a user with the same key already exists
*/
User createUser( CreateUserParams createUserParams );
/**
* Updates an existing user.
*
* @param updateUserParams details of the user to be updated
* @return the user updated
* @throws PrincipalNotFoundException if the specified user does not exist
*/
User updateUser( UpdateUserParams updateUserParams );
/**
* Looks up a user by key and returns an {@code Optional} with the user instance.
*
* @param userKey principal key of the user to retrieve
* @return an {@link Optional} with the user
*/
Optional getUser( PrincipalKey userKey );
/**
* Retrieve the list of principals (groups or roles) that have the specified principal as a member.
* The list returned will contain only direct memberships, i.e. not including transitive dependencies (group of a group).
*
* @param principalKey principal key to obtain memberships of
* @return a list of {@link PrincipalKeys} containing the list of groups and roles that the principal is a member of
*/
PrincipalKeys getMemberships( PrincipalKey principalKey );
/**
* Retrieve the list of principals (groups or roles) that have the specified principal as a member, directly or indirectly.
* The list returned will contain all memberships, including transitive dependencies (group of a group).
*
* @param principalKey principal key to obtain memberships of
* @return a list of {@link PrincipalKeys} containing the list of groups and roles that the principal is a member of
*/
PrincipalKeys getAllMemberships( PrincipalKey principalKey );
/**
* Creates a group on the specified id provider.
*
* @param createGroupParams details of the group to be created
* @return the group created
* @throws PrincipalAlreadyExistsException if a group with the same key already exists
*/
Group createGroup( CreateGroupParams createGroupParams );
/**
* Updates an existing group.
*
* @param updateGroupParams details of the group to be updated
* @return the group updated
* @throws PrincipalNotFoundException if the specified group does not exist
*/
Group updateGroup( UpdateGroupParams updateGroupParams );
/**
* Looks up a group by key and returns an {@code Optional} with the group instance.
*
* @param groupKey principal key of the group to retrieve
* @return an {@link Optional} with the group
*/
Optional getGroup( PrincipalKey groupKey );
/**
* Creates a role on the specified id provider.
*
* @param createRoleParams details of the role to be created
* @return the role created
* @throws PrincipalAlreadyExistsException if a role with the same key already exists
*/
Role createRole( CreateRoleParams createRoleParams );
/**
* Updates an existing role.
*
* @param updateRoleParams details of the role to be updated
* @return the role updated
* @throws PrincipalNotFoundException if the specified role does not exist
*/
Role updateRole( UpdateRoleParams updateRoleParams );
/**
* Looks up a role by key and returns an {@code Optional} with the role instance.
*
* @param roleKey principal key of the role to retrieve
* @return an {@link Optional} with the role
*/
Optional getRole( PrincipalKey roleKey );
/**
* Looks up a principal by key and returns an {@code Optional} with the principal instance.
*
* @param principalKey key of the principal to retrieve
* @return an {@link Optional} with the principal
*/
Optional getPrincipal( PrincipalKey principalKey );
/**
* Looks up a set of principals by key and returns a list of with the {@link Principals} found.
* If one or more principal keys cannot be found, they will be omitted from the result.
*
* @param principalKeys keys of the principals to retrieve
* @return a {@link Principals} object containing the list of principals found
*/
Principals getPrincipals( PrincipalKeys principalKeys );
/**
* Deletes an existing principal.
*
* @param principalKey key of the principal to be deleted
* @throws PrincipalNotFoundException if the specified principal does not exist
*/
void deletePrincipal( PrincipalKey principalKey );
/**
* Deletes an existing idProvider.
*
* @param idProviderKey key of the idProvider to be deleted
* @throws IdProviderNotFoundException if the specified idProvider does not exist
*/
void deleteIdProvider( IdProviderKey idProviderKey );
PrincipalQueryResult query( PrincipalQuery query );
UserQueryResult query( UserQuery query );
PrincipalRelationships getRelationships( PrincipalKey from );
void addRelationship( PrincipalRelationship relationship );
void removeRelationship( PrincipalRelationship relationship );
@Deprecated
void removeRelationships( PrincipalKey from );
}