au.org.ala.biocache.web

Class AssertionController

java.lang.Object

au.org.ala.biocache.web.AbstractSecureController

au.org.ala.biocache.web.AssertionController

@Controller
public class AssertionController
extends AbstractSecureController

This controller provides web services for assertion creation/deletion. TODO Add support for API keys so that only registered applications can use these functions.

Field Summary

Fields

Modifier and Type	Field and Description
protected AssertionUtils	assertionUtils
protected AuthService	authService
protected String	registryUrl

Fields inherited from class au.org.ala.biocache.web.AbstractSecureController

apiCheckUrl

Constructor Summary

Constructors

Constructor and Description
AssertionController()

Method Summary

Methods

Modifier and Type	Method and Description
void	addAssertion(String recordUuid, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) add an assertion
void	addAssertionWithParams(String recordUuid, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This version of the method can handle the situation where we use rowKeys as Uuids.
void	addBulkAssertions(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Adds a bulk list of assertions.
void	deleteAssertion(String recordUuid, String assertionUuid, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Remove an assertion
void	deleteAssertionWithParams(String recordUuid, String assertionUuid, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Removes an assertion This version of the method can handle the situation where we use rowKeys as Uuids.
au.org.ala.biocache.model.QualityAssertion	getAssertion(String recordUuid, String assertionUuid, javax.servlet.http.HttpServletResponse response) Get single assertion
List<au.org.ala.biocache.model.QualityAssertion>	getAssertions(String recordUuid) Get user assertions
Object	getAssertionWithParams(String recordUuid, String assertionUuid, javax.servlet.http.HttpServletResponse response)
void	setAssertionUtils(AssertionUtils assertionUtils)
au.org.ala.biocache.vocab.ErrorCode[]	showCodes() Retrieve an array of the assertion codes in use by the processing system
au.org.ala.biocache.vocab.ErrorCode[]	showGeospatialCodes()
au.org.ala.biocache.vocab.ErrorCode[]	showMiscellaneousCodes()
au.org.ala.biocache.vocab.ErrorCode[]	showTaxonomicCodes()
au.org.ala.biocache.vocab.ErrorCode[]	showTemporalCodes()
au.org.ala.biocache.vocab.ErrorCode[]	showUserCodes()

Methods inherited from class au.org.ala.biocache.web.AbstractSecureController

isValidKey, shouldPerformOperation, shouldPerformOperation

Methods inherited from class java.lang.Object

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

Field Detail

assertionUtils

@Inject
protected AssertionUtils assertionUtils

registryUrl

protected String registryUrl

authService

@Inject
protected AuthService authService

Constructor Detail

AssertionController

public AssertionController()

Method Detail

showCodes

@RequestMapping(value={"/assertions/codes","/assertions/codes/"},
                method=GET)
@ResponseBody
public au.org.ala.biocache.vocab.ErrorCode[] showCodes()
                                                throws Exception

Retrieve an array of the assertion codes in use by the processing system

Returns:

an array of codes

Throws:

Exception

showGeospatialCodes

@RequestMapping(value={"/assertions/geospatial/codes","/assertions/geospatial/codes/"},
                method=GET)
@ResponseBody
public au.org.ala.biocache.vocab.ErrorCode[] showGeospatialCodes()
                                                          throws Exception

Throws:

Exception

showTaxonomicCodes

@RequestMapping(value={"/assertions/taxonomic/codes","/assertions/taxonomic/codes/"},
                method=GET)
@ResponseBody
public au.org.ala.biocache.vocab.ErrorCode[] showTaxonomicCodes()
                                                         throws Exception

Throws:

Exception

showTemporalCodes

@RequestMapping(value={"/assertions/temporal/codes","/assertions/temporal/codes/"},
                method=GET)
@ResponseBody
public au.org.ala.biocache.vocab.ErrorCode[] showTemporalCodes()
                                                        throws Exception

Throws:

Exception

showMiscellaneousCodes

@RequestMapping(value={"/assertions/miscellaneous/codes","/assertions/miscellaneous/codes/"},
                method=GET)
@ResponseBody
public au.org.ala.biocache.vocab.ErrorCode[] showMiscellaneousCodes()
                                                             throws Exception

Throws:

Exception

showUserCodes

@RequestMapping(value={"/assertions/user/codes","/assertions/user/codes/"},
                method=GET)
@ResponseBody
public au.org.ala.biocache.vocab.ErrorCode[] showUserCodes()
                                                    throws Exception

Throws:

Exception

addAssertionWithParams

@RequestMapping(value="/occurrences/assertions/add",
                method=POST)
public void addAssertionWithParams(@RequestParam(value="recordUuid",required=true)
                                         String recordUuid,
                                         javax.servlet.http.HttpServletRequest request,
                                         javax.servlet.http.HttpServletResponse response)
                            throws Exception

This version of the method can handle the situation where we use rowKeys as Uuids. Thus URL style rowKeys can be correctly supported.

Parameters:

recordUuid -

request -

response -

Throws:

Exception

addBulkAssertions

@RequestMapping(value="/bulk/assertions/add",
                method=POST)
public void addBulkAssertions(javax.servlet.http.HttpServletRequest request,
                                    javax.servlet.http.HttpServletResponse response)
                       throws Exception

Adds a bulk list of assertions. This method expects certain request params to be provided apiKey userId userDisplayName assertions - a json list of assertion maps to be applied.

Parameters:

request -

response -

Throws:

Exception

addAssertion

@RequestMapping(value="/occurrences/{recordUuid}/assertions/add",
                method=POST)
public void addAssertion(@PathVariable(value="recordUuid")
                               String recordUuid,
                               javax.servlet.http.HttpServletRequest request,
                               javax.servlet.http.HttpServletResponse response)
                  throws Exception

add an assertion

Throws:

Exception

deleteAssertionWithParams

@RequestMapping(value="/occurrences/assertions/delete",
                method=POST)
public void deleteAssertionWithParams(@RequestParam(value="recordUuid",required=true)
                                            String recordUuid,
                                            @RequestParam(value="assertionUuid",required=true)
                                            String assertionUuid,
                                            javax.servlet.http.HttpServletRequest request,
                                            javax.servlet.http.HttpServletResponse response)
                               throws Exception

Removes an assertion This version of the method can handle the situation where we use rowKeys as Uuids. Thus URL style rowKeys can be correctly supported.

Parameters:

recordUuid -

assertionUuid -

request -

response -

Throws:

Exception

deleteAssertion

@RequestMapping(value="/occurrences/{recordUuid}/assertions/delete",
                method=POST)
public void deleteAssertion(@PathVariable(value="recordUuid")
                                  String recordUuid,
                                  @RequestParam(value="assertionUuid",required=true)
                                  String assertionUuid,
                                  javax.servlet.http.HttpServletRequest request,
                                  javax.servlet.http.HttpServletResponse response)
                     throws Exception

Remove an assertion

Throws:

Exception

getAssertionWithParams

@RequestMapping(value={"/occurrences/assertions","/occurrences/assertions/"},
                method=GET)
@ResponseBody
public Object getAssertionWithParams(@RequestParam(value="recordUuid",required=true)
                                                        String recordUuid,
                                                        @RequestParam(value="assertionUuid",required=false)
                                                        String assertionUuid,
                                                        javax.servlet.http.HttpServletResponse response)
                              throws Exception

Throws:

Exception

getAssertion

@RequestMapping(value={"/occurrences/{recordUuid}/assertions/{assertionUuid}","/occurrences/{recordUuid}/assertions/{assertionUuid}/"},
                method=GET)
@ResponseBody
public au.org.ala.biocache.model.QualityAssertion getAssertion(@PathVariable(value="recordUuid")
                                                                                  String recordUuid,
                                                                                  @PathVariable(value="assertionUuid")
                                                                                  String assertionUuid,
                                                                                  javax.servlet.http.HttpServletResponse response)
                                                        throws Exception

Get single assertion

Throws:

Exception

getAssertions

@RequestMapping(value={"/occurrences/{recordUuid}/assertions","/occurrences/{recordUuid}/assertions/"},
                method=GET)
@ResponseBody
public List<au.org.ala.biocache.model.QualityAssertion> getAssertions(@PathVariable(value="recordUuid")
                                                                                         String recordUuid)
                                                               throws Exception

Get user assertions

Throws:

Exception

setAssertionUtils

public void setAssertionUtils(AssertionUtils assertionUtils)