org.jwat.warc.WarcFileWriterConfig Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jwat-warc Show documentation

Used for reading, writing and validating WARC files. Implemented to follow the WARC/1.0 ISO specification as closely as possible.

There is a newer version: 1.2.1

Show newest version

/**
 * Java Web Archive Toolkit - Software to read and validate ARC, WARC
 * and GZip files. (http://jwat.org/)
 * Copyright 2011-2012 Netarkivet.dk (http://netarkivet.dk/)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.jwat.warc;

import java.io.File;
import java.util.LinkedHashMap;
import java.util.Map;

/**
 * General configuration of WarcFileWriter.
 *
 * @author nicl
 */
public class WarcFileWriterConfig {

    /** Standard/default max file size. */
    public static final long DEFAULT_MAX_FILE_SIZE = 1073741824L;

    /** Target directory in which to write ARC file(s). */
    protected File targetDir;

    /** Compress archive(s). */
    protected boolean bCompression;

    /** Max file size used to determine when to close the current ARC file and start writing to the next one. */
    protected Long maxFileSize = DEFAULT_MAX_FILE_SIZE;

    /** Overwrite existing file(s). */
    public boolean bOverwrite;

    /** Array of metadata. */
    protected LinkedHashMap> metadata = new LinkedHashMap>();

    /**
     * Construct instance with largely default values, except the targetDir which is null.
     */
    public WarcFileWriterConfig() {
    }

    /**
     * Construct an instance with custom values.
     * @param targetDir target directory in which to write WARC file(s)
     * @param bCompression compress archive(s)
     * @param maxFileSize max file size to determine when to move on to a fresh WARC file
     * @param bOverwrite overwrite existing file(s)
     */
    public WarcFileWriterConfig(File targetDir, boolean bCompression, long maxFileSize, boolean bOverwrite) {
        this.targetDir = targetDir;
        this.bCompression = bCompression;
        this.maxFileSize = maxFileSize;
        this.bOverwrite = bOverwrite;
    }

}