org.nhindirect.config.resources

Class DomainResource

java.lang.Object

org.nhindirect.config.resources.ProtectedResource

org.nhindirect.config.resources.DomainResource

@RestController
 @RequestMapping(value="domain")
public class DomainResource
extends ProtectedResource

Resource for managing domain 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
DomainResource() Constructor

Method Summary

Modifier and Type	Method and Description
org.springframework.http.ResponseEntity<reactor.core.publisher.Mono<java.lang.Void>>	addDomain(org.nhindirect.config.model.Domain domain) Adds a domain to the system.
org.springframework.http.ResponseEntity<reactor.core.publisher.Mono<org.nhindirect.config.model.Domain>>	getDomain(java.lang.String domain) Gets a domain by name.
org.springframework.http.ResponseEntity<reactor.core.publisher.Mono<java.lang.Void>>	removedDomain(java.lang.String domain) Deletes a domain by name.
org.springframework.http.ResponseEntity<reactor.core.publisher.Flux<org.nhindirect.config.model.Domain>>	searchDomains(java.lang.String domainName, java.lang.String entityStatus) Gets a list of domains that match a query.
void	setAddressRepository(org.nhindirect.config.repository.AddressRepository addRepo) Sets the address repository.
void	setAddressResource(TrustBundleResource bundleResource) Sets the trust bundle resource.
void	setDomainRepository(org.nhindirect.config.repository.DomainRepository domainRepo) Sets the domain repository.
org.springframework.http.ResponseEntity<reactor.core.publisher.Mono<java.lang.Void>>	updateDomain(org.nhindirect.config.model.Domain domain) Updates a domain's attributes.

Methods inherited from class java.lang.Object

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

Constructor Detail

DomainResource

public DomainResource()

Constructor

Method Detail

setAddressRepository

@Autowired
public void setAddressRepository(org.nhindirect.config.repository.AddressRepository addRepo)

Sets the address repository. Auto populated by Spring

Parameters:

addRepo - Address repository

setDomainRepository

@Autowired
public void setDomainRepository(org.nhindirect.config.repository.DomainRepository domainRepo)

Sets the domain repository. Auto populate by Spring

Parameters:

domainRepo - The domain repository.

setAddressResource

@Autowired
public void setAddressResource(TrustBundleResource bundleResource)

Sets the trust bundle resource. Auto populate by Spring

Parameters:

bundleResource - The trust bundle resource.

getDomain

@GetMapping(value="{domain}",
            produces="application/json")
 @Transactional(readOnly=true)
public org.springframework.http.ResponseEntity<reactor.core.publisher.Mono<org.nhindirect.config.model.Domain>> getDomain(@PathVariable(value="domain")
                                                                                                                                                                                                                                java.lang.String domain)

Gets a domain by name.

Parameters:

domain - The name of the domain to retrieve.

Returns:

A JSON representation of the domain. Returns a status of 404 if a domain with the given name does not exist.

searchDomains

@GetMapping(produces="application/json")
 @Transactional(readOnly=true)
public org.springframework.http.ResponseEntity<reactor.core.publisher.Flux<org.nhindirect.config.model.Domain>> searchDomains(@RequestParam(name="domainName",defaultValue="")
                                                                                                                                                                                                      java.lang.String domainName,
                                                                                                                                                                                                      @RequestParam(name="entityStatus",defaultValue="")
                                                                                                                                                                                                      java.lang.String entityStatus)

Gets a list of domains that match a query.

Parameters:

domainName - The name of the domain to to get. Defaults to an empty string which means get all domains.

entityStatus - The entity status that the returned domain must match. Default to empty string which means to ignore the status filter.

Returns:

A JSON representation of a collection of domains that match the search paremeters. Returns a status of 204 if no domains match the search parameters.

addDomain

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

Adds a domain to the system.

Parameters:

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

domain - The domain to add to the system.

Returns:

Status of 201 if the domain was added or status of 409 if the domain already exists.

updateDomain

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

Updates a domain's attributes.

Parameters:

domain - The name of the domain to update.

Returns:

Status of 204 if the domain is updated or 404 if a domain with the given name does not exist.

removedDomain

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

Deletes a domain by name.

Parameters:

domain - The name of the domain to delete.

Returns:

Status of 200 if the domain was deleted of status of 404 if a domain with the given name does not exists.