com.sap.core.connectivity.api.configuration
Interface ConnectivityConfiguration

public interface ConnectivityConfiguration

ConnectivityConfiguration provides read only access to destination properties.

Method Summary

void	clearCache() Removes all destination configurations from the destination cache if such exist.
DestinationConfiguration	getConfiguration(String name) Retrieves the destination configuration with the provided name.
DestinationConfiguration	getConfiguration(String account, String name) Retrieves the destination configuration on account level with the provided name for the provided account.
Map<String,DestinationConfiguration>	getConfigurations(String account) Retrieves all destination configurations on account level for the provided account.

Method Detail

getConfiguration

DestinationConfiguration getConfiguration(String name)

Retrieves the destination configuration with the provided name.

Parameters:

name - - destination name.

Returns:

DestinationConfiguration or null if configuration is not found.

getConfiguration

DestinationConfiguration getConfiguration(String account,
                                          String name)

Retrieves the destination configuration on account level with the provided name for the provided account. Applications are able to access destination configurations only of accounts which are subscribed to them.

Parameters:

account - - account name

name - - destination name

Returns:

DestinationConfiguration or null if configuration is not found.

Throws:

NotAuthorizedException - if account is not found or missing access permissions for the account. This exception will be thrown in the HCP local development scenario (there is no account information).

getConfigurations

Map<String,DestinationConfiguration> getConfigurations(String account)

Retrieves all destination configurations on account level for the provided account. Applications are able to access destination configurations only of accounts which are subscribed to them.

Parameters:

account - - account name

Returns:

Map with key destination name and value DestinationConfiguration or null if configurations are not found.

Throws:

NotAuthorizedException - if account is not found or missing access permissions for the account. This exception will be thrown in the HCP local development scenario (there is no account information).

clearCache

void clearCache()

Removes all destination configurations from the destination cache if such exist. Note that each application instance has its own cache instance.