org.apache.sling.api.scripting.SlingScript Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of org.apache.sling.api Show documentation

The Apache Sling API defines an extension to the Servlet API 2.4 to provide access to content and unified access to request parameters hiding the differences between the different methods of transferring parameters from client to server. Note that the Apache Sling API bundle does not include the Servlet API but instead requires the API to be provided by the Servlet container in which the Apache Sling framework is running or by another bundle.

There is a newer version: 2.27.6

Show newest version

/*
 * 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.api.scripting;

import javax.annotation.Nonnull;

import org.apache.sling.api.resource.Resource;

import aQute.bnd.annotation.ConsumerType;

/**
 * The SlingScript defines the API for objects which encapsulate
 * a script. To evaluate a script prepare a {@link SlingBindings} instance of
 * variables used as global variables to the script and call the
 * {@link #eval(SlingBindings)} method.
 * 
 * You can obtain scripts by resolving a script resource through
 * {@link org.apache.sling.api.resource.ResourceResolver#resolve(String)}
 * and then trying to adapt the resource to a script by
 * calling {@link Resource#adaptTo(Class)}.
 */
@ConsumerType
public interface SlingScript {

    /**
     * Returns the Resource providing the script source code.
     */
    @Nonnull Resource getScriptResource();

    /**
     * Evaluates this script using the bound variables as global variables to
     * the script.
     *
     * @param props The {@link SlingBindings} providing the bound variables for
     *            evaluating the script. Any bound variables must conform to the
     *            requirements of the {@link SlingBindings} predefined variables
     *            set.
     * @return The value returned by the script.
     * @throws ScriptEvaluationException If an error occurrs executing the
     *             script or preparing the script execution. The cause of the
     *             evaluation execption is available as the exception cause.
     */
    Object eval(@Nonnull SlingBindings props);

    /**
     * Evaluates this script using the bound variables as global variables to
     * the script and then calls the given method with the arguments.
     *
     * @param props The {@link SlingBindings} providing the bound variables for
     *            evaluating the script. Any bound variables must conform to the
     *            requirements of the {@link SlingBindings} predefined variables
     *            set.
     * @param method The name of the method to call.
     * @param args The arguments for the method call.
     * @return The value returned by the method from the script.
     * @throws ScriptEvaluationException If an error occurrs executing the
     *             script or preparing the script execution. The cause of the
     *             evaluation execption is available as the exception cause.
     */
    Object call(@Nonnull SlingBindings props, @Nonnull String method, Object... args);
}