com.cognifide.gradle.aem.common.instance.service.repository

Class Node

com.cognifide.gradle.aem.common.instance.service.repository.Node

public class Node

Represents a node stored in JCR content repository.

Field Detail

DAM_PATH

@NotNull
public static java.lang.String DAM_PATH

See Also:

Constant Field Values

DAM_UPLOAD_SUFFIX

@NotNull
public static java.lang.String DAM_UPLOAD_SUFFIX

See Also:

Constant Field Values

Companion

public static com.cognifide.gradle.aem.common.instance.service.repository.Node.Companion Companion

Constructor Detail

Node

public Node(@NotNull
            Repository repository,
            @NotNull
            java.lang.String path,
            @Nullable
            java.util.Map<java.lang.String,? extends java.lang.Object> props)

Represents a node stored in JCR content repository.

Method Detail

getName

@NotNull
public java.lang.String getName()

Node name

getBaseName

@NotNull
public java.lang.String getBaseName()

File node base name.

getExtension

@NotNull
public java.lang.String getExtension()

File node extension.

getProperties

@NotNull
public Properties getProperties()

JCR node properties.

Keep in mind that these values are loaded lazily and sometimes it is needed to reload them using dedicated method.

getType

@NotNull
public java.lang.String getType()

JCR primary type of node.

getParent

@NotNull
public Node getParent()

Parent node.

getRoot

public boolean getRoot()

parents

@NotNull
public kotlin.sequences.Sequence<com.cognifide.gradle.aem.common.instance.service.repository.Node> parents()

Get all parent nodes.

getParents

@NotNull
public java.util.List<com.cognifide.gradle.aem.common.instance.service.repository.Node> getParents()

child

@NotNull
public Node child(@NotNull
                           java.lang.String name)

Get child node by name.

hasChild

public boolean hasChild(@NotNull
                        java.lang.String name)

Check if child node exists.

getChildren

@NotNull
public java.util.List<com.cognifide.gradle.aem.common.instance.service.repository.Node> getChildren()

Get all child nodes.

Because of performance issues, using method is more preferred.

children

@NotNull
public kotlin.sequences.Sequence<com.cognifide.gradle.aem.common.instance.service.repository.Node> children()

Loop over all node child nodes.

getSiblings

@NotNull
public java.util.List<com.cognifide.gradle.aem.common.instance.service.repository.Node> getSiblings()

siblings

@NotNull
public kotlin.sequences.Sequence<com.cognifide.gradle.aem.common.instance.service.repository.Node> siblings()

sibling

@NotNull
public Node sibling(@NotNull
                             java.lang.String name)

getExists

public boolean getExists()

Check if node exists.

Not checks again if properties of node are already loaded (skips extra HTTP request / optimization).

exists

public boolean exists(boolean recheck)

Check if node exists.

save

@NotNull
public RepositoryResult save(@NotNull
                                      java.util.Map<java.lang.String,? extends java.lang.Object> properties)

Create or update node in repository.

import

@NotNull
public RepositoryResult import(@NotNull
                                        java.util.Map<java.lang.String,? extends java.lang.Object> properties,
                                        @Nullable
                                        java.lang.String name,
                                        boolean replace,
                                        boolean replaceProperties)

Import node into repository.

Effectively it is an alternative method for saving node supporting dots in node names.

import

@NotNull
public RepositoryResult import(@NotNull
                                        java.io.File file,
                                        @Nullable
                                        java.lang.String name,
                                        boolean replace,
                                        boolean replaceProperties)

Import content structure defined in JSON file into repository.

delete

@NotNull
public RepositoryResult delete()

Delete node and all children from repository.

replace

@NotNull
public RepositoryResult replace(@NotNull
                                         java.util.Map<java.lang.String,? extends java.lang.Object> properties)

Delete node and creates it again. Use with caution!

reload

public void reload()

Synchronize on demand previously loaded properties of node (by default properties are loaded lazily). Useful when saving and working on same node again (without instantiating separate variable).

copy

@NotNull
public Node copy(@NotNull
                          java.lang.String targetPath)

Copy node to from source path to destination path.

move

@NotNull
public Node move(@NotNull
                          java.lang.String targetPath,
                          boolean replace)

Move node from source path to destination path.

copyTo

@NotNull
public Node copyTo(@NotNull
                            java.lang.String targetDir)

Copy node to path pointing to folder with preserving original node name.

copyFrom

@NotNull
public Node copyFrom(@NotNull
                              java.lang.String sourcePath)

Copy node from other path to current path.

traverse

@NotNull
public kotlin.sequences.Sequence<com.cognifide.gradle.aem.common.instance.service.repository.Node> traverse(boolean self)

Search nodes by traversing a node tree. Use sequence filter method to find desired nodes.

query

@NotNull
public kotlin.sequences.Sequence<com.cognifide.gradle.aem.common.instance.service.repository.Node> query(@NotNull
                                                                                                                  kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.instance.service.repository.QueryCriteria,kotlin.Unit> criteria)

Search nodes by querying repository under node path.

query

@NotNull
public kotlin.sequences.Sequence<com.cognifide.gradle.aem.common.instance.service.repository.Node> query(@NotNull
                                                                                                                  QueryCriteria criteria)

Search nodes by querying repository under node path.

Note that this method is automatically querying more results (incrementing offset internally).

saveProperty

@NotNull
public RepositoryResult saveProperty(@NotNull
                                              java.lang.String name,
                                              @Nullable
                                              java.lang.Object value)

Update only single property of node.

deleteProperty

@NotNull
public RepositoryResult deleteProperty(@NotNull
                                                java.lang.String name)

Delete single property from node.

deleteProperties

@NotNull
public RepositoryResult deleteProperties(@NotNull
                                                  java.lang.String... names)

Delete multiple properties from node.

deleteProperties

@NotNull
public RepositoryResult deleteProperties(@NotNull
                                                  java.lang.Iterable<java.lang.String> names)

Delete multiple properties from node.

hasProperty

public boolean hasProperty(@NotNull
                           java.lang.String name)

Check if node has property.

hasProperties

public boolean hasProperties(@NotNull
                             java.lang.String... names)

Check if node has properties.

hasProperties

public boolean hasProperties(@NotNull
                             java.lang.Iterable<java.lang.String> names)

Check if node has properties.

getJson

@NotNull
public java.lang.String getJson()

upload

public void upload(@NotNull
                   java.io.File file)

Upload file to node.

If node path points to DAM, separate / dedicated endpoint is used automatically, so that metadata and renditions are generated immediately.

uploadFile

public void uploadFile(@NotNull
                       java.io.File file)

Upload asset using default Sling endpoint.

uploadDamAsset

public void uploadDamAsset(@NotNull
                           java.io.File file)

Upload asset using dedicated DAM endpoint.

uploadTo

@NotNull
public Node uploadTo(@NotNull
                              java.io.File file)

Upload file to current folder node with preserving original file name.

read

public <T> T read(@NotNull
                  kotlin.jvm.functions.Function1<? super java.io.InputStream,? extends T> reader)

Read file stored in node.

download

public void download(@NotNull
                     java.lang.String targetFilePath)

Download file stored in node to specified local file.

download

public void download(@NotNull
                     java.io.File targetFile)

Download file stored in node to specified local file.

download

@NotNull
public java.io.File download()

Download file stored in node to temporary directory with preserving file name.

downloadTo

@NotNull
public java.io.File downloadTo(@NotNull
                                        java.lang.String targetDirPath)

Download file stored in node to specified local directory with preserving file name.

downloadTo

@NotNull
public java.io.File downloadTo(@NotNull
                                        java.io.File targetDir)

Download file stored in node to specified local directory with preserving file name.

downloadPackage

@NotNull
public java.io.File downloadPackage(@NotNull
                                             kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.pkg.PackageDefinition,kotlin.Unit> options)

Download node as CRX package.

equals

public boolean equals(@Nullable
                      java.lang.Object other)

hashCode

public int hashCode()

toString

@NotNull
public java.lang.String toString()

getRepository

@NotNull
public Repository getRepository()

getPath

@NotNull
public java.lang.String getPath()