Interface ApiRegistrationService
- All Known Implementing Classes:
DefaultApiRegistrationService
public interface ApiRegistrationService
Service for exporting/registering APIs
-
Method Summary
Modifier and TypeMethodDescriptionvoidregisterExposedDestination(ExposedDestinationModel destination) Register an ExposedDestinationretrieveRegisteredExposedDestinations(DestinationChannel destinationChannel, DestinationTargetModel destinationTarget) Retrieves all registered exposed destinations from target systemvoidunregisterExposedDestination(ExposedDestinationModel destination) Unregister an ExposedDestinationvoidunregisterExposedDestinationByTargetId(String targetId, DestinationTargetModel destinationTargetModel) Unregister exposed destination from target system
-
Method Details
-
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
List<RegisteredDestinationData> retrieveRegisteredExposedDestinations(DestinationChannel destinationChannel, DestinationTargetModel destinationTarget) throws ApiRegistrationException Retrieves all registered exposed destinations from target system- Parameters:
destinationChannel- destination channel of the target systemdestinationTarget- destination target- Returns:
- list of destination data
- Throws:
ApiRegistrationException- in case when retrieving destinations fails
-
unregisterExposedDestinationByTargetId
void unregisterExposedDestinationByTargetId(String targetId, DestinationTargetModel destinationTargetModel) throws ApiRegistrationException Unregister exposed destination from target system- Parameters:
targetId- target id of the registered destinationdestinationTargetModel- destination target- Throws:
ApiRegistrationException- in case when failed to unregister Destination
-