org.apache.sling.testing.mock.sling.loader

Class ContentLoader

java.lang.Object

org.apache.sling.testing.mock.sling.loader.ContentLoader

public final class ContentLoader
extends Object

Imports JSON data and binary data into Sling resource hierarchy. After all import operations from json or binaries ResourceResolver.commit() is called (when autocommit mode is active).

Constructor Summary

Constructors

Constructor and Description
ContentLoader(@NotNull org.apache.sling.api.resource.ResourceResolver resourceResolver)
ContentLoader(@NotNull org.apache.sling.api.resource.ResourceResolver resourceResolver, @Nullable org.osgi.framework.BundleContext bundleContext)
ContentLoader(@NotNull org.apache.sling.api.resource.ResourceResolver resourceResolver, @Nullable org.osgi.framework.BundleContext bundleContext, boolean autoCommit)
ContentLoader(@NotNull org.apache.sling.api.resource.ResourceResolver resourceResolver, @Nullable org.osgi.framework.BundleContext bundleContext, boolean autoCommit, @Nullable ResourceResolverType resourceResolverType)

Method Summary

Modifier and Type	Method and Description
@NotNull org.apache.sling.api.resource.Resource	binaryFile(@NotNull InputStream inputStream, @NotNull org.apache.sling.api.resource.Resource parentResource, @NotNull String name) Import binary file as nt:file binary node into repository.
@NotNull org.apache.sling.api.resource.Resource	binaryFile(@NotNull InputStream inputStream, @NotNull org.apache.sling.api.resource.Resource parentResource, @NotNull String name, @NotNull String mimeType) Import binary file as nt:file binary node into repository.
@NotNull org.apache.sling.api.resource.Resource	binaryFile(@NotNull InputStream inputStream, @NotNull String path) Import binary file as nt:file binary node into repository.
@NotNull org.apache.sling.api.resource.Resource	binaryFile(@NotNull InputStream inputStream, @NotNull String path, @NotNull String mimeType) Import binary file as nt:file binary node into repository.
@NotNull org.apache.sling.api.resource.Resource	binaryFile(@NotNull String classpathResource, @NotNull String path) Import binary file as nt:file binary node into repository.
@NotNull org.apache.sling.api.resource.Resource	binaryFile(@NotNull String classpathResource, @NotNull String path, @NotNull String mimeType) Import binary file as nt:file binary node into repository.
@NotNull org.apache.sling.api.resource.Resource	binaryResource(@NotNull InputStream inputStream, @NotNull org.apache.sling.api.resource.Resource parentResource, @NotNull String name) Import binary file as nt:resource binary node into repository.
@NotNull org.apache.sling.api.resource.Resource	binaryResource(@NotNull InputStream inputStream, @NotNull org.apache.sling.api.resource.Resource parentResource, @NotNull String name, @NotNull String mimeType) Import binary file as nt:resource binary node into repository.
@NotNull org.apache.sling.api.resource.Resource	binaryResource(@NotNull InputStream inputStream, @NotNull String path) Import binary file as nt:resource binary node into repository.
@NotNull org.apache.sling.api.resource.Resource	binaryResource(@NotNull InputStream inputStream, @NotNull String path, @NotNull String mimeType) Import binary file as nt:resource binary node into repository.
@NotNull org.apache.sling.api.resource.Resource	binaryResource(@NotNull String classpathResource, @NotNull String path) Import binary file as nt:resource binary node into repository.
@NotNull org.apache.sling.api.resource.Resource	binaryResource(@NotNull String classpathResource, @NotNull String path, @NotNull String mimeType) Import binary file as nt:resource binary node into repository.
@NotNull org.apache.sling.api.resource.Resource	json(@NotNull InputStream inputStream, @NotNull org.apache.sling.api.resource.Resource parentResource, @NotNull String childName) Import content of JSON file into repository.
@NotNull org.apache.sling.api.resource.Resource	json(@NotNull InputStream inputStream, @NotNull String destPath) Import content of JSON file into repository.
@NotNull org.apache.sling.api.resource.Resource	json(@NotNull String classpathResource, @NotNull org.apache.sling.api.resource.Resource parentResource, @NotNull String childName) Import content of JSON file into repository.
@NotNull org.apache.sling.api.resource.Resource	json(@NotNull String classpathResource, @NotNull String destPath) Import content of JSON file into repository.

Methods inherited from class java.lang.Object

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

Constructor Detail

ContentLoader

public ContentLoader(@NotNull
                     @NotNull org.apache.sling.api.resource.ResourceResolver resourceResolver)

Parameters:

resourceResolver - Resource resolver

ContentLoader

public ContentLoader(@NotNull
                     @NotNull org.apache.sling.api.resource.ResourceResolver resourceResolver,
                     @Nullable
                     @Nullable org.osgi.framework.BundleContext bundleContext)

Parameters:

resourceResolver - Resource resolver

bundleContext - Bundle context

ContentLoader

public ContentLoader(@NotNull
                     @NotNull org.apache.sling.api.resource.ResourceResolver resourceResolver,
                     @Nullable
                     @Nullable org.osgi.framework.BundleContext bundleContext,
                     boolean autoCommit)

Parameters:

resourceResolver - Resource resolver

bundleContext - Bundle context

autoCommit - Automatically commit changes after loading content (default: true)

ContentLoader

public ContentLoader(@NotNull
                     @NotNull org.apache.sling.api.resource.ResourceResolver resourceResolver,
                     @Nullable
                     @Nullable org.osgi.framework.BundleContext bundleContext,
                     boolean autoCommit,
                     @Nullable
                     @Nullable ResourceResolverType resourceResolverType)

Parameters:

resourceResolver - Resource resolver

bundleContext - Bundle context

autoCommit - Automatically commit changes after loading content (default: true)

resourceResolverType - Resource resolver type.

Method Detail

json

@NotNull
public @NotNull org.apache.sling.api.resource.Resource json(@NotNull
                                                                      @NotNull String classpathResource,
                                                                      @NotNull
                                                                      @NotNull org.apache.sling.api.resource.Resource parentResource,
                                                                      @NotNull
                                                                      @NotNull String childName)

Import content of JSON file into repository.

Parameters:

classpathResource - Classpath resource URL for JSON content

parentResource - Parent resource

childName - Name of child resource to create with JSON content

Returns:

Resource

json

@NotNull
public @NotNull org.apache.sling.api.resource.Resource json(@NotNull
                                                                      @NotNull String classpathResource,
                                                                      @NotNull
                                                                      @NotNull String destPath)

Import content of JSON file into repository. Auto-creates parent hierarchies as nt:unstrucured nodes if missing.

Parameters:

classpathResource - Classpath resource URL for JSON content

destPath - Path to import the JSON content to

Returns:

Resource

json

@NotNull
public @NotNull org.apache.sling.api.resource.Resource json(@NotNull
                                                                      @NotNull InputStream inputStream,
                                                                      @NotNull
                                                                      @NotNull org.apache.sling.api.resource.Resource parentResource,
                                                                      @NotNull
                                                                      @NotNull String childName)

Import content of JSON file into repository.

Parameters:

inputStream - Input stream with JSON content

parentResource - Parent resource

childName - Name of child resource to create with JSON content

Returns:

Resource

json

@NotNull
public @NotNull org.apache.sling.api.resource.Resource json(@NotNull
                                                                      @NotNull InputStream inputStream,
                                                                      @NotNull
                                                                      @NotNull String destPath)

Import content of JSON file into repository. Auto-creates parent hierarchies as nt:unstrucured nodes if missing.

Parameters:

inputStream - Input stream with JSON content

destPath - Path to import the JSON content to

Returns:

Resource

binaryFile

@NotNull
public @NotNull org.apache.sling.api.resource.Resource binaryFile(@NotNull
                                                                            @NotNull String classpathResource,
                                                                            @NotNull
                                                                            @NotNull String path)

Import binary file as nt:file binary node into repository. Auto-creates parent hierarchies as nt:unstrucured nodes if missing. Mime type is auto-detected from either classpathResource or path.

Parameters:

classpathResource - Classpath resource URL for binary file.

path - Path to mount binary data to (parent nodes created automatically)

Returns:

Resource with binary data

binaryFile

@NotNull
public @NotNull org.apache.sling.api.resource.Resource binaryFile(@NotNull
                                                                            @NotNull String classpathResource,
                                                                            @NotNull
                                                                            @NotNull String path,
                                                                            @NotNull
                                                                            @NotNull String mimeType)

Import binary file as nt:file binary node into repository. Auto-creates parent hierarchies as nt:unstrucured nodes if missing.

Parameters:

classpathResource - Classpath resource URL for binary file.

path - Path to mount binary data to (parent nodes created automatically)

mimeType - Mime type of binary data

Returns:

Resource with binary data

binaryFile

@NotNull
public @NotNull org.apache.sling.api.resource.Resource binaryFile(@NotNull
                                                                            @NotNull InputStream inputStream,
                                                                            @NotNull
                                                                            @NotNull String path)

Import binary file as nt:file binary node into repository. Auto-creates parent hierarchies as nt:unstrucured nodes if missing. Mime type is auto-detected from resource name.

Parameters:

inputStream - Input stream for binary data

path - Path to mount binary data to (parent nodes created automatically)

Returns:

Resource with binary data

binaryFile

@NotNull
public @NotNull org.apache.sling.api.resource.Resource binaryFile(@NotNull
                                                                            @NotNull InputStream inputStream,
                                                                            @NotNull
                                                                            @NotNull String path,
                                                                            @NotNull
                                                                            @NotNull String mimeType)

Import binary file as nt:file binary node into repository. Auto-creates parent hierarchies as nt:unstrucured nodes if missing.

Parameters:

inputStream - Input stream for binary data

path - Path to mount binary data to (parent nodes created automatically)

mimeType - Mime type of binary data

Returns:

Resource with binary data

binaryFile

@NotNull
public @NotNull org.apache.sling.api.resource.Resource binaryFile(@NotNull
                                                                            @NotNull InputStream inputStream,
                                                                            @NotNull
                                                                            @NotNull org.apache.sling.api.resource.Resource parentResource,
                                                                            @NotNull
                                                                            @NotNull String name)

Import binary file as nt:file binary node into repository. Auto-creates parent hierarchies as nt:unstrucured nodes if missing. Mime type is auto-detected from resource name.

Parameters:

inputStream - Input stream for binary data

parentResource - Parent resource

name - Resource name for nt:file

Returns:

Resource with binary data

binaryFile

@NotNull
public @NotNull org.apache.sling.api.resource.Resource binaryFile(@NotNull
                                                                            @NotNull InputStream inputStream,
                                                                            @NotNull
                                                                            @NotNull org.apache.sling.api.resource.Resource parentResource,
                                                                            @NotNull
                                                                            @NotNull String name,
                                                                            @NotNull
                                                                            @NotNull String mimeType)

Import binary file as nt:file binary node into repository. Auto-creates parent hierarchies as nt:unstrucured nodes if missing.

Parameters:

inputStream - Input stream for binary data

parentResource - Parent resource

name - Resource name for nt:file

mimeType - Mime type of binary data

Returns:

Resource with binary data

binaryResource

@NotNull
public @NotNull org.apache.sling.api.resource.Resource binaryResource(@NotNull
                                                                                @NotNull String classpathResource,
                                                                                @NotNull
                                                                                @NotNull String path)

Import binary file as nt:resource binary node into repository. Auto-creates parent hierarchies as nt:unstrucured nodes if missing. Mime type is auto-detected from classpathResource or path.

Parameters:

classpathResource - Classpath resource URL for binary file.

path - Path to mount binary data to (parent nodes created automatically)

Returns:

Resource with binary data

binaryResource

@NotNull
public @NotNull org.apache.sling.api.resource.Resource binaryResource(@NotNull
                                                                                @NotNull String classpathResource,
                                                                                @NotNull
                                                                                @NotNull String path,
                                                                                @NotNull
                                                                                @NotNull String mimeType)

Import binary file as nt:resource binary node into repository. Auto-creates parent hierarchies as nt:unstrucured nodes if missing.

Parameters:

classpathResource - Classpath resource URL for binary file.

path - Path to mount binary data to (parent nodes created automatically)

mimeType - Mime type of binary data

Returns:

Resource with binary data

binaryResource

@NotNull
public @NotNull org.apache.sling.api.resource.Resource binaryResource(@NotNull
                                                                                @NotNull InputStream inputStream,
                                                                                @NotNull
                                                                                @NotNull String path)

Import binary file as nt:resource binary node into repository. Auto-creates parent hierarchies as nt:unstrucured nodes if missing. Mime type is auto-detected from resource name.

Parameters:

inputStream - Input stream for binary data

path - Path to mount binary data to (parent nodes created automatically)

Returns:

Resource with binary data

binaryResource

@NotNull
public @NotNull org.apache.sling.api.resource.Resource binaryResource(@NotNull
                                                                                @NotNull InputStream inputStream,
                                                                                @NotNull
                                                                                @NotNull String path,
                                                                                @NotNull
                                                                                @NotNull String mimeType)

Import binary file as nt:resource binary node into repository. Auto-creates parent hierarchies as nt:unstrucured nodes if missing.

Parameters:

inputStream - Input stream for binary data

path - Path to mount binary data to (parent nodes created automatically)

mimeType - Mime type of binary data

Returns:

Resource with binary data

binaryResource

@NotNull
public @NotNull org.apache.sling.api.resource.Resource binaryResource(@NotNull
                                                                                @NotNull InputStream inputStream,
                                                                                @NotNull
                                                                                @NotNull org.apache.sling.api.resource.Resource parentResource,
                                                                                @NotNull
                                                                                @NotNull String name)

Import binary file as nt:resource binary node into repository. Auto-creates parent hierarchies as nt:unstrucured nodes if missing. Mime type is auto-detected from resource name.

Parameters:

inputStream - Input stream for binary data

parentResource - Parent resource

name - Resource name for nt:resource

Returns:

Resource with binary data

binaryResource

@NotNull
public @NotNull org.apache.sling.api.resource.Resource binaryResource(@NotNull
                                                                                @NotNull InputStream inputStream,
                                                                                @NotNull
                                                                                @NotNull org.apache.sling.api.resource.Resource parentResource,
                                                                                @NotNull
                                                                                @NotNull String name,
                                                                                @NotNull
                                                                                @NotNull String mimeType)

Import binary file as nt:resource binary node into repository. Auto-creates parent hierarchies as nt:unstrucured nodes if missing.

Parameters:

inputStream - Input stream for binary data

parentResource - Parent resource

name - Resource name for nt:resource

mimeType - Mime type of binary data

Returns:

Resource with binary data