com.adobe.acs.commons.oak

Interface EnsureOakIndexManager

public interface EnsureOakIndexManager

OSGi Service interface for managing Ensure Oak Indexes.

Method Summary

Modifier and Type	Method and Description
int	ensure(boolean force, String ensureDefinitionsPath) Applies un-applied Ensure Oak Index definitions whose ensure-definition.path @Property is a parameter.
int	ensureAll(boolean force) Applies all un-applied Ensure Oak Index definitions.

Method Detail

ensureAll

@Description(value="Ensure all Ensure Oak Index Definitions")
int ensureAll(@Name(value="force")
                                                                            boolean force)

Applies all un-applied Ensure Oak Index definitions.

Parameters:

force - true to re-apply Ensure Oak Indexes that have been marked as applied, false to skip.

Returns:

the number of ensure oak indexes processed

ensure

@Description(value="Ensure select Ensure Oak Index Definitions")
int ensure(@Name(value="force")
                                                                            boolean force,
                                                                            @Name(value="ensureDefinitionsPath")
                                                                            String ensureDefinitionsPath)

Applies un-applied Ensure Oak Index definitions whose ensure-definition.path @Property is a parameter.

Parameters:

force - true to re-apply Ensure Oak Indexes that have been marked as applied, false to skip.

ensureDefinitionsPath - the path of the Ensure Oak Index Definitions to apply.

Returns:

the number of ensure oak indexes processed