Package org.graylog2.database.entities

Class ScopedDbService<E extends ScopedEntity>

java.lang.Object

org.graylog2.database.PaginatedDbService<E>

org.graylog2.database.entities.ScopedDbService<E>

Type Parameters:

E - type parameter for a ScopedEntity's subclass.

Direct Known Subclasses:

DBCacheService, DBDataAdapterService, DBEventDefinitionService, DBLookupTableService

public abstract class ScopedDbService<E extends ScopedEntity>
extends PaginatedDbService<E>

A base database service to handle persistence and deletion of ScopedEntity instance. Persistence and deletion is performed by the parent class, PaginatedDbService, this service simply performs mutability checks.

A EntityScopeService is used to perform the actual mutability checks based on the entity's scope.

Field Summary

Fields

Modifier and Type	Field	Description
protected final EntityScopeService	entityScopeService

Fields inherited from class org.graylog2.database.PaginatedDbService

db

Constructor Summary

Constructors

Constructor	Description
ScopedDbService(MongoConnection mongoConnection, MongoJackObjectMapperProvider mapper, Class<E> dtoClass, String collectionName, EntityScopeService entityScopeService)

Method Summary

Modifier and Type	Method	Description
final int	delete(String id)	Deletes the PaginatedDbService for the given ID from the database.
final void	ensureDeletability(E entity)
final void	ensureMutability(E entity)
final void	ensureValidScope(E entity)
final int	forceDelete(String id)	Deletes an entity without checking for deletability.
final E	forceSave(E entity)	Saves an entity without checking for mutability.
final boolean	isDeletable(ScopedEntity scopedEntity)
final boolean	isMutable(ScopedEntity scopedEntity)
E	save(E entity)	Stores the given PaginatedDbService in the database.

Methods inherited from class org.graylog2.database.PaginatedDbService

asImmutableList, findPaginatedWithQueryAndSort, findPaginatedWithQueryFilterAndSort, findPaginatedWithQueryFilterAndSortWithGrandTotal, get, getMultiFieldSortBuilder, getPage, getSortBuilder, streamAll, streamByIds, streamQuery, streamQueryWithSort

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

entityScopeService

protected final EntityScopeService entityScopeService

Constructor Details

ScopedDbService

public ScopedDbService(MongoConnection mongoConnection,
 MongoJackObjectMapperProvider mapper,
 Class<E> dtoClass,
 String collectionName,
 EntityScopeService entityScopeService)

Method Details

isMutable

public final boolean isMutable(ScopedEntity scopedEntity)

isDeletable

public final boolean isDeletable(ScopedEntity scopedEntity)

save

public E save(E entity)

Description copied from class: PaginatedDbService

Stores the given PaginatedDbService in the database.

Overrides:

save in class PaginatedDbService<E extends ScopedEntity>

Parameters:

entity - the PaginatedDbService to save

Returns:

the newly saved PaginatedDbService

ensureValidScope

public final void ensureValidScope(E entity)

ensureMutability

public final void ensureMutability(E entity)

ensureDeletability

public final void ensureDeletability(E entity)

delete

public final int delete(String id)

Description copied from class: PaginatedDbService

Deletes the PaginatedDbService for the given ID from the database.

Overrides:

delete in class PaginatedDbService<E extends ScopedEntity>

Parameters:

id - ID of the PaginatedDbService to delete

Returns:

the number of deleted documents

forceDelete

public final int forceDelete(String id)

Deletes an entity without checking for deletability. Do not call this method for API requests for the user interface.

forceSave

public final E forceSave(E entity)

Saves an entity without checking for mutability. Do not call this method for API requests for the user interface.