org.onehippo.repository.bootstrap

Interface InitializationProcessor

All Known Subinterfaces:

InitializationProcessor

public interface InitializationProcessor

Using an InitializationProcessor you can load hippoecm-extension.xml files into the repository, and execute initialize items in order to bootstrap configuration.

Field Summary

Fields

Modifier and Type	Field and Description
static String	INITIALIZATION_FOLDER

Method Summary

Modifier and Type	Method and Description
List<javax.jcr.Node>	loadExtension(javax.jcr.Session session, URL extension) Deprecated. No longer functional as of 7.10. Always returning an empty List. Use loadExtensions(javax.jcr.Session) instead.
List<javax.jcr.Node>	loadExtensions(javax.jcr.Session session) Load all hippoecm-extension.xml files that are on the current classpath into the repository.
boolean	lock(javax.jcr.Session session) Obtain a cluster-wide lock on the initialization process to prevent concurrent initialization attempts.
List<PostStartupTask>	processInitializeItems(javax.jcr.Session session) Process (execute) all pending initialize items currently loaded in the repository.
List<PostStartupTask>	processInitializeItems(javax.jcr.Session session, List<javax.jcr.Node> initializeItems) Process (execute) a specific list of initialize items.
void	setLogger(org.slf4j.Logger logger) Deprecated. No longer functional. Do not use.
void	unlock(javax.jcr.Session session) Free the lock previously obtained by the lock(javax.jcr.Session) method.

Field Detail

INITIALIZATION_FOLDER

static final String INITIALIZATION_FOLDER

See Also:

Constant Field Values

Method Detail

loadExtensions

List<javax.jcr.Node> loadExtensions(javax.jcr.Session session)
                             throws javax.jcr.RepositoryException,
                                    IOException

Load all hippoecm-extension.xml files that are on the current classpath into the repository.

Parameters:

session - the Session to use.

Returns:

the List of initialize item Nodes that are pending after loading

Throws:

javax.jcr.RepositoryException

IOException

loadExtension

@Deprecated
List<javax.jcr.Node> loadExtension(javax.jcr.Session session,
                                                URL extension)
                                         throws javax.jcr.RepositoryException,
                                                IOException

Deprecated. No longer functional as of 7.10. Always returning an empty List. Use loadExtensions(javax.jcr.Session) instead.

Load a specific hippoecm-extension.xml file into the repository.

Parameters:

session - the Session to use.

extension - the hippoecm-extension.xml to load

Returns:

the List of initialize item Nodes that are pending after loading

Throws:

javax.jcr.RepositoryException

IOException

processInitializeItems

List<PostStartupTask> processInitializeItems(javax.jcr.Session session)

Process (execute) all pending initialize items currently loaded in the repository.

Parameters:

session - the Session to use.

processInitializeItems

List<PostStartupTask> processInitializeItems(javax.jcr.Session session,
                                             List<javax.jcr.Node> initializeItems)

Process (execute) a specific list of initialize items.

Parameters:

session - the Session to use.

initializeItems - the items to process

setLogger

@Deprecated
void setLogger(org.slf4j.Logger logger)

Deprecated. No longer functional. Do not use.

Set alternative logger to write messages to.

Parameters:

logger - the logger to use

lock

boolean lock(javax.jcr.Session session)
      throws javax.jcr.RepositoryException

Obtain a cluster-wide lock on the initialization process to prevent concurrent initialization attempts. Waits until the lock becomes available if the lock is already held by another session.

Returns:

whether the lock was successfully obtained.

Throws:

javax.jcr.RepositoryException

unlock

void unlock(javax.jcr.Session session)
     throws javax.jcr.RepositoryException

Free the lock previously obtained by the lock(javax.jcr.Session) method.

Throws:

javax.jcr.RepositoryException