portal-BE/src/main/java/org/onap/portal/domain/db/fn/FnApp.java

   1 /*
   2  * ============LICENSE_START==========================================
   3  * ONAP Portal
   4  * ===================================================================
   5  * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
   6  * ===================================================================
   7  * Modifications Copyright (c) 2019 Samsung
   8  * ===================================================================
   9  *
  10  * Unless otherwise specified, all software contained herein is licensed
  11  * under the Apache License, Version 2.0 (the "License");
  12  * you may not use this software except in compliance with the License.
  13  * You may obtain a copy of the License at
  14  *
  15  *             http://www.apache.org/licenses/LICENSE-2.0
  16  *
  17  * Unless required by applicable law or agreed to in writing, software
  18  * distributed under the License is distributed on an "AS IS" BASIS,
  19  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  20  * See the License for the specific language governing permissions and
  21  * limitations under the License.
  22  *
  23  * Unless otherwise specified, all documentation contained herein is licensed
  24  * under the Creative Commons License, Attribution 4.0 Intl. (the "License");
  25  * you may not use this documentation except in compliance with the License.
  26  * You may obtain a copy of the License at
  27  *
  28  *             https://creativecommons.org/licenses/by/4.0/
  29  *
  30  * Unless required by applicable law or agreed to in writing, documentation
  31  * distributed under the License is distributed on an "AS IS" BASIS,
  32  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  33  * See the License for the specific language governing permissions and
  34  * limitations under the License.
  35  *
  36  * ============LICENSE_END============================================
  37  *
  38  *
  39  */
  40
  41 package org.onap.portal.domain.db.fn;
  42
  43 import java.io.Serializable;
  44 import java.util.Set;
  45 import javax.persistence.CascadeType;
  46 import javax.persistence.Column;
  47 import javax.persistence.Embeddable;
  48 import javax.persistence.Entity;
  49 import javax.persistence.FetchType;
  50 import javax.persistence.GeneratedValue;
  51 import javax.persistence.GenerationType;
  52 import javax.persistence.Id;
  53 import javax.persistence.NamedQueries;
  54 import javax.persistence.NamedQuery;
  55 import javax.persistence.OneToMany;
  56 import javax.persistence.Table;
  57 import javax.validation.constraints.Digits;
  58 import javax.validation.constraints.NotNull;
  59 import javax.validation.constraints.Pattern;
  60 import javax.validation.constraints.Size;
  61 import lombok.AllArgsConstructor;
  62 import lombok.EqualsAndHashCode;
  63 import lombok.Getter;
  64 import lombok.NoArgsConstructor;
  65 import lombok.Setter;
  66 import org.hibernate.validator.constraints.SafeHtml;
  67 import org.hibernate.validator.constraints.URL;
  68 import org.onap.portal.domain.db.ep.EpAppFunction;
  69 import org.onap.portal.domain.db.ep.EpAppRoleFunction;
  70 import org.onap.portal.domain.db.ep.EpMicroservice;
  71 import org.onap.portal.domain.db.ep.EpUserRolesRequest;
  72 import org.onap.portal.domain.db.ep.EpWebAnalyticsSource;
  73 import org.onap.portal.domain.db.ep.EpWidgetCatalogRole;
  74 import org.onap.portal.domain.dto.DomainVo;
  75
  76 /*
  77 CREATE TABLE `fn_app` (
  78         `app_id` int(11) NOT NULL AUTO_INCREMENT,
  79         `app_name` varchar(100) NOT NULL DEFAULT '?',
  80         `app_image_url` varchar(256) DEFAULT NULL,
  81         `app_description` varchar(512) DEFAULT NULL,
  82         `app_notes` varchar(4096) DEFAULT NULL,
  83         `app_url` varchar(256) DEFAULT NULL,
  84         `app_alternate_url` varchar(256) DEFAULT NULL,
  85         `app_rest_endpoint` varchar(2000) DEFAULT NULL,
  86         `ml_app_name` varchar(50) NOT NULL DEFAULT '?',
  87         `ml_app_admin_id` varchar(7) NOT NULL DEFAULT '?',
  88         `mots_id` int(11) DEFAULT NULL,
  89         `app_password` varchar(256) NOT NULL DEFAULT '?',
  90         `open` char(1) DEFAULT 'N',
  91         `enabled` char(1) DEFAULT 'Y',
  92         `thumbnail` mediumblob DEFAULT NULL,
  93         `app_username` varchar(50) DEFAULT NULL,
  94         `ueb_key` varchar(256) DEFAULT NULL,
  95         `ueb_secret` varchar(256) DEFAULT NULL,
  96         `ueb_topic_name` varchar(256) DEFAULT NULL,
  97         `app_type` int(11) NOT NULL DEFAULT 1,
  98         `auth_central` char(1) NOT NULL DEFAULT 'N',
  99         `auth_namespace` varchar(100) DEFAULT NULL,
 100         PRIMARY KEY (`app_id`)
 101         )
 102 */
 103
 104 @NamedQueries({
 105     @NamedQuery(
 106         name = "FnApp.retrieveWhereAuthCentralIsYAndOpenIsNAndAuthNamespaceIsNotNull",
 107         query = "from FnApp where authCentral = 'Y' and open = 'N' and authNamespace is not null"),
 108     @NamedQuery(
 109         name = "FnApp.getByUebKey",
 110         query = "from FnApp where uebKey = :uebKey"
 111     )
 112 })
 113
 114 @Table(name = "fn_app")
 115 @NoArgsConstructor
 116 @AllArgsConstructor
 117 @EqualsAndHashCode(callSuper = true)
 118 @Embeddable
 119 @Getter
 120 @Setter
 121 @Entity
 122 public class FnApp extends DomainVo implements Serializable {
 123
 124   @Id
 125   @GeneratedValue(strategy = GenerationType.AUTO)
 126   @Column(name = "app_Id", length = 11, nullable = false)
 127   @Digits(integer = 11, fraction = 0)
 128   private Long appId;
 129   @Column(name = "app_name", length = 100, nullable = false, columnDefinition = "varchar(100) not null default '?'")
 130   @Size(max = 100)
 131   @SafeHtml
 132   @NotNull
 133   private String appName;
 134   @Column(name = "app_image_url", length = 256)
 135   @Size(max = 256)
 136   @SafeHtml
 137   private String appImageUrl;
 138   @Column(name = "app_description", length = 512)
 139   @Size(max = 256)
 140   @SafeHtml
 141   private String appDescription;
 142   @Column(name = "app_notes", length = 4096)
 143   @Size(max = 4096)
 144   @SafeHtml
 145   private String appNotes;
 146   @Column(name = "app_url", length = 256)
 147   @Size(max = 256)
 148   @SafeHtml
 149   //TODO URL
 150   @URL
 151   private String appUrl;
 152   @Column(name = "app_alternate_url", length = 256)
 153   @Size(max = 256)
 154   @SafeHtml
 155   private String appAlternateUrl;
 156   @Column(name = "app_rest_endpoint", length = 2000)
 157   @Size(max = 2000)
 158   @SafeHtml
 159   private String appRestEndpoint;
 160   @Column(name = "ml_app_name", length = 50, nullable = false, columnDefinition = "varchar(50) not null default '?'")
 161   @Size(max = 50)
 162   @SafeHtml
 163   @NotNull
 164   private String ml_app_name;
 165   @Column(name = "ml_app_admin_id", length = 7, nullable = false, columnDefinition = "varchar(7) not null default '?'")
 166   @Size(max = 7)
 167   @SafeHtml
 168   @NotNull
 169   private String mlAppAdminId;
 170   @Column(name = "mots_id", length = 11)
 171   @Digits(integer = 11, fraction = 0)
 172   private Long motsId;
 173   @Column(name = "app_password", length = 256, nullable = false, columnDefinition = "varchar(256) not null default '?'")
 174   @Size(max = 256)
 175   @SafeHtml
 176   @NotNull
 177   private String appPassword;
 178   @Column(name = "_open", length = 1, columnDefinition = "char(1) default 'N'")
 179   private Boolean open;
 180   @Column(name = "_enabled", length = 1, columnDefinition = "char(1) default 'N'")
 181   private Boolean enabled;
 182   @Column(name = "active_yn", length = 1, columnDefinition = "char(1) default 'Y'")
 183   @Pattern(regexp = "[YNyn]")
 184   @Size(max = 1)
 185   @NotNull
 186   @SafeHtml
 187   private String activeYn;
 188   @Column(name = "_thumbnail", columnDefinition = "mediumblob null default null")
 189   private byte[] thumbnail;
 190   @Column(name = "app_username", length = 50)
 191   @Size(max = 50)
 192   @SafeHtml
 193   private String appUsername;
 194   @Column(name = "ueb_key", length = 256)
 195   @Size(max = 256)
 196   @SafeHtml
 197   private String uebKey;
 198   @Column(name = "ueb_secret", length = 256)
 199   @Size(max = 256)
 200   @SafeHtml
 201   private String uebSecret;
 202   @Column(name = "ueb_topic_name", length = 256)
 203   @Size(max = 256)
 204   @SafeHtml
 205   private String uebTopicName;
 206   @Column(name = "app_type", length = 11, columnDefinition = "int(11) not null default 1")
 207   @Digits(integer = 11, fraction = 0)
 208   private Long appType;
 209   @Column(name = "auth_central", length = 1, columnDefinition = "char(1) not null default 'N'", nullable = false)
 210   private Boolean authCentral;
 211   @Column(name = "auth_namespace", length = 100)
 212   @Size(max = 100)
 213   @SafeHtml
 214   private String authNamespace;
 215   @OneToMany(
 216       targetEntity = FnMenuFunctionalRoles.class,
 217       mappedBy = "appId",
 218       cascade = CascadeType.ALL,
 219       fetch = FetchType.LAZY
 220   )
 221   private Set<FnMenuFunctionalRoles> fnMenuFunctionalRoles;
 222   @OneToMany(
 223       targetEntity = EpUserRolesRequest.class,
 224       mappedBy = "appId",
 225       cascade = CascadeType.ALL,
 226       fetch = FetchType.LAZY
 227   )
 228   private Set<EpUserRolesRequest> epUserRolesRequests;
 229   @OneToMany(
 230       targetEntity = EpAppFunction.class,
 231       mappedBy = "appId",
 232       cascade = CascadeType.ALL,
 233       fetch = FetchType.LAZY
 234   )
 235   private Set<EpAppFunction> epAppFunctions;
 236   @OneToMany(
 237       targetEntity = EpAppRoleFunction.class,
 238       mappedBy = "appId",
 239       cascade = CascadeType.ALL,
 240       fetch = FetchType.LAZY
 241   )
 242   private Set<EpAppRoleFunction> epAppRoleFunctions;
 243   @OneToMany(
 244       targetEntity = FnUserRole.class,
 245       mappedBy = "appId",
 246       cascade = CascadeType.ALL,
 247       fetch = FetchType.LAZY
 248   )
 249   private Set<FnUserRole> fnUserRoles;
 250   @OneToMany(
 251       targetEntity = EpWebAnalyticsSource.class,
 252       mappedBy = "appId",
 253       cascade = CascadeType.ALL,
 254       fetch = FetchType.LAZY
 255   )
 256   private Set<EpWebAnalyticsSource> epWebAnalyticsSources;
 257   @OneToMany(
 258       targetEntity = EpWidgetCatalogRole.class,
 259       mappedBy = "appId",
 260       cascade = CascadeType.ALL,
 261       fetch = FetchType.LAZY
 262   )
 263   private Set<EpWidgetCatalogRole> epWidgetCatalogRoles;
 264   @OneToMany(
 265       targetEntity = EpMicroservice.class,
 266       mappedBy = "appId",
 267       cascade = CascadeType.ALL,
 268       fetch = FetchType.LAZY
 269   )
 270   private Set<EpMicroservice> epMicroservices;
 271   @OneToMany(
 272       targetEntity = FnPersUserAppSel.class,
 273       mappedBy = "appId",
 274       cascade = CascadeType.ALL,
 275       fetch = FetchType.LAZY
 276   )
 277   private Set<FnPersUserAppSel> fnPersUserAppSels;
 278
 279   public Boolean isRestrictedApp() {
 280     return (this.appType == 2);
 281   }
 282 }