com.day.cq.dam.scene7.api

Interface Scene7Service

public interface Scene7Service

The Scene7Service provides methods for interacting with the official Scene7 API.

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONTAINER Scene7 specification used in getAssociatedAssets - Array of set and template assets containing the specified asset.
static int	DERIVED Scene7 specification used in getAssociatedAssets - Array of assets that are derivatives of the specified asset.
static int	GENERATED Scene7 specification used in getAssociatedAssets - Array of assets that were generated from the specified asset.
static int	GENERATOR Scene7 specification used in getAssociatedAssets - Array of assets that were used to generate the specified asset.
static int	MEMBER Scene7 specification used in getAssociatedAssets - Array of assets contained by the specified set or template asset.
static int	OWNER Scene7 specification used in getAssociatedAssets - Array of assets that own the specified asset.

Method Summary

Modifier and Type	Method and Description
String	deleteAsset(String assetHandle, S7Config s7Config) Returns a String success/ failure,, note that the underlying S7 API call does not provide a data response.
String	deleteFolder(String folderHandle, S7Config s7Config) Returns a String success/ failure,, note that the underlying S7 API call does not provide a data response.
String	getApplicationPropertyHandle(S7Config s7Config) Returns the application property handle.
List<Scene7Asset>	getAssets(String[] assetHandles, String[] responseFields, String[] excludeFields, S7Config s7Config) Returns a Scene7Asset list, based on a list of asset handles
Scene7Asset	getAssociatedAssets(Scene7Asset asset, S7Config s7Config) Retrieves the sub-assets and the origiator asset associated with the given asset
String	getCompanyMembership(ResourceResolver resourceResolver, String userHandle, String email, String password, String region) Returns a JSON representation of the company membership information provided by Scene7.
String	getFlashTemplatesServer(S7Config s7Config) Retrieves the server used for serving and manipulating flash templates, depending on the Scene7 configuration.
String	getFolderHandle(String cqFolderPath, S7Config s7Config) Returns s7 folder handle for the associated cq folder
Scene7Folder	getFolderTree(String folderPath, int depth, String[] responseFields, String[] excludeFields, S7Config s7Config) Returns a Scene7Folder holding a tree structure
String	getFxgServer(S7Config s7Config) Retrieves the server handling FXG rendering.
List<String>	getImagePresets(S7Config s7Config) Returns a list of Scene7 image preset names for the given S7Config
List<String>	getJobLogDetails(String jobHandle, S7Config s7Config) Returns a list of Scene7 asset handles(Strings) for the given job handle
Scene7Asset	getMasterAsset(Scene7Asset asset, S7Config s7Config) Retrieves the originator asset associated with the given asset
ArrayList<UploadJobDetail>	getMultiFileJobLogDetails(String jobHandle, S7Config s7Config) Returns an Arraylist of job details objects
List<Scene7PropertySet>	getPropertySets(String typeHandle, S7Config s7Config) Returns the video encoder preset type handle.
String	getPublishServer(S7Config s7Config) Returns the domain name of the S7 publish server
String	getUserHandle(ResourceResolver resourceResolver, String email, String password, String region) Returns a unique user handle from Scene7.
String	getVideoEncoderPresetTypeHandle(S7Config s7Config) Returns the video encoder preset type handle.
boolean	isJobActiveByJobHandle(String jobHandle, S7Config s7Config)
boolean	isJobActiveByOriginalName(String originalName, S7Config s7Config)
List<Scene7Asset>	searchAssets(String folder, Boolean includeSubfolders, Boolean published, String[] assetTypes, String[] assetSubTypes, String[] responseFields, String[] excludeFields, int recordsPerPage, int resultsPage, S7Config s7Config) Retrieves a list of Scene7Assets from the Scene7 server.
List<Scene7Asset>	searchAssets(String folder, Boolean includeSubfolders, Boolean published, String[] assetTypes, String[] assetSubTypes, String[] responseFields, String[] excludeFields, S7Config s7Config) Retrieves a list of Scene7Assets from the Scene7 server.
List<Scene7Asset>	searchAssetsByFilename(String folder, Boolean includeSubfolders, Boolean published, String filename, S7Config s7Config) Retrieve a list of Scene7Assets from the Scene7 server by filename.
List<Scene7Asset>	searchAssetsByMetadata(String folder, Boolean includeSubfolders, String[] assetTypes, String[] assetSubTypes, Boolean published, MetadataCondition[] conditions, int recordsPerPage, int resultsPage, S7Config s7Config) Returns a DOM list with search results (from metadata), support specify
List<Scene7Asset>	searchAssetsByMetadata(String folder, Boolean includeSubfolders, String[] assetTypes, String[] assetSubTypes, Boolean published, MetadataCondition[] conditions, S7Config s7Config) Returns a DOM list with search results (from metadata)
String	setAssetPublishState(Resource resource, boolean markForPublish, S7Config s7Config) Set the publish state of a given Scene7 asset
String	setAssetPublishState(String assetHandle, boolean markForPublish, S7Config s7Config) Set the publish state of a given Scene7 asset

Field Detail

CONTAINER

static final int CONTAINER

Scene7 specification used in getAssociatedAssets - Array of set and template assets containing the specified asset.

See Also:

Constant Field Values

MEMBER

static final int MEMBER

Scene7 specification used in getAssociatedAssets - Array of assets contained by the specified set or template asset.

See Also:

Constant Field Values

OWNER

static final int OWNER

Scene7 specification used in getAssociatedAssets - Array of assets that own the specified asset.

See Also:

Constant Field Values

DERIVED

static final int DERIVED

Scene7 specification used in getAssociatedAssets - Array of assets that are derivatives of the specified asset.

See Also:

Constant Field Values

GENERATOR

static final int GENERATOR

Scene7 specification used in getAssociatedAssets - Array of assets that were used to generate the specified asset.

See Also:

Constant Field Values

GENERATED

static final int GENERATED

Scene7 specification used in getAssociatedAssets - Array of assets that were generated from the specified asset.

See Also:

Constant Field Values

Method Detail

getPublishServer

String getPublishServer(S7Config s7Config)

Returns the domain name of the S7 publish server

Parameters:

s7Config -

Returns:

A string

getApplicationPropertyHandle

String getApplicationPropertyHandle(S7Config s7Config)

Returns the application property handle.

Parameters:

s7Config - the Scene7 configuration

Returns:

the application property handle

getVideoEncoderPresetTypeHandle

String getVideoEncoderPresetTypeHandle(S7Config s7Config)

Returns the video encoder preset type handle.

Parameters:

s7Config - the Scene7 configuration

Returns:

the video encoder preset type handle

getPropertySets

List<Scene7PropertySet> getPropertySets(String typeHandle,
                                        S7Config s7Config)

Returns the video encoder preset type handle.

Parameters:

typeHandle - - the type handle

s7Config - the Scene7 configuration

Returns:

the list of property sets

getUserHandle

String getUserHandle(ResourceResolver resourceResolver,
                     String email,
                     String password,
                     String region)

Returns a unique user handle from Scene7.

Parameters:

resourceResolver - resource resolver used to access Scene7 configuration

email - E-Mail address

password - Password

region - Region of the Scene7 service

Returns:

A unique user handle

getCompanyMembership

String getCompanyMembership(ResourceResolver resourceResolver,
                            String userHandle,
                            String email,
                            String password,
                            String region)

Returns a JSON representation of the company membership information provided by Scene7. The information includes a company handle, a company name and an asset root path.

For example:
{
handle: 'jlkj98',
name: 'Acme Ltd.',
rootPath: '/MyAssets'
}

Parameters:

resourceResolver - resource resolver used to access Scene7 configuration

userHandle - Unique user handle

email - E-Mail address

password - Password

region - Region of the Scene7 service

Returns:

A JSON string

getFolderTree

Scene7Folder getFolderTree(String folderPath,
                           int depth,
                           String[] responseFields,
                           String[] excludeFields,
                           S7Config s7Config)

Returns a Scene7Folder holding a tree structure

Parameters:

folderPath - - the top folder of the request - does not need to be the root.

depth - - depth of the returned folder tree.

responseFields - - fields to be filled in for each node in the tree

excludeFields - - fields to be excluded in each node of the tree

s7Config -

Returns:

A Scene7Folder object containing the requested folder structure

getFolderHandle

String getFolderHandle(String cqFolderPath,
                       S7Config s7Config)

Returns s7 folder handle for the associated cq folder

Parameters:

cqFolderPath - - the path the target cq folder targeted in the s7 folder organization

s7Config -

Returns:

folder handle or null if the folder does not exist in s7.

deleteFolder

String deleteFolder(String folderHandle,
                    S7Config s7Config)

Returns a String success/ failure,, note that the underlying S7 API call does not provide a data response.

Parameters:

folderHandle - - folder to be deleted

s7Config - - s7 config based on cloud service config info.

Returns:

String success / failure

deleteAsset

String deleteAsset(String assetHandle,
                   S7Config s7Config)

Returns a String success/ failure,, note that the underlying S7 API call does not provide a data response.

Parameters:

assetHandle - - asset to be deleted

s7Config - - s7 config based on cloud service config info.

Returns:

String success / failure

searchAssetsByMetadata

List<Scene7Asset> searchAssetsByMetadata(String folder,
                                         Boolean includeSubfolders,
                                         String[] assetTypes,
                                         String[] assetSubTypes,
                                         Boolean published,
                                         MetadataCondition[] conditions,
                                         S7Config s7Config)

Returns a DOM list with search results (from metadata)

Parameters:

folder - - all matched assets will be in this folder

includeSubfolders - - whether to recursively search for assets

assetTypes - - all matched assets will be one of these types

assetSubTypes - array of sub Asset Types to include in search

published - - whether the matched assets must be marked for publish (only marked - not necessarily actually published)

conditions - - metadata conditions for search

s7Config -

Returns:

A list of assets; the list can be empty if no assets have been found.

searchAssetsByMetadata

List<Scene7Asset> searchAssetsByMetadata(String folder,
                                         Boolean includeSubfolders,
                                         String[] assetTypes,
                                         String[] assetSubTypes,
                                         Boolean published,
                                         MetadataCondition[] conditions,
                                         int recordsPerPage,
                                         int resultsPage,
                                         S7Config s7Config)

Returns a DOM list with search results (from metadata), support specify

Parameters:

folder - - all matched assets will be in this folder

includeSubfolders - - whether to recursively search for assets

assetTypes - - all matched assets will be one of these types

assetSubTypes - array of sub Asset Types to include in search

published - - whether the matched assets must be marked for publish (only marked - not necessarily actually published)

conditions - - metadata conditions for search

recordsPerPage - maximum number of results to return

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

s7Config -

Returns:

A list of assets; the list can be empty if no assets have been found.

getAssets

List<Scene7Asset> getAssets(String[] assetHandles,
                            String[] responseFields,
                            String[] excludeFields,
                            S7Config s7Config)

Returns a Scene7Asset list, based on a list of asset handles

Parameters:

assetHandles - - the assets to retrieve

responseFields - - fields to be filled in for each node in the tree

excludeFields - - fields to be excluded in each node of the tree

s7Config -

Returns:

A Scene7Asset list

getMultiFileJobLogDetails

ArrayList<UploadJobDetail> getMultiFileJobLogDetails(String jobHandle,
                                                     S7Config s7Config)

Returns an Arraylist of job details objects

Parameters:

jobHandle - - the handle for the job to get details.

s7Config -

Returns:

An AssetList of UploadJobDetail

isJobActiveByJobHandle

boolean isJobActiveByJobHandle(String jobHandle,
                               S7Config s7Config)

Parameters:

jobHandle - of the job

s7Config -

Returns:

true if active job with this jobHandle or orginalName is active, false otherwise

isJobActiveByOriginalName

boolean isJobActiveByOriginalName(String originalName,
                                  S7Config s7Config)

Parameters:

originalName - of the job

s7Config -

Returns:

true if active job with this jobHandle or orginalName is active, false otherwise

getJobLogDetails

List<String> getJobLogDetails(String jobHandle,
                              S7Config s7Config)

Returns a list of Scene7 asset handles(Strings) for the given job handle

Parameters:

jobHandle - - the handle for the job to get details.

s7Config -

Returns:

A list containing asset handles strings

getImagePresets

List<String> getImagePresets(S7Config s7Config)

Returns a list of Scene7 image preset names for the given S7Config

Parameters:

s7Config -

Returns:

a list containing the names of the image presets defined in SPS

getFlashTemplatesServer

String getFlashTemplatesServer(S7Config s7Config)

Retrieves the server used for serving and manipulating flash templates, depending on the Scene7 configuration.

Parameters:

s7Config - the Scene7 configuration

Returns:

a String containing the server's URL

searchAssets

List<Scene7Asset> searchAssets(String folder,
                               Boolean includeSubfolders,
                               Boolean published,
                               String[] assetTypes,
                               String[] assetSubTypes,
                               String[] responseFields,
                               String[] excludeFields,
                               S7Config s7Config)

Retrieves a list of Scene7Assets from the Scene7 server.

Parameters:

folder - the folder from which the assets are retrieved

includeSubfolders - whether to recursively search for assets in sub-folders of the folder where the search is performed

published - whether the matched assets must be marked for publish (only marked - not necessarily actually published)

assetTypes - all matched assets will be one of these types

assetSubTypes - array of sub Asset Types to include in search

responseFields - the response fields that should be used to populate the Scene7Asset's attributes

excludeFields - fields to be excluded from the response

s7Config - the Scene7 configuration

Returns:

a List of assets; can be empty if no assets have been found

searchAssets

List<Scene7Asset> searchAssets(String folder,
                               Boolean includeSubfolders,
                               Boolean published,
                               String[] assetTypes,
                               String[] assetSubTypes,
                               String[] responseFields,
                               String[] excludeFields,
                               int recordsPerPage,
                               int resultsPage,
                               S7Config s7Config)

Retrieves a list of Scene7Assets from the Scene7 server.

Parameters:

folder - the folder from which the assets are retrieved

includeSubfolders - whether to recursively search for assets in sub-folders of the folder where the search is performed

published - whether the matched assets must be marked for publish (only marked - not necessarily actually published)

assetTypes - all matched assets will be one of these types

assetSubTypes - array of sub Asset Types to include in search

responseFields - the response fields that should be used to populate the Scene7Asset's attributes

excludeFields - fields to be excluded 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:

a List of assets; can be empty if no assets have been found

searchAssetsByFilename

List<Scene7Asset> searchAssetsByFilename(String folder,
                                         Boolean includeSubfolders,
                                         Boolean published,
                                         String filename,
                                         S7Config s7Config)

Retrieve a list of Scene7Assets from the Scene7 server by filename.

Parameters:

folder -

includeSubfolders -

published -

filename -

s7Config -

Returns:

getAssociatedAssets

Scene7Asset getAssociatedAssets(Scene7Asset asset,
                                S7Config s7Config)

Retrieves the sub-assets and the origiator asset associated with the given asset

Parameters:

asset - - the asset to get the sub-assets and generator from

s7Config - - the Scene7 configuration

Returns:

the original Scene7Asset object updated with the sub-assets and the originator asset

getMasterAsset

Scene7Asset getMasterAsset(Scene7Asset asset,
                           S7Config s7Config)

Retrieves the originator asset associated with the given asset

Parameters:

asset - - the asset to get the originator asset

s7Config - - the Scene7 configuration

Returns:

the original Scene7Asset object updated with the originator asset

getFxgServer

String getFxgServer(S7Config s7Config)

Retrieves the server handling FXG rendering.

Parameters:

s7Config - the Scene7 configuration

Returns:

a String containing the FXG server URL

setAssetPublishState

String setAssetPublishState(Resource resource,
                            boolean markForPublish,
                            S7Config s7Config)

Set the publish state of a given Scene7 asset

Parameters:

resource - activated resource

markForPublish - value of markForPublish flag

s7Config - the Scene7 configuration

Returns:

String success / failure

setAssetPublishState

String setAssetPublishState(String assetHandle,
                            boolean markForPublish,
                            S7Config s7Config)

Set the publish state of a given Scene7 asset

Parameters:

assetHandle - unique asset identifier

markForPublish - value of markForPublish flag

s7Config - the Scene7 configuration

Returns:

String success / failure