@Nonnull @ProviderType public interface Scene7Service
Scene7Service
provides methods for interacting with the official Scene7 API.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.
|
Modifier and Type | Method and Description |
---|---|
String |
addUser(S7Config s7Config,
String firstName,
String lastName,
String email,
String defaultRole,
String password,
Instant passwordExpires,
boolean isValid,
List<Scene7CompanyMembership> membershipArray)
Creates a user account and adds the account to one of more companies
|
Scene7BatchMetadataResult |
batchSetAssetMetadata(S7Config s7Config,
List<Scene7MetadataUpdate> updates)
Sets asset metadata using batch mode.
|
Scene7BatchMetadataResult |
batchSetImageFields(S7Config s7Config,
List<Scene7ImageFieldUpdate> updateArray)
Sets asset metadata using batch mode.
|
String |
createAssetSet(S7Config s7Config,
String folder,
String name,
String type,
Resource resource,
Scene7AssetSet setDefinition,
String thumbAssetHandle)
Create an AssetSet asset on Scene7 server
|
String |
createFolder(S7Config s7Config,
String cqFolderPath)
Create a folder on Scene7 server
|
String |
createImageSet(S7Config s7Config,
String imageSetFolder,
String imageSetName,
String thumbAssetHandle)
|
String |
createImageSet(S7Config s7Config,
String folder,
String name,
String type,
Resource resource,
String thumbAssetHandle)
Create an ImageSet asset on Scene7 server
|
String |
createViewerPreset(S7Config s7Config,
String folderHandle,
String name,
String type,
List<Scene7ConfigSetting> configSettings)
|
String |
createViewerPreset(S7Config s7Config,
String folderHandle,
String name,
String type,
Resource resource,
List<Scene7ConfigSetting> configSettings)
Create a preset view to determine what users can see.
|
String |
deleteAsset(String assetHandle,
S7Config s7Config)
Returns a String success, note that the underlying S7 API call does not provide a data response.
|
String |
deleteAssets(String[] assetHandleArr,
S7Config s7Config)
Delete multiple assets
Returns a String success, note that the underlying S7 API call does not provide a data response.
|
String |
deleteFolder(String folderHandle,
S7Config s7Config)
Returns a String success, note that the underlying S7 API call does not provide a data response.
|
String |
deleteImageFormat(S7Config s7Config,
String imageFormatHandle)
Deletes an image format.
|
void |
deleteImageMap(S7Config s7Config,
String imageMapHandle)
Deletes an image map
|
List<Scene7User> |
getAllUsers(S7Config s7Config,
boolean includeInvalid)
Return all users
|
String |
getApplicationPropertyHandle(S7Config s7Config)
Returns the application property handle.
|
Scene7Asset |
getAsset(String assetHandle,
String[] responseFields,
String[] excludeFields,
S7Config s7Config)
Returns a single
Scene7Asset object. |
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.
|
List<Scene7Asset> |
getContainerAssets(Scene7Asset scene7Asset,
S7Config s7Config) |
String |
getFlashTemplatesServer(S7Config s7Config)
Deprecated.
|
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)
Deprecated.
|
Scene7Asset |
getGeneratedAssets(Scene7Asset asset,
S7Config s7Config)
Retrieves the generated assets associated with the given input asset
|
List<Scene7ImageFormat> |
getImageFormats(S7Config s7Config)
Returns image formats, such as PDF, EPS, SWF, and others.
|
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
|
List<UploadJobDetail> |
getJobLogDetailsByJobName(String jobName,
S7Config s7Config)
Returns a list of UploadJobDetail objects for the given job name
|
String |
getJobStatus(S7Config s7Config,
String jobName)
Get scene7 job status with given jobName, the jobName should be uniq, if there are many job have same name, it only get the first one
|
String |
getLinkedScene7ConfigPath(Resource resource)
Returns property
dam:scene7CloudConfigPath of a given
Resource object |
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
|
String |
getPreviewServerUrl(Resource resource,
ResourceResolver configResolver)
Retrieves Scene7 remote asset preview /is/image/ URL (context path with
image server uri).
|
String |
getPreviewVideoServerUrl(Resource resource,
ResourceResolver configResolver)
Retrieves Scene7 remote video preview /is/content/ URL (context path with
image server uri).
|
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 |
getPublishServerUrl(Resource resource,
ResourceResolver configResolver)
Retrieves Scene7 remote asset publish /is/image/ URL (server domain and
image server uri).
|
String |
getPublishVideoServerUrl(Resource resource,
ResourceResolver configResolver)
Retrieves Scene7 remote video publish /is/content/ URL (server domain and
image server uri).
|
Map<String,String> |
getS7AssetMetadata(S7Config s7Config,
String assetHandle)
Retrieves a metadata map (key-value pair) associated with a Scene7 asset
|
List<Scene7Asset> |
getS7VideoRenditions(S7Config s7Config,
String assetHandle)
Retrieves a list of Scene7 video renditions with their names and asset
handles
|
String |
getScene7ID(Resource resource)
Returns property
dam:scene7ID of a given Resource object |
String |
getUserHandle(ResourceResolver resourceResolver,
String email,
String password,
String region)
Returns a unique user handle from Scene7.
|
List<Scene7User> |
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
|
String |
getVideoEncoderPresetTypeHandle(S7Config s7Config)
Returns the video encoder preset type handle.
|
Scene7ViewerConfig |
getViewerConfigSettings(S7Config s7Config,
String assetHandle)
Get the viewer configuration for the referenced asset
|
String |
getXMPPacket(S7Config s7Config,
String assetHandle)
Retrieves an XMP Metadata packet for the specified asset.
|
boolean |
isJobActiveByJobHandle(String jobHandle,
S7Config s7Config) |
boolean |
isJobActiveByOriginalName(String originalName,
S7Config s7Config) |
boolean |
isResourceLinkedToScene7(Resource resource)
Returns true if
Resource object is linked to Scene7 based on its metadata |
boolean |
moveAsset(S7Config s7Config,
Resource resource,
String folder)
Moves an asset to a specific folder
|
boolean |
moveAssets(S7Config s7Config,
Map<Resource,String> resourcesToFolders)
Moves multiple assets independently of each other
|
boolean |
moveAssociatedAsset(S7Config s7Config,
Resource resource,
String folder)
Finds and moves generated assets to a specific folder
|
boolean |
moveFolder(S7Config s7Config,
String sourceFolder,
String destinationFolder)
Move a folder to a new location
|
boolean |
renameAsset(S7Config s7Config,
Resource resource,
String name)
Rename an asset
|
boolean |
renameFolder(S7Config s7Config,
String folder,
String name)
Rename a folder
|
String |
saveImageFormat(S7Config s7Config,
String imageFormatHandle,
String name,
String urlModifier)
Deprecated.
|
String |
saveImageFormat(S7Config s7Config,
String imageFormatHandle,
String name,
String urlModifier,
Resource resource)
Create an image format.
|
String |
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
|
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
Scene7Asset s 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
Scene7Asset s from the Scene7 server. |
List<Scene7Asset> |
searchAssetsByFilename(String folder,
Boolean includeSubfolders,
Boolean published,
String filename,
S7Config s7Config)
Retrieve a list of
Scene7Asset s 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)
|
List<Scene7Asset> |
searchAssetsByName(String folder,
Boolean includeSubfolders,
Boolean published,
String name,
S7Config s7Config)
Retrieve a list of
Scene7Asset s from the Scene7 server by Scene7
asset name. |
List<Scene7Asset> |
searchAssetsByPartialName(String folder,
Boolean includeSubfolders,
Boolean published,
String name,
String conditionMode,
S7Config s7Config)
Retrieve a list of
Scene7Asset s from the Scene7 server by Scene7
asset name with partial name search option |
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
|
String |
setAssetsPublishState(Set<String> assetHandles,
boolean markForPublish,
S7Config s7Config)
Set the publish state of a given Scene7 assets
|
List<String> |
setImageMaps(S7Config s7Config,
String assetHandle,
List<Scene7ImageMapDefinition> imageMap)
Sets the image map for an asset.
|
void |
setUserInfo(S7Config s7Config,
String userHandle,
String firstName,
String lastName,
String email,
String defaultRole,
Instant passwordExpires,
boolean isValid,
List<Scene7CompanyMembership> membershipArray)
Set user attributes
|
Map<String,Integer> |
setVideoThumbnail(S7Config s7Config,
String assetHandle,
String thumbAssetHandle)
Set the video thumbnail with a specifed thumbnail asset, not only for master video, all generated encoded videos and AVS files are
also been set together
|
void |
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
|
String |
submitReprocessAssetsThumbnailJob(S7Config s7Config,
String jobName,
String assetHandle,
long thumbnailTime)
Submit a job to S7 for reprocessing video thumbnail to a specified video frame time
|
void |
updateAssetSet(S7Config s7Config,
String assetHandle,
Scene7AssetSet setDefinition,
String thumbAssetHandle)
Update an AssetSet on Scene7 server
|
void |
updateImageSet(S7Config s7Config,
String assetHandle,
ImageSetMemberUpdateArray members,
String thumbAssetHandle)
Update an ImageSet on Scene7 server
|
void |
updateImageSet(S7Config s7Config,
String imageSetAssetHandle,
List<String> setMemberHandles,
String thumbAssetHandle)
|
boolean |
updateSmartCrops(S7Config s7Config,
Map<String,Map<String,Scene7NormalizedCropRect>> updateSmartCropMap)
Update one or more Smart Crop sub asset(s)
|
void |
updateViewerConfigSettings(S7Config s7Config,
String assetHandle,
List<Scene7ConfigSetting> configSettings)
Updates SWF viewer configuration settings.
|
void |
updateXMPPacket(S7Config s7Config,
String assetHandle,
String xmpPacketAsXml)
Sets or updates an XMP metadata packet for an asset.
|
static final int CONTAINER
static final int MEMBER
static final int OWNER
static final int DERIVED
static final int GENERATOR
static final int GENERATED
@Nullable String getPublishServer(S7Config s7Config)
s7Config
- null
if not presentAssertionError
- in case of IPS failures or undefined data format@Nullable String getApplicationPropertyHandle(S7Config s7Config)
s7Config
- the Scene7 configurationnull
if not presentAssertionError
- in case of IPS failures or undefined data format@Nullable String getVideoEncoderPresetTypeHandle(S7Config s7Config)
s7Config
- the Scene7 configurationnull
if not presentAssertionError
- in case of IPS failures or undefined data formatList<Scene7PropertySet> getPropertySets(String typeHandle, S7Config s7Config)
typeHandle
- - the type handles7Config
- the Scene7 configurationAssertionError
- in case of IPS failures or undefined data formatString getUserHandle(ResourceResolver resourceResolver, String email, String password, String region)
resourceResolver
- resource resolver used to access Scene7 configurationemail
- E-Mail addresspassword
- Passwordregion
- Region of the Scene7 serviceAssertionError
- in case of IPS failures or undefined data formatString getCompanyMembership(ResourceResolver resourceResolver, String userHandle, String email, String password, String region)
For example:
{
handle: 'jlkj98',
name: 'Acme Ltd.',
rootPath: '/MyAssets'
}
resourceResolver
- resource resolver used to access Scene7 configurationuserHandle
- Unique user handleemail
- E-Mail addresspassword
- Passwordregion
- Region of the Scene7 serviceAssertionError
- in case of IPS failures or undefined data formatScene7Folder getFolderTree(String folderPath, int depth, String[] responseFields, String[] excludeFields, S7Config s7Config)
Scene7Folder
holding a tree structurefolderPath
- - 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 treeexcludeFields
- - fields to be excluded in each node of the trees7Config
- Scene7Folder
object containing the requested folder structureAssertionError
- in case of IPS failures or undefined data formatString getFolderHandle(String cqFolderPath, S7Config s7Config)
cqFolderPath
- - the path the target cq folder targeted in the s7 folder organizations7Config
- AssertionError
- in case of IPS failures or undefined data formatString deleteFolder(String folderHandle, S7Config s7Config)
folderHandle
- - folder to be deleteds7Config
- - s7 config based on cloud service config info.AssertionError
- in case of IPS failuresString deleteAsset(String assetHandle, S7Config s7Config)
assetHandle
- - asset to be deleteds7Config
- - s7 config based on cloud service config info.AssertionError
- in case of IPS failures or undefined data formatString deleteAssets(String[] assetHandleArr, S7Config s7Config)
assetHandleArr
- - asset to be deleteds7Config
- - s7 config based on cloud service config info.AssertionError
- in case of IPS failures or undefined data formatList<Scene7Asset> searchAssetsByMetadata(String folder, Boolean includeSubfolders, String[] assetTypes, String[] assetSubTypes, Boolean published, MetadataCondition[] conditions, S7Config s7Config)
folder
- - all matched assets will be in this folderincludeSubfolders
- - whether to recursively search for assetsassetTypes
- - all matched assets will be one of these typesassetSubTypes
- array of sub Asset Types to include in searchpublished
- - whether the matched assets must be marked for publish (only marked - not necessarily actually published)conditions
- - metadata conditions for searchs7Config
- AssertionError
- in case of IPS failuresString submitReprocessAssetsThumbnailJob(S7Config s7Config, String jobName, String assetHandle, long thumbnailTime)
s7Config
- the Scene7 configurationjobName
- the name of the jobassetHandle
- the asset handlethumbnailTime
- the frame timeList<Scene7Asset> searchAssetsByMetadata(String folder, Boolean includeSubfolders, String[] assetTypes, String[] assetSubTypes, Boolean published, MetadataCondition[] conditions, int recordsPerPage, int resultsPage, S7Config s7Config)
folder
- - all matched assets will be in this folderincludeSubfolders
- - whether to recursively search for assetsassetTypes
- - all matched assets will be one of these typesassetSubTypes
- array of sub Asset Types to include in searchpublished
- - whether the matched assets must be marked for publish (only marked - not necessarily actually published)conditions
- - metadata conditions for searchrecordsPerPage
- maximum number of results to returnresultsPage
- specifies the page of results to return, based on recordsPerPage
page sizes7Config
- AssertionError
- in case of IPS failuresList<Scene7Asset> getAssets(String[] assetHandles, String[] responseFields, String[] excludeFields, S7Config s7Config)
Scene7Asset
list, based on a list of asset handlesassetHandles
- - the assets to retrieveresponseFields
- - fields to be filled in for each node in the treeexcludeFields
- - fields to be excluded in each node of the trees7Config
- Scene7Asset
listAssertionError
- in case of IPS failures@Nullable Scene7Asset getAsset(String assetHandle, String[] responseFields, String[] excludeFields, S7Config s7Config)
Scene7Asset
object. If there are multiple
matching assets found, return the first asset.assetHandle
- - the asset to retrieveresponseFields
- - fields to be filled in for each node in the treeexcludeFields
- - fields to be excluded in each node of the trees7Config
- - Scene7 cloud configuration objectScene7Asset
object, or null if not found or failedAssertionError
- in case of IPS failuresArrayList<UploadJobDetail> getMultiFileJobLogDetails(String jobHandle, S7Config s7Config)
jobHandle
- - the handle for the job to get details.s7Config
- AssertionError
- in case of IPS failures or undefined data formatboolean isJobActiveByJobHandle(String jobHandle, S7Config s7Config)
jobHandle
- of the jobs7Config
- true
if active job with this jobHandle or orginalName is active, false
otherwiseAssertionError
- in case of IPS failures or undefined data formatboolean isJobActiveByOriginalName(String originalName, S7Config s7Config)
originalName
- of the jobs7Config
- true
if active job with this jobHandle or orginalName is active, false
otherwiseAssertionError
- in case of IPS failures or undefined data formatList<String> getJobLogDetails(String jobHandle, S7Config s7Config)
jobHandle
- - the handle for the job to get details.s7Config
- AssertionError
- in case of IPS failures or undefined data formatList<UploadJobDetail> getJobLogDetailsByJobName(String jobName, S7Config s7Config)
jobName
- - the handle for the job to get details.s7Config
- AssertionError
- in case of IPS failures or undefined data formatString getJobStatus(S7Config s7Config, String jobName)
s7Config
- the Scene7 configurationjobName
- the name of the jobList<String> getImagePresets(S7Config s7Config)
S7Config
s7Config
- AssertionError
- in case of IPS failures or undefined data format@Deprecated String getFlashTemplatesServer(S7Config s7Config)
s7Config
- the Scene7 configurationList<Scene7Asset> searchAssets(String folder, Boolean includeSubfolders, Boolean published, String[] assetTypes, String[] assetSubTypes, String[] responseFields, String[] excludeFields, S7Config s7Config)
Scene7Asset
s from the Scene7 server.folder
- the folder from which the assets are retrievedincludeSubfolders
- whether to recursively search for assets in sub-folders of the folder where the search is performedpublished
- whether the matched assets must be marked for publish (only marked - not necessarily actually published)assetTypes
- all matched assets will be one of these typesassetSubTypes
- array of sub Asset Types to include in searchresponseFields
- the response fields that should be used to populate the Scene7Asset
's attributesexcludeFields
- fields to be excluded from the responses7Config
- the Scene7 configurationAssertionError
- in case of IPS failuresList<Scene7Asset> searchAssets(String folder, Boolean includeSubfolders, Boolean published, String[] assetTypes, String[] assetSubTypes, String[] responseFields, String[] excludeFields, int recordsPerPage, int resultsPage, S7Config s7Config)
Scene7Asset
s from the Scene7 server.folder
- the folder from which the assets are retrievedincludeSubfolders
- whether to recursively search for assets in sub-folders of the folder where the search is performedpublished
- whether the matched assets must be marked for publish (only marked - not necessarily actually published)assetTypes
- all matched assets will be one of these typesassetSubTypes
- array of sub Asset Types to include in searchresponseFields
- the response fields that should be used to populate the Scene7Asset
's attributesexcludeFields
- fields to be excluded from the responserecordsPerPage
- maximum number of results to returnresultsPage
- specifies the page of results to return, based on recordsPerPage
page sizes7Config
- the Scene7 configurationAssertionError
- in case of IPS failuresList<Scene7Asset> searchAssetsByFilename(String folder, Boolean includeSubfolders, Boolean published, String filename, S7Config s7Config)
Scene7Asset
s from the Scene7 server by
filename.folder
- includeSubfolders
- published
- filename
- s7Config
- AssertionError
- in case of IPS failuresList<Scene7Asset> searchAssetsByName(String folder, Boolean includeSubfolders, Boolean published, String name, S7Config s7Config)
Scene7Asset
s from the Scene7 server by Scene7
asset name.folder
- remote search folder pathincludeSubfolders
- to include children folderspublished
- to include published or non-published assetsname
- Scene7 name of target assets7Config
- Scene7 cloud configurationAssertionError
- in case of IPS failuresList<Scene7Asset> searchAssetsByPartialName(String folder, Boolean includeSubfolders, Boolean published, String name, String conditionMode, S7Config s7Config)
Scene7Asset
s from the Scene7 server by Scene7
asset name with partial name search optionfolder
- remote search folder pathincludeSubfolders
- to include children folderspublished
- to include published or non-published assetsname
- Scene7 name of target assetconditionMode
- partial name search condition mode. Currently supported modes
are "Equals" and "StartsWith"s7Config
- Scene7 cloud configurationScene7Asset
s@Nullable Scene7Asset getGeneratedAssets(Scene7Asset asset, S7Config s7Config)
asset
- - the asset to get the sub-assets and generator froms7Config
- - the Scene7 configurationScene7Asset
object updated with the
sub-assets and the originator assetAssertionError
- in case of IPS failures@Nullable Scene7Asset getAssociatedAssets(Scene7Asset asset, S7Config s7Config)
asset
- - the asset to get the sub-assets and generator froms7Config
- - the Scene7 configurationScene7Asset
object updated with the
sub-assets and the originator assetAssertionError
- in case of IPS failures@Nullable Scene7Asset getMasterAsset(Scene7Asset asset, S7Config s7Config)
asset
- - the asset to get the originator assets7Config
- - the Scene7 configurationScene7Asset
object updated with the
originator assetAssertionError
- in case of IPS failures@Deprecated String getFxgServer(S7Config s7Config)
s7Config
- the Scene7 configurationString setAssetPublishState(Resource resource, boolean markForPublish, S7Config s7Config)
resource
- activated resourcemarkForPublish
- value of markForPublish flags7Config
- the Scene7 configurationAssertionError
- in case of IPS failures or undefined data formatString setAssetPublishState(String assetHandle, boolean markForPublish, S7Config s7Config)
assetHandle
- unique asset identifiermarkForPublish
- value of markForPublish flags7Config
- the Scene7 configurationAssertionError
- in case of IPS failuresString setAssetsPublishState(Set<String> assetHandles, boolean markForPublish, S7Config s7Config)
assetHandles
- asset identifiers to set publish statemarkForPublish
- value of markForPublish flags7Config
- the Scene7 configurationAssertionError
- in case of IPS failuresString createFolder(S7Config s7Config, String cqFolderPath)
s7Config
- the Scene7 configurationcqFolderPath
- the path the target cq folder targeted in the s7 folder
organizationAssertionError
- in case of IPS failures or undefined data format@ParametersAreNonnullByDefault String createImageSet(S7Config s7Config, String folder, String name, String type, @Nullable Resource resource, @Nullable String thumbAssetHandle)
s7Config
- the Scene7 configurationfolder
- relative target folder based on S7 Config root folder. If not
exists, will attempt to create itname
- name for new ImageSettype
- type of new ImageSet (ImageSet, SwatchSet, RenderSet)resource
- (optional) if exists, jcr resource to receive metadata from new objectthumbAssetHandle
- (optional) asset handle of user-defined thumbnail image for
setAssertionError
- in case of IPS failures or undefined data format@Deprecated String createImageSet(@Nonnull S7Config s7Config, @Nullable String imageSetFolder, @Nonnull String imageSetName, @Nullable String thumbAssetHandle)
s7Config
- the Scene7 configurationimageSetFolder
- the path the target imageset cq folder targeted in the s7
folder organizationimageSetName
- name of the image setthumbAssetHandle
- (optional) user defined thumbnail asset handle@ParametersAreNonnullByDefault void updateImageSet(S7Config s7Config, String assetHandle, @Nullable ImageSetMemberUpdateArray members, @Nullable String thumbAssetHandle)
s7Config
- the Scene7 configurationassetHandle
- asset handle of the ImageSet to updatemembers
- (optional) list of ImageSet members (Null = not updated)thumbAssetHandle
- (optional) asset handle of user-defined thumbnail image for set (Null = not updated)AssertionError
- in case of IPS failures@Deprecated void updateImageSet(@Nonnull S7Config s7Config, @Nonnull String imageSetAssetHandle, @Nonnull List<String> setMemberHandles, @Nullable String thumbAssetHandle)
s7Config
- the Scene7 configurationimageSetAssetHandle
- image set Scene7 asset handlesetMemberHandles
- asset handles of image set membersthumbAssetHandle
- (optional) user defined thumbnail asset handle@ParametersAreNonnullByDefault String createAssetSet(S7Config s7Config, String folder, String name, String type, @Nullable Resource resource, @Nullable Scene7AssetSet setDefinition, @Nullable String thumbAssetHandle)
s7Config
- the Scene7 configurationfolder
- relative target folder based on S7 Config root folder. If not
exists, will attempt to create itname
- name for new AssetSettype
- type of new AssetSetresource
- (optional) if exists, jcr resource to receive metadata from new objectsetDefinition
- (optional) set's definition stringthumbAssetHandle
- (optional) asset handle of user-defined thumbnail image for
setAssertionError
- in case of IPS failures or undefined data format@ParametersAreNonnullByDefault void updateAssetSet(S7Config s7Config, String assetHandle, @Nullable Scene7AssetSet setDefinition, @Nullable String thumbAssetHandle)
s7Config
- the Scene7 configurationassetHandle
- asset handle of the AssetSet to updatesetDefinition
- (optional) set's definition string (Null = not updated)thumbAssetHandle
- (optional) asset handle of user-defined thumbnail image for set (Null = not updated)AssertionError
- in case of IPS failuresString createViewerPreset(@Nonnull S7Config s7Config, @Nonnull String folderHandle, @Nonnull String name, @Nonnull String type, @Nullable Resource resource, @Nullable List<Scene7ConfigSetting> configSettings)
s7Config
- the Scene7 configurationfolderHandle
- folder handle of the folder that contains the assetsname
- name for the viewertype
- type of any available viewer in IPSresource
- (optional) if exists, jcr resource to receive metadata from new objectconfigSettings
- (optional) list containing Scene7ConfigSetting
values to applynull
if unsuccessfulAssertionError
- in case of IPS failures or undefined data format@Deprecated String createViewerPreset(@Nonnull S7Config s7Config, @Nonnull String folderHandle, @Nonnull String name, @Nonnull String type, @Nullable List<Scene7ConfigSetting> configSettings)
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 containing Scene7ConfigSetting
values to applynull
if unsuccessfulScene7ViewerConfig getViewerConfigSettings(@Nonnull S7Config s7Config, @Nonnull String assetHandle)
s7Config
- the Scene7 configurationassetHandle
- asset handle for the asset of interestScene7ViewerConfig
with the information or null
if unsuccessfulAssertionError
- in case of IPS failures or undefined data formatvoid setViewerConfigSettings(@Nonnull S7Config s7Config, @Nonnull String assetHandle, @Nonnull String name, @Nonnull String type, @Nonnull List<Scene7ConfigSetting> configSettings)
s7Config
- the Scene7 configurationassetHandle
- asset handle for the asset to modifyname
- name of the assettype
- type of any available viewer in IPSconfigSettings
- list containing Scene7ConfigSetting
values to applyAssertionError
- in case of IPS failuresvoid updateViewerConfigSettings(@Nonnull S7Config s7Config, @Nonnull String assetHandle, @Nonnull List<Scene7ConfigSetting> configSettings)
s7Config
- the Scene7 configurationassetHandle
- asset handle for the asset to modifyconfigSettings
- list containing Scene7ConfigSetting
values to applyAssertionError
- in case of IPS failuresString addUser(@Nonnull S7Config s7Config, @Nonnull String firstName, @Nonnull String lastName, @Nonnull String email, @Nonnull String defaultRole, @Nonnull String password, @Nullable Instant passwordExpires, boolean isValid, @Nonnull List<Scene7CompanyMembership> membershipArray)
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 of Scene7CompanyMembership
entries enumerating the
membership of the user.AssertionError
- in case of IPS failures or undefined data formatList<Scene7User> getAllUsers(@Nonnull S7Config s7Config, boolean includeInvalid)
s7Config
- The Scene7 configurationincludeInvalid
- Indicate if invalid users should be includedScene7User
requestedAssertionError
- in case of IPS failures or undefined data formatList<Scene7User> getUsers(@Nonnull 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)
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 pageScene7User
requestedAssertionError
- in case of IPS failures or undefined data formatvoid setUserInfo(@Nonnull S7Config s7Config, @Nullable String userHandle, @Nonnull String firstName, @Nonnull String lastName, @Nonnull String email, @Nonnull String defaultRole, @Nullable Instant passwordExpires, boolean isValid, @Nonnull List<Scene7CompanyMembership> membershipArray)
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 of Scene7CompanyMembership
entries enumerating the
membership of the userAssertionError
- in case of IPS failuresString deleteImageFormat(@Nonnull S7Config s7Config, @Nonnull String imageFormatHandle)
s7Config
- The Scene7 configimageFormatHandle
- Handle to the image format. (This is returned from
saveImageFormat(S7Config, String, String, String, Resource)
AssertionError
- in case of IPS failuresList<Scene7ImageFormat> getImageFormats(@Nonnull S7Config s7Config)
s7Config
- The Scene7 configScene7ImageFormat
objectsAssertionError
- in case of IPS failures or undefined data formatString saveImageFormat(@Nonnull S7Config s7Config, @Nullable String imageFormatHandle, @Nonnull String name, @Nonnull String urlModifier, @Nullable Resource resource)
s7Config
- The Scene7 configimageFormatHandle
- Image format handle you want to savename
- Image format nameurlModifier
- IPS protocol query stringresource
- (optional) if exists, jcr resource to receive metadata from new objectAssertionError
- in case of IPS failures or undefined data format@Deprecated String saveImageFormat(@Nonnull S7Config s7Config, @Nullable String imageFormatHandle, @Nonnull String name, @Nonnull String urlModifier)
saveImageFormat(S7Config, String, String, String, Resource)
s7Config
- The Scene7 configimageFormatHandle
- Image format handle you want to savename
- Image format nameurlModifier
- IPS protocol query stringvoid deleteImageMap(@Nonnull S7Config s7Config, @Nonnull String imageMapHandle)
s7Config
- The Scene7 configimageMapHandle
- Handle for the image map to deleteAssertionError
- in case of IPS failuresString saveImageMap(@Nonnull S7Config s7Config, @Nonnull String assetHandle, @Nullable String imageMapHandle, @Nonnull String name, @Nonnull String shapeType, @Nonnull String region, @Nonnull String action, int position, boolean enabled)
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 enabledAssertionError
- in case of IPS failures or undefined data formatList<String> setImageMaps(@Nonnull S7Config s7Config, @Nonnull String assetHandle, @Nonnull List<Scene7ImageMapDefinition> imageMap)
s7Config
- The Scene7 configassetHandle
- Handle to the assetimageMap
- list of predefined Scene7ImageMapDefinition
objectsAssertionError
- in case of IPS failures or undefined data format@ParametersAreNonnullByDefault Scene7BatchMetadataResult batchSetAssetMetadata(S7Config s7Config, List<Scene7MetadataUpdate> updates)
s7Config
- The Scene7 configupdates
- List of Scene7ImageFieldUpdate
to be appliedScene7BatchMetadataResult
containing details
on any warnings or errorsAssertionError
- in case of IPS failures or undefined data format@ParametersAreNonnullByDefault Scene7BatchMetadataResult batchSetImageFields(S7Config s7Config, List<Scene7ImageFieldUpdate> updateArray)
s7Config
- The Scene7 configupdateArray
- List of Scene7ImageFieldUpdate
to be appliedScene7BatchMetadataResult
containing details
on any warnings or errorsAssertionError
- in case of IPS failures or undefined data format@Nullable String getPreviewServerUrl(Resource resource, ResourceResolver configResolver)
resource
- Scene7 sync-ed asset in DAMconfigResolver
- resource resolver with access to S7Config object@Nullable String getPublishServerUrl(Resource resource, ResourceResolver configResolver)
resource
- Scene7 sync-ed asset in DAMconfigResolver
- resource resolver with access to S7Config object@Nullable String getPreviewVideoServerUrl(Resource resource, ResourceResolver configResolver)
resource
- Scene7 sync-ed asset in DAMconfigResolver
- resource resolver with access to S7Config object@Nullable String getPublishVideoServerUrl(Resource resource, ResourceResolver configResolver)
resource
- Scene7 sync-ed asset in DAMconfigResolver
- resource resolver with access to S7Config object@Nullable Map<String,String> getS7AssetMetadata(S7Config s7Config, String assetHandle)
s7Config
- The Scene7 cloud configuration objectassetHandle
- Scene7 unique asset identifierAssertionError
- in case of IPS failures or undefined data format@Nullable List<Scene7Asset> getS7VideoRenditions(S7Config s7Config, String assetHandle)
s7Config
- The Scene7 cloud configuration objectassetHandle
- Scene7 unique asset identifierAssertionError
- in case of IPS failures or undefined data format@Nullable String getScene7ID(Resource resource)
dam:scene7ID
of a given Resource
objectresource
- Resource object on which to get Scene7 metadatadam:scene7ID
associated to
Resource
or null if property is unavailableboolean isResourceLinkedToScene7(Resource resource)
Resource
object is linked to Scene7 based on its metadataresource
- Resource object on which to get Scene7 metadataResource
object has dam:scene7ID
metadata@Nullable String getLinkedScene7ConfigPath(Resource resource)
dam:scene7CloudConfigPath
of a given
Resource
objectresource
- Resource object on which to get Scene7 metadatadam:scene7CloudConfigPath
associated to
Resource
or null if property is unavailable@Nullable List<Scene7Asset> getContainerAssets(Scene7Asset scene7Asset, S7Config s7Config)
boolean moveAsset(S7Config s7Config, Resource resource, String folder)
s7Config
- Scene7 S7Config objectresource
- Resource object to be relocatedfolder
- Destination folder pathboolean moveAssets(S7Config s7Config, Map<Resource,String> resourcesToFolders)
s7Config
- Scene7 S7Config objectresourcesToFolders
- Mapping of AEM resource to destination folderboolean moveFolder(S7Config s7Config, String sourceFolder, String destinationFolder)
s7Config
- Scene7 S7Config objectsourceFolder
- Path to source folderdestinationFolder
- Path to destination folderboolean moveAssociatedAsset(S7Config s7Config, Resource resource, String folder)
s7Config
- Scene7 S7Config objectresource
- Resource object to be relocatedfolder
- Destination folder pathboolean renameAsset(S7Config s7Config, Resource resource, String name)
s7Config
- Scene7 S7Config objectresource
- Resource object to be renamedname
- Asset's new nameboolean renameFolder(S7Config s7Config, String folder, String name)
s7Config
- Scene7 S7Config objectfolder
- Folder to be renamedname
- Folder's new nameboolean updateSmartCrops(S7Config s7Config, Map<String,Map<String,Scene7NormalizedCropRect>> updateSmartCropMap)
s7Config
- Scene7 S7Config objectupdateSmartCropMap
- Map of owner handle, sub-asset asset handles and
Scene7NormalizedCropRect objectsMap<String,Integer> setVideoThumbnail(S7Config s7Config, String assetHandle, String thumbAssetHandle)
s7Config
- the Scene7 configurationassetHandle
- the S7 assetHandle of the master video that you want to set thumbnailthumbAssetHandle
- the S7 assetHandle of the thumbnail assetString getXMPPacket(S7Config s7Config, String assetHandle)
s7Config
- the Scene7 configurationassetHandle
- Handle to the asset you want to get XMP metadatavoid updateXMPPacket(S7Config s7Config, String assetHandle, String xmpPacketAsXml)
s7Config
- the Scene7 configurationassetHandle
- Handle to the asset you want to get XMP metadataxmpPacketAsXml
- updated XMP packet to update asset metadata in XML formatCopyright © 2010 - 2020 Adobe. All Rights Reserved