Class LookupTableFacade
java.lang.Object
org.graylog2.contentpacks.facades.LookupTableFacade
- All Implemented Interfaces:
EntityFacade<LookupTableDto>
,EntityWithExcerptFacade<LookupTableDto,
LookupTableDto>
-
Field Summary
-
Constructor Summary
ConstructorDescriptionLookupTableFacade
(com.fasterxml.jackson.databind.ObjectMapper objectMapper, DBLookupTableService lookupTableService) -
Method Summary
Modifier and TypeMethodDescriptioncreateExcerpt
(LookupTableDto lookupTableDto) Create an excerpt (id, type, title) of a native entity for display purposes.createNativeEntity
(Entity entity, Map<String, ValueReference> parameters, Map<EntityDescriptor, Object> nativeEntities, String username) Create a native entity of typeT
from an entity model.void
delete
(LookupTableDto nativeEntity) Delete the given native entity.exportEntity
(EntityDescriptor entityDescriptor, EntityDescriptorIds entityDescriptorIds) Create an exportable model of a native entity referenced by anEntityDescriptor
including optional constraints.findExisting
(Entity entity, Map<String, ValueReference> parameters) Find an existing instance of the native entity described by the entity model.Create entity excerpts of all native entities of typeT
.loadNativeEntity
(NativeEntityDescriptor nativeEntityDescriptor) Loads the native entity instance for the given native entity descriptor.com.google.common.graph.Graph<Entity>
resolveForInstallation
(Entity entity, Map<String, ValueReference> parameters, Map<EntityDescriptor, Entity> entities) Create the dependency graph of an entity described by the given entity model during content pack installation.com.google.common.graph.Graph<EntityDescriptor>
resolveNativeEntity
(EntityDescriptor entityDescriptor) Create the dependency graph of a native entity described by the given entity descriptor.boolean
The implementing facade should return true if the corresponding database entity supports scopes by extendingScopedEntity
.
-
Field Details
-
TYPE_V1
-
-
Constructor Details
-
LookupTableFacade
@Inject public LookupTableFacade(com.fasterxml.jackson.databind.ObjectMapper objectMapper, DBLookupTableService lookupTableService)
-
-
Method Details
-
createNativeEntity
public NativeEntity<LookupTableDto> createNativeEntity(Entity entity, Map<String, ValueReference> parameters, Map<EntityDescriptor, Object> nativeEntities, String username) Description copied from interface:EntityWithExcerptFacade
Create a native entity of typeT
from an entity model.- Specified by:
createNativeEntity
in interfaceEntityWithExcerptFacade<LookupTableDto,
LookupTableDto> - Parameters:
entity
- the entity model from which a native entity should be createdparameters
- user-provided parameters to resolve parameters in the entity modelnativeEntities
- existing native entities to reference during the creation of the native entityusername
- the name of the user creating the entity- Returns:
- the created native entity wrapped in
- See Also:
-
findExisting
public Optional<NativeEntity<LookupTableDto>> 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 interfaceEntityWithExcerptFacade<LookupTableDto,
LookupTableDto> - Parameters:
entity
- the entity model from which a native entity should be createdparameters
- user-provided parameters to resolve parameters in the entity model- Returns:
- the existing native entity in the database wrapped in
NativeEntity<T>
, orOptional.empty()
if the entity couldn't be found. - See Also:
-
loadNativeEntity
public Optional<NativeEntity<LookupTableDto>> loadNativeEntity(NativeEntityDescriptor nativeEntityDescriptor) Description copied from interface:EntityWithExcerptFacade
Loads the native entity instance for the given native entity descriptor.- Specified by:
loadNativeEntity
in interfaceEntityWithExcerptFacade<LookupTableDto,
LookupTableDto> - Parameters:
nativeEntityDescriptor
- the native entity descriptor- Returns:
- the existing native entity in the database wrapped in
NativeEntity<T>
, orOptional.empty()
if the native entity doesn't exist.
-
delete
Description copied from interface:EntityWithExcerptFacade
Delete the given native entity.- Specified by:
delete
in interfaceEntityWithExcerptFacade<LookupTableDto,
LookupTableDto> - Parameters:
nativeEntity
- The native entity to delete
-
createExcerpt
Description copied from interface:EntityWithExcerptFacade
Create an excerpt (id, type, title) of a native entity for display purposes.- Specified by:
createExcerpt
in interfaceEntityWithExcerptFacade<LookupTableDto,
LookupTableDto> - Parameters:
lookupTableDto
- The native entity to create an excerpt of- Returns:
- The entity excerpt of the native entity
- See Also:
-
listEntityExcerpts
Description copied from interface:EntityWithExcerptFacade
Create entity excerpts of all native entities of typeT
.- Specified by:
listEntityExcerpts
in interfaceEntityWithExcerptFacade<LookupTableDto,
LookupTableDto> - Returns:
- A collection of entity excerpts of all native entities of type
T
- See Also:
-
exportEntity
public Optional<Entity> exportEntity(EntityDescriptor entityDescriptor, EntityDescriptorIds entityDescriptorIds) Description copied from interface:EntityWithExcerptFacade
Create an exportable model of a native entity referenced by anEntityDescriptor
including optional constraints.- Specified by:
exportEntity
in interfaceEntityWithExcerptFacade<LookupTableDto,
LookupTableDto> - Parameters:
entityDescriptor
- the descriptor of the native entity to exportentityDescriptorIds
- 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.
-
resolveNativeEntity
public com.google.common.graph.Graph<EntityDescriptor> resolveNativeEntity(EntityDescriptor entityDescriptor) Description copied from interface:EntityWithExcerptFacade
Create the dependency graph of a native entity described by the given entity descriptor.- Specified by:
resolveNativeEntity
in interfaceEntityWithExcerptFacade<LookupTableDto,
LookupTableDto> - Parameters:
entityDescriptor
- the descriptor of the native entity to resolve dependencies for- Returns:
- A directed graph of the native entity with entity descriptors as nodes.
- See Also:
-
Graph
-
resolveForInstallation
public com.google.common.graph.Graph<Entity> resolveForInstallation(Entity entity, Map<String, ValueReference> parameters, Map<EntityDescriptor, Entity> entities) Description copied from interface:EntityWithExcerptFacade
Create the dependency graph of an entity described by the given entity model during content pack installation.- Specified by:
resolveForInstallation
in interfaceEntityWithExcerptFacade<LookupTableDto,
LookupTableDto> - Parameters:
entity
- the entity model to resolve dependencies for- Returns:
- A directed graph of the native entity with entity models as nodes.
- See Also:
-
Graph
-
usesScopedEntities
public boolean usesScopedEntities()Description copied from interface:EntityWithExcerptFacade
The implementing facade should return true if the corresponding database entity supports scopes by extendingScopedEntity
. This provides scope awareness within the implementing facade.- Specified by:
usesScopedEntities
in interfaceEntityWithExcerptFacade<LookupTableDto,
LookupTableDto>
-