<build>
<plugins>
<plugin>
+ <groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
<executions>
<execution>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>${maven-javadoc-plugin.version}</version>
- <configuration/>
+ <configuration>
+ <failOnError>false</failOnError>
+ </configuration>
+ <executions>
+ <execution>
+ <id>attach-javadocs</id>
+ <goals>
+ <goal>jar</goal>
+ </goals>
+ </execution>
+ </executions>
</plugin>
<plugin>
<groupId>org.sonarsource.scanner.maven</groupId>
return sdcAddress;
}
- public List<String> getMsgBusAddress() {
- return msgBusAddress;
- }
-
- public void setMsgBusAddress(List<String> msgBusAddress) {
- this.msgBusAddress = msgBusAddress;
- }
-
@Override
public String getUser() {
return user;
<mockito-all.version>3.6.28</mockito-all.version>
<commons-io.version>2.8.0</commons-io.version>
<slf4j-api.version>1.7.30</slf4j-api.version>
- <jackson.version>2.5.2</jackson.version>
+ <jackson.version>2.8.6</jackson.version>
<kafka.version>3.3.1</kafka.version>
<gson.version>2.8.9</gson.version>
<lombok.version>1.18.24</lombok.version>
/**
* Downloads an artifact from SDC Catalog <br>
*
- * @param artifactInfo
+ * @param artifactInfo - the info about the Artifact to be downloaded
* @return IDistributionClientDownloadResult
*/
IDistributionClientDownloadResult download(IArtifactInfo artifactInfo);
/**
* Initialize the distribution client <br>
- * - get MessageBus server list from configuration <br>
+ * - validate the config <br>
+ * - set up the SDC connector <br>
* - validate artifact types against sdc server <br>
* - set the notification callback <br>
+ * - get and set up the Kafka endpoint and topics <br>
* - set up notification sender <br>
* <p>
* Note: all configuration fields are mandatory. <br>
* ONAP-Component MUST store password as SHA-2 (256) hashed with
* dynamically generated salt value <br>
*
- * @param conf
- * @param callback
+ * @param conf - contains configuration
+ * @param callback - the NotificationCallback logic
* @return IDistributionClientResult
*/
IDistributionClientResult init(IConfiguration conf, INotificationCallback callback);
/**
* Initialize the distribution client <br>
- * - get MessageBus server list from configuration <br>
+ * - validate the config <br>
+ * - set up the SDC connector <br>
* - validate artifact types against sdc server <br>
* - set the notification callback <br>
+ * - get and set up the Kafka endpoint and topics <br>
* - set up notification sender <br>
* <p>
* Note: all configuration fields are mandatory. <br>
* ONAP-Component MUST store password as SHA-2 (256) hashed with
* dynamically generated salt value <br>
*
- * @param conf
- * @param notificationCallback
- * @param statusCallback
+ * @param conf - contains configuration
+ * @param notificationCallback - the NotificationCallback logic
+ * @param statusCallback - the StatusCallback logic
* @return IDistributionClientResult
*/
IDistributionClientResult init(IConfiguration conf, INotificationCallback notificationCallback,
* Build and publish Distribution Download Status event to Distribution
* Status Topic
*
- * @param statusMessage
+ * @param statusMessage - the status message to be published
* @return IDistributionClientResult
*/
IDistributionClientResult sendDownloadStatus(IDistributionStatusMessage statusMessage);
* Build and publish Distribution Download Status event to Distribution
* Status Topic With Error Reason.
*
- * @param statusMessage
- * @param errorReason
+ * @param statusMessage - the status message to be published
+ * @param errorReason - the error details
* @return IDistributionClientResult
*/
IDistributionClientResult sendDownloadStatus(IDistributionStatusMessage statusMessage, String errorReason);
* Build and publish Distribution Deployment Status event to Distribution
* Status Topic
*
- * @param statusMessage
+ * @param statusMessage - the status message to be published
* @return IDistributionClientResult
*/
IDistributionClientResult sendDeploymentStatus(IDistributionStatusMessage statusMessage);
* Build and publish Distribution Deployment Status event to Distribution
* Status Topic With Error Reason.
*
- * @param statusMessage
- * @param errorReason
+ * @param statusMessage - the status message to be published
+ * @param errorReason - the error details
* @return IDistributionClientResult
*/
IDistributionClientResult sendDeploymentStatus(IDistributionStatusMessage statusMessage, String errorReason);
* Build and publish Distribution Component Status event to Distribution
* Status Topic
*
- * @param statusMessage
+ * @param statusMessage - the status message to be published
* @return IDistributionClientResult
*/
IDistributionClientResult sendComponentDoneStatus(IComponentDoneStatusMessage statusMessage);
* Build and publish Distribution Component Status event to Distribution
* Status Topic With Error Reason.
*
- * @param statusMessage
- * @param errorReason
+ * @param statusMessage - the status message to be published
+ * @param errorReason - the error details
* @return IDistributionClientResult
*/
IDistributionClientResult sendComponentDoneStatus(IComponentDoneStatusMessage statusMessage, String errorReason);
* Build and publish Distribution Final Status event to Distribution
* Status Topic
*
- * @param statusMessage
+ * @param statusMessage - the status message to be published
* @return IDistributionClientResult
*/
IDistributionClientResult sendFinalDistrStatus(IFinalDistrStatusMessage statusMessage);
* Build and publish Distribution Final Status event to Distribution
* Status Topic With Error Reason.
*
- * @param statusMessage
- * @param errorReason
+ * @param statusMessage - the status message to be published
+ * @param errorReason - the error details
* @return IDistributionClientResult
*/
IDistributionClientResult sendFinalDistrStatus(IFinalDistrStatusMessage statusMessage, String errorReason);
* @deprecated Method is deprecated due to VF Module changes. Only backward
* compatibility is supported.<br>
*
- * @param artifactPayload
+ * @param artifactPayload - the payload of artifact data
* @return IVfModuleMetadata list
*/
@Deprecated
String getSdcAddress();
/**
- * SDC Distribution Addresses from ONAP Component Values need to be set from
- * impl
- */
- List<String> getMsgBusAddress();
-
- /**
- * Kafka security.protocol
+ * Kafka security protocol to be used by the client to Auth towards the kafka cluster
+ *
+ * @return Kafka security.protocol. Default is SASL_PLAINTEXT
*/
default String getKafkaSecurityProtocolConfig() {
return System.getenv().getOrDefault("SECURITY_PROTOCOL", "SASL_PLAINTEXT");
}
/**
- * Kafka sasl.mechanism
+ * Kafka SASL mechanism to be used by the client to Auth towards the kafka cluster
+ *
+ * @return Kafka sasl.mechanism. Default is SCRAM-SHA-512
*/
default String getKafkaSaslMechanism() {
return System.getenv().getOrDefault("SASL_MECHANISM", "SCRAM-SHA-512");
}
/**
- * Kafka sasl.jaas.config
+ * Kafka JAAS config to be used by the client to Auth towards the kafka cluster.
+ * If overridden, must align with sasl.jaas.config convention set out by the sasl.mechanism being used
+ * otherwise, mandatory setting of the environment variable SASL_JAAS_CONFIG is required to provide default behaviour
+ * @return Kafka sasl.jaas.config
*/
default String getKafkaSaslJaasConfig() {
String saslJaasConfFromEnv = System.getenv("SASL_JAAS_CONFIG");
* default (HTTPS) behavior will be applied. If set to false, distribution
* client will use HTTP when connecting to SDC.
*
- * @return
+ * @return default is true
*/
default Boolean isUseHttpsWithSDC() {
return true;
List<String> getRelevantArtifactTypes();
/**
- * Returns the consumer group defined for this component, if no consumer
- * group is defined return null.
+ * Returns the kafka consumer group defined for this component.
*
* @return SdcKafkaConsumer group.
*/
* Returns the environment name (testing, production etc...). Can Be
* reconfigured in runtime.
*
- * @return
+ * @return Environment name
*/
String getEnvironmentName();
/**
- * Unique ID of component instance (e.x INSTAR name).
+ * Returns the kafka consumer id defined for this component.
*
- * @return
+ * @return SdcKafkaConsumer id.
*/
String getConsumerID();
* the SDC's public key (e.g /etc/keystore/sdc-client.jks) file will be
* deployed with sdc-distribution jar.
*
- * @return
+ * @return Client's Key store path
*/
String getKeyStorePath();
/**
- * @return Returns client's Key Store password
+ * Return the password for the Client's Key Store
+ *
+ * @return Client's Key Store password
*/
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.
*
- * @return
+ * @return true by default
*/
boolean activateServerTLSAuth();
* Setting the method to false will activate the legacy behavior, in which empty
* resources are not part of the notification.<br>
*
- * @return
+ * @return true or false
*/
boolean isFilterInEmptyResources();
/**
- * By default, (false value) Distribution Client will trigger the regular
+ * By default: false. 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>
* this component request to be consumer and producer of the
* SDC-DISTR-STATUS-TOPIC-[ENV] topic.<br>
*
- * @return
+ * @return false by default
*/
default boolean isConsumeProduceStatusTopic() {
return false;
* available proxies from JVM arguments. If set to false, distribution client
* will use proxy parameters configured through properties file.
*
- * @return
+ * @return false by default
*/
default Boolean isUseSystemProxy() {
return false;
* Client will register the proxy configuration with the HttpClient instance
* using HTTP and route requests through the proxy.
*
- * @return
+ * @return Hostname of the http proxy
*/
String getHttpProxyHost();
* register the proxy configuration with the HttpClient instance using HTTP and
* route requests through the proxy.
*
- * @return
+ * @return Port of the http proxy
*/
int getHttpProxyPort();
* Client will register the proxy configuration with the HttpClient instance
* using HTTPS and route requests through the proxy.
*
- * @return
+ * @return Hostname of the https proxy
*/
String getHttpsProxyHost();
* register the proxy configuration with the HttpClient instance using HTTPS and
* route requests through the proxy.
*
- * @return
+ * @return Port of the https proxy
*/
int getHttpsProxyPort();
}
import java.util.List;
import org.onap.sdc.api.consumer.IConfiguration;
-import org.onap.sdc.utils.DistributionClientConstants;
public class Configuration implements IConfiguration {
private String sdcAddress;
private String user;
private String password;
- private int pollingInterval = DistributionClientConstants.MIN_POLLING_INTERVAL_SEC;
- private int pollingTimeout = DistributionClientConstants.POLLING_TIMEOUT_SEC;
+ private int pollingInterval;
+ private int pollingTimeout;
private List<String> relevantArtifactTypes;
private String consumerGroup;
private String environmentName;
return sdcAddress;
}
- public String getStatusTopicName() {
- return sdcStatusTopicName;
- }
-
- public void setStatusTopicName(String sdcStatusTopicName) {
- this.sdcStatusTopicName = sdcStatusTopicName;
- }
-
- public String getNotificationTopicName() {
- return sdcNotificationTopicName;
- }
-
- public void setNotificationTopicName(String sdcNotificationTopicName) {
- this.sdcNotificationTopicName = sdcNotificationTopicName;
- }
-
- @Override
- public List<String> getMsgBusAddress() {
- return msgBusAddressList;
- }
-
- public void setMsgBusAddress(List<String> newMsgBusAddress) {
- msgBusAddressList = newMsgBusAddress;
- }
-
@Override
public String getKafkaSecurityProtocolConfig() {
return kafkaSecurityProtocolConfig;
return useSystemProxy;
}
+ @Override
+ public boolean activateServerTLSAuth() {
+ return this.activateServerTLSAuth;
+ }
+
+ @Override
+ public boolean isFilterInEmptyResources() {
+ return this.filterInEmptyResources;
+ }
+
+ public String getStatusTopicName() {
+ return sdcStatusTopicName;
+ }
+
+ public void setStatusTopicName(String sdcStatusTopicName) {
+ this.sdcStatusTopicName = sdcStatusTopicName;
+ }
+
+ public String getNotificationTopicName() {
+ return sdcNotificationTopicName;
+ }
+
+ public void setNotificationTopicName(String sdcNotificationTopicName) {
+ this.sdcNotificationTopicName = sdcNotificationTopicName;
+ }
+
+ public List<String> getMsgBusAddress() {
+ return msgBusAddressList;
+ }
+
+ public void setMsgBusAddress(List<String> newMsgBusAddress) {
+ msgBusAddressList = newMsgBusAddress;
+ }
+
public void setComsumerID(String comsumerID) {
this.comsumerID = comsumerID;
}
this.useSystemProxy = useSystemProxy;
}
- @Override
- public boolean activateServerTLSAuth() {
- return this.activateServerTLSAuth;
- }
-
- @Override
- public boolean isFilterInEmptyResources() {
- return this.filterInEmptyResources;
- }
-
public void setUseHttpsWithSDC(boolean useHttpsWithSDC) {
this.useHttpsWithSDC = useHttpsWithSDC;
}
return msgs;
}
+ /**
+ *
+ * @return The topic being polled by the consumer
+ */
public String getTopicName() {
return topicName;
}
private final List<String> msgBusAddresses;
private final String topicName;
+ /**
+ *
+ * @param configuration The config provided to the client
+ */
public SdcKafkaProducer(Configuration configuration) {
Properties props = new Properties();
props.put(CommonClientConfigs.BOOTSTRAP_SERVERS_CONFIG, configuration.getMsgBusAddress());
}
return data;
}
+
/**
- *
+ * Flush accumulated records in producer
*/
public void flush() {
try {
}
}
+ /**
+ * @return The list kafka endpoints
+ */
public List<String> getMsgBusAddresses() {
return msgBusAddresses;
}
+ /**
+ * @return The topic name being published to
+ */
public String getTopicName() {
return topicName;
}
return sdcAddress;
}
- @Override
- public List<String> getMsgBusAddress() {
- return msgBusAddress;
- }
-
@Override
public String getKafkaSecurityProtocolConfig() {
return kafkaSecurityProtocolConfig;
Code Review / sdc / sdc-distribution-client.git / commitdiff