diff options
Diffstat (limited to 'rest-services/cbs-client/src/main/java/org/onap/dcaegen2/services/sdk/rest/services/cbs/client/model/CbsClientConfiguration.java')
-rw-r--r-- | rest-services/cbs-client/src/main/java/org/onap/dcaegen2/services/sdk/rest/services/cbs/client/model/CbsClientConfiguration.java | 115 |
1 files changed, 115 insertions, 0 deletions
diff --git a/rest-services/cbs-client/src/main/java/org/onap/dcaegen2/services/sdk/rest/services/cbs/client/model/CbsClientConfiguration.java b/rest-services/cbs-client/src/main/java/org/onap/dcaegen2/services/sdk/rest/services/cbs/client/model/CbsClientConfiguration.java new file mode 100644 index 00000000..e3c7d2ea --- /dev/null +++ b/rest-services/cbs-client/src/main/java/org/onap/dcaegen2/services/sdk/rest/services/cbs/client/model/CbsClientConfiguration.java @@ -0,0 +1,115 @@ +/* + * ============LICENSE_START==================================== + * DCAEGEN2-SERVICES-SDK + * ========================================================= + * Copyright (C) 2019 Nokia. All rights reserved. + * ========================================================= + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ============LICENSE_END===================================== + */ + +package org.onap.dcaegen2.services.sdk.rest.services.cbs.client.model; + +import org.immutables.value.Value; +import org.jetbrains.annotations.Nullable; + +/** + * Immutable object which helps with construction of cloudRequestObject for specified Client. For usage take a look in + * CloudConfigurationClient.class + * + * @author <a href="mailto:przemyslaw.wasala@nokia.com">Przemysław Wąsala</a> on 11/16/18 + * @version 1.0.0 can be passed to ReactiveCloudConfigurationProvider, can be constructed out of + * org.onap.dcaegen2.services.sdk library. + * @since 1.0.0 + */ +@Value.Immutable(prehash = true) +public interface CbsClientConfiguration { + + /** + * Name of environment variable containing Config Binding Service network hostname. + */ + String ENV_CBS_HOSTNAME = "CONFIG_BINDING_SERVICE"; + + /** + * Name of environment variable containing Config Binding Service network port. + */ + String ENV_CBS_PORT = "CONFIG_BINDING_SERVICE_SERVICE_PORT"; + + /** + * Name of environment variable containing current application name. + */ + String ENV_APP_NAME = "HOSTNAME"; + + /** + * Name of environment variable containing Consul host name. + * + * @deprecated CBS lookup in Consul service should not be needed, + * instead {@link #ENV_CBS_HOSTNAME} should be used directly. + */ + @Deprecated + String ENV_CONSUL_HOST = "CONSUL_HOST"; + + /** + * Name of environment variable containing Config Binding Service <em>service name</em> as registered in Consul + * services API. + * + * @deprecated CBS lookup in Consul service should not be needed, + * instead {@link #ENV_CBS_HOSTNAME} should be used directly. + */ + @Deprecated + String ENV_CBS_NAME = "CONFIG_BINDING_SERVICE"; + + @Value.Parameter + @Nullable + String hostname(); + + @Value.Parameter + @Nullable + Integer port(); + + @Value.Parameter + String appName(); + + @Value.Default + @Deprecated + default String consulHost() { + return "consul-server"; + } + + @Value.Default + @Deprecated + default Integer consulPort() { + return 8500; + } + + @Value.Default + @Deprecated + default String cbsName() { + return "config-binding-service"; + } + + /** + * Creates CbsClientConfiguration from system environment variables. + * + * @return an instance of CbsClientConfiguration + * @throws NullPointerException when at least one of required parameters is missing + */ + static CbsClientConfiguration fromEnvironment() { + return ImmutableCbsClientConfiguration.builder() + .consulHost(System.getenv(ENV_CONSUL_HOST)) + .hostname(System.getenv(ENV_CBS_HOSTNAME)) + .port(Integer.valueOf(System.getenv(ENV_CBS_PORT))) + .appName(System.getenv(ENV_APP_NAME)) + .build(); + } +} |