Index (laaws-repository-tools 2.9.0 API)

A C D E F G H I K L M O R S T U V W

A

addSuffix(Path, String) - Static method in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin.LocalSolrCoreAdmin: Adds a suffix extension to a directory or file.
AdminInfoRequest<T extends AdminInfoResponse> - Class in org.lockss.laaws.rs.index.solr
AdminInfoRequest(SolrRequest.METHOD, AdminInfoRequest.AdminInfoSection) - Constructor for class org.lockss.laaws.rs.index.solr.AdminInfoRequest
AdminInfoRequest.AdminInfoSection - Enum in org.lockss.laaws.rs.index.solr
AdminInfoRequest.System - Class in org.lockss.laaws.rs.index.solr
AdminInfoResponse - Class in org.lockss.laaws.rs.index.solr
AdminInfoResponse() - Constructor for class org.lockss.laaws.rs.index.solr.AdminInfoResponse
AdminInfoResponse.System - Class in org.lockss.laaws.rs.index.solr
applySchemaUpdates() - Method in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin.LocalSolrCoreAdmin: Deprecated.
applySchemaUpdates(String) - Method in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin.SolrCloudCollectionAdmin
ArtifactIndexSchemaUpdater(SolrClient, List<String>) - Constructor for class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin.ArtifactIndexSchemaUpdater: Deprecated.

C

collectionExists(String) - Method in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin.SolrCloudCollectionAdmin: Returns a boolean indicating whether a collection exists in a Solr Cloud cluster.
configDirPath - Variable in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin.LocalSolrCoreAdmin: The path to the core's configuration set.
CONFIGOVERLAY_FILE - Static variable in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin.LocalSolrCoreAdmin
CONFIGOVERLAY_USERPROPS_KEY - Static variable in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin.LocalSolrCoreAdmin
CoreConfigRequest<T extends CoreConfigResponse> - Class in org.lockss.laaws.rs.index.solr
CoreConfigRequest(SolrRequest.METHOD, CoreConfigRequest.CoreConfigSection) - Constructor for class org.lockss.laaws.rs.index.solr.CoreConfigRequest
CoreConfigRequest.CoreConfigSection - Enum in org.lockss.laaws.rs.index.solr
CoreConfigRequest.Overlay - Class in org.lockss.laaws.rs.index.solr
CoreConfigResponse - Class in org.lockss.laaws.rs.index.solr
CoreConfigResponse() - Constructor for class org.lockss.laaws.rs.index.solr.CoreConfigResponse
CoreConfigResponse.Overlay - Class in org.lockss.laaws.rs.index.solr
coreExists(SolrClient, String) - Static method in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin: Determines whether a core exists in a Solr instance running in stand-alone mode by attempting to retrieve its status.
coreUsesCommonConfigSet() - Method in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin.LocalSolrCoreAdmin: Returns a boolean indicating whether this Solr core uses a common configuration set.
create() - Method in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin.LocalSolrCoreAdmin: Creates a new Solr core using the parameters of this LocalSolrCoreAdmin.
createCore(Path, String) - Static method in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin.LocalSolrCoreAdmin: Creates a new Solr core under the provided Solr home base directory with the latest LOCKSS configuration set version.
createCore(Path, String, int) - Static method in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin.LocalSolrCoreAdmin: Creates a new Solr core under the provided Solr home base directory with a specified version of the LOCKSS configuration set version.
createResponse(SolrClient) - Method in class org.lockss.laaws.rs.index.solr.AdminInfoRequest.System
createResponse(SolrClient) - Method in class org.lockss.laaws.rs.index.solr.CoreConfigRequest.Overlay
createSolrCloudClient(String, String) - Static method in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin.SolrCloudCollectionAdmin: Creates a CloudSolrClient instance given Solr and ZooKeeper endpoints.

D

dataDir - Variable in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin.LocalSolrCoreAdmin: The path to the core's data directory.
DEFAULT_SOLRCORE_NAME - Static variable in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin: Default Solr core name for SolrArtifactIndex implementations.

E

equals(Object) - Method in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin.LocalSolrCoreAdmin

F

fromCloudSolrClient(CloudSolrClient, List<String>) - Static method in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin.SolrCloudCollectionAdmin
fromSolrCore(SolrCore) - Static method in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin.LocalSolrCoreAdmin: Takes an an open SolrCore and extracts the configuration parameters to instantiate a new LocalSolrCoreAdmin instance.
fromSolrHomeAndCoreName(Path, String) - Static method in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin.LocalSolrCoreAdmin: Returns a LocalCoreUpdater for a Solr core under a Solr home directory.

G

getAvailableConfigSets(SolrClient) - Method in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin: Returns the names of available configuration sets on this Solr instance.
getContentStreams() - Method in class org.lockss.laaws.rs.index.solr.AdminInfoRequest.System: Needed to compile with Solr 6.x.
getCoreName() - Method in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin.LocalSolrCoreAdmin
getLatestFileNameSuffix(Path) - Static method in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin.LocalSolrCoreAdmin: Checks for siblings of the target path having the same name but numeric suffix and returns the maximum suffix.
getLockssConfigSetVersion() - Method in class org.lockss.laaws.rs.index.solr.CoreConfigResponse.Overlay
getLockssConfigSetVersion() - Method in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin.LocalSolrCoreAdmin: Determines the version of the LOCKSS Solr configuration set in this core by reading its configuration overlay JSON file directly and returning the value of the "lockss-configset-version" key from userProps.
getLockssConfigSetVersion() - Static method in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin.SolrCloudCollectionAdmin
getLockssConfigSetVersionFromField(Path, String) - Static method in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin.LocalSolrCoreAdmin: Deprecated.
getLockssConfigSetVersionFromOverlay(Path) - Static method in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin.LocalSolrCoreAdmin: Determines the version of the LOCKSS Solr configuration set installed at a path by reading the configuration overlay JSON file and returning the value of the "lockss-configset-version" key from userProps.
getLockssConfigSetVersionFromSolrCore(SolrCore) - Static method in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin.LocalSolrCoreAdmin: Determines the version of a LOCKSS configuration set installed in this Solr core by looking up the value of the "lockss-configset-version" key in user properties of its Solr configuration.
getParams() - Method in class org.lockss.laaws.rs.index.solr.AdminInfoRequest.System
getParams() - Method in class org.lockss.laaws.rs.index.solr.CoreConfigRequest.Overlay
getRepository() - Method in class org.lockss.laaws.rs.client.WARCImporter: Provides the repository used by this object.
getSegmentInfos() - Method in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin.LocalSolrCoreAdmin: Returns a SegmentInfos containing segment information for all segments in this Lucene index.
getSolrMode() - Method in class org.lockss.laaws.rs.index.solr.AdminInfoResponse
getSolrVersion() - Method in class org.lockss.laaws.rs.index.solr.AdminInfoResponse
getSystemInfo(SolrClient) - Static method in class org.lockss.laaws.rs.index.solr.AdminInfoRequest
getUserProps() - Method in class org.lockss.laaws.rs.index.solr.CoreConfigResponse.Overlay

H

hashCode() - Method in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin.LocalSolrCoreAdmin
hasSolrField(IndexSchema, String, String) - Static method in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin.LocalSolrCoreAdmin: Returns a boolean indicating whether a field by the given field name and type exists in a IndexSchema.

I

importWARC(File) - Method in class org.lockss.laaws.rs.client.WARCImporter: Imports into the repository a WARC file.
indexDir - Variable in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin.LocalSolrCoreAdmin: The path to the core's Lucene index.
installLockssConfigSetVersion(int) - Method in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin.LocalSolrCoreAdmin: Installs the specified version of the LOCKSS configuration set into this Solr core by reading the configuration set's file list resource and copying the resources named within it to disk.
instanceDir - Variable in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin.LocalSolrCoreAdmin: Base path of the Solr core.
isCoreExists() - Method in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin.LocalSolrCoreAdmin: Returns a boolean indicating whether the Solr core exists on disk under the Solr home base directory.
isLockssConfigSetUpdateAvailable() - Method in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin.LocalSolrCoreAdmin: Returns a boolean indicating whether a new LOCKSS configuration set is available for this core.
isLuceneIndexUpgradeAvailable() - Method in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin.LocalSolrCoreAdmin: Returns a boolean indicating whether an upgrade is available for the Lucene index (and its segments) in this core.
isReindexInProgress() - Method in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin.LocalSolrCoreAdmin: Returns a boolean indicating whether a reindex is in progress.
isUpdateAvailable() - Method in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin.LocalSolrCoreAdmin: Convenience method.
isUpdateInProgress() - Method in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin.LocalSolrCoreAdmin: Returns a boolean indicating whether an update is in progress for this core.

K

KEY_ACTION - Static variable in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin
KEY_CLOUD - Static variable in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin
KEY_COLLECTION - Static variable in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin
KEY_CORE - Static variable in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin
KEY_ENDPOINT - Static variable in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin
KEY_LOCAL - Static variable in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin
KEY_LOCALDS - Static variable in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin
KEY_SOLRPASSWORD - Static variable in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin
KEY_SOLRUSERNAME - Static variable in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin
KEY_ZKHOST - Static variable in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin

L

LATEST_LOCKSS_CONFIGSET_VERSION - Static variable in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin: Latest version of the LOCKSS configuration set for SolrArtifactIndex.
LocalSolrCoreAdmin(String, Path, Path, Path, Path, Path, String, Path, int) - Constructor for class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin.LocalSolrCoreAdmin: Constructor.
LOCKSS_CONFIGSET_VERSION_KEY - Static variable in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin: The key in the custom user properties of the Solr core configuration overlay, used to track a Solr core's version of its installed LOCKSS configuration set.
lockssConfigSetVersion - Variable in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin.LocalSolrCoreAdmin: An integer representing the version of the LOCKSS Solr configuration set installed in this core.

M

main(String[]) - Static method in class org.lockss.laaws.rs.client.WARCImporter: Main entry as a standalone program.
main(String[]) - Static method in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin

O

org.lockss.laaws.rs.client - package org.lockss.laaws.rs.client
org.lockss.laaws.rs.index.solr - package org.lockss.laaws.rs.index.solr
Overlay() - Constructor for class org.lockss.laaws.rs.index.solr.CoreConfigRequest.Overlay
Overlay() - Constructor for class org.lockss.laaws.rs.index.solr.CoreConfigResponse.Overlay

R

REINDEX_LOCK_FILE - Static variable in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin.LocalSolrCoreAdmin
reindexAllArtifacts(SolrClient, List<String>, String) - Static method in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin.SolrArtifactIndexReindex: Experimental.
reindexArtifactsForVersion(SolrClient, List<String>, String, int) - Static method in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin.SolrArtifactIndexReindex: Reindexes artifacts in a Solr core or collection for a specific version of the LOCKSS provided Solr configuration set.
reindexArtifactsFrom1To2(SolrClient, List<String>, String) - Static method in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin.SolrArtifactIndexReindex: Performs a reindex (atomic update) of artifacts between LOCKSS configuration set version 1 to 2.
reindexLatest() - Method in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin.LocalSolrCoreAdmin
retireConfigSet() - Method in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin.LocalSolrCoreAdmin: Retires the core's current configuration set by renaming it with a suffix containing a timestamp.
retirePath(Path) - Static method in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin.LocalSolrCoreAdmin: Moves an existing directory or file out of the way by renaming it with a suffix containing a timestamp.
runAction(CommandLine) - Static method in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin

S

setResponse(NamedList<Object>) - Method in class org.lockss.laaws.rs.index.solr.AdminInfoResponse.System
sharedConfigSetBaseDir - Variable in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin.LocalSolrCoreAdmin: The path to the shared configuration set base directory.
sharedConfigSetName - Variable in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin.LocalSolrCoreAdmin: The name of a shared configuration set used by the core.
SOLR_CONFIGSET_NAME - Static variable in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin.SolrCloudCollectionAdmin
SOLR_CONFIGSET_PATH - Static variable in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin.SolrCloudCollectionAdmin
SolrArtifactIndexAdmin - Class in org.lockss.laaws.rs.index.solr
SolrArtifactIndexAdmin() - Constructor for class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin
SolrArtifactIndexAdmin.ArtifactIndexSchemaUpdater - Class in org.lockss.laaws.rs.index.solr: Deprecated.
SolrArtifactIndexAdmin.LocalSolrCoreAdmin - Class in org.lockss.laaws.rs.index.solr: This class contains operations necessary to administrate a Solr core on a local filesystem.
SolrArtifactIndexAdmin.SolrArtifactIndexReindex - Class in org.lockss.laaws.rs.index.solr: This static class contains SolrArtifactIndex reindex operations.
SolrArtifactIndexAdmin.SolrCloudCollectionAdmin - Class in org.lockss.laaws.rs.index.solr
SolrArtifactIndexReindex() - Constructor for class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin.SolrArtifactIndexReindex
SolrCloudCollectionAdmin(CloudSolrClient, List<String>) - Constructor for class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin.SolrCloudCollectionAdmin
solrCoreName - Variable in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin.LocalSolrCoreAdmin: The name of the Solr core.
solrHome - Variable in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin.LocalSolrCoreAdmin: The base path to the Solr home directory containing the core.
System() - Constructor for class org.lockss.laaws.rs.index.solr.AdminInfoRequest.System
System() - Constructor for class org.lockss.laaws.rs.index.solr.AdminInfoResponse.System

T

TARGET_LUCENE_VERSION - Static variable in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin: Target version of the Lucene index and segments.

U

update() - Method in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin.LocalSolrCoreAdmin: Performs all steps necessary to bring the underlying Solr core up-to-date.
update() - Method in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin.SolrCloudCollectionAdmin
updateConfigSet() - Method in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin.LocalSolrCoreAdmin: Updates the configuration set of the LOCKSS repository Solr core iteratively to the latest version, and performs any post-update Solr document reindexing.
updateSolrLockssSchemaVersionField(int) - Method in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin.ArtifactIndexSchemaUpdater: Deprecated.

Updates the Solr schema LOCKSS version field in the index.
UPGRADE_LOCK_FILE - Static variable in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin.LocalSolrCoreAdmin
upgradeLuceneIndex() - Method in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin.LocalSolrCoreAdmin: Performs an upgrade of the Solr core's Lucene index if necessary.
uploadConfigSet(String) - Method in class org.lockss.laaws.rs.index.solr.SolrArtifactIndexAdmin.SolrCloudCollectionAdmin

V

valueOf(String) - Static method in enum org.lockss.laaws.rs.index.solr.AdminInfoRequest.AdminInfoSection: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.lockss.laaws.rs.index.solr.CoreConfigRequest.CoreConfigSection: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.lockss.laaws.rs.index.solr.AdminInfoRequest.AdminInfoSection: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.lockss.laaws.rs.index.solr.CoreConfigRequest.CoreConfigSection: Returns an array containing the constants of this enum type, in the order they are declared.

W

WARCImporter - Class in org.lockss.laaws.rs.client: Imports a WARC file into the repository.
WARCImporter(LockssRepository, String, String) - Constructor for class org.lockss.laaws.rs.client.WARCImporter: Constructor when using an existing repository.
WARCImporter(File, String, String, String) - Constructor for class org.lockss.laaws.rs.client.WARCImporter: Constructor when using a new local repository.
WARCImporter(URL, String, String, String, String) - Constructor for class org.lockss.laaws.rs.client.WARCImporter: Constructor when using a new REST service repository.

A C D E F G H I K L M O R S T U V W