diff options
Diffstat (limited to 'sdc-distribution-client/src/main/java/org/onap/sdc/api/consumer/IConfiguration.java')
| -rw-r--r-- | sdc-distribution-client/src/main/java/org/onap/sdc/api/consumer/IConfiguration.java | 118 |
1 files changed, 86 insertions, 32 deletions
diff --git a/sdc-distribution-client/src/main/java/org/onap/sdc/api/consumer/IConfiguration.java b/sdc-distribution-client/src/main/java/org/onap/sdc/api/consumer/IConfiguration.java index c7248eb..e3013e2 100644 --- a/sdc-distribution-client/src/main/java/org/onap/sdc/api/consumer/IConfiguration.java +++ b/sdc-distribution-client/src/main/java/org/onap/sdc/api/consumer/IConfiguration.java @@ -21,19 +21,20 @@ package org.onap.sdc.api.consumer; import java.util.List; + import org.onap.sdc.api.notification.INotificationData; public interface IConfiguration { /** * SDC Distribution Engine address. Value can be either hostname (with or - * without port), IP:port or FQDN (Fully Qualified Domain Name). * @return - * SDC Distribution Engine address. + * without port), IP:port or FQDN (Fully Qualified Domain Name). * @return SDC + * Distribution Engine address. */ String getAsdcAddress(); /** - * SDC Distribution Addresses from ONAP Component - * Values need to be set from impl + * SDC Distribution Addresses from ONAP Component Values need to be set from + * impl */ List<String> getMsgBusAddress(); @@ -45,10 +46,9 @@ public interface IConfiguration { String getUser(); /** - * Return True if ssl is needed, false otherwise. - * This param can be null, then default (HTTPS) behavior will be - * applied. If set to false, distribution client will use HTTP when - * connecting to SDC. + * Return True if ssl is needed, false otherwise. This param can be null, then + * default (HTTPS) behavior will be applied. If set to false, distribution + * client will use HTTP when connecting to SDC. * * @return */ @@ -72,8 +72,8 @@ public interface IConfiguration { int getPollingInterval(); /** - * Distribution Client Timeout in seconds waiting to UEB server response in - * each fetch interval. Can Be reconfigured in runtime. + * Distribution Client Timeout in seconds waiting to UEB server response in each + * fetch interval. Can Be reconfigured in runtime. * * @return Distribution Client Timeout in seconds. */ @@ -81,16 +81,16 @@ public interface IConfiguration { /** * List of artifact types.<br> - * If the service contains any of the artifacts in the list, the callback - * will be activated. Can Be reconfigured in runtime. + * If the service contains any of the artifacts in the list, the callback will + * be activated. Can Be reconfigured in runtime. * * @return List of artifact types. */ List<String> getRelevantArtifactTypes(); /** - * Returns the consumer group defined for this ECOMP component, if no - * consumer group is defined return null. + * Returns the consumer group defined for this ECOMP component, if no consumer + * group is defined return null. * * @return Consumer group. */ @@ -112,9 +112,9 @@ public interface IConfiguration { String getConsumerID(); /** - * Return full path to Client's Key Store that contains either CA - * certificate or the ASDC's public key (e.g /etc/keystore/asdc-client.jks) - * file will be deployed with sdc-distribution jar. + * Return full path to Client's Key Store that contains either CA certificate or + * the ASDC's public key (e.g /etc/keystore/asdc-client.jks) file will be + * deployed with sdc-distribution jar. * * @return */ @@ -126,8 +126,8 @@ public interface IConfiguration { String getKeyStorePassword(); /** - * Sets whether SDC server TLS authentication is activated. If set to false, - * Key Store path and password are not needed to be set. + * Sets whether SDC server TLS authentication is activated. If set to false, Key + * Store path and password are not needed to be set. * * @return */ @@ -136,31 +136,32 @@ public interface IConfiguration { /** * If set to true the method {@link INotificationData#getResources()} will * return all found resources.<br> - * That means that metadata of resources that do not contain relevant - * artifacts types (artifacts that are defined in - * {@link #getRelevantArtifactTypes()} will be returned.<br> - * Setting the method to false will activate the legacy behavior, in which - * empty resources are not part of the notification.<br> + * That means that metadata of resources that do not contain relevant artifacts + * types (artifacts that are defined in {@link #getRelevantArtifactTypes()} will + * be returned.<br> + * Setting the method to false will activate the legacy behavior, in which empty + * resources are not part of the notification.<br> * * @return */ boolean isFilterInEmptyResources(); /** - * By default, Distribution Client will use HTTPS (TLS 1.2) when connecting - * to DMAAP. This param can be null, then default (HTTPS) behavior will be - * applied. If set to false, distribution client will use HTTP when - * connecting to DMAAP. + * By default, Distribution Client will use HTTPS (TLS 1.2) when connecting to + * DMAAP. This param can be null, then default (HTTPS) behavior will be applied. + * If set to false, distribution client will use HTTP when connecting to DMAAP. * * @return */ Boolean isUseHttpsWithDmaap(); /** - * By default, (false value) Distribution Client will trigger the regular registration - * towards SDC (register component as consumer to the SDC-DISTR-NOTIF-TOPIC-[ENV] topic and register component as producer to the SDC-DISTR-STATUS-TOPIC-[ENV]).<br> - * If set to true, distribution client trigger Register to SDC indicating - * that this component request to be consumer and producer of the + * By default, (false value) Distribution Client will trigger the regular + * registration towards SDC (register component as consumer to the + * SDC-DISTR-NOTIF-TOPIC-[ENV] topic and register component as producer to the + * SDC-DISTR-STATUS-TOPIC-[ENV]).<br> + * If set to true, distribution client trigger Register to SDC indicating that + * this component request to be consumer and producer of the * SDC-DISTR-STATUS-TOPIC-[ENV] topic.<br> * * @return @@ -168,4 +169,57 @@ public interface IConfiguration { default boolean isConsumeProduceStatusTopic() { return false; } + + /** + * By default: false. If set to true, Distribution Client will use System wide + * available proxies from JVM arguments. If set to false, distribution client + * will use proxy parameters configured through properties file. + * + * @return + */ + default Boolean isUseSystemProxy() { + return false; + } + + /** + * Optional configuration parameter. If the httpProxyHost parameter is + * configured and {@link #isUseHttpsWithSDC()} is false then SDC Distribution + * Client will register the proxy configuration with the HttpClient instance + * using HTTP and route requests through the proxy. + * + * @return + */ + String getHttpProxyHost(); + + /** + * Mandatory configuration parameter if httpProxyHost is configured. If the + * httpProxyHost and httpProxyPort parameters are configured and + * {@link #isUseHttpsWithSDC()} is false then SDC Distribution Client will + * register the proxy configuration with the HttpClient instance using HTTP and + * route requests through the proxy. + * + * @return + */ + int getHttpProxyPort(); + + /** + * Optional configuration parameter. If the httpsProxyHost parameter is + * configured and {@link #isUseHttpsWithSDC()} is true then SDC Distribution + * Client will register the proxy configuration with the HttpClient instance + * using HTTPS and route requests through the proxy. + * + * @return + */ + String getHttpsProxyHost(); + + /** + * Mandatory configuration parameter if httpsProxyHost is configured. If the + * httpsProxyHost and httpsProxyPort parameters are configured and + * {@link #isUseHttpsWithSDC()} is true then SDC Distribution Client will + * register the proxy configuration with the HttpClient instance using HTTPS and + * route requests through the proxy. + * + * @return + */ + int getHttpsProxyPort(); } |