org.apache.sling.installer.provider.jcr.impl

Class JcrInstaller

java.lang.Object

org.apache.sling.installer.provider.jcr.impl.JcrInstaller

All Implemented Interfaces:

javax.jcr.observation.EventListener, org.apache.sling.installer.api.UpdateHandler, org.osgi.service.cm.ManagedService

@Properties(value={@Property(name="service.description",value="Sling JCR Install Service"),@Property(name="service.vendor",value="The Apache Software Foundation"),@Property(name="handler.schemes",value="jcrinstall",unbounded=ARRAY),@Property(name="service.ranking",intValue=100)})
@Service(value=org.apache.sling.installer.api.UpdateHandler.class)
public class JcrInstaller
extends Object
implements javax.jcr.observation.EventListener, org.apache.sling.installer.api.UpdateHandler, org.osgi.service.cm.ManagedService

Main class of jcrinstall, runs as a service, observes the repository for changes in folders having names that match configurable regular expressions, and registers resources found in those folders with the OSGi installer for installation.

Field Summary

Fields

Modifier and Type	Field and Description
static int	COUNTERS_COUNT
static int	DEFAULT_FOLDER_MAX_DEPTH
static String	DEFAULT_FOLDER_NAME_REGEXP Default regexp for watched folders
static String[]	DEFAULT_SEARCH_PATH
static String	FOLDER_NAME_REGEXP_PROPERTY ComponentContext property that overrides the folder name regexp
static String	PAUSE_SCAN_NODE_PATH
static String	PROP_INSTALL_FOLDER_MAX_DEPTH Configurable max. path depth for watched folders
static String	PROP_SEARCH_PATH Configurable search path, with per-path priorities.
static int	RUN_LOOP_COUNTER
static long	RUN_LOOP_DELAY_MSEC
static int	SCAN_FOLDERS_COUNTER
static int	UPDATE_FOLDERS_LIST_COUNTER
static String	URL_SCHEME

Fields inherited from interface org.apache.sling.installer.api.UpdateHandler

PROPERTY_SCHEMES

Constructor Summary

Constructors

Constructor and Description
JcrInstaller()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	activate(org.osgi.service.component.ComponentContext context) Activate this component.
protected void	deactivate(org.osgi.service.component.ComponentContext context) Deactivate this component
protected Object	getPropertyValue(String name) Get a property value from the old config, component context or bundle context
org.apache.sling.installer.api.UpdateResult	handleRemoval(String resourceType, String id, String url)
org.apache.sling.installer.api.UpdateResult	handleUpdate(String resourceType, String id, String url, Dictionary<String,Object> dict, Map<String,Object> attributes)
org.apache.sling.installer.api.UpdateResult	handleUpdate(String resourceType, String id, String url, InputStream is, Map<String,Object> attributes)
void	onEvent(javax.jcr.observation.EventIterator it)
void	runOneCycle() Run periodic scans of our watched folders, and watch for folders creations/deletions.
void	updated(Dictionary properties)

Methods inherited from class java.lang.Object

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

Field Detail

RUN_LOOP_DELAY_MSEC

public static final long RUN_LOOP_DELAY_MSEC

See Also:

Constant Field Values

URL_SCHEME

public static final String URL_SCHEME

See Also:

Constant Field Values

SCAN_FOLDERS_COUNTER

public static final int SCAN_FOLDERS_COUNTER

See Also:

Constant Field Values

UPDATE_FOLDERS_LIST_COUNTER

public static final int UPDATE_FOLDERS_LIST_COUNTER

See Also:

Constant Field Values

RUN_LOOP_COUNTER

public static final int RUN_LOOP_COUNTER

See Also:

Constant Field Values

COUNTERS_COUNT

public static final int COUNTERS_COUNT

See Also:

Constant Field Values

DEFAULT_FOLDER_NAME_REGEXP

public static final String DEFAULT_FOLDER_NAME_REGEXP

Default regexp for watched folders

See Also:

Constant Field Values

FOLDER_NAME_REGEXP_PROPERTY

@Property(value=".*/install$")
public static final String FOLDER_NAME_REGEXP_PROPERTY

ComponentContext property that overrides the folder name regexp

See Also:

Constant Field Values

DEFAULT_FOLDER_MAX_DEPTH

public static final int DEFAULT_FOLDER_MAX_DEPTH

See Also:

Constant Field Values

PROP_INSTALL_FOLDER_MAX_DEPTH

@Property(intValue=4)
public static final String PROP_INSTALL_FOLDER_MAX_DEPTH

Configurable max. path depth for watched folders

See Also:

Constant Field Values

PROP_SEARCH_PATH

@Property(value={"/libs:100","/apps:200"},
          unbounded=ARRAY)
public static final String PROP_SEARCH_PATH

Configurable search path, with per-path priorities. We could get it from the ResourceResolver, but introducing a dependency on this just to get those values is too much for this module that's meant to bootstrap other services.

See Also:

Constant Field Values

DEFAULT_SEARCH_PATH

public static final String[] DEFAULT_SEARCH_PATH

PAUSE_SCAN_NODE_PATH

public static final String PAUSE_SCAN_NODE_PATH

See Also:

Constant Field Values

Constructor Detail

JcrInstaller

public JcrInstaller()

Method Detail

activate

protected void activate(org.osgi.service.component.ComponentContext context)

Activate this component.

deactivate

protected void deactivate(org.osgi.service.component.ComponentContext context)

Deactivate this component

updated

public void updated(Dictionary properties)
             throws org.osgi.service.cm.ConfigurationException

Specified by:

updated in interface org.osgi.service.cm.ManagedService

Throws:

org.osgi.service.cm.ConfigurationException

See Also:

ManagedService.updated(java.util.Dictionary)

getPropertyValue

protected Object getPropertyValue(String name)

Get a property value from the old config, component context or bundle context

onEvent

public void onEvent(javax.jcr.observation.EventIterator it)

Specified by:

onEvent in interface javax.jcr.observation.EventListener

See Also:

EventListener.onEvent(javax.jcr.observation.EventIterator)

runOneCycle

public void runOneCycle()

Run periodic scans of our watched folders, and watch for folders creations/deletions.

handleRemoval

public org.apache.sling.installer.api.UpdateResult handleRemoval(String resourceType,
                                                        String id,
                                                        String url)

Specified by:

handleRemoval in interface org.apache.sling.installer.api.UpdateHandler

See Also:

UpdateHandler.handleRemoval(java.lang.String, java.lang.String, java.lang.String)

handleUpdate

public org.apache.sling.installer.api.UpdateResult handleUpdate(String resourceType,
                                                       String id,
                                                       String url,
                                                       Dictionary<String,Object> dict,
                                                       Map<String,Object> attributes)

Specified by:

handleUpdate in interface org.apache.sling.installer.api.UpdateHandler

See Also:

UpdateHandler.handleUpdate(java.lang.String, java.lang.String, java.lang.String, java.util.Dictionary, Map)

handleUpdate

public org.apache.sling.installer.api.UpdateResult handleUpdate(String resourceType,
                                                       String id,
                                                       String url,
                                                       InputStream is,
                                                       Map<String,Object> attributes)

Specified by:

handleUpdate in interface org.apache.sling.installer.api.UpdateHandler

See Also:

UpdateHandler.handleUpdate(java.lang.String, java.lang.String, java.lang.String, java.io.InputStream, Map)