Package org.graylog2.contentpacks.facades

Class ViewFacade

java.lang.Object

org.graylog2.contentpacks.facades.ViewFacade

All Implemented Interfaces:

EntityWithExcerptFacade<ViewDTO,ViewSummaryDTO>

Direct Known Subclasses:

DashboardFacade, DashboardV1Facade, SearchFacade

public abstract class ViewFacade
extends Object
implements EntityWithExcerptFacade<ViewDTO,ViewSummaryDTO>

Field Summary

Fields

Modifier and Type	Field	Description
protected final UserService	userService

Constructor Summary

Constructors

Constructor	Description
ViewFacade(com.fasterxml.jackson.databind.ObjectMapper objectMapper, SearchDbService searchDbService, ViewService viewService, ViewSummaryService viewSummaryService, UserService userService)

Method Summary

Modifier and Type	Method	Description
EntityExcerpt	createExcerpt(ViewSummaryDTO nativeEntity)	Create an excerpt (id, type, title) of a native entity for display purposes.
NativeEntity<ViewDTO>	createNativeEntity(Entity entity, Map<String,ValueReference> parameters, Map<EntityDescriptor,Object> nativeEntities, String username)	Create a native entity of type T from an entity model.
protected NativeEntity<ViewDTO>	decode(EntityV1 entityV1, Map<String,ValueReference> parameters, Map<EntityDescriptor,Object> nativeEntities, User user)
void	delete(ViewDTO nativeEntity)	Delete the given native entity.
protected void	ensureV1(Entity entity)
Optional<Entity>	exportEntity(EntityDescriptor entityDescriptor, EntityDescriptorIds entityDescriptorIds)	Create an exportable model of a native entity referenced by an EntityDescriptor including optional constraints.
abstract ViewDTO.Type	getDTOType()
abstract ModelType	getModelType()
protected Stream<ViewSummaryDTO>	getNativeViews()
Set<EntityExcerpt>	listEntityExcerpts()	Create entity excerpts of all native entities of type T.
Optional<NativeEntity<ViewDTO>>	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.
protected com.google.common.graph.Graph<Entity>	resolveViewEntity(EntityV1 entity, ViewEntity viewEntity, Map<EntityDescriptor,Entity> entities)

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

findExisting, usesScopedEntities

Field Details

userService

protected final UserService userService

Constructor Details

ViewFacade

@Inject
public ViewFacade(com.fasterxml.jackson.databind.ObjectMapper objectMapper,
 SearchDbService searchDbService,
 ViewService viewService,
 ViewSummaryService viewSummaryService,
 UserService userService)

Method Details

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<ViewDTO,ViewSummaryDTO>

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.

getModelType

public abstract ModelType getModelType()

ensureV1

protected void ensureV1(Entity entity)

createNativeEntity

public NativeEntity<ViewDTO> 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<ViewDTO,ViewSummaryDTO>

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

decode

protected NativeEntity<ViewDTO> decode(EntityV1 entityV1,
 Map<String,ValueReference> parameters,
 Map<EntityDescriptor,Object> nativeEntities,
 User user)

loadNativeEntity

public Optional<NativeEntity<ViewDTO>> 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<ViewDTO,ViewSummaryDTO>

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(ViewDTO nativeEntity)

Description copied from interface: EntityWithExcerptFacade

Delete the given native entity.

Specified by:

delete in interface EntityWithExcerptFacade<ViewDTO,ViewSummaryDTO>

Parameters:

nativeEntity - The native entity to delete

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<ViewDTO,ViewSummaryDTO>

Returns:

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

See Also:

• EntityExcerpt

getNativeViews

protected Stream<ViewSummaryDTO> getNativeViews()

createExcerpt

public EntityExcerpt createExcerpt(ViewSummaryDTO nativeEntity)

Description copied from interface: EntityWithExcerptFacade

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

Specified by:

createExcerpt in interface EntityWithExcerptFacade<ViewDTO,ViewSummaryDTO>

Parameters:

nativeEntity - The native entity to create an excerpt of

Returns:

The entity excerpt of the native entity

See Also:

• EntityExcerpt

getDTOType

public abstract ViewDTO.Type getDTOType()

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 interface EntityWithExcerptFacade<ViewDTO,ViewSummaryDTO>

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 interface EntityWithExcerptFacade<ViewDTO,ViewSummaryDTO>

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

resolveViewEntity

protected com.google.common.graph.Graph<Entity> resolveViewEntity(EntityV1 entity,
 ViewEntity viewEntity,
 Map<EntityDescriptor,Entity> entities)