View Javadoc
1   /*
2    * Copyright (C) 2023 B3Partners B.V.
3    *
4    * SPDX-License-Identifier: MIT
5    */
6   package org.tailormap.api.persistence;
7   
8   import com.fasterxml.jackson.annotation.JsonCreator;
9   import jakarta.persistence.Basic;
10  import jakarta.persistence.CascadeType;
11  import jakarta.persistence.Column;
12  import jakarta.persistence.Entity;
13  import jakarta.persistence.EntityListeners;
14  import jakarta.persistence.EnumType;
15  import jakarta.persistence.Enumerated;
16  import jakarta.persistence.GeneratedValue;
17  import jakarta.persistence.GenerationType;
18  import jakarta.persistence.Id;
19  import jakarta.persistence.JoinColumn;
20  import jakarta.persistence.JoinTable;
21  import jakarta.persistence.ManyToOne;
22  import jakarta.persistence.OneToMany;
23  import jakarta.persistence.OrderBy;
24  import jakarta.persistence.Table;
25  import jakarta.persistence.Version;
26  import jakarta.validation.constraints.NotNull;
27  import java.util.ArrayList;
28  import java.util.List;
29  import org.hibernate.annotations.JdbcTypeCode;
30  import org.hibernate.envers.Audited;
31  import org.hibernate.type.SqlTypes;
32  import org.springframework.data.jpa.domain.support.AuditingEntityListener;
33  import org.tailormap.api.persistence.json.JDBCConnectionProperties;
34  import org.tailormap.api.persistence.json.ServiceAuthentication;
35  import org.tailormap.api.persistence.json.TMServiceCaps;
36  import org.tailormap.api.persistence.listener.EntityEventPublisher;
37  import tools.jackson.core.JacksonException;
38  import tools.jackson.databind.json.JsonMapper;
39  
40  @Audited
41  @Entity
42  @Table(name = "feature_source")
43  @EntityListeners({EntityEventPublisher.class, AuditingEntityListener.class})
44  public class TMFeatureSource extends AuditMetadata {
45  
46    public enum Protocol {
47      WFS("wfs"),
48  
49      JDBC("jdbc");
50  
51      private final String value;
52  
53      Protocol(String value) {
54        this.value = value;
55      }
56  
57      public String getValue() {
58        return value;
59      }
60  
61      @Override
62      public String toString() {
63        return String.valueOf(value);
64      }
65  
66      @JsonCreator
67      public static TMFeatureSource.Protocol fromValue(String value) {
68        for (TMFeatureSource.Protocol p : TMFeatureSource.Protocol.values()) {
69          if (p.value.equalsIgnoreCase(value)) {
70            return p;
71          }
72        }
73        throw new IllegalArgumentException("Unexpected value '" + value + "'");
74      }
75    }
76  
77    @Id
78    @GeneratedValue(strategy = GenerationType.IDENTITY)
79    private Long id;
80  
81    @Version
82    private Long version;
83  
84    @Column(columnDefinition = "text")
85    private String notes;
86  
87    @NotNull @Enumerated(EnumType.STRING)
88    private TMFeatureSource.Protocol protocol;
89  
90    @Basic
91    private String title;
92  
93    @Column(length = 2048)
94    private String url;
95  
96    @JdbcTypeCode(SqlTypes.JSON)
97    @Column(columnDefinition = "jsonb")
98    private JDBCConnectionProperties jdbcConnection;
99  
100   @JdbcTypeCode(SqlTypes.JSON)
101   @Column(columnDefinition = "jsonb")
102   private ServiceAuthentication authentication;
103 
104   @ManyToOne
105   @JoinColumn(name = "linked_service")
106   private GeoService linkedService;
107 
108   @JdbcTypeCode(SqlTypes.JSON)
109   @Column(columnDefinition = "jsonb")
110   private TMServiceCaps serviceCapabilities;
111 
112   @OneToMany(cascade = CascadeType.ALL, orphanRemoval = true)
113   @JoinTable(
114       name = "feature_source_feature_types",
115       inverseJoinColumns = @JoinColumn(name = "feature_type"),
116       joinColumns = @JoinColumn(name = "feature_source", referencedColumnName = "id"))
117   @OrderBy("name asc")
118   private List<TMFeatureType> featureTypes = new ArrayList<>();
119 
120   @Override
121   public String toString() {
122     try {
123       return "TMFeatureSource{"
124           + "id="
125           + id
126           + ", protocol="
127           + protocol
128           + ", title='"
129           + title
130           + '\''
131           + ", url='"
132           + url
133           + '\''
134           + ", jdbcConnection="
135           + new JsonMapper().writeValueAsString(jdbcConnection)
136           + '}';
137     } catch (JacksonException e) {
138       throw new RuntimeException(e);
139     }
140   }
141 
142   // <editor-fold desc="getters and setters">
143   public Long getId() {
144     return id;
145   }
146 
147   public TMFeatureSource setId(Long id) {
148     this.id = id;
149     return this;
150   }
151 
152   public Long getVersion() {
153     return version;
154   }
155 
156   public TMFeatureSource setVersion(Long version) {
157     this.version = version;
158     return this;
159   }
160 
161   public String getNotes() {
162     return notes;
163   }
164 
165   public TMFeatureSource setNotes(String notes) {
166     this.notes = notes;
167     return this;
168   }
169 
170   public Protocol getProtocol() {
171     return protocol;
172   }
173 
174   public TMFeatureSource setProtocol(Protocol protocol) {
175     this.protocol = protocol;
176     return this;
177   }
178 
179   public String getTitle() {
180     return title;
181   }
182 
183   public TMFeatureSource setTitle(String title) {
184     this.title = title;
185     return this;
186   }
187 
188   public String getUrl() {
189     return url;
190   }
191 
192   public TMFeatureSource setUrl(String url) {
193     this.url = url;
194     return this;
195   }
196 
197   public JDBCConnectionProperties getJdbcConnection() {
198     return jdbcConnection;
199   }
200 
201   public TMFeatureSource setJdbcConnection(JDBCConnectionProperties jdbcConnection) {
202     this.jdbcConnection = jdbcConnection;
203     return this;
204   }
205 
206   public ServiceAuthentication getAuthentication() {
207     return authentication;
208   }
209 
210   public TMFeatureSource setAuthentication(ServiceAuthentication authentication) {
211     this.authentication = authentication;
212     return this;
213   }
214 
215   public GeoService getLinkedService() {
216     return linkedService;
217   }
218 
219   public TMFeatureSource setLinkedService(GeoService linkedService) {
220     this.linkedService = linkedService;
221     return this;
222   }
223 
224   public TMServiceCaps getServiceCapabilities() {
225     return serviceCapabilities;
226   }
227 
228   public TMFeatureSource setServiceCapabilities(TMServiceCaps serviceCapabilities) {
229     this.serviceCapabilities = serviceCapabilities;
230     return this;
231   }
232 
233   // Added this extra getter to work around Spring Data Rest
234   // By adding a repository for feature types SDR does not add feature types when fetching a feature
235   // source, while the front-end currently depends on having all feature types available.
236   // In the future we could refactor this to give only a list of names and fetch the type itself
237   // when needed.
238   public List<TMFeatureType> getAllFeatureTypes() {
239     return featureTypes;
240   }
241 
242   public List<TMFeatureType> getFeatureTypes() {
243     return featureTypes;
244   }
245 
246   public TMFeatureSource setFeatureTypes(List<TMFeatureType> featureTypes) {
247     this.featureTypes = featureTypes;
248     return this;
249   }
250 
251   // </editor-fold>
252 
253   public TMFeatureType findFeatureTypeByName(String featureTypeName) {
254     return getFeatureTypes().stream()
255         .filter(ft -> featureTypeName.equals(ft.getName()))
256         .findFirst()
257         .orElse(null);
258   }
259 }