org.apache.sling.jcr.contentloader.ContentCreator Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aem-sdk-api Show documentation
Show all versions of aem-sdk-api Show documentation
The Adobe Experience Manager SDK
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.sling.jcr.contentloader;
import java.io.InputStream;
import java.util.Map;
import java.util.Set;
import javax.jcr.Node;
import javax.jcr.RepositoryException;
import javax.jcr.Value;
import org.osgi.annotation.versioning.ProviderType;
/**
* The ContentCreator is used by the {@link org.apache.sling.jcr.contentloader.ContentReader} to create the actual content.
*
* @since 2.0.4
*/
@ProviderType
public interface ContentCreator {
/**
* Create a new node.
* To add properties to this node, one of the createProperty() methods
* should be called.
* To add child nodes, this method should be called to create a new child node.
* If all properties and child nodes have been added {@link #finishNode()} must be called.
*
* @param name The name of the node.
* @param primaryNodeType The primary node type or null.
* @param mixinNodeTypes The mixin node types or null.
* @throws RepositoryException If anything goes wrong.
*/
void createNode(String name, String primaryNodeType, String[] mixinNodeTypes) throws RepositoryException;
/**
* Indicates that a node is finished.
* The parent node of the current node becomes the current node.
*
* @throws RepositoryException If anything goes wrong.
*/
void finishNode() throws RepositoryException;
/**
* Indicates that the import is finished
*
* @throws RepositoryException If anything goes wrong.
*/
void finish() throws RepositoryException;
/**
* Create a new property to the current node.
*
* @param name The property name.
* @param propertyType The type of the property.
* @param value The string value.
* @throws RepositoryException If anything goes wrong.
*/
void createProperty(String name, int propertyType, String value) throws RepositoryException;
/**
* Create a new multi value property to the current node.
*
* @param name The property name.
* @param propertyType The type of the property.
* @param values The string values.
* @throws RepositoryException If anything goes wrong.
*/
void createProperty(String name, int propertyType, String[] values) throws RepositoryException;
/**
* Add a new property to the current node.
*
* @param name The property name.
* @param value The value.
* @throws RepositoryException If anything goes wrong.
*/
void createProperty(String name, Object value) throws RepositoryException;
/**
* Add a new multi value property to the current node.
*
* @param name The property name.
* @param values The values.
* @throws RepositoryException If anything goes wrong.
*/
void createProperty(String name, Object[] values) throws RepositoryException;
/**
* Create a file and a resource node.
* After the nodes have been created, the current node is the resource node.
* So this method call should be followed by two calls to {@link #finishNode()}
* to be on the same level as before the file creation.
*
* @param name The name of the file node
* @param data The data of the file
* @param mimeType The mime type or null
* @param lastModified The last modified or -1
* @throws RepositoryException If anything goes wrong.
*/
void createFileAndResourceNode(String name, InputStream data, String mimeType, long lastModified) throws RepositoryException;
/**
* Switch the current node to the path (which must be relative
* to the current node).
* If the path does not exist and a node type is supplied,
* the nodes are created with the given node type.
* If the path does not exist and node type is null, false is
* returned.
* When the changes to the node are finished, {@link #finishNode()}
* must be called.
*
* @param subPath The relative path
* @param newNodeType Node type for newly created nodes.
* @throws RepositoryException If anything goes wrong.
*/
boolean switchCurrentNode(String subPath, String newNodeType) throws RepositoryException;
/**
* Create a User in the jackrabbit UserManager
*
* @param name the name of the user
* @param password the password of the user
* @param extraProperties extra properties to assign to the created user
* @throws RepositoryException If anything goes wrong.
*/
void createUser(String name, String password, Map extraProperties) throws RepositoryException;
/**
* Create a Group in the jackrabbit UserManager
*
* @param name the name of the group
* @param members the members of the group (principal names)
* @param extraProperties extra properties to assign to the created group
* @throws RepositoryException
*/
void createGroup(String name, String[] members, Map extraProperties) throws RepositoryException;
/**
* Creates an Access Control Entry for the current node for the specified
* principal and privileges.
*
* @param principal the user or group id for the ACE
* @param grantedPrivileges the set of privileges to grant the principal
* @param deniedPrivileges the set of privileges to deny the principal (for users only)
* @param order specifies the position of the ACE in the containing ACL. (may be null)
* Value should be one of these:
*
* Values
* first Place the target ACE as the first amongst its siblings last Place the target ACE as the last amongst its siblings before xyz Place the target ACE immediately before the sibling whose name is xyz after xyz Place the target ACE immediately after the sibling whose name is xyz numeric Place the target ACE at the specified index
* @throws RepositoryException If anything goes wrong.
*/
void createAce(String principal, String[] grantedPrivileges, String[] deniedPrivileges, String order) throws RepositoryException;
/**
* Creates an Access Control Entry for the current node for the specified
* principal and privileges.
*
* @param principal the user or group id for the ACE
* @param grantedPrivileges the set of privileges to grant the principal
* @param deniedPrivileges the set of privileges to deny the principal (for users only)
* @param order specifies the position of the ACE in the containing ACL. (may be null)
* Value should be one of these:
*
* Values
* first Place the target ACE as the first amongst its siblings last Place the target ACE as the last amongst its siblings before xyz Place the target ACE immediately before the sibling whose name is xyz after xyz Place the target ACE immediately after the sibling whose name is xyz numeric Place the target ACE at the specified index
* @param restrictions specifies additional Map of single-value restrictions to apply. (optional)
* @param mvRestrictions specifies additional Map of multi-value restrictions to apply. (optional)
* @param removedRestrictionNames optional set of restriction names that should be removed (if they already exist).
* @throws RepositoryException If anything goes wrong.
*/
default void createAce(String principal, String[] grantedPrivileges, String[] deniedPrivileges, String order,
Map restrictions, Map mvRestrictions, Set removedRestrictionNames) throws RepositoryException {
throw new UnsupportedOperationException();
}
/**
* Gets the current parent Node
* @return the current parent node or null
*/
default Node getParent() {
throw new UnsupportedOperationException();
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy