Package de.hybris.platform.apiregistryservices.services

Interface DestinationService<T extends AbstractDestinationModel>

Type Parameters:

T - the type parameter which extends the AbstractDestinationModel type

All Known Implementing Classes:

DefaultDestinationService

public interface DestinationService<T extends AbstractDestinationModel>

Service layer interface for destinations

Method Summary

Modifier and Type	Method	Description
java.util.List<ExposedDestinationModel>	getActiveExposedDestinationsByChannel(DestinationChannel channel)	Deprecated, for removal: This API element is subject to removal in a future version. since 1905.
java.util.List<ExposedDestinationModel>	getActiveExposedDestinationsByClientId(java.lang.String clientId)	Find the list of active destinations for specific clientId
java.util.List<ExposedDestinationModel>	getActiveExposedDestinationsByDestinationTargetId(java.lang.String destinationTargetId)	Get the list of active exposed destinations for a specific destination target
java.util.List<ConsumedDestinationModel>	getAllConsumedDestinations()	Get all consumed destinations
java.util.List<T>	getAllDestinations()	Get all destinations
T	getDestinationById(java.lang.String id)	Deprecated, for removal: This API element is subject to removal in a future version. since 1905.
T	getDestinationByIdAndByDestinationTargetId(java.lang.String destinationId, java.lang.String destinationTargetId)	Get the destination for a specific destination and a specific destination id
java.util.List<T>	getDestinationsByChannel(DestinationChannel channel)	Deprecated, for removal: This API element is subject to removal in a future version. since 1905.
java.util.List<T>	getDestinationsByDestinationTargetId(java.lang.String destinationTargetId)	Find destinations for specific destinationTarget
void	testDestinationUrl(ConsumedDestinationModel consumedDestination)	Testing the consumed destination url

Method Detail

getDestinationsByChannel

@Deprecated(since="1905",
            forRemoval=true)
java.util.List<T> getDestinationsByChannel(DestinationChannel channel)

Deprecated, for removal: This API element is subject to removal in a future version.

since 1905. Use getDestinationsByDestinationTargetId(String)

Find destinations for specific channel

Parameters:

channel - the channel of the destination

Returns:

List of destinations for the given channel

getDestinationsByDestinationTargetId

java.util.List<T> getDestinationsByDestinationTargetId(java.lang.String destinationTargetId)

Find destinations for specific destinationTarget

Parameters:

destinationTargetId - the id of the DestinationTarget

Returns:

List of destinations for the given DestinationTarget

getActiveExposedDestinationsByClientId

java.util.List<ExposedDestinationModel> getActiveExposedDestinationsByClientId(java.lang.String clientId)

Find the list of active destinations for specific clientId

Parameters:

clientId - The clientId of OAuthClientDetails

Returns:

a List of Destinations by the ExposedOAuthCredential clientId

getActiveExposedDestinationsByChannel

@Deprecated(since="1905",
            forRemoval=true)
java.util.List<ExposedDestinationModel> getActiveExposedDestinationsByChannel(DestinationChannel channel)

Deprecated, for removal: This API element is subject to removal in a future version.

since 1905. Use getActiveExposedDestinationsByDestinationTargetId(String)

Find the list of destinations for specific channel

Parameters:

channel - The channel assigned to Destinations

Returns:

a List of Destinations by the credential

getDestinationById

@Deprecated(since="1905",
            forRemoval=true)
T getDestinationById(java.lang.String id)

Deprecated, for removal: This API element is subject to removal in a future version.

since 1905. Use getDestinationByIdAndByDestinationTargetId(String, String)

Since 1905, the id attribute of the destination is not unique, therefore, this gets the first item of the destinations for specific id.

Parameters:

id - the id of the destination

Returns:

The destination for the given id

getAllDestinations

java.util.List<T> getAllDestinations()

Get all destinations

Returns:

the list of destinations

getActiveExposedDestinationsByDestinationTargetId

java.util.List<ExposedDestinationModel> getActiveExposedDestinationsByDestinationTargetId(java.lang.String destinationTargetId)

Get the list of active exposed destinations for a specific destination target

Parameters:

destinationTargetId - id of the destination target

Returns:

a list of exposed destinations

getDestinationByIdAndByDestinationTargetId

T getDestinationByIdAndByDestinationTargetId(java.lang.String destinationId,
                                             java.lang.String destinationTargetId)

Get the destination for a specific destination and a specific destination id

Parameters:

destinationId - id of the destination

destinationTargetId - id of the destination target

Returns:

a destination

testDestinationUrl

void testDestinationUrl(ConsumedDestinationModel consumedDestination)
                 throws DestinationNotFoundException

Testing the consumed destination url

Parameters:

consumedDestination - given consumedDestination model

Throws:

DestinationNotFoundException - will be thrown in case of any exception during testing the consumed destination url

getAllConsumedDestinations

java.util.List<ConsumedDestinationModel> getAllConsumedDestinations()

Get all consumed destinations

Returns:

the list of consumed destinations