com.autonomy.nonaci.indexing.impl.DreBackupCommand Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of indexing-api Show documentation

API for indexing into IDOL using Java

There is a newer version: 4.0.0

/*
 * (c) Copyright 2008-2015 Micro Focus or one of its affiliates.
 *
 * Licensed under the MIT License (the "License"); you may not use this file
 * except in compliance with the License.
 *
 * The only warranties for products and services of Micro Focus and its affiliates
 * and licensors ("Micro Focus") are as may be set forth in the express warranty
 * statements accompanying such products and services. Nothing herein should be
 * construed as constituting an additional warranty. Micro Focus shall not be
 * liable for technical or editorial errors or omissions contained herein. The
 * information contained herein is subject to change without notice.
 */
package com.autonomy.nonaci.indexing.impl;

import com.autonomy.nonaci.indexing.IndexingException;
import org.apache.commons.codec.net.URLCodec;

import java.io.UnsupportedEncodingException;

/**
 * Allows you to back up IDOL server's data index. This command copies all the IDOL server data index's *.DB files to a 
 * specified location.
 * 
 * To restore backed up files, use the DREINITIAL command.
 *
 * @author boba
 */
public class DreBackupCommand extends IndexCommandImpl {

    /** The full path to the location where the backup is created. */
    private String path;
    
    private final URLCodec urlCodec = new URLCodec();
    
    /** Creates a new instance of DreBackupCommand */
    public DreBackupCommand() {
        super(CMD_DREBACKUP);
    }

    @Override
    public String getQueryString() {
        try {
            return urlCodec.encode(path, "UTF-8");
        }
        catch(final UnsupportedEncodingException uee) {
            throw new IndexingException(uee);
        }
    }
    
    public String getPath() {
        return path;
    }

    /**
     * Enter the full path to the location you want to create IDOL server's backup. In Windows, a unicode path can be 
     * used.
     * 
     * @param path The full path to the location where the backup is created.
     */
    public void setPath(final String path) {
        this.path = path;
    }

} // End of class DreBackupCommand...