SHIBUI-2270

expanding backend API and services supporting the API


Former-commit-id: 52a4d6b

backend/src/main/groovy/edu/internet2/tier/shibboleth/admin/ui/service/ShibPropertiesBootstrap.groovy

@@ -1,7 +1,7 @@
 package edu.internet2.tier.shibboleth.admin.ui.service
 
 import com.opencsv.CSVReader
-import edu.internet2.tier.shibboleth.admin.ui.domain.ShibConfigurationProperty
+import edu.internet2.tier.shibboleth.admin.ui.domain.shib.properties.ShibConfigurationProperty
 import groovy.util.logging.Slf4j
 import org.springframework.beans.factory.annotation.Autowired
 import org.springframework.boot.context.event.ApplicationStartedEvent
@@ -62,7 +62,7 @@ class ShibPropertiesBootstrap {
         // Save anything that's left
         if (propertiesMap.size() > 0) {
             log.info("Saving/loading [" + propertiesMap.size() + "] properties to the database")
-            service.addAll(propertiesMap.values())
+            service.addAllConfigurationProperties(propertiesMap.values())
         }
 
         log.info("COMPLETED: ensuring base Shibboleth properties configuration has loaded")

backend/src/main/java/edu/internet2/tier/shibboleth/admin/ui/configuration/CustomPropertiesConfiguration.java

@@ -2,7 +2,7 @@
 
 import edu.internet2.tier.shibboleth.admin.ui.domain.IRelyingPartyOverrideProperty;
 import edu.internet2.tier.shibboleth.admin.ui.domain.RelyingPartyOverrideProperty;
-import edu.internet2.tier.shibboleth.admin.ui.domain.ShibConfigurationProperty;
+import edu.internet2.tier.shibboleth.admin.ui.domain.shib.properties.ShibConfigurationProperty;
 import edu.internet2.tier.shibboleth.admin.ui.service.CustomEntityAttributesDefinitionService;
 import edu.internet2.tier.shibboleth.admin.ui.service.ShibConfigurationService;
 import edu.internet2.tier.shibboleth.admin.ui.service.events.CustomEntityAttributeDefinitionChangeEvent;

backend/src/main/java/edu/internet2/tier/shibboleth/admin/ui/controller/ShibPropertiesController.java

@@ -1,14 +1,28 @@
 package edu.internet2.tier.shibboleth.admin.ui.controller;
 
+import edu.internet2.tier.shibboleth.admin.ui.domain.CustomEntityAttributeDefinition;
+import edu.internet2.tier.shibboleth.admin.ui.domain.shib.properties.ShibPropertySet;
+import edu.internet2.tier.shibboleth.admin.ui.exception.EntityNotFoundException;
+import edu.internet2.tier.shibboleth.admin.ui.exception.ObjectIdExistsException;
 import edu.internet2.tier.shibboleth.admin.ui.service.ShibConfigurationService;
 import io.swagger.v3.oas.annotations.tags.Tag;
 import io.swagger.v3.oas.annotations.tags.Tags;
 import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.http.HttpHeaders;
+import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
+import org.springframework.security.access.annotation.Secured;
 import org.springframework.transaction.annotation.Transactional;
+import org.springframework.web.bind.annotation.DeleteMapping;
 import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestBody;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
+import org.springframework.web.servlet.support.ServletUriComponentsBuilder;
+
+import java.util.List;
 
 @RestController
 @RequestMapping(value = "/api/shib")
@@ -19,7 +33,47 @@ public class ShibPropertiesController {
 
     @GetMapping("/properties")
     @Transactional(readOnly = true)
-    public ResponseEntity<?> getAll() {
-        return ResponseEntity.ok(service.getAll());
+    public ResponseEntity<?> getAllConfigurationProperties() {
+        return ResponseEntity.ok(service.getAllConfigurationProperties());
+    }
+
+    /**
+     * @return a List of the set names and their ids
+     */
+    @GetMapping("/property/set")
+    @Transactional(readOnly = true)
+    public ResponseEntity<?> getAllPropertySets() {
+        return ResponseEntity.ok(service.getAllPropertySets());
+    }
+
+    @GetMapping("/property/set/{resourceId}")
+    @Transactional(readOnly = true)
+    public ResponseEntity<?> getPropertySet(@PathVariable Integer resourceId) throws EntityNotFoundException {
+        return ResponseEntity.ok(service.getSet(resourceId));
+    }
+
+    @DeleteMapping("/property/set/{resourceId}")
+    @Secured("ROLE_ADMIN")
+    @Transactional
+    public ResponseEntity<?> deletePropertySet(@PathVariable Integer resourceId) throws EntityNotFoundException {
+        service.delete(resourceId);
+        return ResponseEntity.noContent().build();
+    }
+
+    @PostMapping("/property/set")
+    @Secured("ROLE_ADMIN")
+    @Transactional
+    public ResponseEntity<?> createPropertySet(@RequestBody ShibPropertySet newSet) throws ObjectIdExistsException {
+        // If already defined, we won't/can't create a new one, nor will this call update on the definition
+        try {
+            ShibPropertySet set = service.getSet(newSet.getResourceId());
+            throw new ObjectIdExistsException(Integer.toString(newSet.getResourceId()));
+        }
+        catch (EntityNotFoundException e) {
+            // we hope not to find this - do nothing
+        }
+
+        ShibPropertySet result = service.save(newSet);
+        return ResponseEntity.status(HttpStatus.CREATED).body(result);
     }
 }

backend/src/main/java/edu/internet2/tier/shibboleth/admin/ui/controller/ShibPropertiesControllerExceptionHandler.java

@@ -0,0 +1,44 @@
+package edu.internet2.tier.shibboleth.admin.ui.controller;
+
+import edu.internet2.tier.shibboleth.admin.ui.exception.EntityNotFoundException;
+import edu.internet2.tier.shibboleth.admin.ui.exception.ObjectIdExistsException;
+import org.springframework.http.HttpHeaders;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.ControllerAdvice;
+import org.springframework.web.bind.annotation.ExceptionHandler;
+import org.springframework.web.context.request.WebRequest;
+import org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler;
+
+@ControllerAdvice(assignableTypes = {ShibPropertiesController.class})
+public class ShibPropertiesControllerExceptionHandler extends ResponseEntityExceptionHandler {
+
+//    @ExceptionHandler({ ConcurrentModificationException.class })
+//    public ResponseEntity<?> handleConcurrentModificationException(ConcurrentModificationException e, WebRequest request) {
+//        return ResponseEntity.status(HttpStatus.CONFLICT).body(new ErrorResponse(HttpStatus.CONFLICT, e.getMessage()));
+//    }
+
+    @ExceptionHandler({ EntityNotFoundException.class })
+    public ResponseEntity<?> handleEntityNotFoundException(EntityNotFoundException e, WebRequest request) {
+        return ResponseEntity.status(HttpStatus.NOT_FOUND).body(new ErrorResponse(HttpStatus.NOT_FOUND, e.getMessage()));
+    }
+
+//    @ExceptionHandler({ ForbiddenException.class })
+//    public ResponseEntity<?> handleForbiddenAccess(ForbiddenException e, WebRequest request) {
+//        return ResponseEntity.status(HttpStatus.FORBIDDEN).body(new ErrorResponse(HttpStatus.FORBIDDEN, e.getMessage()));
+//    }
+
+//    @ExceptionHandler({ InvalidPatternMatchException.class })
+//    public ResponseEntity<?> handleInvalidUrlMatchException(InvalidPatternMatchException e, WebRequest request) {
+//        return ResponseEntity.status(HttpStatus.BAD_REQUEST).body(new ErrorResponse(HttpStatus.BAD_REQUEST, e.getMessage()));
+//    }
+
+    @ExceptionHandler({ ObjectIdExistsException.class })
+    public ResponseEntity<?> handleObjectIdExistsException(ObjectIdExistsException e, WebRequest request) {
+        HttpHeaders headers = new HttpHeaders();
+        headers.setLocation(EntityDescriptorController.getResourceUriFor(e.getMessage()));
+        return ResponseEntity.status(HttpStatus.CONFLICT).headers(headers).body(new ErrorResponse(
+                        String.valueOf(HttpStatus.CONFLICT.value()),
+                        String.format("The property set with id [%s] already exists.", e.getMessage())));
+    }
+}

backend/src/main/java/edu/internet2/tier/shibboleth/admin/ui/domain/ShibConfigurationProperty.java → backend/src/main/java/edu/internet2/tier/shibboleth/admin/ui/domain/shib/properties/ShibConfigurationProperty.java

@@ -1,4 +1,4 @@
-package edu.internet2.tier.shibboleth.admin.ui.domain;
+package edu.internet2.tier.shibboleth.admin.ui.domain.shib.properties;
 
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import edu.internet2.tier.shibboleth.admin.util.EmptyStringToNullConverter;

backend/src/main/java/edu/internet2/tier/shibboleth/admin/ui/domain/shib/properties/ShibPropertySet.java

@@ -0,0 +1,53 @@
+package edu.internet2.tier.shibboleth.admin.ui.domain.shib.properties;
+
+import edu.internet2.tier.shibboleth.admin.util.EmptyStringToNullConverter;
+import lombok.Getter;
+import lombok.RequiredArgsConstructor;
+import lombok.Setter;
+import lombok.ToString;
+import org.hibernate.envers.Audited;
+
+import javax.persistence.Column;
+import javax.persistence.Convert;
+import javax.persistence.Entity;
+import javax.persistence.GeneratedValue;
+import javax.persistence.Id;
+import javax.persistence.OneToMany;
+import java.util.ArrayList;
+import java.util.List;
+
+@Entity(name = "shib_property_set")
+@Audited
+@Getter
+@Setter
+@ToString
+@RequiredArgsConstructor
+public class ShibPropertySet {
+    @Id
+    @GeneratedValue
+    private int resourceId;
+
+    @Column(unique = true, nullable = false)
+    @Convert(converter = EmptyStringToNullConverter.class)
+    private String name;
+
+    @OneToMany
+    private List<ShibPropertySetting> properties = new ArrayList<>();
+
+    @Override
+    public boolean equals(Object o) {
+        if (o instanceof ShibPropertySet) {
+            ShibPropertySet that = (ShibPropertySet) o;
+            boolean result = this.name.equals(that.name) && this.resourceId == that.resourceId && this.properties.size() == that.properties.size();
+            if (result == true) {
+                for (ShibPropertySetting thisSetting : this.properties) {
+                    if ( !that.properties.contains(thisSetting) ) {
+                        return false;
+                    }
+                }
+            }
+            return result;
+        }
+        return false;
+    }
+}

backend/src/main/java/edu/internet2/tier/shibboleth/admin/ui/domain/shib/properties/ShibPropertySetting.java

@@ -0,0 +1,29 @@
+package edu.internet2.tier.shibboleth.admin.ui.domain.shib.properties;
+
+import lombok.Data;
+import org.hibernate.envers.Audited;
+
+import javax.persistence.Column;
+import javax.persistence.Entity;
+import javax.persistence.GeneratedValue;
+import javax.persistence.Id;
+import javax.persistence.ManyToOne;
+
+@Entity(name = "shib_property_setting")
+@Audited
+@Data
+public class ShibPropertySetting {
+    @Id
+    @GeneratedValue
+    private int resourceId;
+
+    @Column
+    private String configFile;
+
+    @Column
+    private String propertyName;
+
+    @Column
+    private String propertyValue;
+
+}

backend/src/main/java/edu/internet2/tier/shibboleth/admin/ui/exception/EntityNotFoundException.java

@@ -1,5 +1,8 @@
 package edu.internet2.tier.shibboleth.admin.ui.exception;
 
+/**
+ * Generically meaning - hibernate entity, not SAML entity
+ */
 public class EntityNotFoundException extends Exception {
     public EntityNotFoundException(String message) {
         super(message);

backend/src/main/java/edu/internet2/tier/shibboleth/admin/ui/repository/ProjectionIdAndName.java

@@ -0,0 +1,6 @@
+package edu.internet2.tier.shibboleth.admin.ui.repository;
+
+public interface ProjectionIdAndName{
+    String getResourceId();
+    String getName();
+}

backend/src/main/java/edu/internet2/tier/shibboleth/admin/ui/repository/ShibConfigurationRepository.java

@@ -1,6 +1,6 @@
 package edu.internet2.tier.shibboleth.admin.ui.repository;
 
-import edu.internet2.tier.shibboleth.admin.ui.domain.ShibConfigurationProperty;
+import edu.internet2.tier.shibboleth.admin.ui.domain.shib.properties.ShibConfigurationProperty;
 import org.springframework.data.jpa.repository.JpaRepository;
 import org.springframework.data.jpa.repository.Query;
 

backend/src/main/java/edu/internet2/tier/shibboleth/admin/ui/repository/ShibPropertySetRepository.java

@@ -0,0 +1,17 @@
+package edu.internet2.tier.shibboleth.admin.ui.repository;
+
+import edu.internet2.tier.shibboleth.admin.ui.domain.shib.properties.ShibPropertySet;
+import org.springframework.data.jpa.repository.JpaRepository;
+
+import java.util.List;
+
+/**
+ * Repository to manage {@link ShibPropertySet} instances.
+ */
+public interface ShibPropertySetRepository extends JpaRepository<ShibPropertySet, String> {
+    ShibPropertySet findByName(String name);
+
+    ShibPropertySet findByResourceId(Integer id);
+
+    List<ProjectionIdAndName> findAllBy();
+}

backend/src/main/java/edu/internet2/tier/shibboleth/admin/ui/repository/ShibPropertySettingRepository.java

@@ -0,0 +1,10 @@
+package edu.internet2.tier.shibboleth.admin.ui.repository;
+
+import edu.internet2.tier.shibboleth.admin.ui.domain.shib.properties.ShibPropertySetting;
+import org.springframework.data.jpa.repository.JpaRepository;
+
+/**
+ * Repository to manage {@link ShibPropertySetting} instances.
+ */
+public interface ShibPropertySettingRepository extends JpaRepository<ShibPropertySetting, String> {
+}

backend/src/main/java/edu/internet2/tier/shibboleth/admin/ui/service/ShibConfigurationService.java

@@ -1,16 +1,29 @@
 package edu.internet2.tier.shibboleth.admin.ui.service;
 
-import edu.internet2.tier.shibboleth.admin.ui.domain.ShibConfigurationProperty;
+import edu.internet2.tier.shibboleth.admin.ui.domain.shib.properties.ShibConfigurationProperty;
+import edu.internet2.tier.shibboleth.admin.ui.domain.shib.properties.ShibPropertySet;
+import edu.internet2.tier.shibboleth.admin.ui.exception.EntityNotFoundException;
+import edu.internet2.tier.shibboleth.admin.ui.repository.ProjectionIdAndName;
 
 import java.util.Collection;
 import java.util.List;
 
 public interface ShibConfigurationService {
-    void addAll(Collection<ShibConfigurationProperty> newProperties);
+    void addAllConfigurationProperties(Collection<ShibConfigurationProperty> newProperties);
+
+    void delete(int resourceId) throws EntityNotFoundException;
+
+    List<ShibConfigurationProperty> getAllConfigurationProperties();
+
+    List<ProjectionIdAndName> getAllPropertySets();
 
     List<String> getExistingPropertyNames();
 
-    void save(ShibConfigurationProperty prop);
+    ShibPropertySet getSet(int resourceId) throws EntityNotFoundException;
+
+    ShibPropertySet getSet(String name);
+
+    ShibPropertySet save(ShibPropertySet set);
 
-    List<ShibConfigurationProperty> getAll();
+    ShibConfigurationProperty save(ShibConfigurationProperty prop);
 }