org.nhindirect.config.resources

Class AddressResource

java.lang.Object

org.nhindirect.config.resources.ProtectedResource

org.nhindirect.config.resources.AddressResource

@RestController
 @RequestMapping(value="address")
public class AddressResource
extends ProtectedResource

Resource for managing address 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
AddressResource() Constructor

Method Summary

Modifier and Type	Method and Description
org.springframework.http.ResponseEntity<reactor.core.publisher.Mono<java.lang.Void>>	addAddress(org.nhindirect.config.model.Address address) Adds an address to the system and associates it with a domain.
org.springframework.http.ResponseEntity<reactor.core.publisher.Mono<org.nhindirect.config.model.Address>>	getAddress(java.lang.String address) Gets an address by name.
org.springframework.http.ResponseEntity<reactor.core.publisher.Flux<org.nhindirect.config.model.Address>>	getAddressesByDomain(java.lang.String domainName) Gets all addresses configured for a given domain.
org.springframework.http.ResponseEntity<reactor.core.publisher.Mono<java.lang.Void>>	removedAddress(java.lang.String address) Removes an address from the system.
void	setAddressRepository(org.nhindirect.config.repository.AddressRepository addRepo) Sets the address repository.
void	setDomainRepository(org.nhindirect.config.repository.DomainRepository domainRepo) Sets the domain repository.
org.springframework.http.ResponseEntity<reactor.core.publisher.Mono<java.lang.Void>>	updateAddress(org.nhindirect.config.model.Address address) Updates the attributes of an existing address.

Methods inherited from class java.lang.Object

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

Constructor Detail

AddressResource

public AddressResource()

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 -

getAddress

@GetMapping(value="/{address}",
            produces="application/json")
public org.springframework.http.ResponseEntity<reactor.core.publisher.Mono<org.nhindirect.config.model.Address>> getAddress(@PathVariable
                                                                                                                                                                                                     java.lang.String address)

Gets an address by name.

Parameters:

address - The address to retrieve.

Returns:

A JSON representation of an Address. Returns 404 if the address doesn't exists.

getAddressesByDomain

@GetMapping(value="domain/{domainName}",
            produces="application/json")
public org.springframework.http.ResponseEntity<reactor.core.publisher.Flux<org.nhindirect.config.model.Address>> getAddressesByDomain(@PathVariable
                                                                                                                                                                                                                        java.lang.String domainName)

Gets all addresses configured for a given domain.

Parameters:

domainName - The domain name to retrieve addresses for.

Returns:

A JSON representation of a list of addresses. Returns a 404 status if the domain does not exists or a 204 status if no addresses are configured for the domain.

addAddress

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

Adds an address to the system and associates it with a domain.

Parameters:

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

address - The address to add.

Returns:

Returns status 201 if added successfully, 404 if the domain does not exist, or 409 if the address already exists.

updateAddress

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

Updates the attributes of an existing address.

Parameters:

address - The address to update along with new attributes.

Returns:

Returns 204 if the address is updated successfully, 400 if the domain name is empty, 404 if the domain or address does not exist.

removedAddress

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

Removes an address from the system.

Parameters:

address - The address to removed.

Returns:

Returns a status of 200 if the address was removed or 404 if the address does not exists.