Apache Sling

https://sling.apache.org/apidocs/sling13/
Admin
Apache Sling is an innovative REST-based web framework that uses Java Content Repositories to store...
Tokens:1,503,277
Snippets:9,515
Trust Score:10
Update:8 months ago
Show doc for...
Tokens:
Raw
### Mark Bundle Start using TaskResource (Java)

Source: https://sling.apache.org/apidocs/sling13/org/apache/sling/installer/api/tasks/class-use/TaskResource

Marks a bundle associated with a TaskResource for starting. This is a static utility method in org.apache.sling.installer.core.impl.tasks.BundleUtil.

```java
static void BundleUtil.markBundleStart(TaskResource rsrc)
```

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

### OSGi Installer API - Register Resources

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

Provides the OSGi installer with a complete list of installable resources for a given client. This method should be called at startup or when the installer service becomes available.

```APIDOC
## POST /registerResources

### Description
Provides the installer with the complete list of installable resources for a given client. 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.

### Method
POST

### Endpoint
/registerResources

### Parameters
#### Query Parameters
- **urlScheme** (String) - Required - Identifies the client.

#### Request Body
- **resources** (InstallableResource[]) - Required - The list of available resources.

### Request Example
```json
{
  "resources": [
    {
      "resourceType": "bundle",
      "data": "base64EncodedBundleData",
      "name": "my-bundle.jar",
      "version": "1.0.0"
    }
  ]
}
```

### Response
#### Success Response (200)
- **status** (String) - Indicates the success of the operation.

#### Response Example
```json
{
  "status": "Resources registered successfully"
}
```
```

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

### Get OSGi Installer Installation State (Java)

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

Retrieves the current installation state of the OSGi installer. This method returns a snapshot of the state at the time of the method call. It is part of the InfoProvider interface.

```java
/**
 * Return the current installation state.
 * The installation state is a snapshot of the state at method call time.
 *
 * @return The installation state
 */
InstallationState getInstallationState()
```

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

### Installer and Task APIs

Source: https://sling.apache.org/apidocs/sling13/overview-tree

APIs for managing Sling installations, including installable resources and task execution.

```APIDOC
## Installer and Task APIs

### Description
APIs for the Sling installer service, managing the installation and lifecycle of resources and bundles.

### Classes
- `org.apache.sling.installer.api.InstallableResource`
- `org.apache.sling.installer.api.tasks.InstallTask`
- `org.apache.sling.installer.core.impl.AbstractInstallTask`
- `org.apache.sling.installer.core.impl.tasks.AbstractBundleTask`
- `org.apache.sling.installer.core.impl.tasks.BundleInstallTask`
- `org.apache.sling.installer.core.impl.tasks.BundleRemoveTask`
- `org.apache.sling.installer.core.impl.tasks.BundleStartTask`
- `org.apache.sling.installer.core.impl.tasks.BundleUpdateTask`
- `org.apache.sling.installer.core.impl.tasks.RefreshBundlesTask`
- `org.apache.sling.installer.core.impl.tasks.InstallerBundleUpdateTask`
- `org.apache.sling.installer.core.impl.tasks.RestartActiveBundlesTask`
- `org.apache.sling.installer.core.impl.tasks.SystemBundleUpdateTask`
- `org.apache.sling.installer.api.tasks.ChangeStateTask`
```

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

### InstallationState API

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

Provides methods to query the current state of the OSGi installer, including active, installed, and untransformed resources.

```APIDOC
## InstallationState API

### Description
Provides methods to query the current state of the OSGi installer, including active, installed, and untransformed resources.

### Methods

#### getActiveResources

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

##### Method
GET

##### Endpoint
/installation/state/active

##### Response

###### Success Response (200)
- **resourceGroups** (List<ResourceGroup>) - A list of active resource groups.

###### Response Example
```json
{
  "resourceGroups": [
    {
      "id": "group1",
      "resources": ["resourceA", "resourceB"]
    },
    {
      "id": "group2",
      "resources": ["resourceC"]
    }
  ]
}
```

#### getInstalledResources

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

##### Method
GET

##### Endpoint
/installation/state/installed

##### Response

###### Success Response (200)
- **resourceGroups** (List<ResourceGroup>) - A list of installed resource groups.

###### Response Example
```json
{
  "resourceGroups": [
    {
      "id": "group3",
      "resources": ["resourceD", "resourceE"]
    }
  ]
}
```

#### getUntransformedResources

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

##### Method
GET

##### Endpoint
/installation/state/untransformed

##### Response

###### Success Response (200)
- **registeredResources** (List<RegisteredResource>) - A list of untransformed resources.

###### Response Example
```json
{
  "registeredResources": [
    {
      "name": "resourceF",
      "type": "type1"
    },
    {
      "name": "resourceG",
      "type": "type2"
    }
  ]
}
```
```

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

### InstallationEvent and InstallationListener

Source: https://sling.apache.org/apidocs/sling13/org/apache/sling/installer/api/event/package-summary

Provides interfaces for monitoring the activities of the Sling installer. InstallationEvent represents an event during the installation process, and InstallationListener is an optional listener interface to receive these events.

```APIDOC
## InstallationEvent and InstallationListener

### Description
These components allow for monitoring the activities of the Sling installer. `InstallationEvent` signifies an event occurring during the installation process, while `InstallationListener` is an optional interface for receiving these events.

### Method
N/A (These are interfaces, not direct endpoints)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
#### Success Response (N/A)
N/A

#### Response Example
N/A
```

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

### Installation State API

Source: https://sling.apache.org/apidocs/sling13/org/apache/sling/installer/api/info/package-use

Provides information about the current state of the OSGi installer.

```APIDOC
## GET /system/sling/installer/info/installation-state

### Description
Retrieves the current state of the OSGi installer.

### Method
GET

### Endpoint
/system/sling/installer/info/installation-state

### Parameters
#### Query Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **state** (string) - The current installation state (e.g., "INSTALLED", "RESOLVED", "STARTING", "STOPPING", "ACTIVE", "UNINSTALLED").
- **message** (string) - A descriptive message about the current state.

#### Response Example
```json
{
  "state": "ACTIVE",
  "message": "OSGi installer is running normally."
}
```
```

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

### Sling Installer and Scripting Utilities

Source: https://sling.apache.org/apidocs/sling13/overview-tree

Documentation for utilities related to Sling installation tasks and Sightly scripting, including transformation results and tree traversers.

```APIDOC
## Sling Installer and Scripting Utilities

### Description
This section covers utility classes used in Sling's installer framework and Sightly scripting engine, focusing on task results and DOM traversal.

### Key Classes

*   **`org.apache.sling.installer.api.tasks.TransformationResult`**
    *   Represents the result of a transformation task performed by the Sling Installer.

*   **`org.apache.sling.scripting.sightly.impl.html.dom.TreeTraverser`**
    *   A utility class for traversing the Document Object Model (DOM) in the context of Sightly HTML processing.

*   **`org.apache.sling.scripting.jsp.jasper.xmlparser.TreeNode`**
    *   Represents a node in an XML tree structure, used within the Jasper JSP compiler.

*   **`org.apache.sling.scripting.sightly.java.compiler.impl.operator.TypedNode`**
    *   Represents a typed node within the Sightly Java compiler's intermediate representation.

### Usage
`TransformationResult` is used by Sling Installer implementations to report the outcome of applying changes. `TreeTraverser` and `TreeNode` are internal components of the Sightly and Jasper engines, respectively, facilitating the parsing and manipulation of structured data like HTML and XML.
```

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

### org.apache.sling.installer.api.tasks

Source: https://sling.apache.org/apidocs/sling13/org/apache/sling/installer/api/tasks/package-use

This section details the core classes used for defining and managing installation tasks within the Sling OSGi Installer.

```APIDOC
## Package org.apache.sling.installer.api.tasks

### Description
This package contains the core interfaces and classes for defining and executing installation tasks within the Apache Sling OSGi Installer.

### Key Classes

#### Class: InstallationContext

##### Description
Provides the context for the installation tasks, holding information and state relevant to the ongoing installation process.

##### Usage
Instances of `InstallationContext` are passed to `InstallTask` implementations to provide them with the necessary information to perform their operations.

#### Class: InstallTask

##### Description
An abstract base class for all tasks that can be executed by the `OsgiInstaller`. Concrete implementations define the specific actions to be performed during resource installation or modification.

##### Usage
Developers extend this class to create custom installation logic. The `OsgiInstaller` iterates through registered `InstallTaskFactory` instances to create and execute these tasks.

#### Class: RegisteredResource

##### Description
Represents a resource that has been successfully registered in the OSGi controller. It signifies a resource that is known and managed by the system.

##### Usage
Used to track the state and identity of resources being installed or managed.

#### Class: ResourceState

##### Description
Defines the possible states of a resource during the installation process. This helps in managing the lifecycle and status of resources.

##### Usage
`ResourceState` is used internally by the installer to track whether a resource is being processed, has succeeded, or has failed.

#### Class: TaskResource

##### Description
A `TaskResource` is a `RegisteredResource` that has been processed by a `ResourceTransformer` and is now ready to be processed by an `InstallTask`. It encapsulates the resource and any transformations applied to it.

##### Usage
Represents the input to an `InstallTask`, containing the resource data and its transformed state.

#### Class: TaskResourceGroup

##### Description
Represents a group of resources that all refer to the same artifact, potentially across different versions or locations. This is useful for managing related resource artifacts.

##### Usage
Helps in organizing and processing sets of related resources as a single unit.

#### Class: TransformationResult

##### Description
Represents the result of a `ResourceTransformer` operation. It indicates whether a transformation was successful and provides the transformed resource if applicable.

##### Usage
Returned by `ResourceTransformer` implementations to signal the outcome of their transformation process.

#### Class: UpdatableResourceGroup

##### Description
Similar to `TaskResourceGroup`, this class represents a group of resources pointing to the same artifact, designed to facilitate updates or modifications.

##### Usage
Used when managing resources that can be updated or replaced.

```

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

### Installer API

Source: https://sling.apache.org/apidocs/sling13/overview-tree

Provides interfaces and classes for managing OSGi installations and tasks within Apache Sling.

```APIDOC
## Installer API

### Description
This section details the core interfaces for the Sling Installer, enabling programmatic installation and management of resources and tasks within the OSGi environment.

### Endpoints
N/A (This is an API interface documentation, not a REST API)

### Key Interfaces

*   **org.apache.sling.installer.api.jmx.InstallerMBean**
    *   Provides JMX access to the Sling Installer.
*   **org.apache.sling.installer.api.tasks.InstallTaskFactory**
    *   Factory for creating installation tasks.
*   **org.apache.sling.installer.api.OsgiInstaller**
    *   The main interface for the OSGi installer.
*   **org.apache.sling.installer.api.tasks.RegisteredResource**
    *   Represents a resource registered with the installer.
    *   **org.apache.sling.installer.api.info.Resource**
        *   Information about an installer resource.
    *   **org.apache.sling.installer.api.tasks.TaskResource**
        *   A resource specifically for installation tasks.

```

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

### Installer and Event APIs

Source: https://sling.apache.org/apidocs/sling13/overview-tree

APIs for the Sling Installer service, including tasks, events, and state management.

```APIDOC
## Sling Installer APIs

### Description
This section details the APIs for the Apache Sling Installer service, which manages the installation and lifecycle of various Sling resources and configurations.

### Endpoints

- **org.apache.sling.installer.api.tasks.InstallationContext**: Context for installation tasks.
- **org.apache.sling.installer.api.event.InstallationEvent**: Event related to installation.
- **org.apache.sling.installer.api.event.InstallationListener**: Listener for installation events.
- **org.apache.sling.installer.api.info.InstallationState**: Represents the state of an installation.
- **org.apache.sling.installer.api.info.InfoProvider**: SPI for providing installation information.

### Parameters

Parameters for these APIs include installation context, event details, and information about installed artifacts.
```

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

### Installable Resource Constants

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

Defines constants for different resource types and installation hints used within the Apache Sling framework.

```APIDOC
## Field Details

### 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

See Also:
    * Constant Field Values

### 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

See Also:
    * Constant Field Values

### 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.

See Also:
    * Constant Field Values

### 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.

See Also:
    * Constant Field Values

### 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.

See Also:
    * Constant Field Values

### 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

See Also:
    * Constant Field Values

### 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

See Also:
    * Constant Field Values

### 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

See Also:
    * Constant Field Values

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

See Also:
    * Constant Field Values
```

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

### InstallationListener Interface

Source: https://sling.apache.org/apidocs/sling13/org/apache/sling/installer/api/event/InstallationListener

The InstallationListener interface provides a callback method to receive installation events.

```APIDOC
## Interface InstallationListener

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

Since: 1.0

### Methods

#### Instance Methods

##### `onEvent`

void onEvent(InstallationEvent event)

Receive an installation event.

**Parameters:**
- `event` (InstallationEvent) - The installation event.
```

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

### InstallationContext API

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

This section details the methods available within the InstallationContext for managing installation tasks and logging.

```APIDOC
## InstallationContext API

### Description
Provides context for installation tasks. Tasks can schedule other tasks, access an audit log, and manage asynchronous task execution.

### Methods

#### `addTaskToCurrentCycle(InstallTask t)`

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

##### Method
POST

##### Endpoint
`/installation/context/currentCycle`

##### Parameters

###### Request Body
- **t** (InstallTask) - Required - The install task to schedule.

##### Request Example
```json
{
  "t": {
    "type": "InstallTask",
    "description": "Example Install Task"
  }
}
```

##### Response

###### Success Response (200)
- **status** (string) - Indicates success or failure of the operation.

###### Response Example
```json
{
  "status": "Task scheduled successfully"
}
```

#### `addTaskToNextCycle(InstallTask t)`

##### Description
Schedules a task for execution in the next cycle. This is typically used for retries or when a task finishes and another needs to run.

##### Method
POST

##### Endpoint
`/installation/context/nextCycle`

##### Parameters

###### Request Body
- **t** (InstallTask) - Required - The install task to schedule.

##### Request Example
```json
{
  "t": {
    "type": "InstallTask",
    "description": "Example Install Task for next cycle"
  }
}
```

##### Response

###### Success Response (200)
- **status** (string) - Indicates success or failure of the operation.

###### Response Example
```json
{
  "status": "Task scheduled for next cycle"
}
```

#### `log(String message, Object... args)`

##### Description
Makes an entry into the audit log. This should be invoked by tasks whenever something has been installed, uninstalled, etc.

##### Method
POST

##### Endpoint
`/installation/context/log`

##### Parameters

###### Request Body
- **message** (String) - Required - The message to log.
- **args** (Object...) - Optional - Arguments for the message.

##### Request Example
```json
{
  "message": "Installation completed for package X.",
  "args": ["packageX_version1.0"]
}
```

##### Response

###### Success Response (200)
- **status** (string) - Indicates success or failure of the logging operation.

###### Response Example
```json
{
  "status": "Log entry created successfully"
}
```

#### `addAsyncTask(InstallTask t)`

##### Description
Adds a task for asynchronous execution. Deprecated: A async task should return `true` for `InstallTask.isAsynchronousTask()` and be added with `addTaskToCurrentCycle(InstallTask)`.

##### Method
POST

##### Endpoint
`/installation/context/asyncTask`

##### Parameters

###### Request Body
- **t** (InstallTask) - Required - The install task to add asynchronously.

##### Request Example
```json
{
  "t": {
    "type": "InstallTask",
    "description": "Example Async Task"
  }
}
```

##### Response

###### Success Response (200)
- **status** (string) - Indicates success or failure of the operation.

###### Response Example
```json
{
  "status": "Async task added"
}
```

#### `asyncTaskFailed(InstallTask t)`

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

##### Method
POST

##### Endpoint
`/installation/context/asyncTaskFailed`

##### Parameters

###### Request Body
- **t** (InstallTask) - Required - The install task that failed.

##### Request Example
```json
{
  "t": {
    "type": "InstallTask",
    "description": "Failed Async Task"
  }
}
```

##### Response

###### Success Response (200)
- **status** (string) - Indicates success or failure of the operation.

###### Response Example
```json
{
  "status": "Async task failure reported"
}
```
```

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

### AbstractJobStatistics - Get Start Date

Source: https://sling.apache.org/apidocs/sling13/org/apache/sling/event/impl/jobs/jmx/AbstractJobStatistics

Retrieves the start date of the statistics collection. This method is specified by the org.apache.sling.event.jobs.jmx.StatisticsMBean interface.

```java
public Date getStartDate()

```

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

### AbstractJobStatistics - Get Start Time

Source: https://sling.apache.org/apidocs/sling13/org/apache/sling/event/impl/jobs/jmx/AbstractJobStatistics

Retrieves the start time of the statistics collection. This method is specified by the org.apache.sling.event.jobs.Statistics interface.

```java
public long getStartTime()

```

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

### Get Installed Resource Count Java Method

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

Retrieves the count of installed resource groups that have been processed. This method is part of the InstallerMBean interface.

```java
int getInstalledResourceCount()

// Returns: Get the installed resource count.
```

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

### Installer API Task Handling

Source: https://sling.apache.org/apidocs/sling13/deprecated-list

Guidance on handling asynchronous tasks within the `org.apache.sling.installer.api.tasks.InstallationContext`.

```APIDOC
## Installer API Task Handling

### Description
This section provides instructions on how to correctly add asynchronous tasks using the `InstallationContext` in the Apache Sling Installer API.

### Method
N/A (Information about method usage)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A

#### Task Handling:
- `org.apache.sling.installer.api.tasks.InstallationContext.addAsyncTask(InstallTask)`: An asynchronous task should return `true` for `InstallTask.isAsynchronousTask()` and be added using `InstallationContext.addTaskToCurrentCycle(InstallTask)`.
- `org.apache.sling.installer.api.tasks.InstallationContext.addTaskToNextCycle(InstallTask)`
```

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

### InstallerMBean Java Interface Definition

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

Defines the InstallerMBean interface for managing installer resources. It includes methods to retrieve counts of active and installed resources, check the installer's active status, and get the suspension time.

```java
public interface InstallerMBean {
  int getActiveResourceCount();
  int getInstalledResourceCount();
  long getSuspendedSince();
  boolean isActive();
}
```

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

### Procedure.Start Command Processing in Visitor

Source: https://sling.apache.org/apidocs/sling13/org/apache/sling/scripting/sightly/compiler/commands/class-use/Procedure.Start

This section describes how Procedure.Start is handled by the UniformVisitor within the visitor package, detailing the specific visit method.

```APIDOC
## Uses of Procedure.Start in org.apache.sling.scripting.sightly.impl.compiler.visitor

### Description
Methods in `org.apache.sling.scripting.sightly.impl.compiler.visitor` with parameters of type `Procedure.Start`.

### Method
`void`

### Endpoint
N/A (Internal API)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
None

#### Response Example
None
```

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

### Description
Visits a `Procedure.Start` command using the uniform visitor pattern.

### Method
`void`

### Endpoint
N/A (Internal API)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
None

#### Response Example
None
```

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

### Get Method (Java)

Source: https://sling.apache.org/apidocs/sling13/org/apache/sling/engine/impl/adapter/SlingServletRequestAdapter

Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT. This method is inherited from javax.servlet.http.HttpServletRequest.

```java
public String getMethod()

Specified by:
    getMethod in interface javax.servlet.http.HttpServletRequest 

Overrides:
    getMethod in class javax.servlet.http.HttpServletRequestWrapper
```

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

### StatefulVisitor initializeWith Method (Java)

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

Initializes the StatefulVisitor with a given initial command visitor state. This method allows setting up the visitor with a starting point.

```Java
public void initializeWith(CommandVisitor initialState)

```

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

### InstallationEvent and InstallationListener Interfaces

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

This section outlines the core interfaces for handling installation events within Apache Sling. It includes the InstallationEvent interface, which represents an event during the installation process, and the InstallationListener interface, which defines how to receive and process these events.

```APIDOC
## Interface Hierarchy

### `org.apache.sling.installer.api.event.InstallationEvent`

This interface represents an event that occurs during the installation process managed by the Sling Installer.

### `org.apache.sling.installer.api.event.InstallationListener`

This interface defines the contract for listeners that want to be notified of installation events. Implementations of this interface can react to changes in the installation state.
```

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

### Loop.Start Method: Get Begin Variable

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

Retrieves the variable name that specifies the starting point for the loop's iteration.

```java
public String getBeginVariable()
```

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

### InstallationEvent.TYPE Methods

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

This section details the available methods for the InstallationEvent.TYPE enum.

```APIDOC
## Method Summary

### values()
Returns an array containing the constants of this enum type, in the order they are declared.

#### Returns
An array containing the constants of this enum type, in the order they are declared.

### valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match _exactly_ an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

#### Parameters
* **name** (String) - The name of the enum constant to be returned.

#### Returns
The enum constant with the specified name.

#### Throws
* **IllegalArgumentException** - If this enum type has no constant with the specified name.
* **NullPointerException** - If the argument is null.
```

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

### Get Active TaskResource from TaskResourceGroup (Java)

Source: https://sling.apache.org/apidocs/sling13/org/apache/sling/installer/api/tasks/class-use/TaskResource

Retrieves the first TaskResource from a TaskResourceGroup that requires installation or uninstallation. This method is part of the org.apache.sling.installer.api.tasks package.

```java
TaskResource TaskResourceGroup.getActiveResource()
```

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

### Check Bundle Start Status using TaskResource (Java)

Source: https://sling.apache.org/apidocs/sling13/org/apache/sling/installer/api/tasks/class-use/TaskResource

Checks if a bundle associated with a TaskResource is marked for starting. This is a static utility method in org.apache.sling.installer.core.impl.tasks.BundleUtil.

```java
static boolean BundleUtil.isBundleStart(TaskResource rsrc)
```

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

### Procedure.Start Class Documentation

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

Detailed documentation for the Procedure.Start class, outlining its constructors, methods, and inherited functionalities.

```APIDOC
## Class: Procedure.Start

### Description
Represents the start of a procedure command in the Sling scripting engine.

### Class Hierarchy
`java.lang.Object`
  `org.apache.sling.scripting.sightly.compiler.commands.Procedure.Start`

### Implemented Interfaces
`org.apache.sling.scripting.sightly.compiler.Command`

### Constructors
#### Start(String name, Set<String> parameters)

  * **Description**: Constructs a new Start command.
  * **Parameters**:
    * `name` (String) - The name of the procedure.
    * `parameters` (Set<String>) - A set of parameters for the procedure.

### Methods
#### Instance Methods

##### `accept(CommandVisitor visitor)`

  * **Description**: Accepts a visitor to process this command.
  * **Parameters**:
    * `visitor` (CommandVisitor) - The visitor that will process this command.
  * **Specified by**: `accept` in interface `Command`

##### `getName()`

  * **Description**: Gets the name of the procedure.
  * **Returns**: (String) The name of the procedure.

##### `getParameters()`

  * **Description**: Gets the parameters of the procedure.
  * **Returns**: (Set<String>) A set of parameters for the procedure.

### Methods Inherited from `java.lang.Object`

`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`
```

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

### Clear Bundle Start Status using TaskResource (Java)

Source: https://sling.apache.org/apidocs/sling13/org/apache/sling/installer/api/tasks/class-use/TaskResource

Clears the bundle start status associated with a given TaskResource. This is a static utility method in org.apache.sling.installer.core.impl.tasks.BundleUtil.

```java
static void BundleUtil.clearBundleStart(TaskResource rsrc)
```

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

### InstallationContext Usage in org.apache.sling.installer.core.impl.util

Source: https://sling.apache.org/apidocs/sling13/org/apache/sling/installer/api/tasks/class-use/InstallationContext

This section details the methods within the org.apache.sling.installer.core.impl.util package that utilize the InstallationContext.

```APIDOC
## Methods Using InstallationContext in org.apache.sling.installer.core.impl.util

### Description
Methods in the `org.apache.sling.installer.core.impl.util` package that accept an `InstallationContext` as a parameter.

### Methods

*   **BundleRefresher.refreshBundles(InstallationContext ctx, List<org.osgi.framework.Bundle> bundles, boolean wait)**
    *   Type: `void`
    *   Description: Refreshes a list of bundles.

*   **WABundleRefresher.refreshBundles(InstallationContext ctx, List<org.osgi.framework.Bundle> bundles, boolean wait)**
    *   Type: `void`
    *   Description: Refreshes a list of WABundles.
```

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

### Get Suspension Time Java Method

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

Determines the time since the installer was last suspended. This method is part of the InstallerMBean interface.

```java
long getSuspendedSince()

// Returns: Time since last suspended.
```

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

### SmapUtil - installSmap

Source: https://sling.apache.org/apidocs/sling13/org/apache/sling/scripting/jsp/jasper/compiler/SmapUtil

Installs the generated SMAP data into the current compilation context.

```APIDOC
## installSmap

### Description
Installs the generated SMAP data into the current compilation context.

### Method
`static void`

### Endpoint
N/A (Static method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{
  "ctxt": "JspCompilationContext object",
  "smap": ["SMAP line 1", "SMAP line 2"]
}
```

### Response
#### Success Response (200)
No content is returned upon successful execution.

#### Response Example
(No response body)

### Throws
- `IOException`
```

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

### get Method (Scriptable Interface - Integer)

Source: https://sling.apache.org/apidocs/sling13/org/apache/sling/scripting/sightly/js/impl/rhino/HybridObject

Retrieves an element from a JavaScript array by its integer index. This method is part of the org.mozilla.javascript.Scriptable interface and takes the starting scope.

```java
public Object get(int index, org.mozilla.javascript.Scriptable start)
```

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

### get Method (Scriptable Interface - String)

Source: https://sling.apache.org/apidocs/sling13/org/apache/sling/scripting/sightly/js/impl/rhino/HybridObject

Retrieves a property value by its string name. This method is part of the org.mozilla.javascript.Scriptable interface and takes the starting scope as an argument.

```java
public Object get(String name, org.mozilla.javascript.Scriptable start)
```

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

### org.apache.sling.installer.core.impl.tasks.BundleTaskCreator

Source: https://sling.apache.org/apidocs/sling13/overview-tree

Factory for creating installation tasks related to OSGi bundles.

```APIDOC
## Class: org.apache.sling.installer.core.impl.tasks.BundleTaskCreator

### Description
This class implements `InstallTaskFactory` to create installation tasks for OSGi bundles. It also listens to bundle events (`BundleListener`) and framework events (`FrameworkListener`).

### Method
N/A (Class documentation)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

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

### InstallationContext Usage in org.apache.sling.installer.core.impl.tasks

Source: https://sling.apache.org/apidocs/sling13/org/apache/sling/installer/api/tasks/class-use/InstallationContext

This section details the methods within the org.apache.sling.installer.core.impl.tasks package that utilize the InstallationContext.

```APIDOC
## Methods Using InstallationContext in org.apache.sling.installer.core.impl.tasks

### Description
Methods in the `org.apache.sling.installer.core.impl.tasks` package that accept an `InstallationContext` as a parameter.

### Methods

*   **BundleInstallTask.execute(InstallationContext ctx)**
    *   Type: `void`
    *   Description: Executes the bundle installation task.

*   **BundleRemoveTask.execute(InstallationContext ctx)**
    *   Type: `void`
    *   Description: Executes the bundle removal task.

*   **BundleStartTask.execute(InstallationContext ctx)**
    *   Type: `void`
    *   Description: Executes the bundle start task.

*   **BundleUpdateTask.execute(InstallationContext ctx)**
    *   Type: `void`
    *   Description: Executes the bundle update task.

*   **InstallerBundleUpdateTask.execute(InstallationContext ctx)**
    *   Type: `void`
    *   Description: Executes the installer bundle update task.

*   **RefreshBundlesTask.execute(InstallationContext ctx)**
    *   Type: `void`
    *   Description: Executes the refresh bundles task.

*   **RestartActiveBundlesTask.execute(InstallationContext ctx)**
    *   Type: `void`
    *   Description: Executes the restart active bundles task.

*   **SystemBundleUpdateTask.execute(InstallationContext ctx)**
    *   Type: `void`
    *   Description: Executes the system bundle update task.

*   **RefreshBundlesTask.markBundleForRefresh(InstallationContext ctx, TaskSupport btc, org.osgi.framework.Bundle bundle)**
    *   Type: `static void`
    *   Description: Marks a bundle for refresh.
```

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

### Get Resource from Base Path

Source: https://sling.apache.org/apidocs/sling13/org/apache/sling/api/wrappers/ResourceResolverWrapper

Retrieves a Resource object starting from a base resource and a relative path. This is useful for resolving resources within a specific context.

```java
Resource getResource(Resource base, @NotNull String path)
```

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

### Get Active Resource Count Java Method

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

Retrieves the count of active resource groups currently being processed by the installer. This method is part of the InstallerMBean interface.

```java
int getActiveResourceCount()

// Returns: Get the active resource count.
```

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

### StatefulVisitor visit VariableBinding.Start Method (Java)

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

Processes a VariableBinding.Start command. This method is part of the CommandVisitor interface implementation for handling the start of variable bindings.

```Java
public void visit(VariableBinding.Start variableBindingStart)

```

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

### Get Parent Resources

Source: https://sling.apache.org/apidocs/sling13/org/apache/sling/scripting/jsp/taglib/SlingFunctions

Retrieves all parent resources of a specified resource, ordered hierarchically, up to a given start depth. Useful for traversing upwards in the resource tree.

```java
public static final Iterator<Resource> getParents(Resource current, String startDepth)
```

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

### Loop.Start Method: Get List Variable

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

Retrieves the variable name used to represent the list being iterated over in the loop.

```java
public String getListVariable()
```

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

### InstanceInfo Constructor

Source: https://sling.apache.org/apidocs/sling13/org/apache/sling/discovery/oak/cluster/InstanceInfo

Initializes a new InstanceInfo object with cluster node ID, Sling ID, sync token, and leader election ID.

```APIDOC
## InstanceInfo Constructor

### Description
Initializes a new InstanceInfo object with the provided cluster node ID, Sling ID, synchronization token, and leader election ID.

### Method
`InstanceInfo` (Constructor)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
* **clusterNodeId** (int) - Required - The ID of the cluster node.
* **slingId** (String) - Required - The unique identifier for the Sling instance.
* **syncToken** (long) - Required - The synchronization token for the instance.
* **leaderElectionId** (String) - Required - The ID for leader election.

### Request Example
```json
{
  "clusterNodeId": 1,
  "slingId": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "syncToken": 1678886400,
  "leaderElectionId": "leader-123"
}
```

### Response
#### Success Response (200)
This is a constructor, so it does not return a response in the typical API sense. It initializes an object.

#### Response Example
N/A
```

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

### Get Active Task Resource

Source: https://sling.apache.org/apidocs/sling13/org/apache/sling/installer/api/tasks/TaskResourceGroup

Retrieves the first active task resource from the group, which may need installation or uninstallation. Returns null if no active resource is found.

```Java
/**
 * Return the first resource if it either needs to be installed or uninstalled.
 * @return The task resource.
 */
@Nullable TaskResource getActiveResource()
```

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

### Get Resource Priority - Java

Source: https://sling.apache.org/apidocs/sling13/org/apache/sling/installer/api/UpdateResult

Retrieves the priority of the resource. Priorities are used to determine which resource to install when multiple resources are registered for the same OSGi entity.

```java
public int getPriority()
```

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

### Constructor Details

Source: https://sling.apache.org/apidocs/sling13/org/apache/sling/commons/compiler/Options

Details on the constructors available for the Options class, including default initialization and copying existing configurations.

```APIDOC
## Constructors

### Options
`public Options()`
Default options with the following presets: - generate debug info : true

### Options
`public Options(Options options)`
Create a new options object based on an existing one.

Parameters:
    `options` - The base options.
```

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

### InstallationState API

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

Provides methods to retrieve lists of ResourceGroup objects representing active and installed resources.

```APIDOC
## InstallationState API

### Description
This API provides access to the installation state of resources, specifically listing active and installed resource groups.

### Method
GET

### Endpoint
`/installation/state`

### Parameters
#### Query Parameters
None

### Request Example
```
GET /installation/state
```

### Response
#### Success Response (200)
- **activeResources** (List<ResourceGroup>) - A list of resource groups currently in processing.
- **installedResources** (List<ResourceGroup>) - A list of resource groups that have been processed and installed.

#### Response Example
```json
{
  "activeResources": [
    {
      "id": "resource-group-1",
      "status": "processing"
    }
  ],
  "installedResources": [
    {
      "id": "resource-group-2",
      "status": "installed"
    }
  ]
}
```
```

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

### Loop.Start Method: Get End Variable

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

Retrieves the variable name that specifies the ending condition for the loop's iteration.

```java
public String getEndVariable()
```

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

### Loop.Start Method: Get Step Variable

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

Retrieves the variable name that defines the increment or decrement step for the loop's index.

```java
public String getStepVariable()
```

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

### InstallationContext Usage in org.apache.sling.installer.api.tasks

Source: https://sling.apache.org/apidocs/sling13/org/apache/sling/installer/api/tasks/class-use/InstallationContext

This section details the methods within the org.apache.sling.installer.api.tasks package that utilize the InstallationContext.

```APIDOC
## Methods Using InstallationContext in org.apache.sling.installer.api.tasks

### Description
Methods in the `org.apache.sling.installer.api.tasks` package that accept an `InstallationContext` as a parameter.

### Methods

*   **ChangeStateTask.execute(InstallationContext ctx)**
    *   Type: `void`
    *   Description: Executes the state change task.

*   **InstallTask.execute(InstallationContext ctx)**
    *   Type: `abstract void`
    *   Description: This is the heart of the task - it performs the actual task.
```

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

### Loop.Start Method: Get Index Variable

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

Retrieves the variable name used to represent the index of the current item within the list.

```java
public String getIndexVariable()
```

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

### SimpleFrontend Constructor

Source: https://sling.apache.org/apidocs/sling13/org/apache/sling/scripting/sightly/impl/compiler/frontend/SimpleFrontend

Initializes a new instance of the SimpleFrontend class with specified plugins, filters, and known expression options.

```APIDOC
## POST /websites/sling_apache_apidocs_sling13/SimpleFrontend

### Description
Initializes a new instance of the SimpleFrontend class. This constructor allows for the injection of custom plugins, filters, and a set of known expression options to customize the compilation process.

### Method
POST

### Endpoint
/websites/sling_apache_apidocs_sling13/SimpleFrontend

### Parameters
#### Query Parameters
- **plugins** (List<Plugin>) - Required - A list of plugins to be used during compilation.
- **filters** (List<Filter>) - Required - A list of filters to be applied during compilation.
- **knownExpressionOptions** (Set<String>) - Required - A set of known expression options.

### Request Example
```json
{
  "plugins": [
    // ... plugin objects ...
  ],
  "filters": [
    // ... filter objects ...
  ],
  "knownExpressionOptions": [
    "option1",
    "option2"
  ]
}
```

### Response
#### Success Response (200)
- **message** (string) - Indicates successful initialization.

#### Response Example
```json
{
  "message": "SimpleFrontend initialized successfully."
}
```
```

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

### Loop.Start Method: Get Item Variable

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

Retrieves the variable name used to represent the current item within the list during each iteration.

```java
public String getItemVariable()
```

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

### Get Next Active TaskResource from TaskResourceGroup (Java)

Source: https://sling.apache.org/apidocs/sling13/org/apache/sling/installer/api/tasks/class-use/TaskResource

Retrieves the second TaskResource from a TaskResourceGroup if there are more resources than just the active one. This method is part of the org.apache.sling.installer.api.tasks package.

```java
TaskResource TaskResourceGroup.getNextActiveResource()
```

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

### Configure Servlet Initialization Parameters (Java)

Source: https://sling.apache.org/apidocs/sling13/org/apache/sling/engine/impl/helper/SlingServletContext

Allows setting initialization parameters for the servlet context. These parameters are typically configured in the deployment descriptor (web.xml) or via annotations and are read-only after the servlet container has initialized the context.

```java
boolean setInitParameter(String name, String value)

```

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

### OsgiInstaller API

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

This section covers the methods within the OsgiInstaller class that interact with InstallableResource objects for managing installations.

```APIDOC
## POST /installer/resources

### Description
Registers a list of installable resources with the Sling installer for a given URL scheme.

### Method
POST

### Endpoint
/installer/resources

### Parameters
#### Query Parameters
- **urlScheme** (string) - Required - The URL scheme for which to register resources.

#### Request Body
- **resources** (array of InstallableResource) - Required - An array of InstallableResource objects to be registered.

### Request Example
```json
{
  "urlScheme": "my-scheme",
  "resources": [
    {
      "id": "resource1",
      "content": "...",
      "contentType": "application/json"
    },
    {
      "id": "resource2",
      "content": "...",
      "contentType": "text/plain"
    }
  ]
}
```

### Response
#### Success Response (200)
- **message** (string) - A confirmation message indicating successful registration.

#### Response Example
```json
{
  "message": "Resources registered successfully."
}
```

## PUT /installer/resources

### Description
Updates the list of installable resources for a given URL scheme, allowing for additions and removals.

### Method
PUT

### Endpoint
/installer/resources

### Parameters
#### Query Parameters
- **urlScheme** (string) - Required - The URL scheme for which to update resources.

#### Request Body
- **resources** (array of InstallableResource) - Optional - An array of InstallableResource objects to be added or updated.
- **idsToRemove** (array of string) - Optional - An array of resource IDs to be removed.

### Request Example
```json
{
  "resources": [
    {
      "id": "resource3",
      "content": "...",
      "contentType": "application/xml"
    }
  ],
  "idsToRemove": ["resource1"]
}
```

### Response
#### Success Response (200)
- **message** (string) - A confirmation message indicating successful update.

#### Response Example
```json
{
  "message": "Resources updated successfully."
}
```
```

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

### Get Resource from ResourceProvider (Java)

Source: https://sling.apache.org/apidocs/sling13/org/apache/sling/jcr/resource/internal/helper/jcr/JcrResourceProvider

Retrieves a resource from the provider based on its path. The path must start with the provider's root. This method should not return cached instances.

```java
/**
 * Returns a resource from this resource provider or null if the resource provider cannot find it.
 * The path must have the ResourceProvider.PROPERTY_ROOT strings as its prefix.
 * The resource provider must not return cached instances for a resource as the resource resolver will update the resource meta data of the resource at the end of the resolution process and this meta data might be different depending on the full path of resource resolution passed into the resource resolver.
 *
 * Specified by:
 *     getResource in class ResourceProvider<org.apache.sling.jcr.resource.internal.helper.jcr.JcrProviderState>
 *
 * Parameters:
 *     ctx - The ResolveContext.     path - The full path of the resource.     rCtx - Additional information for resolving the resource     parent - Optional parent resource 
 *
 * Returns:
 *     null If this provider does not have a resource for the path.
 */
@Nullable
public @Nullable Resource getResource(@NotNull @NotNull ResolveContext<org.apache.sling.jcr.resource.internal.helper.jcr.JcrProviderState> ctx, @NotNull @NotNull String path, @NotNull @NotNull ResourceContext rCtx, @Nullable Resource parent)
```

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

### Configuration and Strategies

Source: https://sling.apache.org/apidocs/sling13/allclasses-index

APIs for managing default configurations, inheritance, persistence, and resource detection strategies.

```APIDOC
## DefaultConfigurationInheritanceStrategy

### Description
Default strategy for configuration inheritance.

### Method
N/A (Class definition)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A

## DefaultConfigurationPersistenceStrategy

### Description
The default persistence strategy is quite simple: directly use the configuration resources.

### Method
N/A (Class definition)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A

## DefaultConfigurationResourceResolvingStrategy

### Description
Default strategy for resolving configuration resources.

### Method
N/A (Class definition)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

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

### Get TaskResource from InstallTask (Java)

Source: https://sling.apache.org/apidocs/sling13/org/apache/sling/installer/api/tasks/class-use/TaskResource

Retrieves the corresponding TaskResource for an InstallTask. The resource might be null depending on the specific task. This method is part of the org.apache.sling.installer.api.tasks package.

```java
TaskResource InstallTask.getResource()
```

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

### Get TaskResource State (Java)

Source: https://sling.apache.org/apidocs/sling13/org/apache/sling/installer/api/tasks/TaskResource

Retrieves the current state of the TaskResource. The state indicates the processing status of the resource, such as whether it has been installed or encountered an error. This is a core method for understanding the resource's lifecycle.

```Java
/**
 * Get the current state of the resource.
 *
 * @return The state of the resource.
 */
ResourceState getState();
```
Tokens:
Raw