Open Source Repository

Home /spring/spring-context-3.0.5 | Repository Home



org/springframework/scripting/jruby/JRubyScriptFactory.java
/*
 * Copyright 2002-2008 the original author or authors.
 *
 * 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.springframework.scripting.jruby;

import java.io.IOException;

import org.jruby.RubyException;
import org.jruby.exceptions.JumpException;
import org.jruby.exceptions.RaiseException;

import org.springframework.beans.factory.BeanClassLoaderAware;
import org.springframework.scripting.ScriptCompilationException;
import org.springframework.scripting.ScriptFactory;
import org.springframework.scripting.ScriptSource;
import org.springframework.util.Assert;
import org.springframework.util.ClassUtils;

/**
 {@link org.springframework.scripting.ScriptFactory} implementation
 * for a JRuby script.
 *
 <p>Typically used in combination with a
 {@link org.springframework.scripting.support.ScriptFactoryPostProcessor};
 * see the latter's javadoc for a configuration example.
 *
 @author Juergen Hoeller
 @author Rob Harrop
 @since 2.0
 @see JRubyScriptUtils
 @see org.springframework.scripting.support.ScriptFactoryPostProcessor
 */
public class JRubyScriptFactory implements ScriptFactory, BeanClassLoaderAware {

  private final String scriptSourceLocator;

  private final Class[] scriptInterfaces;

  private ClassLoader beanClassLoader = ClassUtils.getDefaultClassLoader();


  /**
   * Create a new JRubyScriptFactory for the given script source.
   @param scriptSourceLocator a locator that points to the source of the script.
   * Interpreted by the post-processor that actually creates the script.
   @param scriptInterfaces the Java interfaces that the scripted object
   * is supposed to implement
   */
  public JRubyScriptFactory(String scriptSourceLocator, Class[] scriptInterfaces) {
    Assert.hasText(scriptSourceLocator, "'scriptSourceLocator' must not be empty");
    Assert.notEmpty(scriptInterfaces, "'scriptInterfaces' must not be empty");
    this.scriptSourceLocator = scriptSourceLocator;
    this.scriptInterfaces = scriptInterfaces;
  }


  public void setBeanClassLoader(ClassLoader classLoader) {
    this.beanClassLoader = classLoader;
  }


  public String getScriptSourceLocator() {
    return this.scriptSourceLocator;
  }

  public Class[] getScriptInterfaces() {
    return this.scriptInterfaces;
  }

  /**
   * JRuby scripts do require a config interface.
   */
  public boolean requiresConfigInterface() {
    return true;
  }

  /**
   * Load and parse the JRuby script via JRubyScriptUtils.
   @see JRubyScriptUtils#createJRubyObject(String, Class[], ClassLoader)
   */
  public Object getScriptedObject(ScriptSource scriptSource, Class[] actualInterfaces)
      throws IOException, ScriptCompilationException {
    try {
      return JRubyScriptUtils.createJRubyObject(
          scriptSource.getScriptAsString(), actualInterfaces, this.beanClassLoader);
    }
    catch (RaiseException ex) {
      RubyException rubyEx = ex.getException();
      String msg = (rubyEx != null && rubyEx.message != null?
          rubyEx.message.toString() "Unexpected JRuby error";
      throw new ScriptCompilationException(scriptSource, msg, ex);
    }
    catch (JumpException ex) {
      throw new ScriptCompilationException(scriptSource, ex);
    }
  }

  public Class getScriptedObjectType(ScriptSource scriptSource)
      throws IOException, ScriptCompilationException {

    return null;
  }

  public boolean requiresScriptedObjectRefresh(ScriptSource scriptSource) {
    return scriptSource.isModified();
  }


  @Override
  public String toString() {
    return "JRubyScriptFactory: script source locator [" this.scriptSourceLocator + "]";
  }

}