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 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
Document	addUser(S7Config s7Config, String firstName, String lastName, String email, String defaultRole, String password, org.joda.time.Instant passwordExpires, boolean isValid, List<Scene7CompanyMembership> membershipArray) Creates a user account and adds the account to one of more companies
Document	createFolder(String folderPath, S7Config s7Config) Create a folder on Scene7 server
Document	createImageSet(S7Config s7Config, String folderHandle, String name, String type, String thumbAssetHandle) Create an image set of a given Scene7 folder asset
Document	createViewerPreset(S7Config s7Config, String folderHandle, String name, String type, List<Scene7ConfigSetting> configSettings) Create a preset view to determine what users can see.
Document	deleteAsset(String assetHandle, S7Config s7Config) Deletes an asset from Scene7.
Document	deleteFolder(String folderHandle, S7Config s7Config) Deletes a folder from Scene7.
Document	deleteImageFormat(S7Config s7Config, String imageFormatHandle) Deletes an image format.
Document	deleteImageMap(S7Config s7Config, String imageMapHandle) Deletes an image map
Document	getActiveJobs(String jobHandle, String originalName, S7Config s7Config) Gets all jobs that are currently active in the system.
Document	getAllUsers(S7Config s7Config, boolean includeInvalid) Return all users
Document	getAssets(String[] assetHandles, String[] responseFields, String[] excludeFields, S7Config s7Config) Gets assets from IPS.
Document	getAssociatedAssets(String assetHandle, String[] responseFields, String[] excludeFields, S7Config s7Config) Gets assets associated with the specified asset and details about their relationship.
Document	getCompanyMembership(ResourceResolver resourceResolver, String userHandle, String email, String password, String region) Gets a user's memberships.
Document	getFolderTree(String folderPath, int depth, String[] responseFields, String[] excludeFields, S7Config s7Config) Gets folders and sub-folders in a hierarchical tree structure.
Document	getImageFormats(S7Config s7Config) Returns image formats, such as PDF, EPS, SWF, and others.
Document	getImagePresets(S7Config s7Config) Gets the SPS image presets
InputStream	getIPSFile(Scene7Asset asset, S7Config s7Config) Deprecated. Incompatible with Scene7 IPS SSL endpoint. Please use getOriginalFile() instead.
Document	getJobLogDetails(String jobHandle, String originalName, int resultsPage, int recordsPerPage, String sortBy, String sortDirection, S7Config s7Config) Gets the details of job logs of a company with specified parameters
Document	getJobLogDetails(String jobHandle, String originalName, S7Config s7Config) Gets the details of job logs of a company.
InputStream	getOriginalFile(String assetHandle, S7Config s7Config) Provides a way to get the originally uploaded file to the Scene7 servers after an asset has been processed.
Document	getPropertySets(String appSettingsTypeHandle, S7Config s7Config) Gets property sets associated with a type handle.
Document	getPropertySetTypes(S7Config s7Config) Gets the property set types associated with the specified company from the S7Config object.
Document	getSystemProperties(S7Config s7Config) Retrieves the system properties XML document served by the GetSystemProperties SPS servlet.
InputStream	getThumbnailForAsset(Scene7Asset scene7Asset, S7Config s7Config) Retrieves a JPEG image in an InputStream that can be used as a thumbnail in CQ DAM.
Document	getUserInfo(ResourceResolver resourceResolver, String email, String password, String region) Gets information about a user.
Document	getUsers(S7Config s7Config, Boolean includeInactive, Boolean includeInvalid, List<String> companyHandleArray, List<String> groupHandleArray, List<String> userRoleArray, String charFilterField, String charFilter, String sortBy, Integer recordsPerPage, Integer resultsPage) Return a optionally sorted, filtered and paged list user results
Document	getViewerConfigSettings(S7Config s7Config, String assetHandle) Get all viewer configuration for the specified asset
Document	saveImageFormat(S7Config s7Config, String imageFormatHandle, String name, String urlModifier) Create an image format.
Document	saveImageMap(S7Config s7Config, String assetHandle, String imageMapHandle, String name, String shapeType, String region, String action, int position, boolean enabled) Create a new image map or edit an existing map
Document	searchAssets(String folder, Boolean includeSubfolders, Boolean published, String[] assetTypes, String[] assetSubTypes, String[] responseFields, String[] excludeFields, int recordsPerPage, int resultsPage, String fileName, String name, S7Config s7Config) Searches for assets based on one or more filter criteria.
Document	searchAssetsByMetadata(String folder, Boolean includeSubfolders, String[] assetTypes, String[] assetSubTypes, 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
Document	searchAssetsByMetadata(String folder, Boolean includeSubfolders, String[] assetTypes, String[] assetSubTypes, Boolean published, MetadataCondition[] conditions, S7Config s7Config) Searches the metadata index repository for the given search terms.
Document	setAssetPublishState(String assetHandle, S7Config s7Config, String publishState) Sets the publish state of a given Scene7 asset
Document	setImageMaps(S7Config s7Config, String assetHandle, List<Scene7ImageMapDefinition> imageMap) Sets the image map for an asset.
Document	setUserInfo(S7Config s7Config, String userHandle, String firstName, String lastName, String email, String defaultRole, org.joda.time.Instant passwordExpires, boolean isValid, List<Scene7CompanyMembership> membershipArray) Set user attributes
Document	setViewerConfigSettings(S7Config s7Config, String assetHandle, String name, String type, List<Scene7ConfigSetting> configSettings) Attach viewer configuration settings to an asset Can be viewer preset or the source asset for the viewer
Document	submitJob(String jobName, Scene7JobType jobType, S7Config s7Config) Submits a job to the system.
Document	updateImageSet(S7Config s7Config, String assetHandle, List<String> setMemberHandles, String thumbAssetHandle) Update an image set of a given a list of Scene7 assets
Document	updateViewerConfigSettings(S7Config s7Config, String assetHandle, List<Scene7ConfigSetting> configSettings) Updates SWF viewer configuration settings.

Field Detail

CONTENTTYPE

static final 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

Document deleteAsset(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

Document deleteFolder(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

Document getActiveJobs(String jobHandle,
                       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

Document getAssets(String[] assetHandles,
                   String[] responseFields,
                   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

Document getAssociatedAssets(String assetHandle,
                             String[] responseFields,
                             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

Document getCompanyMembership(ResourceResolver resourceResolver,
                              String userHandle,
                              String email,
                              String password,
                              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

Document getFolderTree(String folderPath,
                       int depth,
                       String[] responseFields,
                       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

Document getJobLogDetails(String jobHandle,
                          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

getJobLogDetails

Document getJobLogDetails(String jobHandle,
                          String originalName,
                          int resultsPage,
                          int recordsPerPage,
                          String sortBy,
                          String sortDirection,
                          S7Config s7Config)

Gets the details of job logs of a company with specified parameters

Parameters:

jobHandle - a handle to an active or completed job

originalName - the original name of the job log

resultsPage - page number of recordsPerPage-results to return

recordsPerPage - maximum number of detailArray items to return

sortBy - one of the Job Detail Sort Field constant values (Date or LogType)

sortDirection - one of the Sort Direction string constants

s7Config - the Scene7 configuration

Returns:

getPropertySets

Document getPropertySets(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

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

Document getImagePresets(S7Config s7Config)

Gets the SPS image presets

Parameters:

s7Config - the Scene7 configuration

Returns:

the API's response wrapped in a Document

getUserInfo

Document getUserInfo(ResourceResolver resourceResolver,
                     String email,
                     String password,
                     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

Document searchAssets(String folder,
                      Boolean includeSubfolders,
                      Boolean published,
                      String[] assetTypes,
                      String[] assetSubTypes,
                      String[] responseFields,
                      String[] excludeFields,
                      int recordsPerPage,
                      int resultsPage,
                      String fileName,
                      String name,
                      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

name - the Scene7 name used for search asset

s7Config - the Scene7 configuration

Returns:

the API's response wrapped in a Document

searchAssetsByMetadata

Document searchAssetsByMetadata(String folder,
                                Boolean includeSubfolders,
                                String[] assetTypes,
                                String[] assetSubTypes,
                                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

Document searchAssetsByMetadata(String folder,
                                Boolean includeSubfolders,
                                String[] assetTypes,
                                String[] assetSubTypes,
                                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

Document submitJob(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

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

InputStream getOriginalFile(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
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

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

Document setAssetPublishState(String assetHandle,
                              S7Config s7Config,
                              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:

createImageSet

Document createImageSet(S7Config s7Config,
                        String folderHandle,
                        String name,
                        String type,
                        String thumbAssetHandle)

Create an image set of a given Scene7 folder asset

Parameters:

s7Config - the Scene7 configuration

folderHandle - Scene7 folder handle

name - name of image set

type - image set type

thumbAssetHandle - optional parameter to define set thumbnail

Returns:

updateImageSet

Document updateImageSet(S7Config s7Config,
                        String assetHandle,
                        List<String> setMemberHandles,
                        String thumbAssetHandle)

Update an image set of a given a list of Scene7 assets

Parameters:

s7Config - the Scene7 configuration

assetHandle - asset handle of the image set member array

setMemberHandles - list of image set member handles

thumbAssetHandle - optional parameter to define set thumbnail

Returns:

createFolder

Document createFolder(String folderPath,
                      S7Config s7Config)

Create a folder on Scene7 server

Parameters:

folderPath - The root folder used to retrieve folders and all subfolders to the leaf level. If excluded, the company root is used.

s7Config - the Scene7 configuration

Returns:

createViewerPreset

Document createViewerPreset(S7Config s7Config,
                            String folderHandle,
                            String name,
                            String type,
                            List<Scene7ConfigSetting> configSettings)

Create a preset view to determine what users can see. The preset view is applied when assets are published.

Parameters:

s7Config - the Scene7 configuration

folderHandle - folder handle of the folder that contains the assets

name - name for the viewer

type - type of any available viewer in IPS

configSettings - list containing Scene7ConfigSetting values to apply

Returns:

getViewerConfigSettings

Document getViewerConfigSettings(S7Config s7Config,
                                 String assetHandle)

Get all viewer configuration for the specified asset

Parameters:

s7Config - the Scene7 configuration

assetHandle - asset handle for the asset in question

Returns:

setViewerConfigSettings

Document setViewerConfigSettings(S7Config s7Config,
                                 String assetHandle,
                                 String name,
                                 String type,
                                 List<Scene7ConfigSetting> configSettings)

Attach viewer configuration settings to an asset Can be viewer preset or the source asset for the viewer

Parameters:

s7Config - the Scene7 configuration

assetHandle - asset handle for the asset to modify

name - name of the asset

type - type of any available viewer in IPS

configSettings - list containing Scene7ConfigSetting values to apply

updateViewerConfigSettings

Document updateViewerConfigSettings(S7Config s7Config,
                                    String assetHandle,
                                    List<Scene7ConfigSetting> configSettings)

Updates SWF viewer configuration settings.

Parameters:

s7Config - the Scene7 configuration

assetHandle - asset handle for the asset to modify

configSettings - list containing Scene7ConfigSetting values to apply

addUser

Document addUser(S7Config s7Config,
                 String firstName,
                 String lastName,
                 String email,
                 String defaultRole,
                 String password,
                 org.joda.time.Instant passwordExpires,
                 boolean isValid,
                 List<Scene7CompanyMembership> membershipArray)

Creates a user account and adds the account to one of more companies

Parameters:

s7Config - The Scene7 configuration

firstName - The user's first name

lastName - The user's last name

email - The user's email address

defaultRole - The role for the user in the companies they belong, the IpsAdmin role overrides other per-company settings

password - The user's password

passwordExpires - The instant of expiration of the password

isValid - Determine the user's validity

membershipArray - List of Scene7CompanyMembership entries enumerating the membership of the user.

Returns:

getAllUsers

Document getAllUsers(S7Config s7Config,
                     boolean includeInvalid)

Return all users

Parameters:

s7Config - The Scene7 configuration

includeInvalid - Indicate if invalid users should be included

Returns:

getUsers

Document getUsers(S7Config s7Config,
                  Boolean includeInactive,
                  Boolean includeInvalid,
                  List<String> companyHandleArray,
                  List<String> groupHandleArray,
                  List<String> userRoleArray,
                  String charFilterField,
                  String charFilter,
                  String sortBy,
                  Integer recordsPerPage,
                  Integer resultsPage)

Return a optionally sorted, filtered and paged list user results

Parameters:

s7Config - The Scene7 config

includeInactive - Include or exclude inactive members

includeInvalid - Include or exclude invalid members

companyHandleArray - Filter results be company

groupHandleArray - Filter results by group

userRoleArray - Filter results by user role

charFilterField - Filter results by field's string prefix

charFilter - Filter results by a specific character

sortBy - Choice of user sort field

recordsPerPage - Number of records per page to return

resultsPage - The desired result page

Returns:

setUserInfo

Document setUserInfo(S7Config s7Config,
                     String userHandle,
                     String firstName,
                     String lastName,
                     String email,
                     String defaultRole,
                     org.joda.time.Instant passwordExpires,
                     boolean isValid,
                     List<Scene7CompanyMembership> membershipArray)

Set user attributes

Parameters:

s7Config - The Scene7 config

userHandle - User handle

firstName - First name

lastName - Last name

email - Email address

defaultRole - The role for the user in the companies they belong, the IpsAdmin role overrides other per-company settings

passwordExpires - The password's expiration

isValid - Determine if valid IPS user

membershipArray - List of Scene7CompanyMembership entries enumerating the membership of the user

Returns:

deleteImageFormat

Document deleteImageFormat(S7Config s7Config,
                           String imageFormatHandle)

Deletes an image format.

Parameters:

s7Config - The Scene7 config

imageFormatHandle - Handle to the image format. (This is returned from saveImageFormat(S7Config, String, String, String))

getImageFormats

Document getImageFormats(S7Config s7Config)

Returns image formats, such as PDF, EPS, SWF, and others.

Parameters:

s7Config - The Scene7 config

Returns:

saveImageFormat

Document saveImageFormat(S7Config s7Config,
                         String imageFormatHandle,
                         String name,
                         String urlModifier)

Create an image format.

Parameters:

s7Config - The Scene7 config

imageFormatHandle - Image format handle you want to save

name - Image format name

urlModifier - IPS protocol query string

Returns:

deleteImageMap

Document deleteImageMap(S7Config s7Config,
                        String imageMapHandle)

Deletes an image map

Parameters:

s7Config - The Scene7 config

imageMapHandle - Handle for the image map to delete

saveImageMap

Document saveImageMap(S7Config s7Config,
                      String assetHandle,
                      String imageMapHandle,
                      String name,
                      String shapeType,
                      String region,
                      String action,
                      int position,
                      boolean enabled)

Create a new image map or edit an existing map

Parameters:

s7Config - The Scene7 config

assetHandle - Handle to the asset the map belongs to

imageMapHandle - Handle to the image map.

name - Name of the image map

shapeType - Choice of region shape

region - A comma delimited list of points that define the region

action - The href value associated with the image map

position - The order in the list of image maps

enabled - Whether this map is enabled

Returns:

setImageMaps

Document setImageMaps(S7Config s7Config,
                      String assetHandle,
                      List<Scene7ImageMapDefinition> imageMap)

Sets the image map for an asset. You must have already created the image maps. Image maps are applied in order of retrieval from the array. This means the second image map overlays the first, the third overlays the second, and so on.

Parameters:

s7Config - The Scene7 config

assetHandle - Handle to the asset

imageMap - list of predefined Scene7ImageMapDefinition objects

Returns: