com.lucidworks.apollo.component

Class CrudComponent<E extends com.lucidworks.apollo.common.objects.Entity>

java.lang.Object

com.lucidworks.apollo.component.CrudComponent<E>

public class CrudComponent<E extends com.lucidworks.apollo.common.objects.Entity>
extends java.lang.Object

Encapsulate our REST CRUD semantics in a composeable way. API Resources that wish to provide our standard CRUD behavior should use this class. All of the methods are called with functions that perform the "raw" CRUD operations on the underlying ItemStore-s (or other management classes). This class allows us to standardize the behavior before and after these methods are called. This classes uses Suppliers for everything so it can be constructed in our API resource constructors before some of the objects are available. For example, UriInfo is not available at construction time, but is during request time when these methods are called.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CrudComponent.CrudBiFunction<T,U,R>
static interface	CrudComponent.CrudConsumer<T>
static interface	CrudComponent.CrudFunction<T,R>
static interface	CrudComponent.CrudSupplier<R>

Method Summary

Modifier and Type	Method and Description
java.util.List<E>	getAllEntities(CrudComponent.CrudSupplier<java.util.List<E>> getAllEntitiesFunction, java.util.function.Function<E,com.lucidworks.apollo.names.FusionResource> resourceFunction) Return a list of entities of type "E" which has been properly filtered Filters applied: Remove entities which the current user is not authorized to view If "context" query param is provided, only return entities which are part of that context
com.lucidworks.apollo.pipeline.schema.ObjectType	getEntitySchema(java.util.function.Supplier<com.lucidworks.apollo.pipeline.schema.ObjectType> getEntitySchemaFunction)
static <E extends com.lucidworks.apollo.common.objects.Entity> CrudComponent<E>	newCrudComponent(java.lang.Class<E> entityClazz, ObjectMapper objectMapper, com.lucidworks.apollo.links.LinkManager linkManager, java.util.function.Supplier<HttpServletResponse> httpServletResponseSupplier, java.util.function.Supplier<UriInfo> uriInfoSupplier, java.util.function.Supplier<com.lucidworks.apollo.security.AuthorizationContext> authorizationContextSupplier, java.util.function.Function<java.lang.String,com.lucidworks.apollo.common.error.RESTError> notFoundError)
static <E extends com.lucidworks.apollo.common.objects.Entity> CrudComponent<E>	newCrudComponent(java.lang.Class<E> entityClazz, java.util.function.Supplier<ObjectMapper> objectMapperSupplier, java.util.function.Supplier<com.lucidworks.apollo.links.LinkManager> linkManagerSupplier, java.util.function.Supplier<HttpServletResponse> httpServletResponseSupplier, java.util.function.Supplier<UriInfo> uriInfoSupplier, java.util.function.Supplier<com.lucidworks.apollo.security.AuthorizationContext> authorizationContextSupplier)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

newCrudComponent

public static <E extends com.lucidworks.apollo.common.objects.Entity> CrudComponent<E> newCrudComponent(java.lang.Class<E> entityClazz,
                                                                                                        java.util.function.Supplier<ObjectMapper> objectMapperSupplier,
                                                                                                        java.util.function.Supplier<com.lucidworks.apollo.links.LinkManager> linkManagerSupplier,
                                                                                                        java.util.function.Supplier<HttpServletResponse> httpServletResponseSupplier,
                                                                                                        java.util.function.Supplier<UriInfo> uriInfoSupplier,
                                                                                                        java.util.function.Supplier<com.lucidworks.apollo.security.AuthorizationContext> authorizationContextSupplier)

newCrudComponent

public static <E extends com.lucidworks.apollo.common.objects.Entity> CrudComponent<E> newCrudComponent(java.lang.Class<E> entityClazz,
                                                                                                        ObjectMapper objectMapper,
                                                                                                        com.lucidworks.apollo.links.LinkManager linkManager,
                                                                                                        java.util.function.Supplier<HttpServletResponse> httpServletResponseSupplier,
                                                                                                        java.util.function.Supplier<UriInfo> uriInfoSupplier,
                                                                                                        java.util.function.Supplier<com.lucidworks.apollo.security.AuthorizationContext> authorizationContextSupplier,
                                                                                                        java.util.function.Function<java.lang.String,com.lucidworks.apollo.common.error.RESTError> notFoundError)

getEntitySchema

public final com.lucidworks.apollo.pipeline.schema.ObjectType getEntitySchema(java.util.function.Supplier<com.lucidworks.apollo.pipeline.schema.ObjectType> getEntitySchemaFunction)

getAllEntities

public final java.util.List<E> getAllEntities(CrudComponent.CrudSupplier<java.util.List<E>> getAllEntitiesFunction,
                                              java.util.function.Function<E,com.lucidworks.apollo.names.FusionResource> resourceFunction)
                                       throws com.lucidworks.apollo.common.error.RESTError

Return a list of entities of type "E" which has been properly filtered Filters applied:

Remove entities which the current user is not authorized to view If "context" query param is provided, only return entities which are part of that context

Parameters:

getAllEntitiesFunction - A supplier which returns all entities of a type "E"

resourceFunction - A function which derives a FusionResource from an entity of type "E"

Throws:

com.lucidworks.apollo.common.error.RESTError