org.lockss.laaws.rs.client

Class WARCImporter

java.lang.Object

org.lockss.laaws.rs.client.WARCImporter

public class WARCImporter
extends Object

Imports a WARC file into the repository.

Constructor Summary

Constructors

Constructor and Description
WARCImporter(File stateDir, File repoDir, String persistedIndexName, String namespace, String auid) Constructor when using a new local repository.
WARCImporter(LockssRepository repository, String namespace, String auid) Constructor when using an existing repository.
WARCImporter(URL url, String user, String password, String namespace, String auid) Constructor when using a new REST service repository.

Method Summary

Modifier and Type	Method and Description
LockssRepository	getRepository() Provides the repository used by this object.
LockssRepository	importWARC(File warc) Imports into the repository a WARC file.
static void	main(String[] args) Main entry as a standalone program.

Methods inherited from class java.lang.Object

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

Constructor Detail

WARCImporter

public WARCImporter(LockssRepository repository,
                    String namespace,
                    String auid)

Constructor when using an existing repository.

Parameters:

repository - A LockssRepository with the existing repository where to import the WARC file.

namespace - A String with the target namespace of artifacts imported from the WARC file.

auid - A String with the Archival Unit identifier linked to the imported WARC file.

WARCImporter

public WARCImporter(File stateDir,
                    File repoDir,
                    String persistedIndexName,
                    String namespace,
                    String auid)
             throws IOException

Constructor when using a new local repository.

Parameters:

repoDir - A File with the directory of the local repository to be used.

persistedIndexName - A String with the name of the file where to persist the repository index.

namespace - A String with the target namespace of artifacts imported from the WARC file.

auid - A String with the Archival Unit identifier linked to the imported WARC file.

Throws:

IOException - if there are problems creating the local repository.

WARCImporter

public WARCImporter(URL url,
                    String user,
                    String password,
                    String namespace,
                    String auid)
             throws IOException

Constructor when using a new REST service repository.

Parameters:

url - A URL with the location of the repository REST service to be used.

user - A String with the name of the user to use to access the REST service repository.

password - A String with the password of the user to use to access the REST service repository.

namespace - A String with the target namespace of artifacts imported from the WARC file.

auid - A String with the Archival Unit identifier linked to the imported WARC file.

Throws:

IOException

Method Detail

main

public static void main(String[] args)
                 throws org.apache.commons.cli.ParseException,
                        MalformedURLException,
                        IOException

Main entry as a standalone program.

Parameters:

args - A String[] with the command line arguments.

Throws:

org.apache.commons.cli.ParseException - if received.

MalformedURLException - if received.

IOException - if received.

importWARC

public LockssRepository importWARC(File warc)
                            throws IOException

Imports into the repository a WARC file.

Parameters:

warc - A File with the specification of the WARC file to be imported.

Returns:

a LockssRepository with a handle to the repository where the WARC file has been imported.

Throws:

IOException - if there are problems importing the WARC file.

getRepository

public LockssRepository getRepository()

Provides the repository used by this object.

Returns:

a LockssRepository with the repository used by this object.