org.uberfire.ext.security.management.api

Interface AbstractEntityManager<T,S extends Settings>

All Known Subinterfaces:

GroupManager, GroupManagerService, RoleManager, RoleManagerService, UserManager, UserManagerService

public interface AbstractEntityManager<T,S extends Settings>

Basic management API for security realm entities type of T.

Since:

0.8.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	AbstractEntityManager.SearchRequest The request parameters for performing entity searching on the backend security server.
static interface	AbstractEntityManager.SearchResponse<T> The response values for a search operation.

Method Summary

Modifier and Type	Method and Description
T	create(T entity) Creates a given entity in the backend security environment.
void	delete(String... identifiers) Deletes a given entity or entities (bulk delete) in the backend security environment.
T	get(String identifier) Obtain a single entity instance.
S	getSettings() The entity manager settings.
AbstractEntityManager.SearchResponse<T>	search(AbstractEntityManager.SearchRequest request) Search entities.
T	update(T entity) Creates a given entity in the backend security environment.

Method Detail

search

AbstractEntityManager.SearchResponse<T> search(AbstractEntityManager.SearchRequest request)
                                        throws SecurityManagementException

Search entities.

Parameters:

request - The search request constraints.

Returns:

List of resulting entities from the search result.

Throws:

SecurityManagementException

get

T get(String identifier)
throws SecurityManagementException

Obtain a single entity instance.

Parameters:

identifier - The entity's identifier.

Returns:

The entity for the given identifier.

Throws:

SecurityManagementException

create

T create(T entity)
  throws SecurityManagementException

Creates a given entity in the backend security environment.

Parameters:

entity - The entity to create.

Returns:

The entity.

Throws:

SecurityManagementException

update

T update(T entity)
  throws SecurityManagementException

Creates a given entity in the backend security environment.

Parameters:

entity - The entity to create.

Returns:

The entity.

Throws:

SecurityManagementException

delete

void delete(String... identifiers)
     throws SecurityManagementException

Deletes a given entity or entities (bulk delete) in the backend security environment.

Parameters:

identifiers - The entity identifiers to delete.

Throws:

SecurityManagementException

getSettings

S getSettings()

The entity manager settings.

Returns:

The settings for the entitty manager.