-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merged in SHIBUI-645 (pull request #130)
SHIBUI-645 Approved-by: Shibui Jenkins <shibui.jenkins@gmail.com>
- Loading branch information
Showing
10 changed files
with
292 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
34 changes: 34 additions & 0 deletions
34
...ternet2/tier/shibboleth/admin/ui/controller/MetadataResolversPositionOrderController.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| package edu.internet2.tier.shibboleth.admin.ui.controller; | ||
|
|
||
|
|
||
| import edu.internet2.tier.shibboleth.admin.ui.domain.resolvers.MetadataResolversPositionOrderContainer; | ||
| import edu.internet2.tier.shibboleth.admin.ui.service.MetadataResolversPositionOrderContainerService; | ||
| import org.springframework.beans.factory.annotation.Autowired; | ||
| import org.springframework.http.ResponseEntity; | ||
| import org.springframework.web.bind.annotation.GetMapping; | ||
| 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; | ||
|
|
||
| /** | ||
| * @author Dmitriy Kopylenko | ||
| */ | ||
| @RestController | ||
| @RequestMapping("/api/MetadataResolversPositionOrder") | ||
| public class MetadataResolversPositionOrderController { | ||
|
|
||
| @Autowired | ||
| MetadataResolversPositionOrderContainerService positionOrderContainerService; | ||
|
|
||
| @PostMapping | ||
| public ResponseEntity<?> createOrUpdate(@RequestBody MetadataResolversPositionOrderContainer metadataResolversPositionOrderContainer) { | ||
| positionOrderContainerService.addOrUpdatePositionOrderContainer(metadataResolversPositionOrderContainer); | ||
| return ResponseEntity.noContent().build(); | ||
| } | ||
|
|
||
| @GetMapping | ||
| public ResponseEntity<?> getPositionOrderContainer() { | ||
| return ResponseEntity.ok(positionOrderContainerService.retrieveExistingOrEmpty()); | ||
| } | ||
| } |
14 changes: 14 additions & 0 deletions
14
.../internet2/tier/shibboleth/admin/ui/domain/resolvers/MetadataResolversOrderContainer.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| package edu.internet2.tier.shibboleth.admin.ui.domain.resolvers; | ||
|
|
||
| /** | ||
| * This is a persistent entity abstraction encapsulating a collection of metadata resolver ids | ||
| * for the purpose of maintaining an order of all persistent metadata resolvers which becomes significant during | ||
| * generation of XML metadata for the resolvers. | ||
| * | ||
| * Maintaining this separate entity enables UI layer for example to explicitly manipulate ordering e.g. use REST | ||
| * API to reorder resolvers, etc. | ||
| * | ||
| * @author Dmitriy | ||
| */ | ||
| public class MetadataResolversOrderContainer { | ||
| } |
50 changes: 50 additions & 0 deletions
50
...t2/tier/shibboleth/admin/ui/domain/resolvers/MetadataResolversPositionOrderContainer.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| package edu.internet2.tier.shibboleth.admin.ui.domain.resolvers; | ||
|
|
||
| import com.fasterxml.jackson.annotation.JsonIgnore; | ||
| import lombok.EqualsAndHashCode; | ||
| import lombok.Getter; | ||
| import lombok.NoArgsConstructor; | ||
| import lombok.Setter; | ||
| import lombok.ToString; | ||
|
|
||
| import javax.persistence.CollectionTable; | ||
| import javax.persistence.Column; | ||
| import javax.persistence.ElementCollection; | ||
| import javax.persistence.Entity; | ||
| import javax.persistence.GeneratedValue; | ||
| import javax.persistence.GenerationType; | ||
| import javax.persistence.Id; | ||
| import javax.persistence.JoinColumn; | ||
| import javax.persistence.OrderColumn; | ||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
|
|
||
| /** | ||
| * This is a persistent entity abstraction encapsulating a collection of metadata resolver ids | ||
| * for the purpose of maintaining an order of all persistent metadata resolvers which becomes significant during | ||
| * generation of XML metadata for the resolvers. | ||
| * | ||
| * Maintaining this separate entity enables UI layer for example to explicitly manipulate ordering e.g. use REST | ||
| * API to reorder resolvers, etc. | ||
| * | ||
| * @author Dmitriy Kopylenko | ||
| */ | ||
| @Entity | ||
| @EqualsAndHashCode | ||
| @NoArgsConstructor | ||
| @Getter | ||
| @Setter | ||
| @ToString | ||
| public class MetadataResolversPositionOrderContainer { | ||
|
|
||
| @Id | ||
| @GeneratedValue(strategy = GenerationType.SEQUENCE) | ||
| @JsonIgnore | ||
| protected Long id; | ||
|
|
||
| @ElementCollection | ||
| @CollectionTable(name="METADATA_RESOLVER_POSITION_ORDER", joinColumns=@JoinColumn(name="METADATA_RESOLVER_POSITION_ORDER_CONTAINER_ID")) | ||
| @Column(name="METADATA_RESOLVER_RESOURCE_ID") | ||
| @OrderColumn | ||
| private List<String> resourceIds = new ArrayList<>(); | ||
| } |
13 changes: 13 additions & 0 deletions
13
...ier/shibboleth/admin/ui/repository/MetadataResolversPositionOrderContainerRepository.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| package edu.internet2.tier.shibboleth.admin.ui.repository; | ||
|
|
||
| import edu.internet2.tier.shibboleth.admin.ui.domain.resolvers.MetadataResolversPositionOrderContainer; | ||
| import org.springframework.data.repository.CrudRepository; | ||
|
|
||
| /** | ||
| * Spring Data Repository API for persistence operations on instances of {@link MetadataResolversPositionOrderContainer}. | ||
| * | ||
| * @author Dmitriy Kopylenko | ||
| */ | ||
| public interface MetadataResolversPositionOrderContainerRepository | ||
| extends CrudRepository<MetadataResolversPositionOrderContainer, Long> { | ||
| } |
77 changes: 77 additions & 0 deletions
77
...er/shibboleth/admin/ui/service/DefaultMetadataResolversPositionOrderContainerService.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| package edu.internet2.tier.shibboleth.admin.ui.service; | ||
|
|
||
| import edu.internet2.tier.shibboleth.admin.ui.domain.resolvers.MetadataResolver; | ||
| import edu.internet2.tier.shibboleth.admin.ui.domain.resolvers.MetadataResolversPositionOrderContainer; | ||
| import edu.internet2.tier.shibboleth.admin.ui.repository.MetadataResolverRepository; | ||
| import edu.internet2.tier.shibboleth.admin.ui.repository.MetadataResolversPositionOrderContainerRepository; | ||
| import org.springframework.transaction.annotation.Transactional; | ||
|
|
||
| import java.util.Iterator; | ||
| import java.util.List; | ||
| import java.util.Optional; | ||
|
|
||
| import static com.google.common.collect.FluentIterable.from; | ||
| import static java.util.stream.Collectors.toList; | ||
|
|
||
|
|
||
| /** | ||
| * Default implementation of {@link MetadataResolversPositionOrderContainer}. | ||
| * | ||
| * @author Dmitriy Kopylenko | ||
| */ | ||
| public class DefaultMetadataResolversPositionOrderContainerService implements MetadataResolversPositionOrderContainerService { | ||
|
|
||
| private MetadataResolversPositionOrderContainerRepository positionOrderContainerRepository; | ||
|
|
||
| private MetadataResolverRepository metadataResolverRepository; | ||
|
|
||
| public DefaultMetadataResolversPositionOrderContainerService(MetadataResolversPositionOrderContainerRepository positionOrderRepository, | ||
| MetadataResolverRepository metadataResolverRepository) { | ||
| this.positionOrderContainerRepository = positionOrderRepository; | ||
| this.metadataResolverRepository = metadataResolverRepository; | ||
| } | ||
|
|
||
| @Override | ||
| @Transactional | ||
| public void addOrUpdatePositionOrderContainer(MetadataResolversPositionOrderContainer metadataResolversPositionOrderContainer) { | ||
| MetadataResolversPositionOrderContainer existingPositionOrder = getPositionOrderContainerIfExists().orElse(null); | ||
| if (existingPositionOrder != null) { | ||
| existingPositionOrder.setResourceIds(metadataResolversPositionOrderContainer.getResourceIds()); | ||
| positionOrderContainerRepository.save(existingPositionOrder); | ||
| return; | ||
| } | ||
| positionOrderContainerRepository.save(metadataResolversPositionOrderContainer); | ||
| } | ||
|
|
||
| @Override | ||
| @Transactional(readOnly = true) | ||
| public List<MetadataResolver> getAllMetadataResolversInDefinedOrderOrUnordered() { | ||
| Optional<MetadataResolversPositionOrderContainer> orderContainer = getPositionOrderContainerIfExists(); | ||
| if(orderContainer.isPresent()) { | ||
| return orderContainer.get().getResourceIds() | ||
| .stream() | ||
| .map(metadataResolverRepository::findByResourceId) | ||
| .collect(toList()); | ||
| } | ||
|
|
||
| return from(metadataResolverRepository.findAll()).toList(); | ||
| } | ||
|
|
||
| @Override | ||
| public MetadataResolversPositionOrderContainer retrieveExistingOrEmpty() { | ||
| return getPositionOrderContainerIfExists().orElseGet(MetadataResolversPositionOrderContainer::new); | ||
| } | ||
|
|
||
| @Override | ||
| @Transactional | ||
| public void appendPositionOrderForNew(MetadataResolver metadataResolver) { | ||
| MetadataResolversPositionOrderContainer positionOrderContainer = retrieveExistingOrEmpty(); | ||
| positionOrderContainer.getResourceIds().add(metadataResolver.getResourceId()); | ||
| positionOrderContainerRepository.save(positionOrderContainer); | ||
| } | ||
|
|
||
| private Optional<MetadataResolversPositionOrderContainer> getPositionOrderContainerIfExists() { | ||
| Iterator<MetadataResolversPositionOrderContainer> iter = positionOrderContainerRepository.findAll().iterator(); | ||
| return iter.hasNext() ? Optional.of(iter.next()) : Optional.empty(); | ||
| } | ||
| } |
23 changes: 23 additions & 0 deletions
23
...net2/tier/shibboleth/admin/ui/service/MetadataResolversPositionOrderContainerService.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| package edu.internet2.tier.shibboleth.admin.ui.service; | ||
|
|
||
| import edu.internet2.tier.shibboleth.admin.ui.domain.resolvers.MetadataResolver; | ||
| import edu.internet2.tier.shibboleth.admin.ui.domain.resolvers.MetadataResolversPositionOrderContainer; | ||
|
|
||
| import java.util.List; | ||
|
|
||
| /** | ||
| * Service interface for manipulation of instances of {@link MetadataResolversPositionOrderContainer} and | ||
| * to abstract away MetadataResolvers ordering logic. | ||
| * | ||
| * @author Dmitriy Kopylenko | ||
| */ | ||
| public interface MetadataResolversPositionOrderContainerService { | ||
|
|
||
| MetadataResolversPositionOrderContainer retrieveExistingOrEmpty(); | ||
|
|
||
| void addOrUpdatePositionOrderContainer(MetadataResolversPositionOrderContainer metadataResolversPositionOrderContainer); | ||
|
|
||
| List<MetadataResolver> getAllMetadataResolversInDefinedOrderOrUnordered(); | ||
|
|
||
| void appendPositionOrderForNew(MetadataResolver metadataResolver); | ||
| } |
53 changes: 53 additions & 0 deletions
53
...er/shibboleth/admin/ui/service/MetadataResolversPositionOrderContainerServiceTests.groovy
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| package edu.internet2.tier.shibboleth.admin.ui.service | ||
|
|
||
| import edu.internet2.tier.shibboleth.admin.ui.domain.resolvers.MetadataResolver | ||
| import edu.internet2.tier.shibboleth.admin.ui.domain.resolvers.MetadataResolversPositionOrderContainer | ||
| import edu.internet2.tier.shibboleth.admin.ui.repository.MetadataResolverRepository | ||
| import edu.internet2.tier.shibboleth.admin.ui.repository.MetadataResolversPositionOrderContainerRepository | ||
| import spock.lang.Specification | ||
| import spock.lang.Subject | ||
|
|
||
| /** | ||
| * @author Dmitriy Kopylenko | ||
| */ | ||
| class MetadataResolversPositionOrderContainerServiceTests extends Specification { | ||
|
|
||
| def "no order container has been provided and saved, so using unordered persisted resolvers"() { | ||
| given: | ||
| def resolverRepo = Mock(MetadataResolverRepository) | ||
| resolverRepo.findAll() >> [new MetadataResolver(resourceId: 'second'), new MetadataResolver(resourceId: 'first')] | ||
| def positionOrderRepo = Mock(MetadataResolversPositionOrderContainerRepository) | ||
| positionOrderRepo.findAll() >> [] | ||
| @Subject | ||
| def positionContainerSvc = new DefaultMetadataResolversPositionOrderContainerService(positionOrderRepo, resolverRepo) | ||
|
|
||
| when: | ||
| def unorderedResolvers = positionContainerSvc.getAllMetadataResolversInDefinedOrderOrUnordered() | ||
|
|
||
| then: | ||
| unorderedResolvers[0].resourceId == 'second' | ||
| unorderedResolvers[1].resourceId == 'first' | ||
|
|
||
| } | ||
|
|
||
| def "an order container has been provided and saved, so using resolvers with order defined in that position order container"() { | ||
| given: | ||
| def resolverRepo = Mock(MetadataResolverRepository) | ||
| resolverRepo.findAll() >> [new MetadataResolver(resourceId: 'second'), new MetadataResolver(resourceId: 'first')] | ||
| resolverRepo.findByResourceId('first') >> new MetadataResolver(resourceId: 'first') | ||
| resolverRepo.findByResourceId('second') >> new MetadataResolver(resourceId: 'second') | ||
| def positionOrderRepo = Mock(MetadataResolversPositionOrderContainerRepository) | ||
| positionOrderRepo.findAll() >> [new MetadataResolversPositionOrderContainer(resourceIds: ['first', 'second'])] | ||
| positionOrderRepo.findAll() >> [] | ||
| @Subject | ||
| def positionContainerSvc = new DefaultMetadataResolversPositionOrderContainerService(positionOrderRepo, resolverRepo) | ||
|
|
||
| when: | ||
| def orderedResolvers = positionContainerSvc.getAllMetadataResolversInDefinedOrderOrUnordered() | ||
|
|
||
| then: | ||
| orderedResolvers[0].resourceId == 'first' | ||
| orderedResolvers[1].resourceId == 'second' | ||
|
|
||
| } | ||
| } |