org.graylog2.contentpacks.facades

Class OutputFacade

java.lang.Object

org.graylog2.contentpacks.facades.OutputFacade

All Implemented Interfaces:

EntityFacade<Output>

public class OutputFacade
extends Object
implements EntityFacade<Output>

Field Summary

Fields

Modifier and Type	Field and Description
static ModelType	TYPE_V1

Constructor Summary

Constructors

Constructor and Description
OutputFacade(com.fasterxml.jackson.databind.ObjectMapper objectMapper, OutputService outputService, Set<PluginMetaData> pluginMetaData, Map<String,MessageOutput.Factory<? extends MessageOutput>> outputFactories, Map<String,MessageOutput.Factory2<? extends MessageOutput>> outputFactories2)

Method Summary

Modifier and Type	Method and Description
EntityExcerpt	createExcerpt(Output output) Create an excerpt (id, type, title) of a native entity for display purposes.
NativeEntity<Output>	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(Output 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.
Set<EntityExcerpt>	listEntityExcerpts() Create entity excerpts of all native entities of type T.
Optional<NativeEntity<Output>>	loadNativeEntity(NativeEntityDescriptor nativeEntityDescriptor) Loads the native entity instance for the given native entity descriptor.

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.EntityFacade

findExisting, resolveForInstallation, resolveNativeEntity

Field Detail

TYPE_V1

public static final ModelType TYPE_V1

Constructor Detail

OutputFacade

@Inject
public OutputFacade(com.fasterxml.jackson.databind.ObjectMapper objectMapper,
                            OutputService outputService,
                            Set<PluginMetaData> pluginMetaData,
                            Map<String,MessageOutput.Factory<? extends MessageOutput>> outputFactories,
                            Map<String,MessageOutput.Factory2<? extends MessageOutput>> outputFactories2)

Method Detail

createNativeEntity

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

Description copied from interface: EntityFacade

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

Specified by:

createNativeEntity in interface EntityFacade<Output>

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 NativeEntity

See Also:

Entity, NativeEntity

loadNativeEntity

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

Description copied from interface: EntityFacade

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

Specified by:

loadNativeEntity in interface EntityFacade<Output>

Parameters:

nativeEntityDescriptor - the native entity descriptor

Returns:

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

delete

public void delete(Output nativeEntity)

Description copied from interface: EntityFacade

Delete the given native entity.

Specified by:

delete in interface EntityFacade<Output>

Parameters:

nativeEntity - The native entity to delete

createExcerpt

public EntityExcerpt createExcerpt(Output output)

Description copied from interface: EntityFacade

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

Specified by:

createExcerpt in interface EntityFacade<Output>

Parameters:

output - 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: EntityFacade

Create entity excerpts of all native entities of type T.

Specified by:

listEntityExcerpts in interface EntityFacade<Output>

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: EntityFacade

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

Specified by:

exportEntity in interface EntityFacade<Output>

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.