org.nhindirect.config.resources

Class CertPolicyResource

java.lang.Object

org.nhindirect.config.resources.ProtectedResource

org.nhindirect.config.resources.CertPolicyResource

@RestController
 @RequestMapping(value="certpolicy")
public class CertPolicyResource
extends ProtectedResource

Resource for managing certificate policy 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
CertPolicyResource() Constructor

Method Summary

Modifier and Type	Method and Description
org.springframework.http.ResponseEntity<reactor.core.publisher.Mono<java.lang.Void>>	addPolicy(org.nhindirect.config.model.CertPolicy policy) Adds a certificate policy to the system.
org.springframework.http.ResponseEntity<reactor.core.publisher.Mono<java.lang.Void>>	addPolicyGroup(org.nhindirect.config.model.CertPolicyGroup group) Adds a policy group to the system.
org.springframework.http.ResponseEntity<reactor.core.publisher.Mono<java.lang.Void>>	addPolicyUseToGroup(java.lang.String groupName, org.nhindirect.config.model.CertPolicyGroupUse use) Adds a certificate policy usage to a policy group.
org.springframework.http.ResponseEntity<reactor.core.publisher.Mono<java.lang.Void>>	associatePolicyGroupToDomain(java.lang.String groupName, java.lang.String domainName) Associates a policy group to a domain.
org.springframework.http.ResponseEntity<reactor.core.publisher.Mono<java.lang.Void>>	disassociatePolicyGroupFromDomain(java.lang.String groupName, java.lang.String domainName) Removed a policy group from a domain.
org.springframework.http.ResponseEntity<reactor.core.publisher.Mono<java.lang.Void>>	disassociatePolicyGroupFromDomains(java.lang.String groupName) Removes a given policy group from all domains.
org.springframework.http.ResponseEntity<reactor.core.publisher.Mono<java.lang.Void>>	disassociatePolicyGroupsFromDomain(java.lang.String domainName) Removes all policy groups for a given domain.
org.springframework.http.ResponseEntity<reactor.core.publisher.Flux<org.nhindirect.config.model.CertPolicy>>	getPolicies() Gets all certificate policies in the system.
org.springframework.http.ResponseEntity<reactor.core.publisher.Mono<org.nhindirect.config.model.CertPolicy>>	getPolicyByName(java.lang.String policyName) Gets a certificate policy by name.
org.springframework.http.ResponseEntity<reactor.core.publisher.Mono<org.nhindirect.config.model.CertPolicyGroup>>	getPolicyGroupByName(java.lang.String groupName) Gets a policy group name.
org.springframework.http.ResponseEntity<reactor.core.publisher.Flux<org.nhindirect.config.model.CertPolicyGroupDomainReltn>>	getPolicyGroupDomainReltns() Gets all policy group to domain relationships.
org.springframework.http.ResponseEntity<reactor.core.publisher.Flux<org.nhindirect.config.model.CertPolicyGroup>>	getPolicyGroups() Gets all policy groups in the system.
org.springframework.http.ResponseEntity<reactor.core.publisher.Flux<org.nhindirect.config.model.CertPolicyGroup>>	getPolicyGroupsByDomain(java.lang.String domainName) Gets all policy groups associated with a domain.
org.springframework.http.ResponseEntity<reactor.core.publisher.Mono<java.lang.Void>>	removedPolicyUseFromGroup(java.lang.String groupName, org.nhindirect.config.model.CertPolicyGroupUse use) Removes a certificate policy usage from a policy group.
org.springframework.http.ResponseEntity<reactor.core.publisher.Mono<java.lang.Void>>	removePolicyByName(java.lang.String policyName) Deletes a certificate policy by name.
org.springframework.http.ResponseEntity<reactor.core.publisher.Mono<java.lang.Void>>	removePolicyGroupByName(java.lang.String groupName) Deletes a policy group from the system.
void	setCertPolicyGroupDomainReltnRepository(org.nhindirect.config.repository.CertPolicyGroupDomainReltnRepository reltnRepo) Sets the policy group reltn repository.
void	setCertPolicyGroupRepository(org.nhindirect.config.repository.CertPolicyGroupRepository groupRepo) Sets the policy group repository.
void	setCertPolicyRepository(org.nhindirect.config.repository.CertPolicyRepository policyRepo) Sets the policy repository.
void	setDomainRepository(org.nhindirect.config.repository.DomainRepository domainRepo) Sets the domain repository.
void	setInternalThisProxy(CertPolicyResource internalProxy)
org.springframework.http.ResponseEntity<reactor.core.publisher.Mono<java.lang.Void>>	updateGroupAttributes(java.lang.String groupName, java.lang.String newGroupName) Updates the attributes of a policy group.
org.springframework.http.ResponseEntity<reactor.core.publisher.Mono<java.lang.Void>>	updatePolicyAttributes(java.lang.String policyName, org.nhindirect.config.model.CertPolicy policyData) Updates the information of a certificate policy.

Methods inherited from class java.lang.Object

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

Constructor Detail

CertPolicyResource

public CertPolicyResource()

Constructor

Method Detail

setCertPolicyRepository

@Autowired
public void setCertPolicyRepository(org.nhindirect.config.repository.CertPolicyRepository policyRepo)

Sets the policy repository. Auto populated by Spring

Parameters:

policyRepo - CertPolicyDao repository

setDomainRepository

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

Sets the domain repository. Auto populated by Spring

Parameters:

domainRepo - DomainDao repository

setCertPolicyGroupRepository

@Autowired
public void setCertPolicyGroupRepository(org.nhindirect.config.repository.CertPolicyGroupRepository groupRepo)

Sets the policy group repository. Auto populated by Spring

Parameters:

groupRepo - CertPolicyGroup repository

setCertPolicyGroupDomainReltnRepository

@Autowired
public void setCertPolicyGroupDomainReltnRepository(org.nhindirect.config.repository.CertPolicyGroupDomainReltnRepository reltnRepo)

Sets the policy group reltn repository. Auto populated by Spring

Parameters:

reltnRepo - CertPolicyGroupDomainReltn repository

setInternalThisProxy

@Autowired
public void setInternalThisProxy(CertPolicyResource internalProxy)

getPolicies

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

Gets all certificate policies in the system.

Returns:

A JSON representation of a collection of all certificate policies in the system. Returns a status of 204 if no certificate policies exists.

getPolicyByName

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

Gets a certificate policy by name.

Parameters:

policyName - The name of the certificate policy to retrieve.

Returns:

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

addPolicy

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

Adds a certificate policy to the system.

Parameters:

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

policy - The certificate policy to add.

Returns:

A status of 201 if the policy was added or a status of 409 if the policy already exists.

removePolicyByName

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

Deletes a certificate policy by name.

Parameters:

policyName - The name of the certificate policy.

Returns:

Status of 200 if the policy was delete or 404 if a certificate policy with the given name does not exist.

updatePolicyAttributes

@PostMapping(value="{policyName}/policyAttributes",
             consumes="application/json")
public org.springframework.http.ResponseEntity<reactor.core.publisher.Mono<java.lang.Void>> updatePolicyAttributes(@PathVariable(value="policyName")
                                                                                                                                                                                                                 java.lang.String policyName,
                                                                                                                                                                                                                 @RequestBody
                                                                                                                                                                                                                 org.nhindirect.config.model.CertPolicy policyData)

Updates the information of a certificate policy.

Parameters:

policyName - The name of the certificate policy to update.

policyData - Data that should be update. Any null or empty attributes will result in that attribute not being updated.

Returns:

Status of 204 if the certificate policy was updated or 404 if a certificate policy with the given name does not exist.

getPolicyGroups

@GetMapping(value="groups",
            produces="application/json")
 @Transactional(readOnly=true)
public org.springframework.http.ResponseEntity<reactor.core.publisher.Flux<org.nhindirect.config.model.CertPolicyGroup>> getPolicyGroups()

Gets all policy groups in the system.

Returns:

A JSON representation of a collection of all policy groups in the system. Returns a status of 204 if no policy groups exist.

getPolicyGroupByName

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

Gets a policy group name.

Parameters:

groupName - The name of the policy group to retrieve.

Returns:

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

addPolicyGroup

@PutMapping(value="groups",
            consumes="application/json")
public org.springframework.http.ResponseEntity<reactor.core.publisher.Mono<java.lang.Void>> addPolicyGroup(@RequestBody
                                                                                                                                                                                org.nhindirect.config.model.CertPolicyGroup group)

Adds a policy group to the system.

Parameters:

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

group - The policy group to add.

Returns:

Status of 201 if the policy group was added or a status of 409 if the policy group already exists.

removePolicyGroupByName

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

Deletes a policy group from the system.

Parameters:

groupName - The name of the policy group to delete.

Returns:

A status of 200 if the policy group was deleted or a status of 404 if a policy group with the given name does not exist.

updateGroupAttributes

@PostMapping(value="groups/{groupName}/groupAttributes",
             consumes="application/json")
public org.springframework.http.ResponseEntity<reactor.core.publisher.Mono<java.lang.Void>> updateGroupAttributes(@PathVariable(value="groupName")
                                                                                                                                                                                                                     java.lang.String groupName,
                                                                                                                                                                                                                     @RequestBody
                                                                                                                                                                                                                     java.lang.String newGroupName)

Updates the attributes of a policy group. This method only updates the policy group name.

Parameters:

groupName - The name of the policy group to update.

newGroupName - The new name of the policy group.

Returns:

Status of 204 if the policy group was updated or a status of 404 if a policy group with the given name does not exist.

addPolicyUseToGroup

@PostMapping(value="groups/uses/{group}",
             consumes="application/json")
 @Transactional
public org.springframework.http.ResponseEntity<reactor.core.publisher.Mono<java.lang.Void>> addPolicyUseToGroup(@PathVariable(value="group")
                                                                                                                                                                                                                    java.lang.String groupName,
                                                                                                                                                                                                                    @RequestBody
                                                                                                                                                                                                                    org.nhindirect.config.model.CertPolicyGroupUse use)

Adds a certificate policy usage to a policy group.

Parameters:

groupName - The name of the policy group to add the usage to.

use - The certificate policy usage to add to the policy group.

Returns:

Status of 204 if the usage was added to the policy group or a status of 404 if either the certificate policy or policy group does not exist.

removedPolicyUseFromGroup

@PostMapping(value="groups/uses/{group}/removePolicy",
             consumes="application/json")
 @Transactional
public org.springframework.http.ResponseEntity<reactor.core.publisher.Mono<java.lang.Void>> removedPolicyUseFromGroup(@PathVariable(value="group")
                                                                                                                                                                                                                                       java.lang.String groupName,
                                                                                                                                                                                                                                       @RequestBody
                                                                                                                                                                                                                                       org.nhindirect.config.model.CertPolicyGroupUse use)

Removes a certificate policy usage from a policy group.

Parameters:

groupName - The name of the policy group to remove the usage from.

use - The certificate policy usage to removed from the policy group.

Returns:

A status of 200 if the usage is removed from the policy group or a status of 404 if the certificate policy, policy group, or existing relationship is not found.

getPolicyGroupDomainReltns

@GetMapping(value="/groups/domain",
            produces="application/json")
 @Transactional(readOnly=true)
public org.springframework.http.ResponseEntity<reactor.core.publisher.Flux<org.nhindirect.config.model.CertPolicyGroupDomainReltn>> getPolicyGroupDomainReltns()

Gets all policy group to domain relationships.

Returns:

A JSON representation of a collection of domain to policy group relationships. Returns a status of 204 if no relationships exist.

getPolicyGroupsByDomain

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

Gets all policy groups associated with a domain.

Parameters:

domainName - The domain name to retrieve associate policy groups from.

Returns:

A JSON representation of a collection of policy groups that are associated to the given domain. Returns a status of 404 if the a domain with the given name does not exist or a status of 204 or no policy groups are associated to the given domain.

associatePolicyGroupToDomain

@PostMapping(value="groups/domain/{group}/{domain}")
public org.springframework.http.ResponseEntity<reactor.core.publisher.Mono<java.lang.Void>> associatePolicyGroupToDomain(@PathVariable(value="group")
                                                                                                                                                                              java.lang.String groupName,
                                                                                                                                                                              @PathVariable(value="domain")
                                                                                                                                                                              java.lang.String domainName)

Associates a policy group to a domain.

Parameters:

groupName - The policy group name to associate to the domain.

domainName - The domain name to associate to the policy group.

Returns:

Status of 204 if the policy group and domain are associated or a status of 404 if either the policy group or domain with the given respective names do not exist.

disassociatePolicyGroupFromDomain

@DeleteMapping(value="groups/domain/{group}/{domain}")
public org.springframework.http.ResponseEntity<reactor.core.publisher.Mono<java.lang.Void>> disassociatePolicyGroupFromDomain(@PathVariable(value="group")
                                                                                                                                                                                     java.lang.String groupName,
                                                                                                                                                                                     @PathVariable(value="domain")
                                                                                                                                                                                     java.lang.String domainName)

Removed a policy group from a domain.

Parameters:

groupName - The policy group name to remove from the domain.

domainName - The domain name to remove from the policy group.

Returns:

A status of 200 if the policy group is removed from the domain or a status of 404 if either the policy group or domain with the given respective names do not exist.

disassociatePolicyGroupsFromDomain

@DeleteMapping(value="groups/domain/{domain}/deleteFromDomain")
 @Transactional
public org.springframework.http.ResponseEntity<reactor.core.publisher.Mono<java.lang.Void>> disassociatePolicyGroupsFromDomain(@PathVariable(value="domain")
                                                                                                                                                                                                               java.lang.String domainName)

Removes all policy groups for a given domain.

Parameters:

domainName - The domain to remove all policy groups from.

Returns:

Status of 204 if all policy groups are removed from the domain or a status or 404 if a domain with the given name does not exist.

disassociatePolicyGroupFromDomains

@DeleteMapping(value="groups/domain/{group}/deleteFromGroup")
public org.springframework.http.ResponseEntity<reactor.core.publisher.Mono<java.lang.Void>> disassociatePolicyGroupFromDomains(@PathVariable(value="group")
                                                                                                                                                                                             java.lang.String groupName)

Removes a given policy group from all domains.

Parameters:

groupName - The policy group to remove from all domains.

Returns:

Status of 200 if the policy group is removed from all domains or a status of 404 if the a policy group with the given name does not exist.