Package de.hybris.platform.apiregistryservices.services

Interface ApiRegistrationService

All Known Implementing Classes:

DefaultApiRegistrationService

public interface ApiRegistrationService

Service for exporting/registering APIs

Method Summary

Modifier and Type	Method	Description
void	registerExposedDestination(ExposedDestinationModel destination)	Register an ExposedDestination
java.util.List<RegisteredDestinationData>	retrieveRegisteredExposedDestinations(DestinationChannel destinationChannel, DestinationTargetModel destinationTarget)	Retrieves all registered exposed destinations from target system
void	unregisterExposedDestination(ExposedDestinationModel destination)	Unregister an ExposedDestination
void	unregisterExposedDestinationByTargetId(java.lang.String targetId, DestinationTargetModel destinationTargetModel)	Unregister exposed destination from target system

Method Detail

registerExposedDestination

void registerExposedDestination(ExposedDestinationModel destination)
                         throws ApiRegistrationException

Register an ExposedDestination

Parameters:

destination - ExposedDestination to be registered

Throws:

ApiRegistrationException - in case when failed to register Destination

unregisterExposedDestination

void unregisterExposedDestination(ExposedDestinationModel destination)
                           throws ApiRegistrationException

Unregister an ExposedDestination

Parameters:

destination - ExposedDestination to be unregistered

Throws:

ApiRegistrationException - in case when failed to unregister Destination

retrieveRegisteredExposedDestinations

java.util.List<RegisteredDestinationData> retrieveRegisteredExposedDestinations(DestinationChannel destinationChannel,
                                                                                DestinationTargetModel destinationTarget)
                                                                         throws ApiRegistrationException

Retrieves all registered exposed destinations from target system

Parameters:

destinationChannel - destination channel of the target system

destinationTarget - destination target

Returns:

list of destination data

Throws:

ApiRegistrationException - in case when retrieving destinations fails

unregisterExposedDestinationByTargetId

void unregisterExposedDestinationByTargetId(java.lang.String targetId,
                                            DestinationTargetModel destinationTargetModel)
                                     throws ApiRegistrationException

Unregister exposed destination from target system

Parameters:

targetId - target id of the registered destination

destinationTargetModel - destination target

Throws:

ApiRegistrationException - in case when failed to unregister Destination