Package com.day.cq.dam.scene7.api
Interface Scene7APIClient
-
@ProviderType 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. Return values and parameters are @NotNull by default.
-
-
Field Summary
Fields Modifier and Type Field 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
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description Document
addSmartCrops(S7Config s7Config, String assetHandle, SmartCropAddArray addSmartCropArray)
Add one or more Smart Crop sub asset(s)Document
addUser(S7Config s7Config, String firstName, String lastName, String email, String defaultRole, String password, @Nullable Instant passwordExpires, boolean isValid, List<Scene7CompanyMembership> membershipArray)
Creates a user account and adds the account to one of more companiesDocument
batchSetAssetMetadata(S7Config s7Config, List<Scene7MetadataUpdate> updates)
Sets asset metadata using batch mode.Document
batchSetImageFields(S7Config s7Config, List<Scene7ImageFieldUpdate> updates)
Sets asset metadata using batch mode.Document
batchSetThumbAsset(S7Config s7Config, List<ThumbAssetUpdate> thumbnailUpdates)
Sets the thumbnail image for one or more assetsDocument
cdnCacheInvalidation(S7Config s7Config, UrlArray urlArray)
Forwards the supplied list of URLs to the Scene7 CDN (Content Distribution Network) provider to invalidate their existing cache of HTTP responsesDocument
createAssetSet(S7Config s7Config, String folderHandle, String name, String type, @Nullable String setDefinition, @Nullable String thumbAssetHandle)
Create an AssetSet in a given Scene7 folderDocument
createFolder(String folderPath, S7Config s7Config)
Create a folder on Scene7 serverDocument
createImageSet(S7Config s7Config, String folderHandle, String name, String type, @Nullable String thumbAssetHandle)
Create an ImageSet in a given Scene7 folderDocument
createPropertySet(String typeHandle, PropertyArray props, S7Config s7Config)
Create PropertySet of given type, and store given Properties to it.Document
createViewerPreset(S7Config s7Config, String folderHandle, String name, String type, @Nullable 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
deleteAssets(String[] assetHandleArr, S7Config s7Config)
Delete multiple assets 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 mapDocument
deletePropertySet(String propertySetHandle, S7Config s7Config)
Delete PropertySet by the given handle.Document
deleteSubAssets(String companyHandle, String assetHandle, List<String> subAssetHandles, S7Config s7Config)
Deletes the sub assets for an assetDocument
getActiveJobs(String jobHandle, String originalName, S7Config s7Config)
Gets all jobs that are currently active in the system.Document
getAllUsers(@NotNull S7Config s7Config, boolean includeInvalid)
Return all users@Nullable String
getAssetHandleByName(S7Config s7Config, String assetName)
Search asset by name and return its handle, if exists.String
getAssetHandleByName(String assetName)
Gets assethandleDocument
getAssets(String[] assetHandles, String[] responseFields, String[] excludeFields, S7Config s7Config)
Gets assets from IPS.List<Scene7Asset>
getAssetsByName(String companyHandle, String[] responseFields, String[] names)
Gets assets by name.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.GetCompanySettingsReturn
getCompanySettings(S7Config s7Config)
Document
getFolderTree(String folderPath, int depth, String[] responseFields, String[] excludeFields, S7Config s7Config)
Gets folders and sub-folders in a hierarchical tree structure.Document
getImageFormats(@NotNull S7Config s7Config)
Returns image formats, such as PDF, EPS, SWF, and others.Document
getImagePresets(S7Config s7Config)
Gets the SPS image presetsMap<String,Object>
getImageServerSettings(S7Config s7Config, @Nullable String contextHandle)
Gets the preview or publish server settings based on contextHandle.Document
getImageSetMembers(S7Config s7Config, String assetHandle)
Get members of legacy ImageSetInputStream
getIPSFile(Scene7Asset asset, S7Config s7Config)
Deprecated.Incompatible with Scene7 IPS SSL endpoint.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 parametersDocument
getJobLogDetails(String jobHandle, String originalName, S7Config s7Config)
Gets the details of job logs of a company.Document
getLoginStatus(ResourceResolver resourceResolver, String email, String password, String region)
Checks the login in Scene7 with the given credentialsInputStream
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 theS7Config
object.GetPublishContextsReturn
getPublishContexts(S7Config s7Config)
Document
getSecureISAuthToken(S7Config s7Config)
Gets the token for a given company to access secure preview IS.Document
getSystemProperties(S7Config s7Config)
Deprecated.InputStream
getThumbnailForAsset(Scene7Asset scene7Asset, S7Config s7Config)
Retrieves a JPEG image in an InputStream that can be used as a thumbnail in CQ DAM.Document
getUploadTaskStatus(String jobHandle, S7Config s7Config)
Retrieves Scene7 upload job processing statusDocument
getUserInfo(ResourceResolver resourceResolver, String email, String password, String region)
Gets information about a user.Document
getUsers(@NotNull S7Config s7Config, @Nullable Boolean includeInactive, @Nullable Boolean includeInvalid, @Nullable List<String> companyHandleArray, @Nullable List<String> groupHandleArray, @Nullable List<String> userRoleArray, @Nullable String charFilterField, @Nullable String charFilter, @Nullable String sortBy, @Nullable Integer recordsPerPage, @Nullable Integer resultsPage)
Return a optionally sorted, filtered and paged list user resultsDocument
getViewerConfigSettings(S7Config s7Config, String assetHandle)
Get all viewer configuration for the specified assetDocument
getXMPPacket(S7Config s7Config, String assetHandle)
Retrieves an XMP Metadata packet for the specified asset.Document
moveAsset(S7Config s7Config, String assetHandle, String folderHandle)
Moves an asset to a specific folderDocument
moveAssets(S7Config s7Config, Map<String,String> assetFolderHandles)
Moves multiple assets independently of each other.Document
moveFolder(S7Config s7Config, String sourceFolderHandle, String destinationFolderHandle)
Move a folder to a new locationDocument
renameAsset(S7Config s7Config, String assetHandle, String name, boolean validateName)
Rename an assetString
renameAssetToUniqueName(S7Config s7Config, String assetHandle, String newDesiredName)
Tries to rename given asset to the new name, maintaining the requirement of no duplicate asset names can exists in S7 for a given Company.Document
renameFolder(S7Config s7Config, String folderHandle, String folderName)
Rename a folderDocument
saveImageFormat(S7Config s7Config, @Nullable String imageFormatHandle, String name, String urlModifier)
Create an image format.Document
saveImageMap(S7Config s7Config, String assetHandle, @Nullable String imageMapHandle, String name, String shapeType, String region, String action, int position, boolean enabled)
Create a new image map or edit an existing mapDocument
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
searchAssets(String folder, Boolean includeSubfolders, Boolean published, String[] assetTypes, String[] assetSubTypes, String[] responseFields, String[] excludeFields, int recordsPerPage, int resultsPage, String fileName, String name, String conditionMode, 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 pageDocument
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 assetDocument
setAssetsPublishState(Set<String> assetHandles, S7Config s7Config, String publishState)
Sets the publish state of a given Scene7 assetsDocument
setCompanySettings(SetCompanySettingsParam param, S7Config s7Config)
Document
setImageMaps(S7Config s7Config, String assetHandle, List<Scene7ImageMapDefinition> imageMap)
Sets the image map for an asset.Document
setImageServerSettings(S7Config s7Config, String contextHandle, ConfigSettingArray publishSettingArray)
Sets the publish or preview Image server settings based on contextHandleDocument
setPassword(S7Config s7Config, String userHandle, String password, @Nullable Integer validityInDays)
Sets the password for a given user with an expiry of 100 years ahead from the current date.Document
setUserInfo(S7Config s7Config, @Nullable String userHandle, String firstName, String lastName, String email, String defaultRole, @Nullable Instant passwordExpires, boolean isValid, List<Scene7CompanyMembership> membershipArray)
Set user attributesDocument
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 viewerDocument
submitJob(String jobName, Scene7JobType jobType, S7Config s7Config)
Submits a job to the system.Document
submitReprocessAssetsThumbnailJob(@NotNull String jobName, @NotNull S7Config s7Config, String assetHandle, long thumbnailTime)
Submit a job to S7 for reprocessing video thumbnail to a specified video frame timeDocument
updateAssetSet(S7Config s7Config, String assetHandle, @Nullable String setDefinition, @Nullable String thumbAssetHandle)
Update an AssetSetDocument
updateImageSet(S7Config s7Config, String assetHandle, @Nullable ImageSetMemberUpdateArray members, @Nullable String thumbAssetHandle)
Update an ImageSetDocument
updateImageSet(S7Config s7Config, String assetHandle, List<String> setMemberHandles, String thumbAssetHandle)
Document
updatePropertySet(String setHandle, PropertyArray props, S7Config s7Config)
Update PropertySet with the new set of Properties, replacing existing ones.Document
updatePropertySet(String setHandle, String propKey, String propValue, S7Config s7Config)
Update single Property in the PropertySet.Document
updateSmartCrops(S7Config s7Config, SmartCropUpdateArray updateArray)
Update one or more Smart Crop sub asset(s)Document
updateViewerConfigSettings(S7Config s7Config, String assetHandle, List<Scene7ConfigSetting> configSettings)
Updates SWF viewer configuration settings.Document
updateXMPPacket(S7Config s7Config, String assetHandle, String xmpPacketAsXml)
Sets or updates an XMP metadata packet for an asset.
-
-
-
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) throws IpsApiException
Deletes an asset from Scene7.- Parameters:
assetHandle
- the handle to the asset to deletes7Config
- the Scene7 configuration- Returns:
- the API's response wrapped in a
Document
- Throws:
IpsApiException
-
deleteAssets
Document deleteAssets(String[] assetHandleArr, S7Config s7Config) throws IpsApiException
Delete multiple assets from Scene7.- Parameters:
assetHandleArr
- the handle to the asset to deletes7Config
- the Scene7 configuration- Returns:
- the API's response wrapped in a
Document
- Throws:
IpsApiException
-
deleteFolder
Document deleteFolder(String folderHandle, S7Config s7Config) throws IpsApiException
Deletes a folder from Scene7.- Parameters:
folderHandle
- the handle to the folder to deletes7Config
- the Scene7 configuration- Returns:
- the API's response wrapped in a
Document
- Throws:
IpsApiException
-
getActiveJobs
Document getActiveJobs(String jobHandle, String originalName, S7Config s7Config) throws IpsApiException
Gets all jobs that are currently active in the system.- Parameters:
jobHandle
- the handle to the joboriginalName
- the original name of the jobs7Config
- the Scene7 configuration- Returns:
- the API's response wrapped in a
Document
- Throws:
IpsApiException
-
getAssets
Document getAssets(String[] assetHandles, String[] responseFields, String[] excludeFields, S7Config s7Config) throws IpsApiException
Gets assets from IPS.- Parameters:
assetHandles
- the asset handlesresponseFields
- a list of fields and subfields for inclusion in the responseexcludeFields
- a list of fields and subfields for exclusion from the responses7Config
- the Scene7 configuration- Returns:
- the API's response wrapped in a
Document
- Throws:
IpsApiException
-
getAssociatedAssets
Document getAssociatedAssets(String assetHandle, String[] responseFields, String[] excludeFields, S7Config s7Config) throws IpsApiException
Gets assets associated with the specified asset and details about their relationship.- Parameters:
assetHandle
- the handle to the assetresponseFields
- a list of fields and subfields for inclusion in the responseexcludeFields
- a list of fields and subfields for exclusion from the responses7Config
- the Scene7 configuration- Returns:
- the API's response wrapped in a
Document
- Throws:
IpsApiException
-
getAssetsByName
List<Scene7Asset> getAssetsByName(String companyHandle, String[] responseFields, String[] names) throws IpsApiException
Gets assets by name.- Parameters:
companyHandle
- the handle to the companyresponseFields
- a list of fields and subfields for inclusion in the responsenames
- a string array of asset names- Returns:
- the API's response wrapped in a
Document
- Throws:
IpsApiException
-
getAssetHandleByName
String getAssetHandleByName(String assetName) throws IpsApiException
Gets assethandle- Parameters:
assetName
- a String array of asset names- Returns:
- String assetHandle
- Throws:
IpsApiException
-
getAssetHandleByName
@Nullable @Nullable String getAssetHandleByName(S7Config s7Config, String assetName) throws IpsApiException
Search asset by name and return its handle, if exists.- Parameters:
s7Config
- configuration to access Scene7 serverassetName
- asset name to look up- Returns:
- asset handle, or null if not found
- Throws:
IpsApiException
- on error at Scene7
-
getCompanyMembership
Document getCompanyMembership(ResourceResolver resourceResolver, String userHandle, String email, String password, String region) throws IpsApiException
Gets a user's memberships.- Parameters:
resourceResolver
- resource resolver used to access Scene7 configurationuserHandle
- the handle to the user whose memberships you want to obtainemail
- the user's emailpassword
- the user's passwordregion
- the user's region- Returns:
- the API's response wrapped in a
Document
- Throws:
IpsApiException
-
getFolderTree
Document getFolderTree(String folderPath, int depth, String[] responseFields, String[] excludeFields, S7Config s7Config) throws IpsApiException
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 useddepth
- a value of zero gets the top-level folder; any other value specifies the depth to descend into the treeresponseFields
- a list of fields and subfields for inclusion in the responseexcludeFields
- a list of fields and subfields for exclusion from the responses7Config
- the Scene7 configuration- Returns:
- the API's response wrapped in a
Document
- Throws:
IpsApiException
-
getJobLogDetails
Document getJobLogDetails(String jobHandle, String originalName, S7Config s7Config) throws IpsApiException
Gets the details of job logs of a company.- Parameters:
jobHandle
- a handle to an active or completed joboriginalName
- the original name of the job logs7Config
- the Scene7 configuration- Returns:
- the API's response wrapped in a
Document
- Throws:
IpsApiException
-
getJobLogDetails
Document getJobLogDetails(String jobHandle, String originalName, int resultsPage, int recordsPerPage, String sortBy, String sortDirection, S7Config s7Config) throws IpsApiException
Gets the details of job logs of a company with specified parameters- Parameters:
jobHandle
- a handle to an active or completed joboriginalName
- the original name of the job logresultsPage
- page number of recordsPerPage-results to returnrecordsPerPage
- maximum number of detailArray items to returnsortBy
- one of the Job Detail Sort Field constant values (Date or LogType)sortDirection
- one of the Sort Direction string constantss7Config
- the Scene7 configuration- Returns:
- the jobLogDetails API's response wrapped in a
Document
- Throws:
IpsApiException
-
getPropertySets
Document getPropertySets(String appSettingsTypeHandle, S7Config s7Config) throws IpsApiException
Gets property sets associated with a type handle.- Parameters:
appSettingsTypeHandle
- the handle to the property set types7Config
- the Scene7 configuration- Returns:
- the API's response wrapped in a
Document
- Throws:
IpsApiException
-
createPropertySet
Document createPropertySet(String typeHandle, PropertyArray props, S7Config s7Config) throws IpsApiException
Create PropertySet of given type, and store given Properties to it.- Parameters:
typeHandle
- PropertySet type handleprops
- array of Properties to put into new PropertySets7Config
- the Scene7 configuration- Returns:
- the API's response wrapped in a
Document
- Throws:
IpsApiException
- .
-
updatePropertySet
Document updatePropertySet(String setHandle, PropertyArray props, S7Config s7Config) throws IpsApiException
Update PropertySet with the new set of Properties, replacing existing ones.- Parameters:
setHandle
- PropertySet handleprops
- array of Properties to put into PropsertySets7Config
- the Scene7 configuration- Returns:
- the API's response wrapped in a
Document
- Throws:
IpsApiException
- .
-
updatePropertySet
Document updatePropertySet(String setHandle, String propKey, String propValue, S7Config s7Config) throws IpsApiException
Update single Property in the PropertySet.- Parameters:
setHandle
- the PropertySet handle for the company settingspropKey
- property key namepropValue
- property key values7Config
- the Scene7 configuration- Returns:
- the API's response wrapped in a
Document
- Throws:
IpsApiException
-
deletePropertySet
Document deletePropertySet(String propertySetHandle, S7Config s7Config) throws IpsApiException
Delete PropertySet by the given handle.- Parameters:
propertySetHandle
- the PropertySet handle of the company settingss7Config
- the Scene7 configuration- Returns:
- the API's response wrapped in a
Document
- Throws:
IpsApiException
- .
-
getPropertySetTypes
Document getPropertySetTypes(S7Config s7Config) throws IpsApiException
Gets the property set types associated with the specified company from theS7Config
object.- Parameters:
s7Config
- the Scene7 configuration- Returns:
- the API's response wrapped in a
Document
- Throws:
IpsApiException
-
getImagePresets
Document getImagePresets(S7Config s7Config) throws IpsApiException
Gets the SPS image presets- Parameters:
s7Config
- the Scene7 configuration- Returns:
- the API's response wrapped in a
Document
- Throws:
IpsApiException
-
getImageServerSettings
Map<String,Object> getImageServerSettings(S7Config s7Config, @Nullable @Nullable String contextHandle) throws IpsApiException
Gets the preview or publish server settings based on contextHandle. If contextHandle is null, it fetches publish Serving settings by default.- Parameters:
s7Config
- the Scene7 configurationcontextHandle
- Nullable context handle- Returns:
- a map containing publish server settings like MaxPix, jpegQuality and others
- Throws:
IpsApiException
-
getPublishContexts
GetPublishContextsReturn getPublishContexts(S7Config s7Config) throws IpsApiException
- Parameters:
s7Config
- the Scene7 configuration- Returns:
- a List of Publish server context parameters
- Throws:
IpsApiException
-
setImageServerSettings
Document setImageServerSettings(S7Config s7Config, String contextHandle, ConfigSettingArray publishSettingArray) throws IpsApiException
Sets the publish or preview Image server settings based on contextHandle- Parameters:
s7Config
- the Scene7 configurationcontextHandle
- Nullable context handlepublishSettingArray
- Array of settings params- Returns:
- Document response
- Throws:
IpsApiException
-
getUserInfo
Document getUserInfo(ResourceResolver resourceResolver, String email, String password, String region) throws IpsApiException
Gets information about a user.- Parameters:
resourceResolver
- resource resolver used to access Scene7 configurationemail
- the user's emailpassword
- the user's passwordregion
- the user's region- Returns:
- the API's response wrapped in a
Document
- Throws:
IpsApiException
-
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) throws IpsApiException
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 usedincludeSubfolders
- if true, the search includes sub-folderspublished
- if true, the search will include only published assetsassetTypes
- array of Asset Types to include in searchassetSubTypes
- array of sub Asset Types to include in searchresponseFields
- a list of fields and subfields for inclusion in the responseexcludeFields
- a list of fields and subfields for exclusion from the responserecordsPerPage
- maximum number of results to returnresultsPage
- specifies the page of results to return, based onrecordsPerPage
page sizefileName
- the filename for search assetname
- the Scene7 name used for search assets7Config
- the Scene7 configuration- Returns:
- the API's response wrapped in a
Document
- Throws:
IpsApiException
-
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, String conditionMode, S7Config s7Config) throws IpsApiException
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 usedincludeSubfolders
- if true, the search includes sub-folderspublished
- if true, the search will include only published assetsassetTypes
- array of Asset Types to include in searchassetSubTypes
- array of sub Asset Types to include in searchresponseFields
- a list of fields and subfields for inclusion in the responseexcludeFields
- a list of fields and subfields for exclusion from the responserecordsPerPage
- maximum number of results to returnresultsPage
- specifies the page of results to return, based onrecordsPerPage
page sizefileName
- the filename for search assetname
- the Scene7 name used for search assetconditionMode
- filename and asset name string comparison operators7Config
- the Scene7 configuration- Returns:
- the API's response wrapped in a
Document
- Throws:
IpsApiException
-
searchAssetsByMetadata
Document searchAssetsByMetadata(String folder, Boolean includeSubfolders, String[] assetTypes, String[] assetSubTypes, Boolean published, MetadataCondition[] conditions, S7Config s7Config) throws IpsApiException
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 usedincludeSubfolders
- if true, the search includes sub-foldersassetTypes
- array of Asset Types to include in searchassetSubTypes
- array of sub Asset Types to include in searchpublished
- if true, the search will include only published assetsconditions
- one or more query conditions that define the search criterias7Config
- the Scene7 configuration- Returns:
- the API's response wrapped in a
Document
- Throws:
IpsApiException
-
searchAssetsByMetadata
Document searchAssetsByMetadata(String folder, Boolean includeSubfolders, String[] assetTypes, String[] assetSubTypes, Boolean published, MetadataCondition[] conditions, int recordsPerPage, int resultsPage, S7Config s7Config) throws IpsApiException
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 usedincludeSubfolders
- if true, the search includes sub-foldersassetTypes
- array of Asset Types to include in searchassetSubTypes
- array of sub Asset Types to include in searchpublished
- if true, the search will include only published assetsconditions
- one or more query conditions that define the search criteriarecordsPerPage
- maximum number of results to returnresultsPage
- specifies the page of results to return, based onrecordsPerPage
page sizes7Config
- the Scene7 configuration- Returns:
- the API's response wrapped in a
Document
- Throws:
IpsApiException
-
submitJob
Document submitJob(String jobName, Scene7JobType jobType, S7Config s7Config) throws IpsApiException
Submits a job to the system.- Parameters:
jobName
- the name of the jobjobType
- the job's types7Config
- the Scene7 configuration- Returns:
- the API's response wrapped in a
Document
- Throws:
IpsApiException
- See Also:
Scene7JobType
-
submitReprocessAssetsThumbnailJob
Document submitReprocessAssetsThumbnailJob(@NotNull @NotNull String jobName, @NotNull @NotNull S7Config s7Config, String assetHandle, long thumbnailTime) throws IpsApiException
Submit a job to S7 for reprocessing video thumbnail to a specified video frame time- Parameters:
jobName
- the name of the jobs7Config
- the Scene7 configurationassetHandle
- the asset handlethumbnailTime
- the frame time- Returns:
- the API's response wrapped in a
Document
- Throws:
IpsApiException
-
getSystemProperties
@Deprecated Document getSystemProperties(S7Config s7Config)
Deprecated.Retrieves the system properties XML document served by the GetSystemProperties SPS servlet. Deprecated- Parameters:
s7Config
- the Scene7 configuration- Returns:
- the SPS system properties wrapped in a
Document
-
getOriginalFile
InputStream getOriginalFile(String assetHandle, S7Config s7Config) throws IpsApiException
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
- Throws:
IpsApiException
-
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
- theScene7Asset
asset objects7Config
- theS7Config
configuration- Returns:
- an
InputStream
of the published image asset
-
getThumbnailForAsset
InputStream getThumbnailForAsset(Scene7Asset scene7Asset, S7Config s7Config) throws IpsApiException
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 abstractizations7Config
- the Scene7 configuration- Returns:
- an InputStream from which the file can be retrieved; the InputStream can be null if any error occurred
- Throws:
IpsApiException
-
setAssetPublishState
Document setAssetPublishState(String assetHandle, S7Config s7Config, String publishState) throws IpsApiException
Sets the publish state of a given Scene7 asset- Parameters:
assetHandle
- the Scene7 asset handlepublishState
- the asset publish states7Config
- the Scene7 configuration- Returns:
- the setAssetPublishState API's response wrapped in a
Document
- Throws:
IpsApiException
-
setAssetsPublishState
Document setAssetsPublishState(Set<String> assetHandles, S7Config s7Config, String publishState) throws IpsApiException
Sets the publish state of a given Scene7 assets- Parameters:
assetHandles
- the Scene7 asset handlespublishState
- the asset publish states7Config
- the Scene7 configuration- Returns:
- the setAssetPublishState API's response wrapped in a
Document
- Throws:
IpsApiException
-
createImageSet
Document createImageSet(S7Config s7Config, String folderHandle, String name, String type, @Nullable @Nullable String thumbAssetHandle) throws IpsApiException
Create an ImageSet in a given Scene7 folder- Parameters:
s7Config
- the Scene7 configurationfolderHandle
- Scene7 folder handlename
- name of image settype
- type of new image setthumbAssetHandle
- (optional) asset handle of user-defined thumbnail image for set- Returns:
- the IPS API response wrapped in a
Document
- Throws:
IpsApiException
-
updateImageSet
Document updateImageSet(S7Config s7Config, String assetHandle, @Nullable @Nullable ImageSetMemberUpdateArray members, @Nullable @Nullable String thumbAssetHandle) throws IpsApiException
Update an ImageSet- Parameters:
s7Config
- the Scene7 configurationassetHandle
- asset handle of the image set to updatemembers
- (optional) list of imageset members (Null = not updated)thumbAssetHandle
- (optional) asset handle of user-defined thumbnail image for set (Null = not updated)- Returns:
- the IPS API response wrapped in a
Document
- Throws:
IpsApiException
-
updateImageSet
@Deprecated 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 configurationassetHandle
- asset handle of the image set member arraysetMemberHandles
- list of image set member handlesthumbAssetHandle
- optional parameter to define set thumbnail- Returns:
- the updateImageSet API's response wrapped in a
Document
-
getImageSetMembers
Document getImageSetMembers(S7Config s7Config, String assetHandle) throws IpsApiException
Get members of legacy ImageSet- Parameters:
s7Config
- the Scene7 configurationassetHandle
- asset handle of the ImageSet- Returns:
- the IPS API response as XML
Document
- Throws:
IpsApiException
- on error at IPS
-
createAssetSet
Document createAssetSet(S7Config s7Config, String folderHandle, String name, String type, @Nullable @Nullable String setDefinition, @Nullable @Nullable String thumbAssetHandle) throws IpsApiException
Create an AssetSet in a given Scene7 folder- Parameters:
s7Config
- the Scene7 configurationfolderHandle
- Scene7 folder handlename
- name for new asset settype
- type of new asset setsetDefinition
- (optional) set's definition stringthumbAssetHandle
- (optional) asset handle of user-defined thumbnail image for set- Returns:
- the IPS API response wrapped in a
Document
- Throws:
IpsApiException
-
updateAssetSet
Document updateAssetSet(S7Config s7Config, String assetHandle, @Nullable @Nullable String setDefinition, @Nullable @Nullable String thumbAssetHandle) throws IpsApiException
Update an AssetSet- Parameters:
s7Config
- the Scene7 configurationassetHandle
- asset handle of the asset set to updatesetDefinition
- (optional) set's definition string (Null = not updated)thumbAssetHandle
- (optional) asset handle of user-defined thumbnail image for set (Null = not updated)- Returns:
- the IPS API response wrapped in a
Document
- Throws:
IpsApiException
-
createFolder
Document createFolder(String folderPath, S7Config s7Config) throws IpsApiException
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:
- the createFolder API response wrapped in a
Document
- Throws:
IpsApiException
-
createViewerPreset
Document createViewerPreset(S7Config s7Config, String folderHandle, String name, String type, @Nullable @Nullable List<Scene7ConfigSetting> configSettings) throws IpsApiException
Create a preset view to determine what users can see. The preset view is applied when assets are published.- Parameters:
s7Config
- the Scene7 configurationfolderHandle
- folder handle of the folder that contains the assetsname
- name for the viewertype
- type of any available viewer in IPSconfigSettings
- list containingScene7ConfigSetting
values to apply- Returns:
- the createViewerPreset API response wrapped in a
Document
- Throws:
IpsApiException
-
getViewerConfigSettings
Document getViewerConfigSettings(S7Config s7Config, String assetHandle) throws IpsApiException
Get all viewer configuration for the specified asset- Parameters:
s7Config
- the Scene7 configurationassetHandle
- asset handle for the asset in question- Returns:
- the getViewerConfigSettings API response wrapped in a
Document
- Throws:
IpsApiException
-
setViewerConfigSettings
Document setViewerConfigSettings(S7Config s7Config, String assetHandle, String name, String type, List<Scene7ConfigSetting> configSettings) throws IpsApiException
Attach viewer configuration settings to an asset Can be viewer preset or the source asset for the viewer- Parameters:
s7Config
- the Scene7 configurationassetHandle
- asset handle for the asset to modifyname
- name of the assettype
- type of any available viewer in IPSconfigSettings
- list containingScene7ConfigSetting
values to apply- Throws:
IpsApiException
-
updateViewerConfigSettings
Document updateViewerConfigSettings(S7Config s7Config, String assetHandle, List<Scene7ConfigSetting> configSettings) throws IpsApiException
Updates SWF viewer configuration settings.- Parameters:
s7Config
- the Scene7 configurationassetHandle
- asset handle for the asset to modifyconfigSettings
- list containingScene7ConfigSetting
values to apply- Throws:
IpsApiException
-
addUser
Document addUser(S7Config s7Config, String firstName, String lastName, String email, String defaultRole, String password, @Nullable @Nullable Instant passwordExpires, boolean isValid, List<Scene7CompanyMembership> membershipArray) throws IpsApiException
Creates a user account and adds the account to one of more companies- Parameters:
s7Config
- The Scene7 configurationfirstName
- The user's first namelastName
- The user's last nameemail
- The user's email addressdefaultRole
- The role for the user in the companies they belong, the IpsAdmin role overrides other per-company settingspassword
- The user's passwordpasswordExpires
- The instant of expiration of the passwordisValid
- Determine the user's validitymembershipArray
- List ofScene7CompanyMembership
entries enumerating the membership of the user.- Returns:
- Throws:
IpsApiException
-
getAllUsers
Document getAllUsers(@NotNull @NotNull S7Config s7Config, boolean includeInvalid) throws IpsApiException
Return all users- Parameters:
s7Config
- The Scene7 configurationincludeInvalid
- Indicate if invalid users should be included- Returns:
- Throws:
IpsApiException
-
getUsers
Document getUsers(@NotNull @NotNull S7Config s7Config, @Nullable @Nullable Boolean includeInactive, @Nullable @Nullable Boolean includeInvalid, @Nullable @Nullable List<String> companyHandleArray, @Nullable @Nullable List<String> groupHandleArray, @Nullable @Nullable List<String> userRoleArray, @Nullable @Nullable String charFilterField, @Nullable @Nullable String charFilter, @Nullable @Nullable String sortBy, @Nullable @Nullable Integer recordsPerPage, @Nullable @Nullable Integer resultsPage) throws IpsApiException
Return a optionally sorted, filtered and paged list user results- Parameters:
s7Config
- The Scene7 configincludeInactive
- Include or exclude inactive membersincludeInvalid
- Include or exclude invalid memberscompanyHandleArray
- Filter results be companygroupHandleArray
- Filter results by groupuserRoleArray
- Filter results by user rolecharFilterField
- Filter results by field's string prefixcharFilter
- Filter results by a specific charactersortBy
- Choice of user sort fieldrecordsPerPage
- Number of records per page to returnresultsPage
- The desired result page- Returns:
- Throws:
IpsApiException
-
setUserInfo
Document setUserInfo(S7Config s7Config, @Nullable @Nullable String userHandle, String firstName, String lastName, String email, String defaultRole, @Nullable @Nullable Instant passwordExpires, boolean isValid, List<Scene7CompanyMembership> membershipArray) throws IpsApiException
Set user attributes- Parameters:
s7Config
- The Scene7 configuserHandle
- User handlefirstName
- First namelastName
- Last nameemail
- Email addressdefaultRole
- The role for the user in the companies they belong, the IpsAdmin role overrides other per-company settingspasswordExpires
- The password's expirationisValid
- Determine if valid IPS usermembershipArray
- List ofScene7CompanyMembership
entries enumerating the membership of the user- Returns:
- Throws:
IpsApiException
-
deleteImageFormat
Document deleteImageFormat(S7Config s7Config, String imageFormatHandle) throws IpsApiException
Deletes an image format.- Parameters:
s7Config
- The Scene7 configimageFormatHandle
- Handle to the image format. (This is returned fromsaveImageFormat(S7Config, String, String, String)
)- Throws:
IpsApiException
-
getImageFormats
Document getImageFormats(@NotNull @NotNull S7Config s7Config) throws IpsApiException
Returns image formats, such as PDF, EPS, SWF, and others.- Parameters:
s7Config
- The Scene7 config- Returns:
- Throws:
IpsApiException
-
saveImageFormat
Document saveImageFormat(S7Config s7Config, @Nullable @Nullable String imageFormatHandle, String name, String urlModifier) throws IpsApiException
Create an image format.- Parameters:
s7Config
- The Scene7 configimageFormatHandle
- Image format handle you want to savename
- Image format nameurlModifier
- IPS protocol query string- Returns:
- Throws:
IpsApiException
-
deleteImageMap
Document deleteImageMap(S7Config s7Config, String imageMapHandle) throws IpsApiException
Deletes an image map- Parameters:
s7Config
- The Scene7 configimageMapHandle
- Handle for the image map to delete- Throws:
IpsApiException
-
saveImageMap
Document saveImageMap(S7Config s7Config, String assetHandle, @Nullable @Nullable String imageMapHandle, String name, String shapeType, String region, String action, int position, boolean enabled) throws IpsApiException
Create a new image map or edit an existing map- Parameters:
s7Config
- The Scene7 configassetHandle
- Handle to the asset the map belongs toimageMapHandle
- Handle to the image map.name
- Name of the image mapshapeType
- Choice of region shaperegion
- A comma delimited list of points that define the regionaction
- The href value associated with the image mapposition
- The order in the list of image mapsenabled
- Whether this map is enabled- Returns:
- Throws:
IpsApiException
-
setImageMaps
Document setImageMaps(S7Config s7Config, String assetHandle, List<Scene7ImageMapDefinition> imageMap) throws IpsApiException
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 configassetHandle
- Handle to the assetimageMap
- list of predefinedScene7ImageMapDefinition
objects- Returns:
- Throws:
IpsApiException
-
batchSetAssetMetadata
Document batchSetAssetMetadata(S7Config s7Config, List<Scene7MetadataUpdate> updates) throws IpsApiException
Sets asset metadata using batch mode.- Parameters:
s7Config
- The Scene7 configupdates
- List ofScene7ImageFieldUpdate
to be applied- Throws:
IpsApiException
-
batchSetImageFields
Document batchSetImageFields(S7Config s7Config, List<Scene7ImageFieldUpdate> updates) throws IpsApiException
Sets asset metadata using batch mode.- Parameters:
s7Config
- The Scene7 configupdates
- List ofScene7ImageFieldUpdate
to be applied- Throws:
IpsApiException
-
getUploadTaskStatus
Document getUploadTaskStatus(String jobHandle, S7Config s7Config) throws IpsApiException
Retrieves Scene7 upload job processing status- Parameters:
jobHandle
- Scene7 upload job handles7Config
- Scene7 configuration object- Returns:
- the API's response wrapped in a
Document
- Throws:
IpsApiException
-
moveAsset
Document moveAsset(S7Config s7Config, String assetHandle, String folderHandle) throws IpsApiException
Moves an asset to a specific folder- Parameters:
s7Config
- Scene7 configuration objectassetHandle
- Handle to the asset you want to movefolderHandle
- Handle to the destination folder- Returns:
- The API's response wrapped in a
Document
- Throws:
IpsApiException
-
moveAssets
Document moveAssets(S7Config s7Config, Map<String,String> assetFolderHandles) throws IpsApiException
Moves multiple assets independently of each other. It accomplishes this using the AssetMove type contained in the assetMoveArray. Each AssetMove field contains a destination folder- Parameters:
s7Config
- Scene7 configuration objectassetFolderHandles
- Map that contains an asset and an asset destination folder- Returns:
- The API's response wrapped in a
Document
- Throws:
IpsApiException
-
moveFolder
Document moveFolder(S7Config s7Config, String sourceFolderHandle, String destinationFolderHandle) throws IpsApiException
Move a folder to a new location- Parameters:
s7Config
- Scene7 configuration objectsourceFolderHandle
- Handle to the source folderdestinationFolderHandle
- Handle to the destination folder- Returns:
- The API's response wrapped in a
Document
- Throws:
IpsApiException
-
renameAsset
Document renameAsset(S7Config s7Config, String assetHandle, String name, boolean validateName) throws IpsApiException
Rename an asset- Parameters:
s7Config
- Scene7 configuration objectassetHandle
- Handle to the asset you want to movename
- Asset's new namevalidateName
- If the validateName is true and the asset type requires a unique IPS ID, then the new name is checked for global uniqueness and renameAsset throws a fault if it is not unique.- Returns:
- The API's response wrapped in a
Document
- Throws:
IpsApiException
-
renameFolder
Document renameFolder(S7Config s7Config, String folderHandle, String folderName) throws IpsApiException
Rename a folder- Parameters:
s7Config
- Scene7 configuration objectfolderHandle
- Handle to the folderfolderName
- New folder name- Returns:
- The API's response wrapped in a
Document
- Throws:
IpsApiException
-
renameAssetToUniqueName
String renameAssetToUniqueName(S7Config s7Config, String assetHandle, String newDesiredName) throws IpsApiException
Tries to rename given asset to the new name, maintaining the requirement of no duplicate asset names can exists in S7 for a given Company. If attempt was failed, it tries adding "-1" to the name, and repeat, then "-2" and so on. The maximum attempts count is 100. Note: when name ends with "-AVS" suffix - numbers are added before "-AVS" (S7 requirement).- Parameters:
s7Config
- configuration for access to Scene7 serverassetHandle
- asset handle (ID)newDesiredName
- new asset name, case-sensitive- Returns:
- actual name which was able to rename
- Throws:
IpsApiException
- on error at Scene7
-
batchSetThumbAsset
Document batchSetThumbAsset(S7Config s7Config, List<ThumbAssetUpdate> thumbnailUpdates) throws IpsApiException
Sets the thumbnail image for one or more assets- Parameters:
s7Config
- Scene7 configuration objectthumbnailUpdates
- List ofThumbAssetUpdate
objects to be applied- Returns:
- The API's response wrapped in a
Document
- Throws:
IpsApiException
- in case of IPS failures or undefined data format
-
updateSmartCrops
Document updateSmartCrops(S7Config s7Config, SmartCropUpdateArray updateArray) throws IpsApiException
Update one or more Smart Crop sub asset(s)- Parameters:
s7Config
- Scene7 configuration objectupdateArray
- Array of SmartCropUpdate objects containing subasset handles and NormalizedCropRect values- Returns:
- The API's response wrapped in a
Document
- Throws:
IpsApiException
-
addSmartCrops
Document addSmartCrops(S7Config s7Config, String assetHandle, SmartCropAddArray addSmartCropArray) throws IpsApiException
Add one or more Smart Crop sub asset(s)- Parameters:
s7Config
- Scene7 configuration objectassetHandle
- asset handle for asset to which smart crops are to be addedaddSmartCropArray
- Array of SmartCropUpdate objects NormalizedCropRect values and their respective names- Returns:
- The API's response wrapped in a
Document
- Throws:
IpsApiException
-
getXMPPacket
Document getXMPPacket(S7Config s7Config, String assetHandle) throws IpsApiException
Retrieves an XMP Metadata packet for the specified asset.- Parameters:
s7Config
- Scene7 configuration objectassetHandle
- Handle to the asset you want to get XMP metadata- Returns:
- The API's response wrapped in a
Document
- Throws:
IpsApiException
- in case of IPS failures or undefined data format
-
updateXMPPacket
Document updateXMPPacket(S7Config s7Config, String assetHandle, String xmpPacketAsXml) throws IpsApiException
Sets or updates an XMP metadata packet for an asset.- Parameters:
s7Config
- Scene7 configuration objectassetHandle
- Handle to the asset you want to update XMP metadataxmpPacketAsXml
- updated XMP packet to update asset metadata in XML format- Returns:
- The API's response wrapped in a
Document
- Throws:
IpsApiException
- in case of IPS failures or undefined data format
-
getLoginStatus
Document getLoginStatus(ResourceResolver resourceResolver, String email, String password, String region) throws IpsApiException
Checks the login in Scene7 with the given credentials- Parameters:
resourceResolver
- Resource Resolver used to access Scene7 configurationemail
- Email id of the userpassword
- Password of the userregion
- the user's region- Returns:
- The API's response wrapped in a
Document
- Throws:
IpsApiException
- in case of IPS failures or undefined data format
-
setPassword
Document setPassword(S7Config s7Config, String userHandle, String password, @Nullable @Nullable Integer validityInDays) throws IpsApiException
Sets the password for a given user with an expiry of 100 years ahead from the current date.- Parameters:
s7Config
- Scene7 configuration objectuserHandle
- Scene7 User Handle of the userpassword
- Password to be setvalidityInDays
- Password validity in number of days. Set it to null/zero for default expiry of 100 years.- Returns:
- The API's response wrapped in a
Document
- Throws:
IpsApiException
- in case of IPS failures or undefined data format
-
cdnCacheInvalidation
Document cdnCacheInvalidation(S7Config s7Config, UrlArray urlArray) throws IpsApiException
Forwards the supplied list of URLs to the Scene7 CDN (Content Distribution Network) provider to invalidate their existing cache of HTTP responses- Parameters:
s7Config
- Scene7 configuration objecturlArray
- List of up to 1000 URLs to invalidate from the CDN cache- Returns:
- The API's response wrapped in a
Document
- Throws:
IpsApiException
- in case of IPS failures or undefined data format
-
getSecureISAuthToken
Document getSecureISAuthToken(S7Config s7Config) throws IpsApiException
Gets the token for a given company to access secure preview IS.- Parameters:
s7Config
- Scene7 configuration object- Returns:
- The API's response wrapped in a
Document
- Throws:
IpsApiException
- in case of IPS failures or undefined data format
-
deleteSubAssets
Document deleteSubAssets(String companyHandle, String assetHandle, List<String> subAssetHandles, S7Config s7Config) throws IpsApiException
Deletes the sub assets for an asset- Parameters:
companyHandle
- the scene7 handle to the companyassetHandle
- the scene7 handle to the main assetsubAssetHandles
- list of scene7 handles to the sub assetss7Config
- the scene7 configuration- Returns:
- The API's response wrapped in a
Document
- Throws:
IpsApiException
- in case of IPS failures or undefined data format
-
setCompanySettings
Document setCompanySettings(SetCompanySettingsParam param, S7Config s7Config) throws IpsApiException
- Parameters:
param
- set company setting requests7Config
- the scene7 configuration- Returns:
- The API's response wrapped in a
Document
- Throws:
IpsApiException
- in case of IPS failures or undefined data format
-
getCompanySettings
GetCompanySettingsReturn getCompanySettings(S7Config s7Config) throws IpsApiException
- Parameters:
s7Config
- the scene7 configuration- Returns:
- response of company settings params
- Throws:
IpsApiException
- in case of IPS failures or undefined data format
-
-