com.adobe.cq.testing.client.components.foundation

Class Download

java.lang.Object

com.adobe.cq.testing.client.components.AbstractComponent

com.adobe.cq.testing.client.components.foundation.AbstractFoundationComponent

com.adobe.cq.testing.client.components.foundation.Download

public class Download
extends AbstractFoundationComponent

Wraps the Download foundation component, providing methods for editing it. See /libs/foundation/components/download in the repository for implementation details.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROP_DESCRIPTION
static String	PROP_FILE
static String	PROP_FILE_NAME
static String	PROP_FILE_REF
static String	PROP_UNDO_BLOBS
static String	RESOURCE_TYPE

Fields inherited from class com.adobe.cq.testing.client.components.AbstractComponent

changeProperties, client, componentPath, DEFAULT_LOCATION, jsonNode, location, pagePath

Constructor Summary

Constructors

Constructor and Description
Download(ComponentClient client, String pagePath, String location, String nameHint) The constructor stores all the component path information like parentPage, name etc.

Method Summary

Modifier and Type	Method and Description
String	getResourceType() The resource type for the component, e.g.
org.apache.sling.testing.clients.SlingHttpResponse	setDownload(String mimeType, String fileName, String resourcePath, int... expectedStatus) Uploads the file to be used for the download component.
org.apache.sling.testing.clients.SlingHttpResponse	setReference(String fileReference, String fileName, int... expectedStatus) Sets the reference to a file in the repository to be used by the download component.

Methods inherited from class com.adobe.cq.testing.client.components.AbstractComponent

create, getClient, getComponentNode, getComponentPath, getCreateFormEntity, getFirstChild, getLocation, getName, getNext, getNextNodePath, getPagePath, getParentPath, getPrevious, getPreviousNodePath, getProperty, getPropertyAsString, getPropertyAsStringArray, reorder, save, setProperty, setProperty

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE_TYPE

public static final String RESOURCE_TYPE

See Also:

Constant Field Values

PROP_DESCRIPTION

public static final String PROP_DESCRIPTION

See Also:

Constant Field Values

PROP_FILE_NAME

public static final String PROP_FILE_NAME

See Also:

Constant Field Values

PROP_FILE_REF

public static final String PROP_FILE_REF

See Also:

Constant Field Values

PROP_FILE

public static final String PROP_FILE

See Also:

Constant Field Values

PROP_UNDO_BLOBS

public static final String PROP_UNDO_BLOBS

See Also:

Constant Field Values

Constructor Detail

Download

public Download(ComponentClient client,
                String pagePath,
                String location,
                String nameHint)

The constructor stores all the component path information like parentPage, name etc.

Parameters:

client - The FoundationClient that's creating this instance.

pagePath - path to the page that will contain the component.

location - relative location to the parent node inside the page that will contain the component node.

nameHint - name to be used for the component node. Might get altered by the server if a naming conflict occurs. The AbstractComponent.getName() method will return the correct name after (String,int...) has been called.

Method Detail

getResourceType

public String getResourceType()

Description copied from class: AbstractComponent

The resource type for the component, e.g. foundation/components/text. this will be set in the sling:resourceType property of the node.

Specified by:

getResourceType in class AbstractComponent

Returns:

the resource type

setDownload

public org.apache.sling.testing.clients.SlingHttpResponse setDownload(String mimeType,
                                                                      String fileName,
                                                                      String resourcePath,
                                                                      int... expectedStatus)
                                                               throws org.apache.sling.testing.clients.ClientException

Uploads the file to be used for the download component.

Parameters:

mimeType - mime type of file

fileName - file name

resourcePath - path to the resource

expectedStatus - list of allowed HTTP Status to be returned. if not set, status 200 is assumed

Returns:

a SlingHttpResponse wrapping the HTML response returned by Sling

Throws:

org.apache.sling.testing.clients.ClientException - If something fails during request/response cycle

setReference

public org.apache.sling.testing.clients.SlingHttpResponse setReference(String fileReference,
                                                                       String fileName,
                                                                       int... expectedStatus)
                                                                throws org.apache.sling.testing.clients.ClientException

Sets the reference to a file in the repository to be used by the download component.

Parameters:

fileReference - reference to file

fileName - file name

expectedStatus - list of allowed HTTP Status to be returned. if not set, status 200 is assumed

Returns:

a SlingHttpResponse wrapping the HTML response returned by Sling

Throws:

org.apache.sling.testing.clients.ClientException - If something fails during request/response cycle