Package org.graylog2.contentpacks.facades

Class StreamReferenceFacade

java.lang.Object

org.graylog2.contentpacks.facades.StreamFacade

org.graylog2.contentpacks.facades.StreamReferenceFacade

All Implemented Interfaces:

EntityFacade<Stream>, EntityWithExcerptFacade<Stream,Stream>

public class StreamReferenceFacade
extends StreamFacade

Field Summary

Fields

Modifier and Type	Field	Description
static final ModelType	TYPE_V1

Constructor Summary

Constructors

Constructor	Description
StreamReferenceFacade(com.fasterxml.jackson.databind.ObjectMapper objectMapper, StreamService streamService, StreamRuleService streamRuleService, V20190722150700_LegacyAlertConditionMigration legacyAlertsMigration, IndexSetService indexSetService, UserService userService)

Method Summary

Modifier and Type	Method	Description
EntityExcerpt	createExcerpt(Stream stream)	Create an excerpt (id, type, title) of a native entity for display purposes.
NativeEntity<Stream>	createNativeEntity(Entity entity, Map<String,ValueReference> parameters, Map<EntityDescriptor,Object> nativeEntities, String username)	Create a native entity of type T from an entity model.
Optional<Entity>	exportEntity(EntityDescriptor entityDescriptor, EntityDescriptorIds entityDescriptorIds)	Create an exportable model of a native entity referenced by an EntityDescriptor including optional constraints.
Optional<NativeEntity<Stream>>	findExisting(Entity entity, Map<String,ValueReference> parameters)	Find an existing instance of the native entity described by the entity model.
static Optional<String>	getStreamEntityId(String id, EntityDescriptorIds entityDescriptorIds)
static String	getStreamEntityIdOrThrow(String id, EntityDescriptorIds entityDescriptorIds)
Set<EntityExcerpt>	listEntityExcerpts()	Create entity excerpts of all native entities of type T.
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.
static Entity	resolveStreamEntity(String id, Map<EntityDescriptor,Entity> entities)
static Object	resolveStreamEntityObject(String id, Map entities)

Methods inherited from class org.graylog2.contentpacks.facades.StreamFacade

delete, loadNativeEntity

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

usesScopedEntities

Field Details

TYPE_V1

public static final ModelType TYPE_V1

Constructor Details

StreamReferenceFacade

@Inject
public StreamReferenceFacade(com.fasterxml.jackson.databind.ObjectMapper objectMapper,
 StreamService streamService,
 StreamRuleService streamRuleService,
 V20190722150700_LegacyAlertConditionMigration legacyAlertsMigration,
 IndexSetService indexSetService,
 UserService userService)

Method Details

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<Stream,Stream>

Overrides:

resolveNativeEntity in class StreamFacade

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

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<Stream,Stream>

Overrides:

exportEntity in class StreamFacade

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.

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<Stream,Stream>

Overrides:

resolveForInstallation in class StreamFacade

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

findExisting

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

Overrides:

findExisting in class StreamFacade

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

createNativeEntity

public NativeEntity<Stream> 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<Stream,Stream>

Overrides:

createNativeEntity in class StreamFacade

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

createExcerpt

public EntityExcerpt createExcerpt(Stream stream)

Description copied from interface: EntityWithExcerptFacade

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

Specified by:

createExcerpt in interface EntityWithExcerptFacade<Stream,Stream>

Overrides:

createExcerpt in class StreamFacade

Parameters:

stream - 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<Stream,Stream>

Overrides:

listEntityExcerpts in class StreamFacade

Returns:

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

See Also:

• EntityExcerpt

resolveStreamEntity

public static Entity resolveStreamEntity(String id,
 Map<EntityDescriptor,Entity> entities)

resolveStreamEntityObject

public static Object resolveStreamEntityObject(String id,
 Map entities)

getStreamEntityId

public static Optional<String> getStreamEntityId(String id,
 EntityDescriptorIds entityDescriptorIds)

getStreamEntityIdOrThrow

public static String getStreamEntityIdOrThrow(String id,
 EntityDescriptorIds entityDescriptorIds)