org.nuxeo.runtime.model.impl

Class ComponentPersistence

java.lang.Object

org.nuxeo.runtime.model.impl.ComponentPersistence

public class ComponentPersistence
extends Object

Manage persistent components. Persistent components are located in ${nxserver_data_dir}/components directory, and can be dynamically removed or registered. After framework startup (after the application was completely started) the persistent components are deployed. The layout of the components directory is the following:

 components/
     component1.xml
     component2.xml
     ...
     bundle_symbolicName1/
         component1.xml
         component2.xml
         ...
     bundle_symbolicName1/
         ...
     ...
 

If components are put directly under the root then they will be deployed in the runtime bundle context. If they are put in a directory having as name the symbolicName of a bundle in the system, then the component will be deployed in that bundle context.

Any files not ending with .xml are ignored. Any directory that doesn't match a bundle symbolic name will be ignored too.

Dynamic components must use the following name convention: (it is not mandatory but it is recommended)

• Components deployed in root directory must use as name the file name without the .xml extension.
• Components deployed in a bundle directory must use the relative file path without the .xml extensions.

Examples: Given the following component files: components/mycomp1.xml and components/mybundle/mycomp2.xml the name for mycomp1 must be: comp1 and for mycomp2 must be mybundle/mycomp2

This service is working only with OSGiRuntimeService

Author:

Bogdan Stefanescu

Field Summary

Fields

Modifier and Type	Field and Description
protected ReadWriteLock	fileLock
protected Set<RegistrationInfo>	persistedComponents
protected File	root
protected OSGiRuntimeService	runtime
protected RuntimeContext	sysrc

Constructor Summary

Constructors

Constructor and Description
ComponentPersistence(OSGiRuntimeService runtime)

Method Summary

Modifier and Type	Method and Description
void	createComponent(byte[] bytes)
void	createComponent(byte[] bytes, boolean isPersistent)
protected void	deploy(RuntimeContext rc, File file)
RuntimeContext	getContext(String symbolicName)
File	getRoot()
void	loadPersistedComponent(File file)
void	loadPersistedComponents()
void	loadPersistedComponents(RuntimeContext rc, File root)
Document	loadXml(File file)
static Document	loadXml(InputStream in)
boolean	removeComponent(String compName)
protected byte[]	safeReadFile(File file)
protected void	safeWriteFile(byte[] bytes, File file)

Methods inherited from class java.lang.Object

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

Field Detail

root

protected final File root

sysrc

protected final RuntimeContext sysrc

runtime

protected final OSGiRuntimeService runtime

fileLock

protected final ReadWriteLock fileLock

persistedComponents

protected final Set<RegistrationInfo> persistedComponents

Constructor Detail

ComponentPersistence

public ComponentPersistence(OSGiRuntimeService runtime)

Method Detail

getRoot

public File getRoot()

getContext

public final RuntimeContext getContext(String symbolicName)

deploy

protected void deploy(RuntimeContext rc,
                      File file)
               throws IOException

Throws:

IOException

loadPersistedComponents

public void loadPersistedComponents()
                             throws IOException

Throws:

IOException

loadPersistedComponents

public void loadPersistedComponents(RuntimeContext rc,
                                    File root)
                             throws IOException

Throws:

IOException

loadPersistedComponent

public void loadPersistedComponent(File file)
                            throws IOException

Throws:

IOException

loadXml

public Document loadXml(File file)
                 throws IOException

Throws:

IOException

loadXml

public static Document loadXml(InputStream in)

createComponent

public void createComponent(byte[] bytes)
                     throws IOException

Throws:

IOException

createComponent

public void createComponent(byte[] bytes,
                            boolean isPersistent)
                     throws IOException

Throws:

IOException

removeComponent

public boolean removeComponent(String compName)
                        throws IOException

Throws:

IOException

safeWriteFile

protected void safeWriteFile(byte[] bytes,
                             File file)
                      throws IOException

Throws:

IOException

safeReadFile

protected byte[] safeReadFile(File file)
                       throws IOException

Throws:

IOException