org.pentaho.di.job.entry.validator.FileExistsValidator.java Source code

Introduction

Here is the source code for org.pentaho.di.job.entry.validator.FileExistsValidator.java

Source

/*! ******************************************************************************
 *
 * Pentaho Data Integration
 *
 * Copyright (C) 2002-2013 by Pentaho : http://www.pentaho.com
 *
 *******************************************************************************
 *
 * 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.pentaho.di.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 org.pentaho.di.core.CheckResultInterface;
import org.pentaho.di.core.CheckResultSourceInterface;
import org.pentaho.di.core.variables.VariableSpace;
import org.pentaho.di.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";

    private static final String KEY_FAIL_IF_DOES_NOT_EXIST = "org.pentaho.di.job.entries.createfile.failIfDoesNotExist";

    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, variableSpace);
            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) {
                // Ignore close errors
            }
        } 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);
    }

}