public interface ProtectedNodeImporter extends ProtectedItemImporter
ProtectedNodeImporter
provides means to import protected
Node
s and the subtree defined below such nodes.
The import of a protected tree is started by the Importer
by
calling start(NodeImpl)
. If the ProtectedNodeImporter
is able to deal with that type of protected node, it is in charge of dealing
with all subsequent child NodeInfo
s present below the protected
parent until end(NodeImpl)
is called. The latter resets this importer
and makes it available for another protected import.
Modifier and Type | Method and Description |
---|---|
void |
end(NodeImpl protectedParent)
Informs this importer that the tree to be imported below
protectedParent has bee completed. |
void |
end(NodeState protectedParent)
Informs this importer that the tree to be imported below
protectedParent has bee completed. |
void |
endChildInfo()
Informs this importer about the end of a child info.
|
boolean |
start(NodeImpl protectedParent)
Notifies this importer about the existence of a protected node that
has either been created (NEW) or has been found to be existing.
|
boolean |
start(NodeState protectedParent)
Notifies this importer about the existence of a protected node that
has either been created (NEW) or has been found to be existing.
|
void |
startChildInfo(NodeInfo childInfo,
List<PropInfo> propInfos)
Informs this importer about a new
childInfo and it's properties. |
init, processReferences
boolean start(NodeImpl protectedParent) throws IllegalStateException, RepositoryException
protectedParent
- A protected node that has either been created
during the current XML import or that has been found to be existing
without allowing same-name siblings.true
If this importer is able to deal with the
tree that may be present below the given protected Node.IllegalStateException
- If this method is called on
this importer without having reached end(NodeImpl)
.RepositoryException
- If an error occurs.boolean start(NodeState protectedParent) throws IllegalStateException, RepositoryException
protectedParent
- A protected node that has either been created
during the current XML import or that has been found to be existing
without allowing same-name siblings.true
If this importer is able to deal with the
tree that may be present below the given protected NodeState.IllegalStateException
- If this method is called on
this importer without having reached end(NodeState)
.RepositoryException
- If an error occurs.void end(NodeImpl protectedParent) throws IllegalStateException, ConstraintViolationException, RepositoryException
protectedParent
has bee completed. This allows the importer
to be reset in order to be able to deal with another call to
start(NodeImpl)
.
If start(NodeImpl)
hasn't been called before, this method returns
silently.
protectedParent
- IllegalStateException
- If end is called in an illegal state.ConstraintViolationException
- If the tree
that was imported is incomplete.RepositoryException
- If another error occurs.void end(NodeState protectedParent) throws IllegalStateException, ConstraintViolationException, RepositoryException
protectedParent
has bee completed. This allows the importer
to be reset in order to be able to deal with another call to
start(NodeState)
.
If start(NodeState)
hasn't been called before, this method returns
silently.
protectedParent
- IllegalStateException
- If end is called in an illegal state.ConstraintViolationException
- If the tree
that was imported is incomplete.RepositoryException
- If another error occurs.void startChildInfo(NodeInfo childInfo, List<PropInfo> propInfos) throws IllegalStateException, ConstraintViolationException, RepositoryException
childInfo
and it's properties.
If the importer is able to successfully import the given information
this method returns silently. Otherwise
ConstraintViolationException
is thrown, in which case the
whole import fails.
In case this importer deals with multiple levels of nodes, it is in charge of maintaining the hierarchical structure (see also {#link endChildInfo()}.
If start(NodeImpl)
hasn't been called before, this method returns
silently.
childInfo
- propInfos
- IllegalStateException
- If called in an illegal state.ConstraintViolationException
- If the given
infos contain invalid or incomplete data and therefore cannot be properly
handled by this importer.RepositoryException
- If another error occurs.void endChildInfo() throws RepositoryException
If start(NodeImpl)
hasn't been called before, this method returns
silently.
IllegalStateException
- If end is called in an illegal state.ConstraintViolationException
- If this method
is called before all required child information has been imported.RepositoryException
- If another error occurs.Copyright © 2004–2021 The Apache Software Foundation. All rights reserved.