Package org.apache.sling.api.scripting

Interface SlingScriptHelper

All Known Implementing Classes:
ScriptHelper
@ProviderType public interface SlingScriptHelper
The SlingScriptHelper interface defines the API of a helper class which is provided to the scripts called from sling through the global sling variable.

  • Method Details

    • getRequest

      @NotNull @NotNull SlingHttpServletRequest getRequest()
      Returns the SlingHttpServletRequest representing the input of the request.
      Returns:
      The request

    • getResponse

      @NotNull @NotNull SlingHttpServletResponse getResponse()
      Returns the SlingHttpServletResponse representing the output of the request.
      Returns:
      The response

    • getScript

      @NotNull @NotNull SlingScript getScript()
      Returns the SlingScript being called to handle the request.
      Returns:
      The script

    • include

      void include(@NotNull @NotNull String path)
      Same as include(String,RequestDispatcherOptions), but using empty options.
      Parameters:
      path - The path to include
      Throws:
      SlingIOException - Wrapping a IOException thrown while handling the include.
      SlingServletException - Wrapping a ServletException thrown while handling the include.

    • include

      void include(@NotNull @NotNull String path, String requestDispatcherOptions)
      Helper method to include the result of processing the request for the given path and requestDispatcherOptions. This method is intended to be implemented as follows: 
       RequestDispatcher dispatcher = getRequest().getRequestDispatcher(path,
     "option:xyz");
 if (dispatcher != null) {
     dispatcher.include(getRequest(), getResponse());
 }

      This method creates a RequestDispatcherOptions object by calling the RequestDispatcherOptions(String) constructor.

      Parameters:
      path - The path to the resource to include.
      requestDispatcherOptions - influence the rendering of the included Resource
      Throws:
      SlingIOException - Wrapping a IOException thrown while handling the include.
      SlingServletException - Wrapping a ServletException thrown while handling the include.
      See Also:

    • include

      void include(@NotNull @NotNull String path, RequestDispatcherOptions options)
      Helper method to include the result of processing the request for the given path and options. This method is intended to be implemented as follows: 
       RequestDispatcherOptions opts = new RequestDispatcherOptions();
 opts.put("option", "xyz");
 RequestDispatcher dispatcher = getRequest().getRequestDispatcher(path, opts);
 if (dispatcher != null) {
     dispatcher.include(getRequest(), getResponse());
 }
      Parameters:
      path - The path to the resource to include.
      options - influence the rendering of the included Resource
      Throws:
      SlingIOException - Wrapping a IOException thrown while handling the include.
      SlingServletException - Wrapping a ServletException thrown while handling the include.
      See Also:

    • include

      void include(@NotNull @NotNull Resource resource)
      Same as include(Resource,RequestDispatcherOptions), but using empty options.
      Parameters:
      resource - The resource to include
      Throws:
      SlingIOException - Wrapping a IOException thrown while handling the include.
      SlingServletException - Wrapping a ServletException thrown while handling the include.

    • include

      void include(@NotNull @NotNull Resource resource, String requestDispatcherOptions)
      Helper method to include the result of processing the request for the given resource and requestDispatcherOptions. This method is intended to be implemented as follows: 
       RequestDispatcher dispatcher = getRequest().getRequestDispatcher(resource,
     "option:xyz");
 if (dispatcher != null) {
     dispatcher.include(getRequest(), getResponse());
 }

      This method creates a RequestDispatcherOptions object by calling the RequestDispatcherOptions(String) constructor.

      Parameters:
      resource - The resource to include.
      requestDispatcherOptions - influence the rendering of the included Resource
      Throws:
      SlingIOException - Wrapping a IOException thrown while handling the include.
      SlingServletException - Wrapping a ServletException thrown while handling the include.
      See Also:

    • include

      void include(@NotNull @NotNull Resource resource, RequestDispatcherOptions options)
      Helper method to include the result of processing the request for the given resource and options. This method is intended to be implemented as follows: 
       RequestDispatcherOptions opts = new RequestDispatcherOptions();
 opts.put("option", "xyz");
 RequestDispatcher dispatcher = getRequest().getRequestDispatcher(resource, opts);
 if (dispatcher != null) {
     dispatcher.include(getRequest(), getResponse());
 }
      Parameters:
      resource - The resource to include.
      options - influence the rendering of the included Resource
      Throws:
      SlingIOException - Wrapping a IOException thrown while handling the include.
      SlingServletException - Wrapping a ServletException thrown while handling the include.
      See Also:

    • forward

      void forward(@NotNull @NotNull String path)
      Same as forward(String,RequestDispatcherOptions), but using empty options.
      Parameters:
      path - The path to forward to
      Throws:
      SlingIOException - Wrapping a IOException thrown while handling the forward.
      SlingServletException - Wrapping a ServletException thrown while handling the forward.

    • forward

      void forward(@NotNull @NotNull String path, String requestDispatcherOptions)
      Helper method to forward the request to a Servlet or script for the given path and requestDispatcherOptions. This method is intended to be implemented as follows: 
       RequestDispatcher dispatcher = getRequest().getRequestDispatcher(path,
     "option:xyz");
 if (dispatcher != null) {
     dispatcher.forward(getRequest(), getResponse());
 }

      This method creates a RequestDispatcherOptions object by calling the RequestDispatcherOptions(String) constructor.

      Parameters:
      path - The path to the resource to forward to.
      requestDispatcherOptions - influence the rendering of the forwarded Resource
      Throws:
      SlingIOException - Wrapping a IOException thrown while handling the forward.
      SlingServletException - Wrapping a ServletException thrown while handling the forward.
      See Also:

    • forward

      void forward(@NotNull @NotNull String path, RequestDispatcherOptions options)
      Helper method to forward the request to a Servlet or script for the given path and options. This method is intended to be implemented as follows: 
       RequestDispatcherOptions opts = new RequestDispatcherOptions();
 opts.put("option", "xyz");
 RequestDispatcher dispatcher = getRequest().getRequestDispatcher(path, opts);
 if (dispatcher != null) {
     dispatcher.forward(getRequest(), getResponse());
 }
      Parameters:
      path - The path to the resource to forward the request to.
      options - influence the rendering of the forwarded Resource
      Throws:
      SlingIOException - Wrapping a IOException thrown while handling the forward.
      SlingServletException - Wrapping a ServletException thrown while handling the forward.
      IllegalStateException - If the respoonse has already been committed
      See Also:

    • forward

      void forward(@NotNull @NotNull Resource resource)
      Same as forward(Resource,RequestDispatcherOptions), but using empty options.
      Parameters:
      resource - The resource to forward to.
      Throws:
      SlingIOException - Wrapping a IOException thrown while handling the forward.
      SlingServletException - Wrapping a ServletException thrown while handling the forward.

    • forward

      void forward(@NotNull @NotNull Resource resource, String requestDispatcherOptions)
      Helper method to forward the request to a Servlet or script for the given resource and requestDispatcherOptions. This method is intended to be implemented as follows: 
       RequestDispatcher dispatcher = getRequest().getRequestDispatcher(resource,
     "option:xyz");
 if (dispatcher != null) {
     dispatcher.forward(getRequest(), getResponse());
 }

      This method creates a RequestDispatcherOptions object by calling the RequestDispatcherOptions(String) constructor.

      Parameters:
      resource - The resource to forward to.
      requestDispatcherOptions - influence the rendering of the forwarded Resource
      Throws:
      SlingIOException - Wrapping a IOException thrown while handling the forward.
      SlingServletException - Wrapping a ServletException thrown while handling the forward.
      See Also:

    • forward

      void forward(@NotNull @NotNull Resource resource, RequestDispatcherOptions options)
      Helper method to forward the request to a Servlet or script for the given resource and options. This method is intended to be implemented as follows: 
       RequestDispatcherOptions opts = new RequestDispatcherOptions();
 opts.put("option", "xyz");
 RequestDispatcher dispatcher = getRequest().getRequestDispatcher(resource, opts);
 if (dispatcher != null) {
     dispatcher.forward(getRequest(), getResponse());
 }
      Parameters:
      resource - The resource to forward the request to.
      options - influence the rendering of the forwarded Resource
      Throws:
      SlingIOException - Wrapping a IOException thrown while handling the forward.
      SlingServletException - Wrapping a ServletException thrown while handling the forward.
      IllegalStateException - If the respoonse has already been committed
      See Also:

    • getService

      @Nullable <ServiceType> ServiceType getService(@NotNull @NotNull Class<ServiceType> serviceType)
      Lookup a single service.

      If multiple such services exist, the service with the highest ranking (as specified in its Constants.SERVICE_RANKING property) is returned. If there is a tie in ranking, the service with the lowest service ID (as specified in its Constants.SERVICE_ID property); that is, the service that was registered first is returned.

      This is equal to the semantics from BundleContext.getServiceReference(Class).

      Type Parameters:
      ServiceType - The type (interface) of the service.
      Parameters:
      serviceType - The type (interface) of the service.
      Returns:
      The service instance, or null if no services are registered which implement the specified class.

    • getServices

      @Nullable <ServiceType> @Nullable ServiceType[] getServices(@NotNull @NotNull Class<ServiceType> serviceType, String filter)
      Lookup one or several services.

      The returned array is sorted descending by service ranking (i.e. the service with the highest ranking is returned first). If there is a tie in ranking, the service with the lowest service ID (as specified in its Constants.SERVICE_ID property); that is, the service that was registered first is returned first.

      Type Parameters:
      ServiceType - The type (interface) of the service.
      Parameters:
      serviceType - The type (interface) of the service.
      filter - An optional filter (LDAP-like, see OSGi spec)
      Returns:
      An array of services objects or null.
      Throws:
      InvalidServiceFilterSyntaxException - If the filter string is not a valid OSGi service filter string.
      See Also:

    • dispose

      @Deprecated void dispose()
      Deprecated.
      This method is deprecated since version 2.1 and will be removed. It should never be called by clients.
      Dispose the helper. This method can be used to clean up the script helper after the script is run.