org.nhindirect.config.resources

Class DNSResource

java.lang.Object

org.nhindirect.config.resources.ProtectedResource

org.nhindirect.config.resources.DNSResource

@RestController
 @RequestMapping(value="dns")
public class DNSResource
extends ProtectedResource

JAX-RS resource for managing DNS 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
DNSResource() Constructor

Method Summary

Modifier and Type	Method and Description
org.springframework.http.ResponseEntity<reactor.core.publisher.Mono<java.lang.Void>>	addDNSRecord(org.nhindirect.config.model.DNSRecord record) Adds a DNS record.
org.springframework.http.ResponseEntity<reactor.core.publisher.Flux<org.nhindirect.config.model.DNSRecord>>	getDNSRecords(int type, java.lang.String name) Gets DNS records that match a given name, type, or combination of both.
org.springframework.http.ResponseEntity<reactor.core.publisher.Mono<java.lang.Void>>	removeDNSRecordsByIds(java.lang.String ids) Delete DNS records by system id.
void	setDNSRepository(org.nhindirect.config.repository.DNSRepository dnsRepo) Sets the DNS repository.
org.springframework.http.ResponseEntity<reactor.core.publisher.Mono<java.lang.Void>>	updateDNSRecord(org.nhindirect.config.model.DNSRecord updateRecord) Updates the attributes of an existing DNS record.

Methods inherited from class java.lang.Object

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

Constructor Detail

DNSResource

public DNSResource()

Constructor

Method Detail

setDNSRepository

@Autowired
public void setDNSRepository(org.nhindirect.config.repository.DNSRepository dnsRepo)

Sets the DNS repository. Auto populated by Spring

Parameters:

dnsRepo - DNS repository

getDNSRecords

@GetMapping(produces="application/json")
public org.springframework.http.ResponseEntity<reactor.core.publisher.Flux<org.nhindirect.config.model.DNSRecord>> getDNSRecords(@RequestParam(name="type",defaultValue="-1")
                                                                                                                                                                          int type,
                                                                                                                                                                          @RequestParam(name="name",defaultValue="")
                                                                                                                                                                          java.lang.String name)

Gets DNS records that match a given name, type, or combination of both.

Parameters:

type - DNS record type filter. Defaults to -1 which means no filter will be applied.

name - DNS record name filter. Defaults to an empty string which means no filter will be applied.

Returns:

A JSON representation of a collection of all DNS records that match the given search criteria. Returns a status of 204 if no records match the search criteria.

addDNSRecord

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

Adds a DNS record.

Parameters:

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

record - The DNS record to add.

Returns:

Status fo 201 if the DNS record was added to the system or a status of 409 if the record already exists.

updateDNSRecord

@PostMapping(consumes="application/json")
public org.springframework.http.ResponseEntity<reactor.core.publisher.Mono<java.lang.Void>> updateDNSRecord(@RequestBody
                                                                                                                                                      org.nhindirect.config.model.DNSRecord updateRecord)

Updates the attributes of an existing DNS record.

Parameters:

updateRecord - The DNS record to update.

Returns:

Status of 204 if the DNS record was updated or status of 404 if the record could not be found.

removeDNSRecordsByIds

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

Delete DNS records by system id.

Parameters:

ids - Comma delimited list of ids to delete.

Returns:

Status of 200 if the DNS records were deleted.