au.org.ala.sds.ws.resources

Class ConservationResource

java.lang.Object

au.org.ala.sds.ws.resources.ConservationResource

All Implemented Interfaces:

au.org.ala.sds.api.ConservationApi, Checkable, Closeable, AutoCloseable

@Produces(value="application/json")
 @Path(value="/api")
 @Singleton
public class ConservationResource
extends Object
implements au.org.ala.sds.api.ConservationApi, Closeable, Checkable

TODO add diagnostics to payload - similar to GBIF

Field Summary

Fields

Modifier and Type	Field and Description
static Set<org.gbif.dwc.terms.Term>	PROPERTIES_TO_REMOVE
static Set<org.gbif.dwc.terms.Term>	PROPERTIES_TO_REQUEST

Constructor Summary

Constructors

Constructor and Description
ConservationResource(SDSConfiguration configuration)

Method Summary

Modifier and Type	Method and Description
protected Set<org.gbif.dwc.terms.Term>	buildRequestTerms() Build the list of terms that might be needed.
boolean	check() Make sure that the system is still operating.
void	close() Close the resource.
protected boolean	doIsSensitive(au.org.ala.sds.api.SpeciesCheck check) Search for a sensitive data instance in the underlying SDS library.
List<au.org.ala.sds.generalise.Generalisation>	getGeneralisations()
List<String>	getSensitiveDataFields()
boolean	isSensitive(au.org.ala.sds.api.SpeciesCheck check)
boolean	isSensitive(String scientificName, String taxonId)
au.org.ala.sds.api.SensitivityReport	process(au.org.ala.sds.api.ProcessQuery query)
au.org.ala.sds.api.SensitivityReport	report(au.org.ala.sds.api.SensitivityQuery query)
au.org.ala.sds.api.SensitivityReport	report(String scientificName, String taxonId, String dataResourceUid, String stateProvince, String country, List<String> zones)

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTIES_TO_REMOVE

public static final Set<org.gbif.dwc.terms.Term> PROPERTIES_TO_REMOVE

PROPERTIES_TO_REQUEST

public static final Set<org.gbif.dwc.terms.Term> PROPERTIES_TO_REQUEST

Constructor Detail

ConservationResource

public ConservationResource(SDSConfiguration configuration)

Method Detail

buildRequestTerms

protected Set<org.gbif.dwc.terms.Term> buildRequestTerms()

Build the list of terms that might be needed.

Returns:

A set of terms that get used somewhere

check

public boolean check()

Make sure that the system is still operating.

Specified by:

check in interface Checkable

Returns:

True if things can still be found, etc.

getSensitiveDataFields

@GET
 @Path(value="/sensitiveDataFields")
public List<String> getSensitiveDataFields()

Specified by:

getSensitiveDataFields in interface au.org.ala.sds.api.ConservationApi

getGeneralisations

@GET
 @Path(value="/generalisations")
public List<au.org.ala.sds.generalise.Generalisation> getGeneralisations()

Specified by:

getGeneralisations in interface au.org.ala.sds.api.ConservationApi

isSensitive

@POST
 @Timed
 @Path(value="/isSensitive")
public boolean isSensitive(au.org.ala.sds.api.SpeciesCheck check)

Specified by:

isSensitive in interface au.org.ala.sds.api.ConservationApi

isSensitive

@GET
 @Timed
 @Path(value="/isSensitive")
public boolean isSensitive(@QueryParam(value="scientificName")
                                                                     String scientificName,
                                                                     @QueryParam(value="taxonId")
                                                                     String taxonId)

Specified by:

isSensitive in interface au.org.ala.sds.api.ConservationApi

doIsSensitive

protected boolean doIsSensitive(au.org.ala.sds.api.SpeciesCheck check)

Search for a sensitive data instance in the underlying SDS library.

Parameters:

check - What to check

Returns:

True for possibly sensitive, false otherwise

report

@POST
 @Path(value="/report")
public au.org.ala.sds.api.SensitivityReport report(au.org.ala.sds.api.SensitivityQuery query)

Specified by:

report in interface au.org.ala.sds.api.ConservationApi

report

@GET
 @Path(value="/report")
public au.org.ala.sds.api.SensitivityReport report(@QueryParam(value="scientificName")
                                                                                String scientificName,
                                                                                @QueryParam(value="taxonId")
                                                                                String taxonId,
                                                                                @QueryParam(value="dataResourceUid")
                                                                                String dataResourceUid,
                                                                                @QueryParam(value="stateProvince")
                                                                                String stateProvince,
                                                                                @QueryParam(value="country")
                                                                                String country,
                                                                                @QueryParam(value="zone")
                                                                                List<String> zones)

Specified by:

report in interface au.org.ala.sds.api.ConservationApi

process

@POST
 @Path(value="/process")
public au.org.ala.sds.api.SensitivityReport process(au.org.ala.sds.api.ProcessQuery query)

Specified by:

process in interface au.org.ala.sds.api.ConservationApi

close

public void close()

Close the resource.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable