com.day.cq.dam.scene7.api

Interface Scene7APIClient

public interface Scene7APIClient

The Scene7APIClient provides the Scene7 SPS API methods used by CQ DAM. For more details about the methods please consult the SPS API.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONTENTTYPE default content-type (i.e.
static int	RECORDS_PER_PAGE_NO_FILTER
static int	RECORDS_PER_PAGE_WITH_FILTER

Method Summary

Modifier and Type	Method and Description
org.w3c.dom.Document	deleteAsset(java.lang.String assetHandle, S7Config s7Config) Deletes an asset from Scene7.
org.w3c.dom.Document	deleteFolder(java.lang.String folderHandle, S7Config s7Config) Deletes a folder from Scene7.
org.w3c.dom.Document	getActiveJobs(java.lang.String jobHandle, java.lang.String originalName, S7Config s7Config) Gets all jobs that are currently active in the system.
org.w3c.dom.Document	getAssets(java.lang.String[] assetHandles, java.lang.String[] responseFields, java.lang.String[] excludeFields, S7Config s7Config) Gets assets from IPS.
org.w3c.dom.Document	getAssociatedAssets(java.lang.String assetHandle, java.lang.String[] responseFields, java.lang.String[] excludeFields, S7Config s7Config) Gets assets associated with the specified asset and details about their relationship.
org.w3c.dom.Document	getCompanyMembership(ResourceResolver resourceResolver, java.lang.String userHandle, java.lang.String email, java.lang.String password, java.lang.String region) Gets a user's memberships.
org.w3c.dom.Document	getFolderTree(java.lang.String folderPath, int depth, java.lang.String[] responseFields, java.lang.String[] excludeFields, S7Config s7Config) Gets folders and sub-folders in a hierarchical tree structure.
org.w3c.dom.Document	getImagePresets(S7Config s7Config) Gets the SPS image presets
java.io.InputStream	getIPSFile(Scene7Asset asset, S7Config s7Config) Deprecated. Incompatible with Scene7 IPS SSL endpoint. Please use getOriginalFile() instead.
org.w3c.dom.Document	getJobLogDetails(java.lang.String jobHandle, java.lang.String originalName, S7Config s7Config) Gets the details of job logs of a company.
java.io.InputStream	getOriginalFile(java.lang.String assetHandle, S7Config s7Config) Provides a way to get the originally uploaded file to the Scene7 servers after an asset has been processed.
org.w3c.dom.Document	getPropertySets(java.lang.String appSettingsTypeHandle, S7Config s7Config) Gets property sets associated with a type handle.
org.w3c.dom.Document	getPropertySetTypes(S7Config s7Config) Gets the property set types associated with the specified company from the S7Config object.
org.w3c.dom.Document	getSystemProperties(S7Config s7Config) Retrieves the system properties XML document served by the GetSystemProperties SPS servlet.
java.io.InputStream	getThumbnailForAsset(Scene7Asset scene7Asset, S7Config s7Config) Retrieves a JPEG image in an InputStream that can be used as a thumbnail in CQ DAM.
org.w3c.dom.Document	getUserInfo(ResourceResolver resourceResolver, java.lang.String email, java.lang.String password, java.lang.String region) Gets information about a user.
org.w3c.dom.Document	searchAssets(java.lang.String folder, java.lang.Boolean includeSubfolders, java.lang.Boolean published, java.lang.String[] assetTypes, java.lang.String[] assetSubTypes, java.lang.String[] responseFields, java.lang.String[] excludeFields, int recordsPerPage, int resultsPage, S7Config s7Config) Deprecated. * @deprecated No longer supported. Replaced by searchAssets(String, Boolean, Boolean, String[], String[], String[], String[], int, int, String, S7Config)
org.w3c.dom.Document	searchAssets(java.lang.String folder, java.lang.Boolean includeSubfolders, java.lang.Boolean published, java.lang.String[] assetTypes, java.lang.String[] assetSubTypes, java.lang.String[] responseFields, java.lang.String[] excludeFields, int recordsPerPage, int resultsPage, java.lang.String fileName, S7Config s7Config) Searches for assets based on one or more filter criteria.
org.w3c.dom.Document	searchAssetsByMetadata(java.lang.String folder, java.lang.Boolean includeSubfolders, java.lang.String[] assetTypes, java.lang.String[] assetSubTypes, java.lang.Boolean published, MetadataCondition[] conditions, int recordsPerPage, int resultsPage, S7Config s7Config) Searches the metadata index repository for the given search terms, support loading assets by page
org.w3c.dom.Document	searchAssetsByMetadata(java.lang.String folder, java.lang.Boolean includeSubfolders, java.lang.String[] assetTypes, java.lang.String[] assetSubTypes, java.lang.Boolean published, MetadataCondition[] conditions, S7Config s7Config) Searches the metadata index repository for the given search terms.
org.w3c.dom.Document	setAssetPublishState(java.lang.String assetHandle, S7Config s7Config, java.lang.String publishState) Sets the publish state of a given Scene7 asset
org.w3c.dom.Document	submitJob(java.lang.String jobName, Scene7JobType jobType, S7Config s7Config) Submits a job to the system.

Field Detail

CONTENTTYPE

static final java.lang.String CONTENTTYPE

default content-type (i.e. 'application/soap+xml'), defaults to 'text/xml'

See Also:

Constant Field Values

RECORDS_PER_PAGE_NO_FILTER

static final int RECORDS_PER_PAGE_NO_FILTER

See Also:

Constant Field Values

RECORDS_PER_PAGE_WITH_FILTER

static final int RECORDS_PER_PAGE_WITH_FILTER

See Also:

Constant Field Values

Method Detail

deleteAsset

org.w3c.dom.Document deleteAsset(java.lang.String assetHandle,
                                 S7Config s7Config)

Deletes an asset from Scene7.

Parameters:

assetHandle - the handle to the asset to delete

s7Config - the Scene7 configuration

Returns:

the API's response wrapped in a Document

deleteFolder

org.w3c.dom.Document deleteFolder(java.lang.String folderHandle,
                                  S7Config s7Config)

Deletes a folder from Scene7.

Parameters:

folderHandle - the handle to the folder to delete

s7Config - the Scene7 configuration

Returns:

the API's response wrapped in a Document

getActiveJobs

org.w3c.dom.Document getActiveJobs(java.lang.String jobHandle,
                                   java.lang.String originalName,
                                   S7Config s7Config)

Gets all jobs that are currently active in the system.

Parameters:

jobHandle - the handle to the job

originalName - the original name of the job

s7Config - the Scene7 configuration

Returns:

the API's response wrapped in a Document

getAssets

org.w3c.dom.Document getAssets(java.lang.String[] assetHandles,
                               java.lang.String[] responseFields,
                               java.lang.String[] excludeFields,
                               S7Config s7Config)

Gets assets from IPS.

Parameters:

assetHandles - the asset handles

responseFields - a list of fields and subfields for inclusion in the response

excludeFields - a list of fields and subfields for exclusion from the response

s7Config - the Scene7 configuration

Returns:

the API's response wrapped in a Document

getAssociatedAssets

org.w3c.dom.Document getAssociatedAssets(java.lang.String assetHandle,
                                         java.lang.String[] responseFields,
                                         java.lang.String[] excludeFields,
                                         S7Config s7Config)

Gets assets associated with the specified asset and details about their relationship.

Parameters:

assetHandle - the handle to the asset

responseFields - a list of fields and subfields for inclusion in the response

excludeFields - a list of fields and subfields for exclusion from the response

s7Config - the Scene7 configuration

Returns:

the API's response wrapped in a Document

getCompanyMembership

org.w3c.dom.Document getCompanyMembership(ResourceResolver resourceResolver,
                                          java.lang.String userHandle,
                                          java.lang.String email,
                                          java.lang.String password,
                                          java.lang.String region)

Gets a user's memberships.

Parameters:

resourceResolver - resource resolver used to access Scene7 configuration

userHandle - the handle to the user whose memberships you want to obtain

email - the user's email

password - the user's password

region - the user's region

Returns:

the API's response wrapped in a Document

getFolderTree

org.w3c.dom.Document getFolderTree(java.lang.String folderPath,
                                   int depth,
                                   java.lang.String[] responseFields,
                                   java.lang.String[] excludeFields,
                                   S7Config s7Config)

Gets folders and sub-folders in a hierarchical tree structure. The getFolderTree response is limited to a maximum of 100000 folders.

Parameters:

folderPath - the root folder to retrieve folders and all subfolders to the leaflevel; if excluded, the company root is used

depth - a value of zero gets the top-level folder; any other value specifies the depth to descend into the tree

responseFields - a list of fields and subfields for inclusion in the response

excludeFields - a list of fields and subfields for exclusion from the response

s7Config - the Scene7 configuration

Returns:

the API's response wrapped in a Document

getJobLogDetails

org.w3c.dom.Document getJobLogDetails(java.lang.String jobHandle,
                                      java.lang.String originalName,
                                      S7Config s7Config)

Gets the details of job logs of a company.

Parameters:

jobHandle - a handle to an active or completed job

originalName - the original name of the job log

s7Config - the Scene7 configuration

Returns:

the API's response wrapped in a Document

getPropertySets

org.w3c.dom.Document getPropertySets(java.lang.String appSettingsTypeHandle,
                                     S7Config s7Config)

Gets property sets associated with a type handle.

Parameters:

appSettingsTypeHandle - the handle to the property set type

s7Config - the Scene7 configuration

Returns:

the API's response wrapped in a Document

getPropertySetTypes

org.w3c.dom.Document getPropertySetTypes(S7Config s7Config)

Gets the property set types associated with the specified company from the S7Config object.

Parameters:

s7Config - the Scene7 configuration

Returns:

the API's response wrapped in a Document

getImagePresets

org.w3c.dom.Document getImagePresets(S7Config s7Config)

Gets the SPS image presets

Parameters:

s7Config - the Scene7 configuration

Returns:

the API's response wrapped in a Document

getUserInfo

org.w3c.dom.Document getUserInfo(ResourceResolver resourceResolver,
                                 java.lang.String email,
                                 java.lang.String password,
                                 java.lang.String region)

Gets information about a user.

Parameters:

resourceResolver - resource resolver used to access Scene7 configuration

email - the user's email

password - the user's password

region - the user's region

Returns:

the API's response wrapped in a Document

searchAssets

@Deprecated
org.w3c.dom.Document searchAssets(java.lang.String folder,
                                              java.lang.Boolean includeSubfolders,
                                              java.lang.Boolean published,
                                              java.lang.String[] assetTypes,
                                              java.lang.String[] assetSubTypes,
                                              java.lang.String[] responseFields,
                                              java.lang.String[] excludeFields,
                                              int recordsPerPage,
                                              int resultsPage,
                                              S7Config s7Config)

Deprecated. * @deprecated No longer supported. Replaced by searchAssets(String, Boolean, Boolean, String[], String[], String[], String[], int, int, String, S7Config)

Searches for assets based on one or more filter criteria.

Parameters:

folder - the root path for searching for assets; if omitted, the company root folder will be used

includeSubfolders - if true, the search includes sub-folders

published - if true, the search will include only published assets

assetTypes - array of Asset Types to include in search

assetSubTypes - array of sub Asset Types to include in search

responseFields - a list of fields and subfields for inclusion in the response

excludeFields - a list of fields and subfields for exclusion from the response

recordsPerPage - maximum number of results to return

resultsPage - specifies the page of results to return, based on recordsPerPage page size

s7Config - the Scene7 configuration

Returns:

the API's response wrapped in a Document

searchAssets

org.w3c.dom.Document searchAssets(java.lang.String folder,
                                  java.lang.Boolean includeSubfolders,
                                  java.lang.Boolean published,
                                  java.lang.String[] assetTypes,
                                  java.lang.String[] assetSubTypes,
                                  java.lang.String[] responseFields,
                                  java.lang.String[] excludeFields,
                                  int recordsPerPage,
                                  int resultsPage,
                                  java.lang.String fileName,
                                  S7Config s7Config)

Searches for assets based on one or more filter criteria.

Parameters:

folder - the root path for searching for assets; if omitted, the company root folder will be used

includeSubfolders - if true, the search includes sub-folders

published - if true, the search will include only published assets

assetTypes - array of Asset Types to include in search

assetSubTypes - array of sub Asset Types to include in search

responseFields - a list of fields and subfields for inclusion in the response

excludeFields - a list of fields and subfields for exclusion from the response

recordsPerPage - maximum number of results to return

resultsPage - specifies the page of results to return, based on recordsPerPage page size

fileName - the filename for search asset

s7Config - the Scene7 configuration

Returns:

the API's response wrapped in a Document

searchAssetsByMetadata

org.w3c.dom.Document searchAssetsByMetadata(java.lang.String folder,
                                            java.lang.Boolean includeSubfolders,
                                            java.lang.String[] assetTypes,
                                            java.lang.String[] assetSubTypes,
                                            java.lang.Boolean published,
                                            MetadataCondition[] conditions,
                                            S7Config s7Config)

Searches the metadata index repository for the given search terms.

Parameters:

folder - the root path for searching for assets; if omitted, the company root folder will be used

includeSubfolders - if true, the search includes sub-folders

assetTypes - array of Asset Types to include in search

assetSubTypes - array of sub Asset Types to include in search

published - if true, the search will include only published assets

conditions - one or more query conditions that define the search criteria

s7Config - the Scene7 configuration

Returns:

the API's response wrapped in a Document

searchAssetsByMetadata

org.w3c.dom.Document searchAssetsByMetadata(java.lang.String folder,
                                            java.lang.Boolean includeSubfolders,
                                            java.lang.String[] assetTypes,
                                            java.lang.String[] assetSubTypes,
                                            java.lang.Boolean published,
                                            MetadataCondition[] conditions,
                                            int recordsPerPage,
                                            int resultsPage,
                                            S7Config s7Config)

Searches the metadata index repository for the given search terms, support loading assets by page

Parameters:

folder - the root path for searching for assets; if omitted, the company root folder will be used

includeSubfolders - if true, the search includes sub-folders

assetTypes - array of Asset Types to include in search

assetSubTypes - array of sub Asset Types to include in search

published - if true, the search will include only published assets

conditions - one or more query conditions that define the search criteria

recordsPerPage - maximum number of results to return

resultsPage - specifies the page of results to return, based on recordsPerPage page size

s7Config - the Scene7 configuration

Returns:

the API's response wrapped in a Document

submitJob

org.w3c.dom.Document submitJob(java.lang.String jobName,
                               Scene7JobType jobType,
                               S7Config s7Config)

Submits a job to the system.

Parameters:

jobName - the name of the job

jobType - the job's type

s7Config - the Scene7 configuration

Returns:

the API's response wrapped in a Document

See Also:

Scene7JobType

getSystemProperties

org.w3c.dom.Document getSystemProperties(S7Config s7Config)

Retrieves the system properties XML document served by the GetSystemProperties SPS servlet.

Parameters:

s7Config -

Returns:

the SPS system properties wrapped in a Document

getOriginalFile

java.io.InputStream getOriginalFile(java.lang.String assetHandle,
                                    S7Config s7Config)

Provides a way to get the originally uploaded file to the Scene7 servers after an asset has been processed.

Parameters:

assetHandle - the asset's handle (unique id generated by Scene7)

s7Config - the Scene7 configuration

Returns:

an InputStream from which the file can be retrieved; the InputStream can be null if any error occurred

getIPSFile

@Deprecated
java.io.InputStream getIPSFile(Scene7Asset asset,
                                           S7Config s7Config)

Deprecated. Incompatible with Scene7 IPS SSL endpoint. Please use getOriginalFile() instead.

Provides a way to get the published image for a Scene7 asset

Parameters:

asset - the Scene7Asset asset object

s7Config - the S7Config configuration

Returns:

an InputStream of the published image asset

getThumbnailForAsset

java.io.InputStream getThumbnailForAsset(Scene7Asset scene7Asset,
                                         S7Config s7Config)

Retrieves a JPEG image in an InputStream that can be used as a thumbnail in CQ DAM. The image has the same size as the originally uploaded asset from Scene7.

Parameters:

scene7Asset - the Scene7 asset abstractization

s7Config - the Scene7 configuration

Returns:

an InputStream from which the file can be retrieved; the InputStream can be null if any error occurred

setAssetPublishState

org.w3c.dom.Document setAssetPublishState(java.lang.String assetHandle,
                                          S7Config s7Config,
                                          java.lang.String publishState)

Sets the publish state of a given Scene7 asset

Parameters:

assetHandle - the Scene7 asset handle

publishState - the asset publish state

s7Config - the Scene7 configuration

Returns: