From da9f29c9333d859bda350fed7a3949ed1e1bfcb6 Mon Sep 17 00:00:00 2001
From: vzikratyi <vzikratyi@thingsboard.io>
Date: Thu, 13 Aug 2020 11:48:14 +0300
Subject: [PATCH] Added 'comment' to ClientRegistrationTemplate

---
 application/src/main/data/upgrade/3.1.0/schema_update.sql     | 1 +
 .../common/data/oauth2/OAuth2ClientRegistrationTemplate.java  | 2 ++
 .../java/org/thingsboard/server/dao/model/ModelConstants.java | 1 +
 .../dao/model/sql/OAuth2ClientRegistrationTemplateEntity.java | 4 ++++
 dao/src/main/resources/sql/schema-entities-hsql.sql           | 1 +
 dao/src/main/resources/sql/schema-entities.sql                | 1 +
 .../dao/service/BaseOAuth2ConfigTemplateServiceTest.java      | 1 +
 7 files changed, 11 insertions(+)

diff --git a/application/src/main/data/upgrade/3.1.0/schema_update.sql b/application/src/main/data/upgrade/3.1.0/schema_update.sql
index a0eacbacbd..445df2b97e 100644
--- a/application/src/main/data/upgrade/3.1.0/schema_update.sql
+++ b/application/src/main/data/upgrade/3.1.0/schema_update.sql
@@ -72,5 +72,6 @@ CREATE TABLE IF NOT EXISTS oauth2_client_registration_template (
     basic_customer_name_pattern varchar(255),
     basic_default_dashboard_name varchar(255),
     basic_always_full_screen boolean,
+    comment varchar,
     CONSTRAINT oauth2_template_provider_id_unq_key UNIQUE (provider_id)
 );
\ No newline at end of file
diff --git a/common/data/src/main/java/org/thingsboard/server/common/data/oauth2/OAuth2ClientRegistrationTemplate.java b/common/data/src/main/java/org/thingsboard/server/common/data/oauth2/OAuth2ClientRegistrationTemplate.java
index 4e0d0c0e65..f3cb077e78 100644
--- a/common/data/src/main/java/org/thingsboard/server/common/data/oauth2/OAuth2ClientRegistrationTemplate.java
+++ b/common/data/src/main/java/org/thingsboard/server/common/data/oauth2/OAuth2ClientRegistrationTemplate.java
@@ -43,6 +43,7 @@ public class OAuth2ClientRegistrationTemplate extends BaseData<OAuth2ClientRegis
     private String userNameAttributeName;
     private String jwkSetUri;
     private String clientAuthenticationMethod;
+    private String comment;
 
     public OAuth2ClientRegistrationTemplate(OAuth2ClientRegistrationTemplate clientRegistrationTemplate) {
         super(clientRegistrationTemplate);
@@ -56,6 +57,7 @@ public class OAuth2ClientRegistrationTemplate extends BaseData<OAuth2ClientRegis
         this.userNameAttributeName = clientRegistrationTemplate.userNameAttributeName;
         this.jwkSetUri = clientRegistrationTemplate.jwkSetUri;
         this.clientAuthenticationMethod = clientRegistrationTemplate.clientAuthenticationMethod;
+        this.comment = clientRegistrationTemplate.comment;
     }
 
     @Override
diff --git a/dao/src/main/java/org/thingsboard/server/dao/model/ModelConstants.java b/dao/src/main/java/org/thingsboard/server/dao/model/ModelConstants.java
index 4015473d9f..8042d13927 100644
--- a/dao/src/main/java/org/thingsboard/server/dao/model/ModelConstants.java
+++ b/dao/src/main/java/org/thingsboard/server/dao/model/ModelConstants.java
@@ -388,6 +388,7 @@ public class ModelConstants {
     public static final String OAUTH2_MAPPER_URL_PROPERTY = "custom_url";
     public static final String OAUTH2_MAPPER_USERNAME_PROPERTY = "custom_username";
     public static final String OAUTH2_MAPPER_PASSWORD_PROPERTY = "custom_password";
+    public static final String OAUTH2_TEMPLATE_COMMENT_PROPERTY = "comment";
 
     /**
      * Cassandra attributes and timeseries constants.
diff --git a/dao/src/main/java/org/thingsboard/server/dao/model/sql/OAuth2ClientRegistrationTemplateEntity.java b/dao/src/main/java/org/thingsboard/server/dao/model/sql/OAuth2ClientRegistrationTemplateEntity.java
index 004e00fedb..1c32efd625 100644
--- a/dao/src/main/java/org/thingsboard/server/dao/model/sql/OAuth2ClientRegistrationTemplateEntity.java
+++ b/dao/src/main/java/org/thingsboard/server/dao/model/sql/OAuth2ClientRegistrationTemplateEntity.java
@@ -74,6 +74,8 @@ public class OAuth2ClientRegistrationTemplateEntity extends BaseSqlEntity<OAuth2
     private String defaultDashboardName;
     @Column(name = ModelConstants.OAUTH2_ALWAYS_FULL_SCREEN_PROPERTY)
     private Boolean alwaysFullScreen;
+    @Column(name = ModelConstants.OAUTH2_TEMPLATE_COMMENT_PROPERTY)
+    private String comment;
 
     public OAuth2ClientRegistrationTemplateEntity() {
     }
@@ -94,6 +96,7 @@ public class OAuth2ClientRegistrationTemplateEntity extends BaseSqlEntity<OAuth2
         this.userNameAttributeName = clientRegistrationTemplate.getUserNameAttributeName();
         this.jwkSetUri = clientRegistrationTemplate.getJwkSetUri();
         this.clientAuthenticationMethod = clientRegistrationTemplate.getClientAuthenticationMethod();
+        this.comment = clientRegistrationTemplate.getComment();
         OAuth2BasicMapperConfig basicConfig = clientRegistrationTemplate.getBasic();
         if (basicConfig != null) {
             this.emailAttributeKey = basicConfig.getEmailAttributeKey();
@@ -134,6 +137,7 @@ public class OAuth2ClientRegistrationTemplateEntity extends BaseSqlEntity<OAuth2
         clientRegistrationTemplate.setUserNameAttributeName(userNameAttributeName);
         clientRegistrationTemplate.setJwkSetUri(jwkSetUri);
         clientRegistrationTemplate.setClientAuthenticationMethod(clientAuthenticationMethod);
+        clientRegistrationTemplate.setComment(comment);
         return clientRegistrationTemplate;
     }
 }
diff --git a/dao/src/main/resources/sql/schema-entities-hsql.sql b/dao/src/main/resources/sql/schema-entities-hsql.sql
index cb05bf800c..ea3a73313d 100644
--- a/dao/src/main/resources/sql/schema-entities-hsql.sql
+++ b/dao/src/main/resources/sql/schema-entities-hsql.sql
@@ -345,5 +345,6 @@ CREATE TABLE IF NOT EXISTS oauth2_client_registration_template (
     basic_customer_name_pattern varchar(255),
     basic_default_dashboard_name varchar(255),
     basic_always_full_screen boolean,
+    comment varchar,
     CONSTRAINT oauth2_template_provider_id_unq_key UNIQUE (provider_id)
 );
diff --git a/dao/src/main/resources/sql/schema-entities.sql b/dao/src/main/resources/sql/schema-entities.sql
index 65d1138b99..c9da6a9e35 100644
--- a/dao/src/main/resources/sql/schema-entities.sql
+++ b/dao/src/main/resources/sql/schema-entities.sql
@@ -360,6 +360,7 @@ CREATE TABLE IF NOT EXISTS oauth2_client_registration_template (
     basic_customer_name_pattern varchar(255),
     basic_default_dashboard_name varchar(255),
     basic_always_full_screen boolean,
+    comment varchar,
     CONSTRAINT oauth2_template_provider_id_unq_key UNIQUE (provider_id)
 );
 
diff --git a/dao/src/test/java/org/thingsboard/server/dao/service/BaseOAuth2ConfigTemplateServiceTest.java b/dao/src/test/java/org/thingsboard/server/dao/service/BaseOAuth2ConfigTemplateServiceTest.java
index 824e992c21..c5bc4f0f30 100644
--- a/dao/src/test/java/org/thingsboard/server/dao/service/BaseOAuth2ConfigTemplateServiceTest.java
+++ b/dao/src/test/java/org/thingsboard/server/dao/service/BaseOAuth2ConfigTemplateServiceTest.java
@@ -124,6 +124,7 @@ public class BaseOAuth2ConfigTemplateServiceTest extends AbstractServiceTest {
         clientRegistrationTemplate.setUserNameAttributeName("userNameAttributeName");
         clientRegistrationTemplate.setJwkSetUri("jwkSetUri");
         clientRegistrationTemplate.setClientAuthenticationMethod("clientAuthenticationMethod");
+        clientRegistrationTemplate.setComment("comment");
         return clientRegistrationTemplate;
     }
 }