org.apache.jackrabbit.oak.spi.xml

Interface ProtectedPropertyImporter

All Superinterfaces:

ProtectedItemImporter

public interface ProtectedPropertyImporter
extends ProtectedItemImporter

ProtectedPropertyImporter is in charge of importing single properties with a protected PropertyDefinition.

See Also:

for an abstract class used to import protected nodes and the subtree below them.

Field Summary

Fields inherited from interface org.apache.jackrabbit.oak.spi.xml.ProtectedItemImporter

PARAM_IMPORT_BEHAVIOR

Method Summary

Modifier and Type	Method and Description
boolean	handlePropInfo(@NotNull Tree parent, @NotNull PropInfo protectedPropInfo, @NotNull PropertyDefinition def) Handles a single protected property.
void	propertiesCompleted(@NotNull Tree protectedParent) Informs this importer that all properties to be imported below protectedParent have been processed by the importer.

Methods inherited from interface org.apache.jackrabbit.oak.spi.xml.ProtectedItemImporter

init, processReferences

Method Detail

handlePropInfo

boolean handlePropInfo(@NotNull
                       @NotNull Tree parent,
                       @NotNull
                       @NotNull PropInfo protectedPropInfo,
                       @NotNull
                       @NotNull PropertyDefinition def)
                throws RepositoryException

Handles a single protected property.

Parameters:

parent - The affected parent node.

protectedPropInfo - The PropInfo to be imported.

def - The property definition determined by the importer that calls this method.

Returns:

true If the property could be successfully imported; false otherwise.

Throws:

RepositoryException - If an error occurs.

propertiesCompleted

void propertiesCompleted(@NotNull
                         @NotNull Tree protectedParent)
                  throws java.lang.IllegalStateException,
                         ConstraintViolationException,
                         RepositoryException

Informs this importer that all properties to be imported below protectedParent have been processed by the importer. If this importer did not import any protected properties this method doesn't do anything. Otherwise it may perform some validation and cleanup required based on the set of protected properties handled by this importer.

Parameters:

protectedParent - The protected parent tree.

Throws:

java.lang.IllegalStateException - If this method is called in an illegal state.

ConstraintViolationException - If the set of properties was incomplete and the importer was not able to fix the problem.

RepositoryException - If another error occurs.