A B C D E G H I L O P R S T U V

A

addAsyncTask(InstallTask) - Method in interface org.apache.sling.installer.api.tasks.InstallationContext

Deprecated. A async task should return true for InstallTask.isAsynchronousTask() and be add with InstallationContext.addTaskToCurrentCycle(InstallTask)

addTaskToCurrentCycle(InstallTask) - Method in interface org.apache.sling.installer.api.tasks.InstallationContext

Schedule a task for execution in the current cycle.

addTaskToNextCycle(InstallTask) - Method in interface org.apache.sling.installer.api.tasks.InstallationContext

Deprecated.

ASYNC_ATTR_NAME - Static variable in class org.apache.sling.installer.api.tasks.InstallTask

Attribute which is set by the OSGi installer for asynchronous execution.

asyncTaskFailed(InstallTask) - Method in interface org.apache.sling.installer.api.tasks.InstallationContext

Inform the installer about a failed async task.

ATTR_INSTALL_EXCLUDED - Static variable in interface org.apache.sling.installer.api.tasks.TaskResource

If this attribute is set and the resource has the state installed, it actually means that this resource has been processed but not installed.

ATTR_INSTALL_INFO - Static variable in interface org.apache.sling.installer.api.tasks.TaskResource

Additional installation information in human readable format.

B

BUNDLE_START_LEVEL - Static variable in class org.apache.sling.installer.api.InstallableResource

Optional parameter in the dictionary if a bundle is installed.

C

ChangeStateTask - Class in org.apache.sling.installer.api.tasks

Simple general task, setting the state of a registered resource.

ChangeStateTask(TaskResourceGroup, ResourceState) - Constructor for class org.apache.sling.installer.api.tasks.ChangeStateTask

Change the state of the task

ChangeStateTask(TaskResourceGroup, ResourceState, Map<String, Object>, String[]) - Constructor for class org.apache.sling.installer.api.tasks.ChangeStateTask

Change the state of the task

compareTo(InstallTask) - Method in class org.apache.sling.installer.api.tasks.InstallTask

All comparisons are based on getSortKey().

createTask(TaskResourceGroup) - Method in interface org.apache.sling.installer.api.tasks.InstallTaskFactory

Creates an InstallTask for the resource or null if the factory does not support the resource.

D

DEFAULT_PRIORITY - Static variable in class org.apache.sling.installer.api.InstallableResource

Default resource priority

E

equals(Object) - Method in class org.apache.sling.installer.api.tasks.InstallTask

execute(InstallationContext) - Method in class org.apache.sling.installer.api.tasks.ChangeStateTask

execute(InstallationContext) - Method in class org.apache.sling.installer.api.tasks.InstallTask

This is the heart of the task - it performs the actual task.

G

getActiveResource() - Method in interface org.apache.sling.installer.api.tasks.TaskResourceGroup

Return the first resource if it either needs to be installed or uninstalled.

getActiveResources() - Method in interface org.apache.sling.installer.api.info.InstallationState

Active resource groups These resource groups are currently in processing.

getAlias() - Method in interface org.apache.sling.installer.api.info.ResourceGroup

Get the current alias for this group.

getAlias() - Method in interface org.apache.sling.installer.api.tasks.TaskResourceGroup

Get the current alias for this group.

getAttribute(String) - Method in interface org.apache.sling.installer.api.info.Resource

Get the value of an attribute.

getAttribute(String) - Method in interface org.apache.sling.installer.api.tasks.TaskResource

Get the value of an attribute.

getAttributes() - Method in class org.apache.sling.installer.api.tasks.TransformationResult

Attributes include the bundle symbolic name, bundle version, etc.

getDictionary() - Method in class org.apache.sling.installer.api.InstallableResource

Return this resource's dictionary.

getDictionary() - Method in interface org.apache.sling.installer.api.tasks.RegisteredResource

Return this resource's dictionary.

getDigest() - Method in class org.apache.sling.installer.api.InstallableResource

Return this resource's digest.

getDigest() - Method in interface org.apache.sling.installer.api.tasks.RegisteredResource

Return this resource's digest.

getDigest() - Method in class org.apache.sling.installer.api.UpdateResult

Return this resource's digest.

getEntityId() - Method in interface org.apache.sling.installer.api.tasks.RegisteredResource

Return the identifier of the OSGi "entity" that this resource represents, for example "bundle:SID" where SID is the bundle's symbolic ID, or "config:PID" where PID is config's PID.

getId() - Method in class org.apache.sling.installer.api.InstallableResource

Return this data's id.

getId() - Method in class org.apache.sling.installer.api.tasks.TransformationResult

Get the new unique id

getInputStream() - Method in class org.apache.sling.installer.api.InstallableResource

Return an input stream with the data of this resource.

getInputStream() - Method in interface org.apache.sling.installer.api.tasks.RegisteredResource

Return an input stream with the data of this resource.

getInputStream() - Method in class org.apache.sling.installer.api.tasks.TransformationResult

Get the new input stream

getInstallationState() - Method in interface org.apache.sling.installer.api.info.InfoProvider

Return the current installation state.

getInstalledResources() - Method in interface org.apache.sling.installer.api.info.InstallationState

Installed resource groups These resources groups are processed.

getLastChange() - Method in interface org.apache.sling.installer.api.info.Resource

When did the last change happen?

getNextActiveResource() - Method in interface org.apache.sling.installer.api.tasks.TaskResourceGroup

If there is more than the active resource in the group, return the second resource from the group.

getPriority() - Method in class org.apache.sling.installer.api.InstallableResource

Return the priority of this resource.

getPriority() - Method in interface org.apache.sling.installer.api.tasks.RegisteredResource

Return the priority of this resource.

getPriority() - Method in class org.apache.sling.installer.api.UpdateResult

Return the priority of this resource.

getResource() - Method in class org.apache.sling.installer.api.tasks.InstallTask

Return the corresponding resource - depending on the task this might be null.

getResourceGroup() - Method in class org.apache.sling.installer.api.tasks.InstallTask

Return the corresponding resource - depending on the task this might be null.

getResourceId() - Method in class org.apache.sling.installer.api.UpdateResult

Return just the resource id (everything in the url after the colon)

getResourceIsMoved() - Method in class org.apache.sling.installer.api.UpdateResult

Has this resource been moved or added?

getResources() - Method in interface org.apache.sling.installer.api.info.ResourceGroup

Get all resources for this group.

getResourceType() - Method in class org.apache.sling.installer.api.tasks.TransformationResult

Get the new resource type

getScheme() - Method in interface org.apache.sling.installer.api.tasks.RegisteredResource

Return the scheme from where the artifact is originated.

getScheme() - Method in class org.apache.sling.installer.api.UpdateResult

Return the scheme of the provider.

getSortKey() - Method in class org.apache.sling.installer.api.tasks.ChangeStateTask

getSortKey() - Method in class org.apache.sling.installer.api.tasks.InstallTask

Tasks are sorted according to this key.

getSource() - Method in interface org.apache.sling.installer.api.event.InstallationEvent

Return the source of the event.

getState() - Method in interface org.apache.sling.installer.api.info.Resource

Get the current state of the resource.

getState() - Method in interface org.apache.sling.installer.api.tasks.TaskResource

Get the current state of the resource.

getTemporaryAttribute(String) - Method in interface org.apache.sling.installer.api.tasks.TaskResource

Get the value of a temporary attribute.

getType() - Method in interface org.apache.sling.installer.api.event.InstallationEvent

Return the event type.

getType() - Method in class org.apache.sling.installer.api.InstallableResource

Return the type of this resource.

getType() - Method in interface org.apache.sling.installer.api.tasks.RegisteredResource

Return the type of this resource.

getUntransformedResources() - Method in interface org.apache.sling.installer.api.info.InstallationState

Return all untransformed resources

getURL() - Method in interface org.apache.sling.installer.api.tasks.RegisteredResource

Return this data's URL.

getURL() - Method in class org.apache.sling.installer.api.UpdateResult

Return this data's url.

getVersion() - Method in interface org.apache.sling.installer.api.info.Resource

Return the version of the artifact.

getVersion() - Method in interface org.apache.sling.installer.api.tasks.TaskResource

Return the version of the artifact.

getVersion() - Method in class org.apache.sling.installer.api.tasks.TransformationResult

Get the version

H

handleRemoval(String, String, String) - Method in interface org.apache.sling.installer.api.UpdateHandler

Handle the remove of a resource

handleUpdate(String, String, String, Dictionary<String, Object>, Map<String, Object>) - Method in interface org.apache.sling.installer.api.UpdateHandler

Handle the update of a resource

handleUpdate(String, String, String, InputStream, Map<String, Object>) - Method in interface org.apache.sling.installer.api.UpdateHandler

Handle the update of a resource

hashCode() - Method in class org.apache.sling.installer.api.tasks.InstallTask

I

InfoProvider - Interface in org.apache.sling.installer.api.info

The info provider delivers information about the current state of the OSGi installer

InstallableResource - Class in org.apache.sling.installer.api

A piece of data that can be installed by the OsgiInstaller Currently the OSGi installer supports bundles and configurations, but it can be extended by additional task factories supporting other formats.

InstallableResource(String, InputStream, Dictionary<String, Object>, String, String, Integer) - Constructor for class org.apache.sling.installer.api.InstallableResource

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

INSTALLATION_HINT - Static variable in class org.apache.sling.installer.api.InstallableResource

Optional parameter in the dictionary if a resource (not a dict) is installed.

InstallationContext - Interface in org.apache.sling.installer.api.tasks

Context for the installation tasks.

InstallationEvent - Interface in org.apache.sling.installer.api.event

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

InstallationEvent.TYPE - Enum in org.apache.sling.installer.api.event

InstallationListener - Interface in org.apache.sling.installer.api.event

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

InstallationState - Interface in org.apache.sling.installer.api.info

The state of the OSGi installer at a given time.

InstallTask - Class in org.apache.sling.installer.api.tasks

Base class for tasks that can be executed by the OsgiInstaller.

InstallTask(TaskResourceGroup) - Constructor for class org.apache.sling.installer.api.tasks.InstallTask

Constructor for the task

InstallTaskFactory - Interface in org.apache.sling.installer.api.tasks

The install task factory creates a task for a given resource.

isAsynchronousTask() - Method in class org.apache.sling.installer.api.tasks.InstallTask

If this an asynchronous task it should return true The OSGi installer will set the attribute InstallTask.ASYNC_ATTR_NAME with an integer value.

L

log(String, Object...) - Method in interface org.apache.sling.installer.api.tasks.InstallationContext

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

O

onEvent(InstallationEvent) - Method in interface org.apache.sling.installer.api.event.InstallationListener

Receive an installation event.

org.apache.sling.installer.api - package org.apache.sling.installer.api

org.apache.sling.installer.api.event - package org.apache.sling.installer.api.event

org.apache.sling.installer.api.info - package org.apache.sling.installer.api.info

org.apache.sling.installer.api.tasks - package org.apache.sling.installer.api.tasks

OsgiInstaller - Interface in org.apache.sling.installer.api

Service for installing/updating/removing installable resources InstallableResource in an OSGi framework.

P

PROPERTY_SCHEMES - Static variable in interface org.apache.sling.installer.api.UpdateHandler

Required configuration property defining the schemes, this handler is handling.

R

RegisteredResource - Interface in org.apache.sling.installer.api.tasks

A resource that's been registered in the OSGi controller.

registerResources(String, InstallableResource[]) - Method in interface org.apache.sling.installer.api.OsgiInstaller

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

Resource - Interface in org.apache.sling.installer.api.info

A resource provides all relevant information about a registered resource.

RESOURCE_URI_HINT - Static variable in class org.apache.sling.installer.api.InstallableResource

Optional parameter in the dictionary if a resource (not a dict) is installed.

resourceAddedOrUpdated(String, String, InputStream, Dictionary<String, Object>, Map<String, Object>) - Method in interface org.apache.sling.installer.api.ResourceChangeListener

Inform the installer about an added or updated resource

ResourceChangeListener - Interface in org.apache.sling.installer.api

OSGi Service listening for changes of resources.

ResourceGroup - Interface in org.apache.sling.installer.api.info

This is a group of resources all pointing to the same artifact, but maybe in different versions or locations.

resourceRemoved(String, String) - Method in interface org.apache.sling.installer.api.ResourceChangeListener

Inform the installer about a removed resource

ResourceState - Enum in org.apache.sling.installer.api.tasks

The state of a resource.

ResourceTransformer - Interface in org.apache.sling.installer.api.tasks

A resource transformer transform a registered resource before it can be installed.

RetryHandler - Interface in org.apache.sling.installer.api.tasks

The retry handler should be informed by external services whenever something in the system changed which might make it worth to retry a failed installed.

S

scheduleRetry() - Method in interface org.apache.sling.installer.api.tasks.RetryHandler

Schedule a retry.

setAttribute(String, Object) - Method in interface org.apache.sling.installer.api.tasks.TaskResource

Set the value of an attribute.

setAttributes(Map<String, Object>) - Method in class org.apache.sling.installer.api.tasks.TransformationResult

Set the new attributes.

setDigest(String) - Method in class org.apache.sling.installer.api.UpdateResult

Set the digest.

setFinishedState(ResourceState) - Method in class org.apache.sling.installer.api.tasks.InstallTask

Set the finished state for the resource.

setFinishedState(ResourceState, String) - Method in class org.apache.sling.installer.api.tasks.InstallTask

Set the finished state for the resource and the alias

setFinishState(ResourceState) - Method in interface org.apache.sling.installer.api.tasks.TaskResourceGroup

Set the finish state for the active resource.

setFinishState(ResourceState, String) - Method in interface org.apache.sling.installer.api.tasks.TaskResourceGroup

Set the finish state for the active resource and register an alias.

setId(String) - Method in class org.apache.sling.installer.api.tasks.TransformationResult

Set a new unique id.

setInputStream(InputStream) - Method in class org.apache.sling.installer.api.tasks.TransformationResult

Set a new input stream.

setPriority(Integer) - Method in class org.apache.sling.installer.api.UpdateResult

Set the priority.

setResourceIsMoved(boolean) - Method in class org.apache.sling.installer.api.UpdateResult

Sett whether this resource has been moved or added.

setResourceType(String) - Method in class org.apache.sling.installer.api.tasks.TransformationResult

Set a new resource type.

setTemporaryAttribute(String, Object) - Method in interface org.apache.sling.installer.api.tasks.TaskResource

Set the value of a temporary attribute.

setVersion(Version) - Method in class org.apache.sling.installer.api.tasks.TransformationResult

Set the version.

T

TaskResource - Interface in org.apache.sling.installer.api.tasks

A task resource is a registered resource which has been processed by a ResourceTransformer and is now about to be processed by an .

TaskResourceGroup - Interface in org.apache.sling.installer.api.tasks

This is a group of resources all pointing to the same artifact, but maybe in different versions or locations.

toString() - Method in class org.apache.sling.installer.api.InstallableResource

toString() - Method in class org.apache.sling.installer.api.tasks.InstallTask

toString() - Method in class org.apache.sling.installer.api.UpdateResult

transform(RegisteredResource) - Method in interface org.apache.sling.installer.api.tasks.ResourceTransformer

Try to transform the registered resource.

TransformationResult - Class in org.apache.sling.installer.api.tasks

A result of a ResourceTransformer.

TransformationResult() - Constructor for class org.apache.sling.installer.api.tasks.TransformationResult

TYPE_BUNDLE - Static variable in class org.apache.sling.installer.api.InstallableResource

The type for a bundle - in this case InstallableResource.getInputStream() must return an input stream to the bundle.

TYPE_CONFIG - Static variable in class org.apache.sling.installer.api.InstallableResource

The type for a configuration - in this case InstallableResource.getDictionary() must return a dictionary with the configuration.

TYPE_FILE - Static variable in class org.apache.sling.installer.api.InstallableResource

The type for all other provided data like a bundle etc.

TYPE_PROPERTIES - Static variable in class org.apache.sling.installer.api.InstallableResource

The type for properties - in this case InstallableResource.getDictionary() should contain a dictionary or the InstallableResource.getInputStream() should point to a property or configuration file.

U

UpdateHandler - Interface in org.apache.sling.installer.api

An update handler is a service handling updates of resources through other ways than the installer, e.g. handling a configuration change through the web console or directly through the configuration admin API.

updateResources(String, InstallableResource[], String[]) - Method in interface org.apache.sling.installer.api.OsgiInstaller

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

UpdateResult - Class in org.apache.sling.installer.api

The update result is returned by an UpdateHandler if a resource could be persisted by the handler.

UpdateResult(String) - Constructor for class org.apache.sling.installer.api.UpdateResult

Create an update result

V

valueOf(String) - Static method in enum org.apache.sling.installer.api.event.InstallationEvent.TYPE

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.apache.sling.installer.api.tasks.ResourceState

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.apache.sling.installer.api.event.InstallationEvent.TYPE

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

values() - Static method in enum org.apache.sling.installer.api.tasks.ResourceState

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

A B C D E G H I L O P R S T U V