Apache Sling

https://sling.apache.org/apidocs/sling14/
Admin
Apache Sling is a REST-based web framework powered by OSGi that uses Java Content Repositories to...
Tokens:935,296
Snippets:10,247
Trust Score:10
Update:5 months ago
Show doc for...
Tokens:
Raw
### start(BundleContext, String, boolean)

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/jcr/base/AbstractSlingRepositoryManager.html

Starts the backing repository instance and registers the repository service. This method is deprecated and should be replaced by `start(BundleContext, AbstractSlingRepositoryManager.Config)`.

```APIDOC
## start(BundleContext, String, boolean)

### Description
Starts the backing repository instance and registers the repository service. This method is deprecated and should be replaced by `start(BundleContext, AbstractSlingRepositoryManager.Config)`.

### Method
protected final boolean

### Parameters
* **bundleContext** (org.osgi.framework.BundleContext) - The bundle context.
* **defaultWorkspace** (String) - The default workspace name.
* **disableLoginAdministrative** (boolean) - Whether to disable the `SlingRepository.loginAdministrative` method.
```

--------------------------------

### registerResources

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/installer/api/OsgiInstaller.html

Provides the installer with the complete list of installable resources for a given client. This method should be called at startup or when the installer service becomes available. The installer compares this list with previously registered resources and removes any that have disappeared.

```APIDOC
## registerResources

### Description
Provide the installer with the complete list of installable resources for a given client.

### Method Signature
`void registerResources(String urlScheme, InstallableResource[] resources)`

### Parameters
* `urlScheme` (String) - Identifies the client.
* `resources` (InstallableResource[]) - The list of available resources.

### Notes
Client must call this at startup and/or when the installer service becomes available. The installer stores the list of previously registered/added resources, compares with the new list and removes resources that have disappeared. Invalid resources are ignored.
```

--------------------------------

### start

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/jcr/base/AbstractSlingRepositoryManager.html

This method actually starts the backing repository instannce and registeres the repository service.

```APIDOC
## start
protected final void start(org.osgi.framework.BundleContext bundleContext, AbstractSlingRepositoryManager.Config config)

### Description
This method actually starts the backing repository instannce and registeres the repository service. Multiple subsequent calls to this method without calling `stop()` first have no effect.

### Parameters
* `bundleContext` - The `BundleContext` to register the repository service (and optionally more services required to operate the repository)
* `config` - The configuration to apply to this instance.
```

--------------------------------

### start(BundleContext, AbstractSlingRepositoryManager.Config)

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/jcr/base/AbstractSlingRepositoryManager.html

This method actually starts the backing repository instance and registers the repository service.

```APIDOC
## start(BundleContext, AbstractSlingRepositoryManager.Config)

### Description
This method actually starts the backing repository instance and registers the repository service.

### Method
protected final void

### Parameters
* **bundleContext** (org.osgi.framework.BundleContext) - The bundle context.
* **config** (AbstractSlingRepositoryManager.Config) - The configuration object.
```

--------------------------------

### start (Deprecated)

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/jcr/base/AbstractSlingRepositoryManager.html

Deprecated. use `start(BundleContext, AbstractSlingRepositoryManager.Config)` instead. This method was deprecated with the introduction of asynchronous repository registration.

```APIDOC
## start (Deprecated)
@Deprecated protected final boolean start(org.osgi.framework.BundleContext bundleContext, String defaultWorkspace, boolean disableLoginAdministrative)

### Description
Deprecated. use `start(BundleContext, AbstractSlingRepositoryManager.Config)` instead. This method was deprecated with the introduction of asynchronous repository registration. With asynchronous registration a boolean return value can no longer be guaranteed, as registration may happen after the method returns. Instead a `ServiceListener` for `SlingRepository` may be registered to get informed about its successful registration.

### Parameters
* `bundleContext` - The `BundleContext` to register the repository service (and optionally more services required to operate the repository)
* `defaultWorkspace` - The name of the default workspace to use to login. This may be `null` to have the actual repository instance define its own default
* `disableLoginAdministrative` - Whether to disable the `SlingRepository.loginAdministrative` method or not.

### Returns
`true` if the repository has been started and the service is registered; `false` if the service has not been registered, which may indicate that startup was unsuccessful OR that it is happening asynchronously. A more reliable way to determin availability of the `SlingRepository` as a service is using a `ServiceListener`.
```

--------------------------------

### InstallationEvent Interface

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/installer/api/event/InstallationEvent.html

The InstallationEvent interface is an optional listener that can be used to monitor the activities of the installer. It provides methods to get the event type and the source of the event.

```APIDOC
## Interface: InstallationEvent

### Description
Optional listener which can be used to monitor the activities of the installer.

### Methods

#### getType

*   **Signature**: `InstallationEvent.TYPE getType()`
*   **Description**: Return the event type.
*   **Returns**: The event type.

#### getSource

*   **Signature**: `Object getSource()`
*   **Description**: Return the source of the event. For `InstallationEvent.TYPE.STARTED` and `InstallationEvent.TYPE.SUSPENDED` events this is `null`. For `InstallationEvent.TYPE.PROCESSED` events this is a `TaskResource`.
*   **Returns**: The source of the event.
```

--------------------------------

### OsgiInstaller.registerResources

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/installer/api/class-use/InstallableResource.html

This method is used to provide the installer with the complete list of installable resources for a given client. It takes a URL scheme and an array of InstallableResource objects.

```APIDOC
## registerResources(String urlScheme, InstallableResource[] resources)

### Description
Provide the installer with the complete list of installable resources for a given client.

### Method Signature
`void registerResources(String urlScheme, InstallableResource[] resources)`

### Parameters
* **urlScheme** (String) - The scheme for the resources.
* **resources** (InstallableResource[]) - An array of installable resources.
```

--------------------------------

### InstallableResource Constants

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/installer/api/InstallableResource.html

Constants defining resource types and installation hints for the Apache Sling Installer.

```APIDOC
## InstallableResource Constants

### TYPE_PROPERTIES
`public static final String TYPE_PROPERTIES`
The type for properties - in this case `getDictionary()` should contain a dictionary or the `getInputStream()` should point to a property or configuration file.

Since: 3.1

### TYPE_FILE
`public static final String TYPE_FILE`
The type for all other provided data like a bundle etc. In this case `getInputStream()` must return an input stream to the data. `getDictionary()` might return additional information.

Since: 3.1

### TYPE_BUNDLE
`public static final String TYPE_BUNDLE`
The type for a bundle - in this case `getInputStream()` must return an input stream to the bundle. `getDictionary()` might return additional information. This type should only be used if the client really knows that the provided data is a bundle.

### TYPE_CONFIG
`public static final String TYPE_CONFIG`
The type for a configuration - in this case `getDictionary()` must return a dictionary with the configuration. This type should only be used if the client really knows that the provided data is an OSGi configuration.

### BUNDLE_START_LEVEL
`public static final String BUNDLE_START_LEVEL`
Optional parameter in the dictionary if a bundle is installed. If this is set with a valid start level, the bundle is installed in that start level.

### INSTALLATION_HINT
`public static final String INSTALLATION_HINT`
Optional parameter in the dictionary if a resource (not a dict) is installed. This parameter might be used by the installation task for any purpose like bundle start level etc.

Since: 3.1

### RESOURCE_URI_HINT
`public static final String RESOURCE_URI_HINT`
Optional parameter in the dictionary if a resource (not a dict) is installed. If this parameter is specified, the installer uses the URI to get the input stream of the resource! Usually the installer copies the resource into the file system and uses this copy. To optimize this, if the URI of the resource is always available (like a file URI), this property can be used to avoid copying the resource. It is only evaluated if the resource type is either unknown (null) or `TYPE_FILE` and a digest for the resource is delivered. The value of this property is a string. This property might also be set for an `UpdateHandler` in order to give a hint for the (file) name the resource or dictionary should have.

Since: 3.1.2

### RESOURCE_IS_TEMPLATE
`public static final String RESOURCE_IS_TEMPLATE`
Optional parameter to be passed in the dictionary. If this property is set (the value is ignored), this artifact acts like a template: If the artifact is changed into a new artifact and later this new artifact is deleted, the installer will not revert to the template. Without this property, the installer would install the original artifact again. For example: if a configuration is installed and then changed through configuration admin, a new artifact for the new configuration is created and managed. If now this configuration is deleted through configuration admin and the original configuration is not marked as a template, the original configuration is applied: the delete through config admin is not a remove of the configuration but a revert to the initial version. If the initial configuration is marked as template with this property, the removal of the changed configuration results in a real removal.

Since: 3.2.0

### DEFAULT_PRIORITY
`public static final int DEFAULT_PRIORITY`
Default resource priority.
```

--------------------------------

### InfoProvider.getInstallationState()

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/installer/api/info/class-use/InstallationState.html

Retrieves the current installation state of the system.

```APIDOC
## InfoProvider.getInstallationState()

### Description
Return the current installation state.

### Method
N/A (Method signature provided)

### Parameters
None

### Response
- **InstallationState** (InstallationState) - The current installation state.
```

--------------------------------

### installSmap

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/scripting/jsp/jasper/class-use/JspCompilationContext.html

Installs the generated SMAP for the current compilation context.

```APIDOC
## installSmap

### Description
Installs the generated SMAP for the current compilation context.

### Method Signature
`static void installSmap(JspCompilationContext ctxt, String[] smap)`

### Parameters
* **ctxt** (JspCompilationContext) - The compilation context.
* **smap** (String[]) - The SMAP data to install.
```

--------------------------------

### getInstallationState

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/installer/api/info/InfoProvider.html

Retrieves the current installation state of the OSGi installer. The state is a snapshot taken at the time the method is called.

```APIDOC
## getInstallationState

### Description
Return the current installation state. The installation state is a snapshot of the state at method call time.

### Method Signature
InstallationState getInstallationState()

### Returns
- InstallationState: The current installation state.
```

--------------------------------

### InstallationContext.addAsyncTask

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/installer/api/tasks/class-use/InstallTask.html

Adds an asynchronous task for installation. This method is deprecated.

```APIDOC
## InstallationContext.addAsyncTask

### Description
Deprecated. A async task should return `true` for `isAsynchronousTask()` and be added with `InstallationContext.addTaskToCurrentCycle(InstallTask)`.

### Method Signature
`void addAsyncTask(InstallTask t)`
```

--------------------------------

### InstallationContext.addTaskToCurrentCycle

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/installer/api/tasks/class-use/InstallTask.html

Schedules a task for execution in the current installation cycle.

```APIDOC
## InstallationContext.addTaskToCurrentCycle

### Description
Schedule a task for execution in the current cycle.

### Method Signature
`void addTaskToCurrentCycle(InstallTask t)`
```

--------------------------------

### activate

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/discovery/commons/providers/spi/base/OakBacklogClusterSyncService.html

Activates the service, performing necessary setup.

```APIDOC
## activate()

### Description
Activates the OakBacklogClusterSyncService.

### Method
protected void
```

--------------------------------

### InstallationState.getInstalledResources()

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/installer/api/info/class-use/ResourceGroup.html

Retrieves a list of resource groups that have been successfully installed.

```APIDOC
## getInstalledResources()

### Description
Returns a list of `ResourceGroup` objects that have been successfully installed.

### Method
`List<ResourceGroup>`

### Returns
`List<ResourceGroup>` - A list of installed resource groups.
```

--------------------------------

### InstallationContext.asyncTaskFailed

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/installer/api/tasks/class-use/InstallTask.html

Informs the installer about a failed asynchronous task.

```APIDOC
## InstallationContext.asyncTaskFailed

### Description
Inform the installer about a failed async task.

### Method Signature
`void asyncTaskFailed(InstallTask t)`
```

--------------------------------

### InstallationEvent.TYPE Enum Constants

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/installer/api/event/InstallationEvent.TYPE.html

The InstallationEvent.TYPE enum defines constants for different installation event states: PROCESSED, STARTED, and SUSPENDED.

```APIDOC
## Enum Constants

Enum Constant | Description
---|---
`PROCESSED` | Represents a completed installation event.
`STARTED` | Represents the start of an installation process.
`SUSPENDED` | Represents a suspended installation process.
```

--------------------------------

### InstallationEvent.TYPE Enum

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/installer/api/event/package-tree.html

Enumeration of the different types of installation events.

```APIDOC
## Enum: org.apache.sling.installer.api.event.InstallationEvent.TYPE

### Description
Enumeration of the different types of installation events.

### Values

*   **INSTALL**: Indicates a resource has been installed.
*   **UPDATE**: Indicates a resource has been updated.
*   **DELETE**: Indicates a resource has been deleted.
*   **FAILED**: Indicates an installation or update operation failed.
```

--------------------------------

### updateResources

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/installer/api/OsgiInstaller.html

Informs the installer about changes in resources, including new or modified resources available for installation, or resources that should be uninstalled. This method is called when installed resources have been modified, new resources are available, or installed resources should be uninstalled.

```APIDOC
## updateResources

### Description
Inform the installer that resources are available for installation and/or other resources are no longer available.

### Method Signature
`void updateResources(String urlScheme, InstallableResource[] resources, String[] idsToRemove)`

### Parameters
* `urlScheme` (String) - Identifies the client.
* `resources` (InstallableResource[]) - An array of updated/new resources - might be null.
* `idsToRemove` (String[]) - An array of identifiers for removed resources - might be null.

### Notes
This method is called if - installed resources have been modified - new resources are available - installed resources should be uninstalled. Invalid resources are ignored.
```

--------------------------------

### InstallationListener Interface

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/installer/api/event/package-tree.html

A listener interface for receiving notifications about installation events.

```APIDOC
## Interface: org.apache.sling.installer.api.event.InstallationListener

### Description
A listener interface for receiving notifications about installation events.

### Methods

*   **onEvent(InstallationEvent event)**: Called when an installation event occurs. Implementations should process the event.
```

--------------------------------

### StatefulVisitor.visit(Loop.Start loopStart)

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/scripting/sightly/compiler/commands/StatefulVisitor.html

Processes a Loop.Start command.

```APIDOC
## visit(Loop.Start loopStart)

### Description
Processes a Loop.Start command.

### Method
`void visit(Loop.Start loopStart)`
```

--------------------------------

### get

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/scripting/javascript/wrapper/ScriptableNode.html

Gets the value of a JavaScript property or child node.

```APIDOC
## get(String name, org.mozilla.javascript.Scriptable start)

### Description
Gets the value of a (Javascript) property or child node. If there is a single single-value JCR property of this node, return its string value. If there are multiple properties of the same name or child nodes of the same name, return an array.

### Method
`get(String name, org.mozilla.javascript.Scriptable start)`

### Parameters
- **name** (String) - The name of the property or child node.
- **start** (org.mozilla.javascript.Scriptable) - The scope object.

### Returns
- `Object`: The value of the property or child node.
```

--------------------------------

### Get Duration

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/api/request/RequestProgressTracker.html

Get the total duration of the request processing in nanoseconds.

```APIDOC
## getDuration

### Description
Get the duration in nanoseconds for the entire request processing tracked by this instance.

### Method
`default long getDuration()`

### Returns
The duration in nanoseconds.
```

--------------------------------

### addTaskToCurrentCycle

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/installer/api/tasks/InstallationContext.html

Schedules an installation task for execution within the current installation cycle.

```APIDOC
## addTaskToCurrentCycle

### Description
Schedules a task for execution in the current cycle.

### Method
void

### Parameters
* **t** (InstallTask) - The install task to schedule.
```

--------------------------------

### StatefulVisitor.visit(Conditional.Start conditionalStart)

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/scripting/sightly/compiler/commands/StatefulVisitor.html

Processes a Conditional.Start command.

```APIDOC
## visit(Conditional.Start conditionalStart)

### Description
Processes a Conditional.Start command.

### Method
`void visit(Conditional.Start conditionalStart)`
```

--------------------------------

### getInstalledResourceCount

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/installer/api/jmx/InstallerMBean.html

Retrieves the count of resource groups that have been successfully installed and processed by the installer.

```APIDOC
## getInstalledResourceCount

### Description
Count of Installed resource groups. These resources groups are processed.

### Method
`int` getInstalledResourceCount()

### Returns
Get the installed resource count.
```

--------------------------------

### isActive

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/installer/api/jmx/InstallerMBean.html

Indicates whether the installer is currently active and operational.

```APIDOC
## isActive

### Description
Indicates that whether the installer is currently active.

### Method
`boolean` isActive()

### Returns
If the installer is active.
```

--------------------------------

### visit(VariableBinding.Start)

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/scripting/sightly/compiler/commands/AbstractCommandVisitor.html

Processes a VariableBinding.Start command.

```APIDOC
## visit(VariableBinding.Start variableBindingStart)

### Description
Process a `VariableBinding.Start` command.

Specified by:
    `visit` in interface `CommandVisitor` 

### Parameters
* **variableBindingStart** (VariableBinding.Start) - the command
```

--------------------------------

### log

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/installer/api/tasks/InstallationContext.html

Logs a message to the audit log, indicating installation events such as installations, updates, or deletions.

```APIDOC
## log

### Description
Make an entry into the audit log - this should be invoked by the tasks whenever something has been installed/uninstalled etc.

### Method
void

### Parameters
* **message** (String) - The message to log
* **args** (Object...) - Arguments for the message.
```

--------------------------------

### VariableBinding.Start Constructor

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/scripting/sightly/compiler/commands/VariableBinding.Start.html

Initializes a new instance of the VariableBinding.Start class.

```APIDOC
## Start

public Start(String variableName, ExpressionNode expression)

### Description
Initializes a new instance of the `Start` class.

### Parameters
* **variableName** (String) - The name of the variable to bind.
* **expression** (ExpressionNode) - The expression node representing the value to bind.
```

--------------------------------

### StatefulVisitor.visit(Procedure.Start startProcedure)

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/scripting/sightly/compiler/commands/StatefulVisitor.html

Processes a Procedure.Start command.

```APIDOC
## visit(Procedure.Start startProcedure)

### Description
Processes a Procedure.Start command.

### Method
`void visit(Procedure.Start startProcedure)`
```

--------------------------------

### doGet

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/jcr/jackrabbit/accessmanager/post/AbstractAccessGetServlet.html

Handles HTTP GET requests. This method is called by SlingJakartaSafeMethodsServlet.mayService to process incoming GET requests.

```APIDOC
## doGet

### Description
Called by the `SlingJakartaSafeMethodsServlet.mayService(SlingJakartaHttpServletRequest, SlingJakartaHttpServletResponse)` method to handle an HTTP _GET_ request.

### Method
protected void

### Signature
`doGet(SlingJakartaHttpServletRequest request, SlingJakartaHttpServletResponse response)`
```

--------------------------------

### Loop.Start Methods

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/scripting/sightly/compiler/commands/Loop.Start.html

Details the methods available for the Loop.Start command.

```APIDOC
## getListVariable Method

### Description
Retrieves the name of the variable used to represent the list in the loop.

### Returns
* **String** - The name of the list variable.
```

```APIDOC
## getItemVariable Method

### Description
Retrieves the name of the variable used to represent the current item in the loop.

### Returns
* **String** - The name of the item variable.
```

```APIDOC
## getIndexVariable Method

### Description
Retrieves the name of the variable used to represent the index of the current item in the loop.

### Returns
* **String** - The name of the index variable.
```

```APIDOC
## getBeginVariable Method

### Description
Retrieves the name of the variable used to represent the starting point of the loop.

### Returns
* **String** - The name of the begin variable.
```

```APIDOC
## getStepVariable Method

### Description
Retrieves the name of the variable used to represent the step or increment of the loop.

### Returns
* **String** - The name of the step variable.
```

```APIDOC
## getEndVariable Method

### Description
Retrieves the name of the variable used to represent the ending point of the loop.

### Returns
* **String** - The name of the end variable.
```

```APIDOC
## accept Method

### Description
Accepts a visitor to process this command. This method is part of the Command pattern implementation.

### Parameters
* **visitor** (`CommandVisitor`) - The visitor that will process this command.

### Returns
* **void**
```

```APIDOC
## toString Method

### Description
Returns a string representation of the `Loop.Start` command.

### Returns
* **String** - A string representation of the command.
```

--------------------------------

### requireItemPathPrefix

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/servlets/post/AbstractPostOperation.html

Returns true if any of the request parameters starts with `./`. In this case only parameters starting with either of the prefixes `./`, `../` and `/` are considered as providing content to be stored. Otherwise all parameters not starting with the command prefix `:` are considered as parameters to be stored.

```APIDOC
## requireItemPathPrefix

### Description
Returns true if any of the request parameters starts with `./`. In this case only parameters starting with either of the prefixes `./`, `../` and `/` are considered as providing content to be stored. Otherwise all parameters not starting with the command prefix `:` are considered as parameters to be stored.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
* `request` - The http request

### Returns
If a prefix is required.
```

--------------------------------

### InstallTask.compareTo

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/installer/api/tasks/class-use/InstallTask.html

Compares this InstallTask with another InstallTask for order. Comparisons are based on the sort key obtained from getSortKey().

```APIDOC
## InstallTask.compareTo

### Description
All comparisons are based on getSortKey().

### Method Signature
`final int compareTo(InstallTask o)`
```

--------------------------------

### asyncTaskFailed

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/installer/api/tasks/InstallationContext.html

Informs the installer that an asynchronous task has failed, triggering an OSGi installer restart and removing the async task attribute.

```APIDOC
## asyncTaskFailed

### Description
Inform the installer about a failed async task. This will restart the OSGi installer. This will also remove the `InstallTask.ASYNC_ATTR_NAME` attribute from the resource.

### Method
void

### Parameters
* **t** (InstallTask) - The install task that failed.
```

--------------------------------

### addTaskToNextCycle

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/installer/api/tasks/InstallationContext.html

Schedules an installation task for execution in the next installation cycle. This is typically used for retries or sequential task execution.

```APIDOC
## addTaskToNextCycle

### Description
Deprecated. Schedules a task for execution in the next cycle, usually to indicate that a task must be retried or the current task is finished and another task has to be run.

### Method
void

### Parameters
* **t** (InstallTask) - The install task to schedule.
```

--------------------------------

### StatefulVisitor.initializeWith(CommandVisitor initialState)

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/scripting/sightly/compiler/commands/StatefulVisitor.html

Initializes the visitor with a given initial state.

```APIDOC
## initializeWith(CommandVisitor initialState)

### Description
Initializes the visitor with a given initial state.

### Method
`void initializeWith(CommandVisitor initialState)`

### Parameters
#### Path Parameters
- **initialState** (CommandVisitor) - Description not provided
```

--------------------------------

### InstallationEvent Interface

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/installer/api/event/package-tree.html

Represents an event during the Sling installation process. It provides information about the type of installation event and the resource(s) affected.

```APIDOC
## Interface: org.apache.sling.installer.api.event.InstallationEvent

### Description
Represents an event during the Sling installation process. It provides information about the type of installation event and the resource(s) affected.

### Methods

*   **getType()**: Returns the type of the installation event.
*   **getSubject()**: Returns the subject of the event, typically the resource path.
*   **getException()**: Returns any exception associated with the event, if applicable.
```

--------------------------------

### Constructor

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/discovery/commons/providers/DefaultInstanceDescription.html

Initializes a new DefaultInstanceDescription.

```APIDOC
## Constructor DefaultInstanceDescription
public DefaultInstanceDescription(DefaultClusterView clusterView, boolean isLeader, boolean isOwn, String slingId, Map<String,String> properties)

### Parameters
* `clusterView` (DefaultClusterView) - The cluster view this instance belongs to.
* `isLeader` (boolean) - Indicates if this instance is the leader.
* `isOwn` (boolean) - Indicates if this is the local instance.
* `slingId` (String) - The unique identifier for the Sling instance.
* `properties` (Map<String,String>) - A map of properties associated with the instance.
```

--------------------------------

### resourceRemoved

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/installer/api/ResourceChangeListener.html

Inform the installer about a removed resource. This method is called when a resource is removed outside of the installer's direct management.

```APIDOC
## resourceRemoved

### Description
Inform the installer about a removed resource.

### Method Signature
`void resourceRemoved(String resourceType, String entityId)`

### Parameters
* `resourceType` (String) - The resource type.
* `entityId` (String) - The entity id (symbolic name etc.).
```

--------------------------------

### Procedure.Start Methods

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/scripting/sightly/compiler/commands/Procedure.Start.html

Provides methods to interact with the Procedure.Start command.

```APIDOC
## Procedure.Start Methods

### getName

#### Description
Gets the name of the procedure.

#### Signature
`public String getName()`

### getParameters

#### Description
Gets the parameters of the procedure.

#### Signature
`public Set<String> getParameters()`

### accept

#### Description
Accepts a visitor to process this command.

#### Signature
`public void accept(CommandVisitor visitor)`

#### Parameters
* **visitor** (CommandVisitor) - The visitor that will process this command.
```

--------------------------------

### InstallableResource Methods

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/installer/api/InstallableResource.html

Provides methods to retrieve information about the installable resource, such as its dictionary, digest, ID, input stream, priority, and type.

```APIDOC
## getDictionary()

### Description
Return this resource's dictionary.

### Returns
- Dictionary<String,Object> - The dictionary associated with the resource.
```

```APIDOC
## getDigest()

### Description
Return this resource's digest.

### Returns
- String - The digest of the resource.
```

```APIDOC
## getId()

### Description
Return this data's id.

### Returns
- String - The ID of the resource.
```

```APIDOC
## getInputStream()

### Description
Return an input stream with the data of this resource.

### Returns
- InputStream - An input stream to the resource data.
```

```APIDOC
## getPriority()

### Description
Return the priority of this resource.

### Returns
- int - The priority of the resource.
```

```APIDOC
## getType()

### Description
Return the type of this resource.

### Returns
- String - The type of the resource.
```

```APIDOC
## toString()

### Description
Returns a string representation of the InstallableResource.

### Returns
- String - A string representation of the object.
```

--------------------------------

### resourceAddedOrUpdated

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/installer/api/ResourceChangeListener.html

Inform the installer about an added or updated resource. This method is called when a resource is added or modified outside of the installer's direct management.

```APIDOC
## resourceAddedOrUpdated

### Description
Inform the installer about an added or updated resource.

### Method Signature
`void resourceAddedOrUpdated(String resourceType, String entityId, InputStream is, Dictionary<String,Object> dict, Map<String,Object> attributes)`

### Parameters
* `resourceType` (String) - The resource type.
* `entityId` (String) - The entity id (symbolic name etc.).
* `is` (InputStream) - Input stream of the resource.
* `dict` (Dictionary<String,Object>) - Dictionary of resource properties.
* `attributes` (Map<String,Object>) - Map of additional attributes.
```

--------------------------------

### AbstractAccessGetServlet doGet

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/jcr/jackrabbit/accessmanager/post/AbstractAccessGetServlet.html

Handles HTTP GET requests for access management. Implementations should override this method to provide specific GET request handling.

```APIDOC
## doGet

### Description
Called by the `SlingJakartaSafeMethodsServlet.mayService(SlingJakartaHttpServletRequest, SlingJakartaHttpServletResponse)` method to handle an HTTP _GET_ request. This default implementation reports back to the client that the method is not supported. Implementations of this class should overwrite this method with their implementation for the HTTP _GET_ method support.

### Method
protected void

### Parameters
- **request** (SlingJakartaHttpServletRequest) - The HTTP request
- **response** (SlingJakartaHttpServletResponse) - The HTTP response

### Throws
- `jakarta.servlet.ServletException` - Not thrown by this implementation.
- `IOException` - If the error status cannot be reported back to the client.
```

--------------------------------

### visit(Procedure.Start)

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/scripting/sightly/compiler/commands/AbstractCommandVisitor.html

Processes a Procedure.Start command.

```APIDOC
## visit(Procedure.Start startProcedure)

### Description
Process a `Procedure.Start` command.

Specified by:
    `visit` in interface `CommandVisitor` 

### Parameters
* **startProcedure** (Procedure.Start) - the command
```

--------------------------------

### Loop.Start Constructors

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/scripting/sightly/compiler/commands/Loop.Start.html

Details the constructors available for the Loop.Start command.

```APIDOC
## Start Constructor

### Description
Initializes a new instance of the `Loop.Start` class with list, item, and index variables.

### Parameters
* **listVariable** (String) - The variable representing the list to iterate over.
* **itemVariable** (String) - The variable representing the current item in the iteration.
* **indexVariable** (String) - The variable representing the index of the current item.

## Start Constructor

### Description
Initializes a new instance of the `Loop.Start` class with list, item, index, begin, step, and end variables, allowing for more control over the loop's range and increment.

### Parameters
* **listVariable** (String) - The variable representing the list to iterate over.
* **itemVariable** (String) - The variable representing the current item in the iteration.
* **indexVariable** (String) - The variable representing the index of the current item.
* **beginVariable** (String) - The variable representing the starting point of the loop.
* **stepVariable** (String) - The variable representing the increment step of the loop.
* **endVariable** (String) - The variable representing the ending point of the loop.
```

--------------------------------

### InstallationState Methods

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/installer/api/info/InstallationState.html

This snippet details the methods available on the InstallationState interface to retrieve different states of installed resources.

```APIDOC
## getActiveResources

### Description
Retrieves a list of resource groups that are currently being processed by the installer.

### Method
`List<ResourceGroup> getActiveResources()`

### Returns
- `List<ResourceGroup>`: All active resource groups.

## getInstalledResources

### Description
Retrieves a list of resource groups that have been successfully processed and installed.

### Method
`List<ResourceGroup> getInstalledResources()`

### Returns
- `List<ResourceGroup>`: All installed resource groups.

## getUntransformedResources

### Description
Retrieves a list of all resources that have not yet been transformed by the installer.

### Method
`List<RegisteredResource> getUntransformedResources()`

### Returns
- `List<RegisteredResource>`: All untransformed resources.
```

--------------------------------

### Get Effective ACL

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/jcr/jackrabbit/accessmanager/post/GetEffectiveAclServlet.html

Retrieves the effective ACL for a resource. This endpoint is accessible via a GET request to the resource's path appended with '.acl.json'.

```APIDOC
## GET /<resource>.acl.json

### Description
Gets the effective access control list for a resource. Provided the user has access to the ACL, they get a chunk of JSON representing the ACL.

### Method
GET

### Endpoint
/<resource>.acl.json

### Response
#### Success Response (200)
Returns a JSON object representing the effective ACL. The structure includes principal names as keys, each containing a 'permissions' object detailing the allow/deny status for various permissions and their associated restrictions.

#### Response Example
```json
{
  "principalNameA":{
    "permissions": {
      "permission1":{
        "allow":true
      },
      "permission2":{
        "allow":true
      },
      "permission5":{
        "deny":true
      }
    }
  },
  "principalNameB":{
    "permissions": {
      "permission1":{
        "allow":true
      },
      "permission2":{
        "allow":[
          "restrictionName1: restrictionValue1",
          "restrictionName2: [
            "restrictionValue2a",
            "restrictionValue2b"
          ]"
        ]
      },
      "permission5":{
        "deny":true
      }
    }
  }
}
```

#### Error Response
- **404** The resource was not found.
- **500** Failure. HTML explains the failure.
```

--------------------------------

### Creating a SlingUriBuilder

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/api/uri/SlingUriBuilder.html

Demonstrates how to create a new SlingUriBuilder instance.

```APIDOC
## create()

### Description
Creates a builder without any URI parameters set.

### Method
`static SlingUriBuilder create()`

### Returns
A new `SlingUriBuilder` instance.
```

--------------------------------

### Media Range String Examples

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/api/request/header/MediaRangeList.html

Examples of valid string formats for media ranges used in constructing a MediaRangeList. These follow RFC specifications for quality values and parameters.

```text
text/*;q=0.3, text/html;q=0.7, text/html;level=1, text/html;level=2;q=0.4, */*;q=0.5
```

```text
text/html;q=0.8, application/json
```

--------------------------------

### OsgiInstaller.updateResources

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/installer/api/class-use/InstallableResource.html

This method informs the installer that resources are available for installation and/or other resources are no longer available. It accepts a URL scheme, an array of InstallableResource objects, and an array of resource IDs to remove.

```APIDOC
## updateResources(String urlScheme, InstallableResource[] resources, String[] idsToRemove)

### Description
Inform the installer that resources are available for installation and/or other resources are no longer available.

### Method Signature
`void updateResources(String urlScheme, InstallableResource[] resources, String[] idsToRemove)`

### Parameters
* **urlScheme** (String) - The scheme for the resources.
* **resources** (InstallableResource[]) - An array of installable resources to add or update.
* **idsToRemove** (String[]) - An array of resource IDs to remove.
```

--------------------------------

### InstallationState Interface

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/installer/api/info/package-summary.html

Represents the state of the OSGi installer at a given time.

```APIDOC
## Interface InstallationState

### Description
The state of the OSGi installer at a given time.

### Methods
* `isBusy()`: Returns true if the installer is currently busy processing changes.
* `getProcessingMessage()`: Returns a message describing the current processing activity.
```

--------------------------------

### getRequest

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/scripting/jsp/jasper/runtime/JspContextWrapper.html

Gets the ServletRequest object.

```APIDOC
## getRequest
public javax.servlet.ServletRequest getRequest()

Specified by:
`getRequest` in class `javax.servlet.jsp.PageContext`
```

--------------------------------

### BundleFileProcessor Constructor

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/commons/osgi/BundleFileProcessor.html

Initializes a new BundleFileProcessor with the input bundle file and the output folder.

```APIDOC
## BundleFileProcessor Constructor

### Description
Initializes a new instance of the `BundleFileProcessor` class.

### Signature
`public BundleFileProcessor(File input, File outputFolder)`

### Parameters
* **input** (File) - The input bundle file.
* **outputFolder** (File) - The folder where the processed bundle will be saved.
```

--------------------------------

### getPage

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/scripting/jsp/jasper/runtime/JspContextWrapper.html

Gets the page object.

```APIDOC
## getPage
public Object getPage()

Specified by:
`getPage` in class `javax.servlet.jsp.PageContext`
```

--------------------------------

### UseProvider.provide Method

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/scripting/sightly/use/class-use/ProviderOutcome.html

Provides an instance based on the given identifier and render context.

```APIDOC
## UseProvider.provide(String identifier, RenderContext renderContext, Bindings arguments)

### Description
Provides an instance based on the given identifier, render context, and arguments.

### Method
ProviderOutcome

### Parameters
* **identifier** (String) - The identifier for the instance to provide.
* **renderContext** (RenderContext) - The render context.
* **arguments** (Bindings) - The arguments for the instance.
```

--------------------------------

### getVariableResolver

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/scripting/jsp/jasper/runtime/JspContextWrapper.html

Gets the VariableResolver for this JspContextWrapper.

```APIDOC
## getVariableResolver()

### Description
Gets the VariableResolver for this JspContextWrapper.

### Method
getVariableResolver

### Returns
* **javax.servlet.jsp.el.VariableResolver** - The VariableResolver.
```

--------------------------------

### getOut

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/scripting/jsp/jasper/runtime/JspContextWrapper.html

Gets the JspWriter for this JspContextWrapper.

```APIDOC
## getOut()

### Description
Gets the JspWriter associated with this JspContextWrapper.

### Method
getOut

### Returns
* **javax.servlet.jsp.JspWriter** - The JspWriter.
```

--------------------------------

### initializeWith

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/scripting/sightly/compiler/commands/StatefulVisitor.html

Initializes the visitor with a given initial state.

```APIDOC
## initializeWith

### Description
Initializes the visitor with a given initial state.

### Method
`public void initializeWith(CommandVisitor initialState)`

### Parameters
#### Path Parameters
- **initialState** (CommandVisitor) - The initial state to set for the visitor.
```

--------------------------------

### Constructor

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/jcr/base/AbstractSlingRepository2.html

Initializes a new instance of the AbstractSlingRepository2 class.

```APIDOC
## Constructor

### Description
Sets up this abstract SlingRepository implementation.

### Signature
`protected AbstractSlingRepository2(AbstractSlingRepositoryManager manager, org.osgi.framework.Bundle usingBundle)`
```

--------------------------------

### getExpressionEvaluator

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/scripting/jsp/jasper/runtime/JspContextWrapper.html

Gets the ExpressionEvaluator for this JspContextWrapper.

```APIDOC
## getExpressionEvaluator()

### Description
Gets the ExpressionEvaluator for this JspContextWrapper.

### Method
getExpressionEvaluator

### Returns
* **javax.servlet.jsp.el.ExpressionEvaluator** - The ExpressionEvaluator.
```

--------------------------------

### InstallableResource Constructor

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/installer/api/InstallableResource.html

Creates a new InstallableResource object. This constructor takes all necessary information to define a resource for installation, including its ID, input stream, dictionary of properties, digest, type, and priority.

```APIDOC
## InstallableResource Constructor

### Description
Creates a data object - this is a simple constructor just using the values as they are provided.

### Method Signature
`public InstallableResource(String id, InputStream is, Dictionary<String,Object> dict, String digest, String type, Integer priority)`

### Parameters
* `id` (String) - Unique id for the resource. For auto detection of the resource type, the id should contain an extension like .jar, .cfg etc.
* `is` (InputStream) - The input stream to the data.
* `dict` (Dictionary<String,Object>) - A dictionary with data.
* `digest` (String) - A digest of the data - providers should make sure to set a digest. Calculating a digest by the installer can be very expensive for input streams.
* `type` (String) - The resource type if known, otherwise `TYPE_PROPERTIES` or `TYPE_FILE`.
* `priority` (Integer) - Optional priority - if not specified `DEFAULT_PRIORITY` is used.

### Throws
* `IllegalArgumentException` - if something is wrong
```

--------------------------------

### getAttribute

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/scripting/jsp/jasper/runtime/JspContextWrapper.html

Gets an attribute from the JspContextWrapper.

```APIDOC
## getAttribute(String name)

### Description
Gets an attribute from the JspContextWrapper without specifying a scope.

### Method
getAttribute

### Parameters
* **name** (String) - The name of the attribute.

### Returns
* **Object** - The attribute value.
```

```APIDOC
## getAttribute(String name, int scope)

### Description
Gets an attribute from the JspContextWrapper within a specified scope.

### Method
getAttribute

### Parameters
* **name** (String) - The name of the attribute.
* **scope** (int) - The scope in which to look for the attribute.

### Returns
* **Object** - The attribute value.
```

--------------------------------

### InstallTask Class

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/installer/api/tasks/InstallTask.html

The InstallTask abstract class is the base for tasks executed by the OsgiInstaller. It defines methods for task execution, state management, and sorting.

```APIDOC
## Class: InstallTask

### Description
Base class for tasks that can be executed by the `OsgiInstaller`. The task is invoked by the installer through the `execute(InstallationContext)` method. During execution the task should use the `setFinishedState(ResourceState)` or `setFinishedState(ResourceState, String)` method once the task is performed or the task decided that the task can never be performed. If the task needs to be retried, the implementation should just not alter the state at all. The installer will invoke the tasks at a later time again for retrying.

### Implements
`Comparable<InstallTask>`

### Known Subclasses
`ChangeStateTask`

### Constructor
#### `InstallTask(TaskResourceGroup erl)`
Constructor for the task.

### Methods
#### `execute(InstallationContext ctx)`
This is the heart of the task - it performs the actual task.

#### `getResource()`
Return the corresponding resource - depending on the task this might be null.

#### `getResourceGroup()`
Return the corresponding resource - depending on the task this might be null.

#### `getSortKey()`
Tasks are sorted according to this key.

#### `isAsynchronousTask()`
If this an asynchronous task it should return `true`. The OSGi installer will set the attribute `ASYNC_ATTR_NAME` with an integer value.

#### `setFinishedState(ResourceState state)`
Set the finished state for the resource.

#### `setFinishedState(ResourceState state, String alias)`
Set the finished state for the resource and the alias.

#### `setFinishedState(ResourceState state, String alias, String error)`
Set the finish state for the active resource and alias (may be null).

#### `compareTo(InstallTask o)`
All comparisons are based on getSortKey().

#### `equals(Object o)`

#### `hashCode()`

#### `toString()`

```

--------------------------------

### getExpressionFactory

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/scripting/jsp/jasper/runtime/JspApplicationContextImpl.html

Gets the ExpressionFactory for this JspApplicationContext.

```APIDOC
## getExpressionFactory

### Description
Returns the ExpressionFactory associated with this JspApplicationContext. The ExpressionFactory is used to parse and evaluate EL expressions.

### Method Signature
`public javax.el.ExpressionFactory getExpressionFactory()`
```

--------------------------------

### visit(Loop.Start)

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/scripting/sightly/compiler/commands/AbstractCommandVisitor.html

Processes a Loop.Start command.

```APIDOC
## visit(Loop.Start loopStart)

### Description
Process a `Loop.Start` command.

Specified by:
    `visit` in interface `CommandVisitor` 

### Parameters
* **loopStart** (Loop.Start) - the command
```

--------------------------------

### getCachedScripts

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/commons/fsclassloader/FSClassLoaderMBean.html

Gets the scripts in the FSClassLoaderCache.

```APIDOC
## getCachedScripts

### Description
Gets the scripts in the FSClassLoaderCache.

### Method
List<String> getCachedScripts() throws IOException

### Returns
the scripts from the FSClassLoaderCache

### Throws
`IOException`

```

--------------------------------

### getStartLevel

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/provisioning/model/ArtifactGroup.html

Retrieves the start level of the ArtifactGroup.

```APIDOC
## getStartLevel()

### Description
Get the start level.

### Returns
- **int** - The start level.
```

--------------------------------

### Conditional.Start Constructor

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/scripting/sightly/compiler/commands/Conditional.Start.html

Initializes a new instance of the Conditional.Start command.

```APIDOC
## Start(String variable, boolean expectedTruthValue)

### Description
Constructs a new Conditional.Start command.

### Parameters
* **variable** (String) - The variable to check.
* **expectedTruthValue** (boolean) - The expected truth value of the variable.
```

--------------------------------

### getSession

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/scripting/jsp/jasper/runtime/JspContextWrapper.html

Gets the HttpSession associated with this request.

```APIDOC
## getSession
public javax.servlet.http.HttpSession getSession()

Specified by:
`getSession` in class `javax.servlet.jsp.PageContext`
```

--------------------------------

### getSession

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/scripting/jsp/jasper/runtime/JspContextWrapper.html

Gets the HttpSession associated with this JspContextWrapper.

```APIDOC
## getSession()

### Description
Gets the HttpSession associated with this JspContextWrapper.

### Method
getSession

### Returns
* **javax.servlet.http.HttpSession** - The HttpSession.
```

--------------------------------

### visit(Conditional.Start)

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/scripting/sightly/compiler/commands/AbstractCommandVisitor.html

Processes a Conditional.Start command.

```APIDOC
## visit(Conditional.Start conditionalStart)

### Description
Process a `Conditional.Start` command.

Specified by:
    `visit` in interface `CommandVisitor` 

### Parameters
* **conditionalStart** (Conditional.Start) - the command
```

--------------------------------

### getServletContext

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/scripting/jsp/jasper/runtime/JspContextWrapper.html

Gets the ServletContext associated with this JspContextWrapper.

```APIDOC
## getServletContext()

### Description
Gets the ServletContext associated with this JspContextWrapper.

### Method
getServletContext

### Returns
* **javax.servlet.ServletContext** - The ServletContext.
```

--------------------------------

### Creating a ConfigurationSerializer

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/installer/api/serializer/class-use/ConfigurationSerializerFactory.Format.html

Demonstrates how to create a ConfigurationSerializer instance for a specific format.

```APIDOC
## ConfigurationSerializerFactory.create

### Description
Creates a `ConfigurationSerializer` for the specified format.

### Method Signature
`static @NotNull ConfigurationSerializer create(@NotNull ConfigurationSerializerFactory.Format format)`

### Parameters
* **format** (`ConfigurationSerializerFactory.Format`) - Required - The desired serialization format.
```

--------------------------------

### getServletConfig

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/scripting/jsp/jasper/runtime/JspContextWrapper.html

Gets the ServletConfig associated with this JspContextWrapper.

```APIDOC
## getServletConfig()

### Description
Gets the ServletConfig associated with this JspContextWrapper.

### Method
getServletConfig

### Returns
* **javax.servlet.ServletConfig** - The ServletConfig.
```

--------------------------------

### InstallableResource Constructor

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/installer/api/InstallableResource.html

Creates an InstallableResource object with the provided details. This is a simple constructor that uses the values as they are given.

```APIDOC
## InstallableResource(String id, InputStream is, Dictionary<String,Object> dict, String digest, String type, Integer priority)

### Description
Creates a data object - this is a simple constructor just using the values as they are provided.

### Parameters
#### Path Parameters
- **id** (String) - Description of the id parameter
- **is** (InputStream) - Description of the is parameter
- **dict** (Dictionary<String,Object>) - Description of the dict parameter
- **digest** (String) - Description of the digest parameter
- **type** (String) - Description of the type parameter
- **priority** (Integer) - Description of the priority parameter
```

--------------------------------

### getResponse

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/scripting/jsp/jasper/runtime/JspContextWrapper.html

Gets the ServletResponse associated with this JspContextWrapper.

```APIDOC
## getResponse()

### Description
Gets the ServletResponse associated with this JspContextWrapper.

### Method
getResponse

### Returns
* **javax.servlet.ServletResponse** - The ServletResponse.
```

--------------------------------

### getRequest

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/scripting/jsp/jasper/runtime/JspContextWrapper.html

Gets the ServletRequest associated with this JspContextWrapper.

```APIDOC
## getRequest()

### Description
Gets the ServletRequest associated with this JspContextWrapper.

### Method
getRequest

### Returns
* **javax.servlet.ServletRequest** - The ServletRequest.
```

--------------------------------

### getELContext

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/scripting/jsp/jasper/runtime/JspContextWrapper.html

Gets the ELContext associated with this JspContextWrapper.

```APIDOC
## getELContext()

### Description
Gets the ELContext associated with this JspContextWrapper.

### Method
getELContext

### Returns
* **javax.el.ELContext** - The ELContext.
```

--------------------------------

### Constructor Details

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/commons/threads/ModifiableThreadPoolConfig.html

Provides details on how to create new thread pool configurations.

```APIDOC
## Constructor Details

### ModifiableThreadPoolConfig

```java
public ModifiableThreadPoolConfig()
```

Create a new default configuration.

### ModifiableThreadPoolConfig

```java
public ModifiableThreadPoolConfig(ThreadPoolConfig copy)
```

Clone an existing configuration.

Parameters:
* `copy` - The config to clone
```

--------------------------------

### getAttributesScope

Source: https://sling.apache.org/apidocs/sling14/org/apache/sling/scripting/jsp/jasper/runtime/JspContextWrapper.html

Gets the scope of a named attribute.

```APIDOC
## getAttributesScope(String name)

### Description
Gets the scope of the attribute with the given name.

### Method
getAttributesScope

### Parameters
* **name** (String) - The name of the attribute.

### Returns
* **int** - The scope of the attribute.
```
Tokens:
Raw