com.liferay.adaptive.media.image.configuration

Interface AMImageConfigurationHelper

@ProviderType
public interface AMImageConfigurationHelper

Manages and fetches an AMImageConfigurationEntry. This interface is the preferred mechanism to interact with image configuration entries.

Method Summary

Modifier and Type	Method and Description
AMImageConfigurationEntry	addAMImageConfigurationEntry(long companyId, java.lang.String name, java.lang.String description, java.lang.String uuid, java.util.Map<java.lang.String,java.lang.String> properties) Adds a new image configuration entry.
void	deleteAMImageConfigurationEntry(long companyId, java.lang.String uuid) Deletes an existing and disabled image configuration entry.
void	disableAMImageConfigurationEntry(long companyId, java.lang.String uuid) Disables an existing and enabled image configuration entry.
void	enableAMImageConfigurationEntry(long companyId, java.lang.String uuid) Enables an existing and disabled image configuration entry.
void	forceDeleteAMImageConfigurationEntry(long companyId, java.lang.String uuid) Deletes an existing image configuration entry, even if it is enabled.
java.util.Collection<AMImageConfigurationEntry>	getAMImageConfigurationEntries(long companyId) Returns a collection of the enabled image configuration entries for a company.
java.util.Collection<AMImageConfigurationEntry>	getAMImageConfigurationEntries(long companyId, java.util.function.Predicate<? super AMImageConfigurationEntry> predicate) Returns a collection of image configuration entries filtered by the given predicate for a company.
java.util.Optional<AMImageConfigurationEntry>	getAMImageConfigurationEntry(long companyId, java.lang.String configurationEntryUUID) Returns an optional image configuration entry for the given company and image configuration entry UUID.
AMImageConfigurationEntry	updateAMImageConfigurationEntry(long companyId, java.lang.String oldUuid, java.lang.String name, java.lang.String description, java.lang.String newUuid, java.util.Map<java.lang.String,java.lang.String> properties) Updates an existing image configuration entry.

Method Detail

addAMImageConfigurationEntry

AMImageConfigurationEntry addAMImageConfigurationEntry(long companyId,
                                                       java.lang.String name,
                                                       java.lang.String description,
                                                       java.lang.String uuid,
                                                       java.util.Map<java.lang.String,java.lang.String> properties)
                                                throws AMImageConfigurationException,
                                                       java.io.IOException

Adds a new image configuration entry.

Parameters:

companyId - the primary key of the company

name - the image configuration entry's unique name

description - the image configuration entry's description

uuid - the image configuration entry's UUID

properties - a set of properties with additional information about how the adaptive media image will be generated

Returns:

the image configuration entry

Throws:

AMImageConfigurationException - if there was an issue with the values of the new configuration entry

java.io.IOException - if there was an issue when persisting the new image configuration entry in the store

deleteAMImageConfigurationEntry

void deleteAMImageConfigurationEntry(long companyId,
                                     java.lang.String uuid)
                              throws AMImageConfigurationException.InvalidStateAMImageConfigurationException,
                                     java.io.IOException

Deletes an existing and disabled image configuration entry. If no image configuration entry matches the specified UUID, no operation is performed.

Parameters:

companyId - the primary key of the company

uuid - the image configuration entry's UUID

Throws:

AMImageConfigurationException.InvalidStateAMImageConfigurationException - if the image configuration entry to delete was not disabled

java.io.IOException - if there was an issue when deleting the image configuration entry from the store

disableAMImageConfigurationEntry

void disableAMImageConfigurationEntry(long companyId,
                                      java.lang.String uuid)
                               throws java.io.IOException

Disables an existing and enabled image configuration entry. If there is no image configuration entry with the specified UUID or it is already disabled, no operation is performed.

Parameters:

companyId - the primary key of the company

uuid - the image configuration entry's UUID

Throws:

java.io.IOException - if there was an issue when updating the image configuration entry from the store

enableAMImageConfigurationEntry

void enableAMImageConfigurationEntry(long companyId,
                                     java.lang.String uuid)
                              throws java.io.IOException

Enables an existing and disabled image configuration entry. If there is no image configuration entry with the specified UUID or it is already enabled, no operation is performed.

Parameters:

companyId - the primary key of the company

uuid - the image configuration entry's UUID

Throws:

java.io.IOException - if there was an issue when updating the image configuration entry from the store

forceDeleteAMImageConfigurationEntry

void forceDeleteAMImageConfigurationEntry(long companyId,
                                          java.lang.String uuid)
                                   throws java.io.IOException

Deletes an existing image configuration entry, even if it is enabled. This should be a last resort. If possible, an image configuration should be disabled before deleting. If there is no image configuration entry with the specified UUID, no operation is performed.

Parameters:

companyId - the primary key of the company

uuid - the image configuration entry's UUID

Throws:

java.io.IOException - if there was an issue when deleting the image configuration entry from the store

getAMImageConfigurationEntries

java.util.Collection<AMImageConfigurationEntry> getAMImageConfigurationEntries(long companyId)

Returns a collection of the enabled image configuration entries for a company.

Parameters:

companyId - the primary key of the company

Returns:

the collection of enabled image configuration entries

getAMImageConfigurationEntries

java.util.Collection<AMImageConfigurationEntry> getAMImageConfigurationEntries(long companyId,
                                                                               java.util.function.Predicate<? super AMImageConfigurationEntry> predicate)

Returns a collection of image configuration entries filtered by the given predicate for a company.

Parameters:

companyId - the primary key of the company

predicate - the predicate used to filter the collection

Returns:

the filtered collection of image configuration entries

getAMImageConfigurationEntry

java.util.Optional<AMImageConfigurationEntry> getAMImageConfigurationEntry(long companyId,
                                                                           java.lang.String configurationEntryUUID)

Returns an optional image configuration entry for the given company and image configuration entry UUID.

Parameters:

companyId - the primary key of the company

configurationEntryUUID - the image configuration entry's UUID

Returns:

an optional image configuration entry

updateAMImageConfigurationEntry

AMImageConfigurationEntry updateAMImageConfigurationEntry(long companyId,
                                                          java.lang.String oldUuid,
                                                          java.lang.String name,
                                                          java.lang.String description,
                                                          java.lang.String newUuid,
                                                          java.util.Map<java.lang.String,java.lang.String> properties)
                                                   throws AMImageConfigurationException,
                                                          java.io.IOException

Updates an existing image configuration entry.

Parameters:

companyId - the primary key of the company

oldUuid - the image configuration entry's UUID to update

name - the new image configuration entry's name

description - the new image configuration entry's description

newUuid - the new image configuration entry's UUID

properties - the new set of properties with additional information about how the adaptive media image will be generated

Returns:

the updated image configuration entry

Throws:

AMImageConfigurationException - if there was an issue with the values of the new configuration entry

java.io.IOException - if there was an issue when persisting the new image configuration entry in the store