com.sap.cloud.sdk.cloudplatform.connectivity.ScpXfDestinationLoader Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of connectivity-scp-cf Show documentation

Implementation of the Cloud platform abstraction for general-purpose connectivity on the SAP Cloud Platform (Cloud Foundry).

The newest version!

/*
 * Copyright (c) 2020 SAP SE or an SAP affiliate company. All rights reserved.
 */

package com.sap.cloud.sdk.cloudplatform.connectivity;

import java.util.Map;

import javax.annotation.Nonnull;

import com.google.common.annotations.Beta;

/**
 * Interface to encapsulate the logic {@code ScpXfDestination}s are read in the SAP Cloud Platform Cloud Foundry
 * environment.
 */
@Beta
@FunctionalInterface
public interface ScpXfDestinationLoader
{
    /**
     * This method returns a map containing all destination to be considered with {@link Destination#getName()} as their
     * key.
     * 
     * Note: This method will be called for each getter call to the {@link DestinationAccessor} (e.g.
     * {@link DestinationAccessor#getDestination(String)}), so the implementation should not contain excessive retrieval
     * logic, or cache the result.
     *
     * @return A {@code Map} with all relevant destinations.
     */
    @Nonnull
    Map loadDestinations();
}