com.panet.imeta.job.entry.validator.FileExistsValidator.java Source code

Introduction

Here is the source code for com.panet.imeta.job.entry.validator.FileExistsValidator.java

Source

/*
 * Copyright (c) 2007 Pentaho Corporation.  All rights reserved. 
 * This software was developed by Pentaho Corporation and is provided under the terms 
 * of the GNU Lesser General Public License, Version 2.1. You may not use 
 * this file except in compliance with the license. If you need a copy of the license, 
 * please go to http://www.gnu.org/licenses/lgpl-2.1.txt. The Original Code is Pentaho 
 * Data Integration.  The Initial Developer is Pentaho Corporation.
 *
 * Software distributed under the GNU Lesser Public License is distributed on an "AS IS" 
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or  implied. Please refer to 
 * the license for the specific language governing your rights and limitations.
*/
package com.panet.imeta.job.entry.validator;

import java.io.IOException;
import java.util.List;

import org.apache.commons.validator.util.ValidatorUtils;
import org.apache.commons.vfs.FileObject;

import com.panet.imeta.core.CheckResultInterface;
import com.panet.imeta.core.CheckResultSourceInterface;
import com.panet.imeta.core.variables.VariableSpace;
import com.panet.imeta.core.vfs.KettleVFS;

/**
 * Fails if a field's value is a filename and the file does not exist.
 *
 * @author mlowery
 */
public class FileExistsValidator extends AbstractFileValidator {

    public static final FileExistsValidator INSTANCE = new FileExistsValidator();

    static final String VALIDATOR_NAME = "fileExists"; //$NON-NLS-1$

    private static final String KEY_FAIL_IF_DOES_NOT_EXIST = "com.panet.imeta.job.entries.createfile.failIfDoesNotExist"; //$NON-NLS-1$

    public boolean validate(CheckResultSourceInterface source, String propertyName,
            List<CheckResultInterface> remarks, ValidatorContext context) {

        String filename = ValidatorUtils.getValueAsString(source, propertyName);
        VariableSpace variableSpace = getVariableSpace(source, propertyName, remarks, context);
        boolean failIfDoesNotExist = getFailIfDoesNotExist(source, propertyName, remarks, context);

        if (null == variableSpace) {
            return false;
        }

        String realFileName = variableSpace.environmentSubstitute(filename);
        FileObject fileObject = null;
        try {
            fileObject = KettleVFS.getFileObject(realFileName);
            if (fileObject == null || (fileObject != null && !fileObject.exists() && failIfDoesNotExist)) {
                JobEntryValidatorUtils.addFailureRemark(source, propertyName, VALIDATOR_NAME, remarks,
                        JobEntryValidatorUtils.getLevelOnFail(context, VALIDATOR_NAME));
                return false;
            }
            try {
                fileObject.close(); // Just being paranoid
            } catch (IOException ignored) {
            }
        } catch (Exception e) {
            JobEntryValidatorUtils.addExceptionRemark(source, propertyName, VALIDATOR_NAME, remarks, e);
            return false;
        }
        return true;
    }

    public String getName() {
        return VALIDATOR_NAME;
    }

    public static ValidatorContext putFailIfDoesNotExist(boolean failIfDoesNotExist) {
        ValidatorContext context = new ValidatorContext();
        context.put(KEY_FAIL_IF_DOES_NOT_EXIST, failIfDoesNotExist);
        return context;
    }

    protected boolean getFailIfDoesNotExist(CheckResultSourceInterface source, String propertyName,
            List<CheckResultInterface> remarks, ValidatorContext context) {
        Object obj = context.get(KEY_FAIL_IF_DOES_NOT_EXIST);
        if (obj instanceof Boolean) {
            return (Boolean) obj;
        } else {
            // default is false
            return false;
        }
    }

    public static void putFailIfDoesNotExist(ValidatorContext context, boolean failIfDoesNotExist) {
        context.put(KEY_FAIL_IF_DOES_NOT_EXIST, failIfDoesNotExist);
    }

}