Package org.graylog2.contentpacks.facades

Class LookupCacheFacade

java.lang.Object

org.graylog2.contentpacks.facades.LookupCacheFacade

All Implemented Interfaces:

EntityFacade<CacheDto>, EntityWithExcerptFacade<CacheDto,CacheDto>

public class LookupCacheFacade
extends Object
implements EntityFacade<CacheDto>

Field Summary

Fields

Modifier and Type	Field	Description
static final ModelType	TYPE_V1

Constructor Summary

Constructors

Constructor	Description
LookupCacheFacade(com.fasterxml.jackson.databind.ObjectMapper objectMapper, DBCacheService cacheService, Set<PluginMetaData> pluginMetaData)

Method Summary

Modifier and Type	Method	Description
EntityExcerpt	createExcerpt(CacheDto cacheDto)	Create an excerpt (id, type, title) of a native entity for display purposes.
NativeEntity<CacheDto>	createNativeEntity(Entity entity, Map<String,ValueReference> parameters, Map<EntityDescriptor,Object> nativeEntities, String username)	Create a native entity of type T from an entity model.
void	delete(CacheDto nativeEntity)	Delete the given native entity.
Optional<Entity>	exportEntity(EntityDescriptor entityDescriptor, EntityDescriptorIds entityDescriptorIds)	Create an exportable model of a native entity referenced by an EntityDescriptor including optional constraints.
Optional<NativeEntity<CacheDto>>	findExisting(Entity entity, Map<String,ValueReference> parameters)	Find an existing instance of the native entity described by the entity model.
Set<EntityExcerpt>	listEntityExcerpts()	Create entity excerpts of all native entities of type T.
Optional<NativeEntity<CacheDto>>	loadNativeEntity(NativeEntityDescriptor nativeEntityDescriptor)	Loads the native entity instance for the given native entity descriptor.
boolean	usesScopedEntities()	The implementing facade should return true if the corresponding database entity supports scopes by extending ScopedEntity.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.graylog2.contentpacks.facades.EntityWithExcerptFacade

resolveForInstallation, resolveNativeEntity

Field Details

TYPE_V1

public static final ModelType TYPE_V1

Constructor Details

LookupCacheFacade

@Inject
public LookupCacheFacade(com.fasterxml.jackson.databind.ObjectMapper objectMapper,
 DBCacheService cacheService,
 Set<PluginMetaData> pluginMetaData)

Method Details

createNativeEntity

public NativeEntity<CacheDto> createNativeEntity(Entity entity,
 Map<String,ValueReference> parameters,
 Map<EntityDescriptor,Object> nativeEntities,
 String username)

Description copied from interface: EntityWithExcerptFacade

Create a native entity of type T from an entity model.

Specified by:

createNativeEntity in interface EntityWithExcerptFacade<CacheDto,CacheDto>

Parameters:

entity - the entity model from which a native entity should be created

parameters - user-provided parameters to resolve parameters in the entity model

nativeEntities - existing native entities to reference during the creation of the native entity

username - the name of the user creating the entity

Returns:

the created native entity wrapped in

See Also:

• Entity
• NativeEntity

findExisting

public Optional<NativeEntity<CacheDto>> findExisting(Entity entity,
 Map<String,ValueReference> parameters)

Description copied from interface: EntityWithExcerptFacade

Find an existing instance of the native entity described by the entity model.

Specified by:

findExisting in interface EntityWithExcerptFacade<CacheDto,CacheDto>

Parameters:

entity - the entity model from which a native entity should be created

parameters - user-provided parameters to resolve parameters in the entity model

Returns:

the existing native entity in the database wrapped in NativeEntity<T>, or Optional.empty() if the entity couldn't be found.

See Also:

• Entity
• NativeEntity

loadNativeEntity

public Optional<NativeEntity<CacheDto>> loadNativeEntity(NativeEntityDescriptor nativeEntityDescriptor)

Description copied from interface: EntityWithExcerptFacade

Loads the native entity instance for the given native entity descriptor.

Specified by:

loadNativeEntity in interface EntityWithExcerptFacade<CacheDto,CacheDto>

Parameters:

nativeEntityDescriptor - the native entity descriptor

Returns:

the existing native entity in the database wrapped in NativeEntity<T>, or Optional.empty() if the native entity doesn't exist.

delete

public void delete(CacheDto nativeEntity)

Description copied from interface: EntityWithExcerptFacade

Delete the given native entity.

Specified by:

delete in interface EntityWithExcerptFacade<CacheDto,CacheDto>

Parameters:

nativeEntity - The native entity to delete

createExcerpt

public EntityExcerpt createExcerpt(CacheDto cacheDto)

Description copied from interface: EntityWithExcerptFacade

Create an excerpt (id, type, title) of a native entity for display purposes.

Specified by:

createExcerpt in interface EntityWithExcerptFacade<CacheDto,CacheDto>

Parameters:

cacheDto - The native entity to create an excerpt of

Returns:

The entity excerpt of the native entity

See Also:

• EntityExcerpt

listEntityExcerpts

public Set<EntityExcerpt> listEntityExcerpts()

Description copied from interface: EntityWithExcerptFacade

Create entity excerpts of all native entities of type T.

Specified by:

listEntityExcerpts in interface EntityWithExcerptFacade<CacheDto,CacheDto>

Returns:

A collection of entity excerpts of all native entities of type T

See Also:

• EntityExcerpt

exportEntity

public Optional<Entity> exportEntity(EntityDescriptor entityDescriptor,
 EntityDescriptorIds entityDescriptorIds)

Description copied from interface: EntityWithExcerptFacade

Create an exportable model of a native entity referenced by an EntityDescriptor including optional constraints.

Specified by:

exportEntity in interface EntityWithExcerptFacade<CacheDto,CacheDto>

Parameters:

entityDescriptor - the descriptor of the native entity to export

entityDescriptorIds - the IDs for all entity descriptors

Returns:

an exportable (serializable) model of the entity including optional constraints, or Optional.empty() if the entity couldn't be found.

usesScopedEntities

public boolean usesScopedEntities()

Description copied from interface: EntityWithExcerptFacade

The implementing facade should return true if the corresponding database entity supports scopes by extending ScopedEntity. This provides scope awareness within the implementing facade.

Specified by:

usesScopedEntities in interface EntityWithExcerptFacade<CacheDto,CacheDto>