au.org.ala.biocache.web

Class AdminController

java.lang.Object

au.org.ala.biocache.web.AbstractSecureController

au.org.ala.biocache.web.AdminController

@Controller
public class AdminController
extends AbstractSecureController

Provides administration web services for the biocache-service. All services should require an API key.

Author:

"Natasha Carter "

Field Summary

Fields

Modifier and Type	Field and Description
protected AuthService	authService
protected Integer	ingestProcessingThreads

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

apiCheckUrl

Constructor Summary

Constructors

Constructor and Description
AdminController()

Method Summary

Methods

Modifier and Type	Method and Description
void	ingestResources(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Ingests the list of supplied data resource uids.
boolean	isReadOnly() Returns true when in service is in readonly mode.
List<String>	modifyServer(Boolean readOnly, Boolean reopenIndex) Modifies the biocache-store: - reopen the index - enter/exit readonly mode.
void	optimiseIndex(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Optimises the SOLR index.
String	refreshAuth() Returns true when in service is in readonly mode.
void	reindex(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Reindexes the supplied dr based on modifications since the supplied date.
void	setAuthService(AuthService authService)

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

authService

@Inject
protected AuthService authService

ingestProcessingThreads

protected Integer ingestProcessingThreads

Constructor Detail

AdminController

public AdminController()

Method Detail

ingestResources

@RequestMapping(value="/admin/ingest",
                method=GET)
public void ingestResources(javax.servlet.http.HttpServletRequest request,
                                  javax.servlet.http.HttpServletResponse response)
                     throws Exception

Ingests the list of supplied data resource uids. When no dr param is provided all data resources with the configured collectory are ingested. Prevents the exact same ingestion from being started multiple times. Only prevents the exact same list of drs being started.

Parameters:

request -

response -

Throws:

Exception

optimiseIndex

@RequestMapping(value="/admin/index/optimise",
                method=POST)
public void optimiseIndex(javax.servlet.http.HttpServletRequest request,
                                javax.servlet.http.HttpServletResponse response)
                   throws Exception

Optimises the SOLR index. Use this API to optimise the index so that the biocache-service can enter read only mode during this process.

Parameters:

request -

response -

Throws:

Exception

modifyServer

@RequestMapping(value="/admin/modify*",
                method=GET)
@ResponseBody
public List<String> modifyServer(@RequestParam(value="ro",required=false)
                                                    Boolean readOnly,
                                                    @RequestParam(value="reopenIndex",required=false,defaultValue="false")
                                                    Boolean reopenIndex)
                          throws Exception

Modifies the biocache-store: - reopen the index - enter/exit readonly mode.

Parameters:

readOnly -

reopenIndex -

Returns:

Throws:

Exception

reindex

@RequestMapping(value="/admin/index/reindex",
                method=POST)
public void reindex(javax.servlet.http.HttpServletRequest request,
                          javax.servlet.http.HttpServletResponse response)
             throws Exception

Reindexes the supplied dr based on modifications since the supplied date.

Parameters:

request -

response -

Throws:

Exception

isReadOnly

@RequestMapping(value="/admin/isReadOnly",
                method=GET)
@ResponseBody
public boolean isReadOnly()

Returns true when in service is in readonly mode.

Returns:

refreshAuth

@RequestMapping(value="/admin/refreshAuth",
                method=GET)
@ResponseBody
public String refreshAuth()

Returns true when in service is in readonly mode.

Returns:

setAuthService

public void setAuthService(AuthService authService)