org.graylog2.contentpacks.facades.EntityWithExcerptFacade Maven / Gradle / Ivy
/*
* Copyright (C) 2020 Graylog, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the Server Side Public License, version 1,
* as published by MongoDB, Inc.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* Server Side Public License for more details.
*
* You should have received a copy of the Server Side Public License
* along with this program. If not, see
* .
*/
package org.graylog2.contentpacks.facades;
import com.google.common.graph.Graph;
import com.google.common.graph.GraphBuilder;
import com.google.common.graph.ImmutableGraph;
import com.google.common.graph.MutableGraph;
import org.graylog2.contentpacks.EntityDescriptorIds;
import org.graylog2.contentpacks.model.entities.Entity;
import org.graylog2.contentpacks.model.entities.EntityDescriptor;
import org.graylog2.contentpacks.model.entities.EntityExcerpt;
import org.graylog2.contentpacks.model.entities.NativeEntity;
import org.graylog2.contentpacks.model.entities.NativeEntityDescriptor;
import org.graylog2.contentpacks.model.entities.references.ValueReference;
import org.graylog2.plugin.indexer.searches.timeranges.InvalidRangeParametersException;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
public interface EntityWithExcerptFacade {
/**
* Create an exportable model of a native entity referenced by an {@link EntityDescriptor}
* including optional constraints.
*
* @param entityDescriptor the descriptor of the native entity to export
* @param entityDescriptorIds the IDs for all entity descriptors
* @return an exportable (serializable) model of the entity including optional constraints,
* or {@link Optional#empty()} if the entity couldn't be found.
*/
Optional exportEntity(EntityDescriptor entityDescriptor, EntityDescriptorIds entityDescriptorIds);
/**
* Create a native entity of type {@code T} from an entity model.
*
* @param entity the entity model from which a native entity should be created
* @param parameters user-provided parameters to resolve parameters in the entity model
* @param nativeEntities existing native entities to reference during the creation of the native entity
* @param username the name of the user creating the entity
* @return the created native entity wrapped in {@link NativeEntity }
* @see Entity
* @see NativeEntity
*/
NativeEntity createNativeEntity(Entity entity,
Map parameters,
Map nativeEntities,
String username) throws InvalidRangeParametersException;
/**
* Find an existing instance of the native entity described by the entity model.
*
* @param entity the entity model from which a native entity should be created
* @param parameters user-provided parameters to resolve parameters in the entity model
* @return the existing native entity in the database wrapped in {@link NativeEntity},
* or {@link Optional#empty()} if the entity couldn't be found.
* @see Entity
* @see NativeEntity
*/
default Optional> findExisting(Entity entity, Map parameters) {
return Optional.empty();
}
/**
* Loads the native entity instance for the given native entity descriptor.
*
* @param nativeEntityDescriptor the native entity descriptor
* @return the existing native entity in the database wrapped in {@link NativeEntity},
* or {@link Optional#empty()} if the native entity doesn't exist.
*/
Optional> loadNativeEntity(NativeEntityDescriptor nativeEntityDescriptor);
/**
* Delete the given native entity.
*
* @param nativeEntity The native entity to delete
*/
void delete(EntityClass nativeEntity);
/**
* Create an excerpt (id, type, title) of a native entity for display purposes.
*
* @param nativeEntity The native entity to create an excerpt of
* @return The entity excerpt of the native entity
* @see EntityExcerpt
*/
EntityExcerpt createExcerpt(ExcerptClass nativeEntity);
/**
* Create entity excerpts of all native entities of type {@code T}.
*
* @return A collection of entity excerpts of all native entities of type {@code T}
* @see EntityExcerpt
*/
Set listEntityExcerpts();
/**
* Create the dependency graph of a native entity described by the given entity descriptor.
*
* @param entityDescriptor the descriptor of the native entity to resolve dependencies for
* @return A directed graph of the native entity with entity descriptors as nodes.
* @see Graph
*/
default Graph resolveNativeEntity(EntityDescriptor entityDescriptor) {
final MutableGraph mutableGraph = GraphBuilder.directed().build();
mutableGraph.addNode(entityDescriptor);
return ImmutableGraph.copyOf(mutableGraph);
}
/**
* Create the dependency graph of an entity described by the given entity model during content pack installation.
*
* @param entity the entity model to resolve dependencies for
* @return A directed graph of the native entity with entity models as nodes.
* @see Graph
*/
default Graph resolveForInstallation(Entity entity,
Map parameters,
Map entities) {
final MutableGraph mutableGraph = GraphBuilder.directed().build();
mutableGraph.addNode(entity);
return ImmutableGraph.copyOf(mutableGraph);
}
}