JRuby Base 10.0.0.0 · org.jruby.embed.osgi.OSGiScriptingContainer

Helpers to create a ScriptingContainer and set it up so it lives as well as possible in the OSGi world.

Currently:

Access to the java classes and resources provided by the osgi bundle.
Setup of jruby home pointing at the jruby bundle by default. Supporting unzipped jruby bundle for now.

Todo

look into using the LoadService of jruby. Look if it would be possible to reuse the base runtime and minimize the cost of new jruby runtimes.

Constructor Summary

Access	Constructor and Description
public	OSGiScriptingContainer(Bundle creator) A scripting container where the classloader can find classes in the osgi creator bundle and where the jruby home is set to point to the one in the jruby's bundle home folder.
public	OSGiScriptingContainer(Bundle creator, LocalContextScope if null, LocalContextScope.SINGLETHREAD scope, LocalVariableBehavior if null, LocalVariableBehavior.TRANSIENT behavior) A scripting container where the classloader can find classes in the osgi creator bundle and where the jruby home is set to point to the one in the jruby's bundle home folder.

Method Summary

Modifier and Type	Method and Description
public void	addToClassPath(Bundle Add a bundle to the jruby classloader. Equivalent to require `"bundle:/#{bundle.symbolic.name}"` bundle)
private String	Returns: a nice debugging string for the stack traces that is passed as the 'filename' of this script to jruby. getFilename(Bundle bundle, String path)
public JRubyOSGiBundleClassLoader	Returns: The ScriptingContainer's classloader casted to a JRubyOSGiBundleClassLoader. It is the parent classloader of the actual's runtime's JRubyClassLoader. It enables finding classes and resources in the OSGi environment. getOSGiBundleClassLoader()
public EmbedEvalUnit	Returns: an object which can be run parse(Bundle is where the script is located bundle, String is the entry in the bundle. path, int... are linenumbers to display for parse errors and backtraces. This field is optional. Only the first argument is used for parsing. When no line number is specified, 0 is applied to. lines) Parses a script given by a input stream and return an object which can be run().
public Object	runScriptlet(String The bundle where the script is located. Lazily added to the loader of the OSGiScriptingContainer. (require bundle:/... is implicitly done here) bundleSymbolicName, String The entry in the bundle path)
public Object	runScriptlet(Bundle The bundle where the script is located. Lazily added to the loader of the OSGiScriptingContainer. (require bundle:/... is implicitly done here) bundle, String The entry in the bundle path)

Inherited from org.jruby.embed.ScriptingContainer:: addClassLoader addGemPath addGemPath addLoadPath addLoadPath callMethod callMethod callMethod callMethod callMethod callMethod callMethod callMethod callMethod callSuper callSuper clear finalize get get getArgv getAttribute getAttributeMap getClassLoader getClassloaderDelegate getCompileMode getCurrentDirectory getEnvironment getErr getError getErrorWriter getHomeDirectory getIn getInput getInstance getJitLogEvery getJitMax getJitMaxSize getJitThreshold getKCode getLoadPaths getLoadServiceCreator getOut getOutput getProfile getProfileOutput getProfilingMode getProperty getProvider getReader getRecordSeparator getRuntime getScriptFilename getSupportedRubyVersion getVarMap getWriter isNativeEnabled isObjectSpaceEnabled isRunRubyInProcess newObjectAdapter newRuntimeAdapter parse parse parse parse put put remove remove removeAttribute resetErrorWriter resetWriter runRubyMethod runRubyMethod runScriptlet runScriptlet runScriptlet runScriptlet setArgv setAttribute setClassLoader setClassloaderDelegate setCompileMode setCurrentDirectory setEnvironment setError setError setErrorWriter setHomeDirectory setInput setInput setJitLogEvery setJitMax setJitMaxSize setJitThreshold setKCode setLoadPaths setLoadServiceCreator setNativeEnabled setObjectSpaceEnabled setOutput setOutput setProfile setProfile setProfileOutput setProfilingMode setReader setRecordSeparator setRunRubyInProcess setScriptFilename setWriter terminate

Constructor Detail

OSGiScriptingContainer	back to summary
public OSGiScriptingContainer(Bundle creator) A scripting container where the classloader can find classes in the osgi creator bundle and where the jruby home is set to point to the one in the jruby's bundle home folder. scope: LocalContextScope.SINGLETHREAD; behavior: LocalVariableBehavior.TRANSIENT

OSGiScriptingContainer

back to summary

public OSGiScriptingContainer(Bundle creator)

A scripting container where the classloader can find classes in the osgi creator bundle and where the jruby home is set to point to the one in the jruby's bundle home folder.

scope: LocalContextScope.SINGLETHREAD; behavior: LocalVariableBehavior.TRANSIENT

OSGiScriptingContainer	back to summary
public OSGiScriptingContainer(Bundle creator, LocalContextScope scope, LocalVariableBehavior behavior) A scripting container where the classloader can find classes in the osgi creator bundle and where the jruby home is set to point to the one in the jruby's bundle home folder. Parameters scope:LocalContextScope if null, LocalContextScope.SINGLETHREAD behavior:LocalVariableBehavior if null, LocalVariableBehavior.TRANSIENT

OSGiScriptingContainer

back to summary

public OSGiScriptingContainer(Bundle creator, LocalContextScope scope, LocalVariableBehavior behavior)

A scripting container where the classloader can find classes in the osgi creator bundle and where the jruby home is set to point to the one in the jruby's bundle home folder.

Parameters

scope:LocalContextScope: if null, LocalContextScope.SINGLETHREAD
behavior:LocalVariableBehavior: if null, LocalVariableBehavior.TRANSIENT

Method Detail

addToClassPath	back to summary
public void addToClassPath(Bundle bundle) Parameters bundle:Bundle Add a bundle to the jruby classloader. Equivalent to require `"bundle:/#{bundle.symbolic.name}"`

getFilename	back to summary
private String getFilename(Bundle bundle, String path) Returns:String a nice debugging string for the stack traces that is passed as the 'filename' of this script to jruby.

getOSGiBundleClassLoader	back to summary
public JRubyOSGiBundleClassLoader getOSGiBundleClassLoader() Returns:JRubyOSGiBundleClassLoader The ScriptingContainer's classloader casted to a JRubyOSGiBundleClassLoader. It is the parent classloader of the actual's runtime's JRubyClassLoader. It enables finding classes and resources in the OSGi environment.

parse	back to summary
public EmbedEvalUnit parse(Bundle bundle, String path, int... lines) throws IOException Parses a script given by a input stream and return an object which can be run(). This allows the script to be parsed once and evaluated many times. Parameters bundle:Bundle is where the script is located path:String is the entry in the bundle. lines:int[] are linenumbers to display for parse errors and backtraces. This field is optional. Only the first argument is used for parsing. When no line number is specified, 0 is applied to. Returns:EmbedEvalUnit an object which can be run

parse

back to summary

public EmbedEvalUnit parse(Bundle bundle, String path, int... lines) throws IOException

Parses a script given by a input stream and return an object which can be run(). This allows the script to be parsed once and evaluated many times.

Parameters

bundle:Bundle: is where the script is located
path:String: is the entry in the bundle.
lines:int[]: are linenumbers to display for parse errors and backtraces. This field is optional. Only the first argument is used for parsing. When no line number is specified, 0 is applied to.

Returns:EmbedEvalUnit

an object which can be run

runScriptlet	back to summary
public Object runScriptlet(String bundleSymbolicName, String path) Parameters bundleSymbolicName:String The bundle where the script is located. Lazily added to the loader of the OSGiScriptingContainer. (require bundle:/... is implicitly done here) path:String The entry in the bundle

runScriptlet	back to summary
public Object runScriptlet(Bundle bundle, String path) Parameters bundle:Bundle The bundle where the script is located. Lazily added to the loader of the OSGiScriptingContainer. (require bundle:/... is implicitly done here) path:String The entry in the bundle

public Class OSGiScriptingContainer

Constructor Summary

Method Summary

Constructor Detail

Method Detail