org.apache.sling.scripting.javascript.RhinoHostObjectProvider Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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.apache.sling.scripting.javascript;
import org.mozilla.javascript.Scriptable;
/**
* The RhinoHostObjectProvider defines the service interface to
* inject additional ECMAScript host objects as well as to make classes and
* packages known.
*/
public interface RhinoHostObjectProvider {
/**
* Returns an array of classes implementing the Rhino
* Scriptable interface. These classes will be registered
* with the global scope as host objects and may then be used in any
* server-side ECMAScript scripts.
*
* @return the host object classes; may return null instead of an empty array for implementations that do not provide
* any host objects
*/
Class[] getHostObjectClasses();
/**
* Returns an array of classes, which are transparently converted into
* ECMAScript host objects in the global scope.
*
* Normally any Java class may be used within ECMAScript but it must be
* prefixed with Packages and the fully qualified package
* name of the class. For example to use the class
* org.slf4j.Log in an ECMAScript it must be noted as
* Packages.org.slf4j.Log. By registering the
* org.slf4j.Log as an imported class, it may simply be
* referred to as Log (provided there is no other object of
* that name, of course).
*
* @return the imported classes; may return null instead of an empty array for implementations that do not import any
* classes
*/
Class[] getImportedClasses();
/**
* Returns an array of Java package names to define name spaces in the
* global scope.
*
* Normally any Java class may be used within ECMAScript but it must be
* prefixed with Packages and the fully qualified package
* name of the class. For example to use the class
* org.slf4j.Log in an ECMAScript it must be noted as
* Packages.org.slf4j.Log. By registering the
* org.slf4j package as an imported package, it may simply be
* referred to as Log (provided there is no other object of
* that name, of course).
*
* The difference between importing packages and importing classes is that
* for a package import to work, the package must be visible to the
* ECMAScript bundle.
*
* Implementations may return null instead of an empty array
* if they do not provide any package names.
*
* @return the imported packages; may return null instead of an empty array for implementations that do import any packages
*/
String[] getImportedPackages();
}