org.nhindirect.config.resources

Class AnchorResource

java.lang.Object

org.nhindirect.config.resources.ProtectedResource

org.nhindirect.config.resources.AnchorResource

@RestController
 @RequestMapping(value="anchor")
public class AnchorResource
extends ProtectedResource

Resource for managing anchor resources in the configuration service.

Although not required, this class is instantiated using the Jersey SpringServlet and dependencies are defined in the Sprint context XML file.

Since:

2.0

Author:

Greg Meyer

Constructor Summary

Constructors

Constructor and Description
AnchorResource() Constructor

Method Summary

Modifier and Type	Method and Description
org.springframework.http.ResponseEntity<reactor.core.publisher.Mono<java.lang.Void>>	addAnchor(org.nhindirect.config.model.Anchor anchor) Adds an anchor to the system.
org.springframework.http.ResponseEntity<reactor.core.publisher.Flux<org.nhindirect.config.model.Anchor>>	getAnchorForOwner(boolean incoming, boolean outgoing, java.lang.String thumbprint, java.lang.String owner) Gets a set of list of anchor for a given owner of the anchor.
org.springframework.http.ResponseEntity<reactor.core.publisher.Flux<org.nhindirect.config.model.Anchor>>	getAnchors() Gets all anchors in the system.
org.springframework.http.ResponseEntity<reactor.core.publisher.Mono<java.lang.Void>>	removeAnchorsByIds(java.lang.String ids) Deletes anchor from the system by system id.
org.springframework.http.ResponseEntity<reactor.core.publisher.Mono<java.lang.Void>>	removeAnchorsByOwner(java.lang.String owner) Delete all anchors for a specific owner.
void	setAnchorRepository(org.nhindirect.config.repository.AnchorRepository anchorRepo) Sets the anchor repository.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AnchorResource

public AnchorResource()

Constructor

Method Detail

setAnchorRepository

@Autowired
public void setAnchorRepository(org.nhindirect.config.repository.AnchorRepository anchorRepo)

Sets the anchor repository. Auto populated by Spring

Parameters:

anchorRepo - Anchor repository

getAnchorForOwner

@GetMapping(value="/{owner}",
            produces="application/json")
public org.springframework.http.ResponseEntity<reactor.core.publisher.Flux<org.nhindirect.config.model.Anchor>> getAnchorForOwner(@RequestParam(name="incoming",defaultValue="false")
                                                                                                                                                                                                         boolean incoming,
                                                                                                                                                                                                         @RequestParam(name="outgoing",defaultValue="false")
                                                                                                                                                                                                         boolean outgoing,
                                                                                                                                                                                                         @RequestParam(name="thumbprint",defaultValue="")
                                                                                                                                                                                                         java.lang.String thumbprint,
                                                                                                                                                                                                         @PathVariable(value="owner")
                                                                                                                                                                                                         java.lang.String owner)

Gets a set of list of anchor for a given owner of the anchor. Additional query parameters can further filter the return list.

Parameters:

incoming - Returned anchors must be marked for use of incoming messages. Defaults to false meaning that no filter is applied.

outgoing - Returned anchors must be marked for use of outgoing messages. Defaults to false meaning that no filter is applied.

thumbprint - Returned anchors that match a specific thumbprint effectively limiting the number of returned anchors to 1. Defaults to an empty string meaning that no filter is applied.

owner - The owner to retrieve anchors for.

Returns:

A JSON representation of a collection of anchors that match the filters. Returns a status of 204 if no anchors match the filters or no anchors exist for the owner.

getAnchors

@GetMapping(produces="application/json")
public org.springframework.http.ResponseEntity<reactor.core.publisher.Flux<org.nhindirect.config.model.Anchor>> getAnchors()

Gets all anchors in the system.

Returns:

A JSON representation of a collection of all anchors in the system.

addAnchor

@PutMapping(consumes="application/json")
public org.springframework.http.ResponseEntity<reactor.core.publisher.Mono<java.lang.Void>> addAnchor(@RequestBody
                                                                                                                                               org.nhindirect.config.model.Anchor anchor)

Adds an anchor to the system.

Parameters:

uriInfo - Injected URI context used for building the location URI.

anchor - The anchor to add to the system.

Returns:

Returns a status of 201 if the anchor was added, or a status of 409 if the anchor already exists for a specific owner.

removeAnchorsByIds

@DeleteMapping(value="ids/{ids}")
public org.springframework.http.ResponseEntity<reactor.core.publisher.Mono<java.lang.Void>> removeAnchorsByIds(@PathVariable(value="ids")
                                                                                                                                                 java.lang.String ids)

Deletes anchor from the system by system id.

Parameters:

ids - List of ids to delete from the system.

Returns:

Status of 200 if the anchors were deleted successfully.

removeAnchorsByOwner

@DeleteMapping(value="{owner}")
public org.springframework.http.ResponseEntity<reactor.core.publisher.Mono<java.lang.Void>> removeAnchorsByOwner(@PathVariable(value="owner")
                                                                                                                                                 java.lang.String owner)

Delete all anchors for a specific owner.

Parameters:

owner - The owner to delete anchor from.

Returns:

Status of 200 if the anchors were deleted successfully.