com.adaptris.core.services.ScriptingService.java Source code

Introduction

Here is the source code for com.adaptris.core.services.ScriptingService.java

Source

/*
 * Copyright 2015 Adaptris Ltd.
 * 
 * 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 com.adaptris.core.services;

import static org.apache.commons.lang.StringUtils.isEmpty;

import java.io.File;
import java.io.FileReader;
import java.io.IOException;
import java.io.Reader;

import org.hibernate.validator.constraints.NotBlank;

import com.adaptris.annotation.AdapterComponent;
import com.adaptris.annotation.ComponentProfile;
import com.adaptris.annotation.DisplayOrder;
import com.adaptris.core.CoreException;
import com.thoughtworks.xstream.annotations.XStreamAlias;

/**
 * Supports arbitary scripting languges that are supported by JSR223.
 * <p>
 * You should take care when configuring this class; it can present an audit trail issue when used in combination with
 * {@link com.adaptris.core.services.dynamic.DynamicServiceLocator} or
 * {@link com.adaptris.core.services.dynamic.DynamicServiceExecutor} if your script executes arbitrary system commands. In that
 * situation, all commands will be executed with the current users permissions may be subject to the virtual machines security
 * manager.
 * </p>
 * <p>
 * The script is executed and the AdaptrisMessage that is due to be processed is bound against the key "message". This can be used
 * as a standard variable within the script
 * </p>
 * <p>
 * Note that this class can be used as the selector as part of a {@link com.adaptris.core.BranchingServiceCollection}. If used as
 * such, then you need
 * to remember to invoke {@link com.adaptris.core.AdaptrisMessage#setNextServiceId(String)} as part of the script and {@link
 * #setBranching(Boolean)}
 * should be true.
 * <p>
 * 
 * @config scripting-service
 * 
 * 
 * @author lchan
 * 
 */
@XStreamAlias("scripting-service")
@AdapterComponent
@ComponentProfile(summary = "Execute a JSR223 script stored on the filesystem", tag = "service,scripting")
@DisplayOrder(order = { "language", "scriptFilename", "branching" })
public class ScriptingService extends ScriptingServiceImp {

    @NotBlank
    private String scriptFilename;

    public ScriptingService() {
        super();
    }

    public ScriptingService(String uniqueId) {
        this();
        setUniqueId(uniqueId);
    }

    public String getScriptFilename() {
        return scriptFilename;
    }

    /**
     * Set the contents of the script.
     *
     * @param s the script
     */
    public void setScriptFilename(String s) {
        this.scriptFilename = s;
    }

    @Override
    protected void initService() throws CoreException {
        if (isEmpty(getScriptFilename())) {
            throw new CoreException("script filename is null");
        }
        File f = new File(getScriptFilename());
        if (!f.exists() || !f.isFile() || !f.canRead()) {
            throw new CoreException(getScriptFilename() + " is not accessible");
        }
        super.initService();
    }

    @Override
    protected Reader createReader() throws IOException {
        return new FileReader(getScriptFilename());
    }

    @Override
    public void prepare() throws CoreException {
    }

}