com.lucidworks.apollo.component

Class CollectionManager

java.lang.Object

com.lucidworks.apollo.component.CollectionManager

public class CollectionManager
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CollectionManager.IdPathCheckUpdateStrategy
static class	CollectionManager.IdValidatingUpdateStrategy
static class	CollectionManager.PipelineCreatingUpdateStrategy

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CATCH_ALL_FIELD
static java.lang.String	RAW_CONTENT_FIELD_NAME

Constructor Summary

Constructors

Constructor and Description
CollectionManager(CollectionStore collectionStore, SearchClusterComponent searchClusterComponent, FeatureStore featureStore, com.lucidworks.apollo.call.CallFactory callFactory, ConfigurationComponent config, ClientComponent clientComponent, InterProcessLockFactory lockFactory, com.lucidworks.apollo.links.LinkManager linkManager)

Method Summary

Modifier and Type	Method and Description
InterProcessLockFactory.ClosableLock	acquireLockOnCollection(java.lang.String collectionId)
boolean	collectionExists(java.lang.String collectionId)
void	configureCollectionLayout(com.lucidworks.apollo.common.models.Collection collection, java.lang.String clusterName, org.apache.commons.configuration.Configuration... configs) Configures the numShards, replicationFactor, and maxShardsPerNodes parameters for creating a collection based on configuration settings and the cluster size.
<any>	createCollection(com.lucidworks.apollo.common.models.Collection collection) Deprecated.
<any>	createCollection(com.lucidworks.apollo.common.models.Collection collection, boolean createDefaultPipelines) Deprecated.
<any>	createSystemCollection(com.lucidworks.apollo.common.models.Collection collection, com.lucidworks.apollo.common.models.Collection.CollectionType collectionType, java.lang.String searchClusterConfigPrefix, java.lang.String configPrefix, java.util.List<java.lang.String> features, boolean createPipelines, Configuration userConfiguration) Handles a lot of the boilerplate for creating system collections: looking up search cluster and collection layout based on properties, optionally enabling features, and so on.
void	deleteCollection(java.lang.String collectionId, boolean deleteFromSolr, boolean purge, boolean deletePipelines, int version)
<any>	getCollection(java.lang.String collectionId)
java.util.List<com.lucidworks.apollo.common.models.Collection>	getCollections()
com.lucidworks.apollo.component.crud.UpdateBuilder<com.lucidworks.apollo.common.models.Collection>	getCreateBuilder()
com.lucidworks.apollo.component.crud.DeleteBuilder	getDeleteBuilder(boolean deleteFromSolr, boolean purge, boolean deletePipelines)
com.lucidworks.apollo.component.crud.ListBuilder<com.lucidworks.apollo.common.models.Collection>	getListBuilder()
com.lucidworks.apollo.component.crud.ReadBuilder<com.lucidworks.apollo.common.models.Collection>	getReadBuilder()
com.lucidworks.apollo.component.crud.UpdateBuilder<com.lucidworks.apollo.common.models.Collection>	getUpdateBuilder(java.lang.String collectionId)
com.lucidworks.apollo.component.crud.UpdateBuilder<com.lucidworks.apollo.common.models.Collection>	getUpdateBuilder(java.lang.String collectionId, UriInfo uriInfo)
<any>	overwriteCollection(java.lang.String collectionId, int version, com.lucidworks.apollo.common.models.Collection collection)
void	runCallbackForFeature(com.lucidworks.apollo.common.models.CallParams callParams, com.lucidworks.apollo.common.models.Feature feature)

Methods inherited from class java.lang.Object

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

Field Detail

RAW_CONTENT_FIELD_NAME

public static final java.lang.String RAW_CONTENT_FIELD_NAME

See Also:

Constant Field Values

CATCH_ALL_FIELD

public static final java.lang.String CATCH_ALL_FIELD

See Also:

Constant Field Values

Constructor Detail

CollectionManager

public CollectionManager(CollectionStore collectionStore,
                         SearchClusterComponent searchClusterComponent,
                         FeatureStore featureStore,
                         com.lucidworks.apollo.call.CallFactory callFactory,
                         ConfigurationComponent config,
                         ClientComponent clientComponent,
                         InterProcessLockFactory lockFactory,
                         com.lucidworks.apollo.links.LinkManager linkManager)

Method Detail

getCollections

public java.util.List<com.lucidworks.apollo.common.models.Collection> getCollections()

getCollection

public <any> getCollection(java.lang.String collectionId)

createCollection

@Deprecated
public <any> createCollection(com.lucidworks.apollo.common.models.Collection collection)
                                   throws com.lucidworks.apollo.common.error.RESTError

Deprecated.

Create a Collection without its related default objects.

Parameters:

collection -

Returns:

Throws:

com.lucidworks.apollo.common.error.RESTError

See Also:

createCollection(Collection, boolean)

createCollection

@Deprecated
public <any> createCollection(com.lucidworks.apollo.common.models.Collection collection,
                                          boolean createDefaultPipelines)
                                   throws com.lucidworks.apollo.common.error.RESTError

Deprecated.

Create a Collection and optionally its related default objects. Keeping this around for the many direct callers we have. Ideally, all calls to this class would come from CollectionResource, but that is not the case. Normally the creation of a Collection's related objects happens in the Orchestrator, but for certain startup cases we still rely on direct calls to CollectionManager. This and createCollection(Collection) are not called by CollectionResource.

Parameters:

collection -

createDefaultPipelines -

Returns:

Throws:

com.lucidworks.apollo.common.error.RESTError

overwriteCollection

public <any> overwriteCollection(java.lang.String collectionId,
                                 int version,
                                 com.lucidworks.apollo.common.models.Collection collection)
                          throws com.lucidworks.apollo.common.error.RESTError

Throws:

com.lucidworks.apollo.common.error.RESTError

getListBuilder

public com.lucidworks.apollo.component.crud.ListBuilder<com.lucidworks.apollo.common.models.Collection> getListBuilder()

getReadBuilder

public com.lucidworks.apollo.component.crud.ReadBuilder<com.lucidworks.apollo.common.models.Collection> getReadBuilder()

getCreateBuilder

public com.lucidworks.apollo.component.crud.UpdateBuilder<com.lucidworks.apollo.common.models.Collection> getCreateBuilder()

getUpdateBuilder

public com.lucidworks.apollo.component.crud.UpdateBuilder<com.lucidworks.apollo.common.models.Collection> getUpdateBuilder(java.lang.String collectionId,
                                                                                                                           UriInfo uriInfo)

getUpdateBuilder

public com.lucidworks.apollo.component.crud.UpdateBuilder<com.lucidworks.apollo.common.models.Collection> getUpdateBuilder(java.lang.String collectionId)

getDeleteBuilder

public com.lucidworks.apollo.component.crud.DeleteBuilder getDeleteBuilder(boolean deleteFromSolr,
                                                                           boolean purge,
                                                                           boolean deletePipelines)

collectionExists

public boolean collectionExists(java.lang.String collectionId)

createSystemCollection

public <any> createSystemCollection(com.lucidworks.apollo.common.models.Collection collection,
                                    com.lucidworks.apollo.common.models.Collection.CollectionType collectionType,
                                    java.lang.String searchClusterConfigPrefix,
                                    java.lang.String configPrefix,
                                    java.util.List<java.lang.String> features,
                                    boolean createPipelines,
                                    Configuration userConfiguration)
                             throws com.lucidworks.apollo.common.error.RESTError

Handles a lot of the boilerplate for creating system collections: looking up search cluster and collection layout based on properties, optionally enabling features, and so on.

Parameters:

collection - note that this argument may be modified, based on configuration.

collectionType - the collectionType to set on the above collection. Called out specifically to make sure people set it.

searchClusterConfigPrefix -

configPrefix -

features -

createPipelines -

userConfiguration -

Returns:

Throws:

com.lucidworks.apollo.common.error.RESTError

deleteCollection

public void deleteCollection(java.lang.String collectionId,
                             boolean deleteFromSolr,
                             boolean purge,
                             boolean deletePipelines,
                             int version)
                      throws com.lucidworks.apollo.common.error.RESTError

Throws:

com.lucidworks.apollo.common.error.RESTError

runCallbackForFeature

public void runCallbackForFeature(com.lucidworks.apollo.common.models.CallParams callParams,
                                  com.lucidworks.apollo.common.models.Feature feature)
                           throws com.lucidworks.apollo.common.error.RESTError

Throws:

com.lucidworks.apollo.common.error.RESTError

configureCollectionLayout

public void configureCollectionLayout(com.lucidworks.apollo.common.models.Collection collection,
                                      java.lang.String clusterName,
                                      org.apache.commons.configuration.Configuration... configs)
                               throws com.lucidworks.apollo.common.error.RESTError

Configures the numShards, replicationFactor, and maxShardsPerNodes parameters for creating a collection based on configuration settings and the cluster size. This method generates a RESTError if there are no live nodes in the Solr cluster.

Parameters:

collection -

clusterName -

configs -

Throws:

com.lucidworks.apollo.common.error.RESTError

acquireLockOnCollection

public InterProcessLockFactory.ClosableLock acquireLockOnCollection(java.lang.String collectionId)
                                                             throws java.lang.Exception

Throws:

java.lang.Exception