com.lucidworks.apollo.pipeline

Interface BasePipelineComponent<T extends PipelineDefinition<T>,M>

Type Parameters:

T - fulfill the role of pipeline definition

M - fulfills the role of pipeline manager

All Known Implementing Classes:

DefaultBasePipelineComponent

public interface BasePipelineComponent<T extends PipelineDefinition<T>,M>

Contract for all components to fulfill basic pipeline requirements. Basic CRUD operations and other related tasks.

Method Summary

Modifier and Type	Method and Description
void	deletePipeline(java.lang.String pipelineId, int version)
ClientComponent	getClientComponent()
java.lang.Class<? extends com.lucidworks.apollo.client.resources.AbstractPipelineClientResource>	getClientInterface()
com.lucidworks.apollo.component.crud.UpdateBuilder<T>	getCreateBuilder()
com.lucidworks.apollo.component.crud.DeleteBuilder	getDeleteBuilder()
com.lucidworks.apollo.component.crud.ListBuilder<T>	getListBuilder()
<any>	getPipeline(java.lang.String pipelineId)
<any>	getPipelineDefinitionRegistry()
PipelineManager<M>	getPipelineManager()
com.lucidworks.apollo.component.crud.ReadBuilder<T>	getReadBuilder()
com.lucidworks.apollo.component.crud.UpdateBuilder<T>	getUpdateBuilder(java.lang.String idFromUrl)
java.util.Collection<T>	listPipelines() list the pipelines
boolean	managedModeEnabled()
void	refreshPipeline(java.lang.String pipelineId)
void	setClientInterfaceClazz(java.lang.Class<? extends com.lucidworks.apollo.client.resources.AbstractPipelineClientResource> clientInterfaceClazz)
void	stopAndFinalizePipelineJob(java.lang.String pipelineId)
void	validateStages(T pipeline)

Method Detail

setClientInterfaceClazz

void setClientInterfaceClazz(java.lang.Class<? extends com.lucidworks.apollo.client.resources.AbstractPipelineClientResource> clientInterfaceClazz)

listPipelines

java.util.Collection<T> listPipelines()
                               throws com.lucidworks.apollo.common.error.ComponentError

list the pipelines

Returns:

Throws:

com.lucidworks.apollo.common.error.ComponentError

getPipeline

<any> getPipeline(java.lang.String pipelineId)
           throws com.lucidworks.apollo.common.error.ComponentError

Throws:

com.lucidworks.apollo.common.error.ComponentError

getPipelineDefinitionRegistry

<any> getPipelineDefinitionRegistry()

getListBuilder

com.lucidworks.apollo.component.crud.ListBuilder<T> getListBuilder()

getReadBuilder

com.lucidworks.apollo.component.crud.ReadBuilder<T> getReadBuilder()

getCreateBuilder

com.lucidworks.apollo.component.crud.UpdateBuilder<T> getCreateBuilder()

getUpdateBuilder

com.lucidworks.apollo.component.crud.UpdateBuilder<T> getUpdateBuilder(java.lang.String idFromUrl)

getDeleteBuilder

com.lucidworks.apollo.component.crud.DeleteBuilder getDeleteBuilder()

deletePipeline

void deletePipeline(java.lang.String pipelineId,
                    int version)
             throws com.lucidworks.apollo.common.error.ComponentError

Throws:

com.lucidworks.apollo.common.error.ComponentError

validateStages

void validateStages(T pipeline)
             throws com.lucidworks.apollo.common.error.ComponentError

Throws:

com.lucidworks.apollo.common.error.ComponentError

getClientComponent

ClientComponent getClientComponent()

refreshPipeline

void refreshPipeline(java.lang.String pipelineId)
              throws com.lucidworks.apollo.common.error.ComponentError

Throws:

com.lucidworks.apollo.common.error.ComponentError

stopAndFinalizePipelineJob

void stopAndFinalizePipelineJob(java.lang.String pipelineId)

getClientInterface

java.lang.Class<? extends com.lucidworks.apollo.client.resources.AbstractPipelineClientResource> getClientInterface()

getPipelineManager

PipelineManager<M> getPipelineManager()

managedModeEnabled

boolean managedModeEnabled()