org.dataone.cn.rest.v2

Class RegistryController

java.lang.Object

org.dataone.cn.rest.AbstractServiceController

org.dataone.cn.rest.v2.RegistryController

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.web.context.ServletContextAware

@Controller(value="nodeControllerV2")
public class RegistryController
extends AbstractServiceController
implements org.springframework.web.context.ServletContextAware

This package will expose endpoints to handle manipulation of the Node Registry structure.

Author:

waltz

Field Summary

Fields inherited from class org.dataone.cn.rest.AbstractServiceController

FRAGMENT_REQUEST_PARAM_KEY, SCHEME_REQUEST_PARAM_KEY

Constructor Summary

Constructors

Constructor and Description
RegistryController()

Method Summary

Modifier and Type	Method and Description
com.hazelcast.core.HazelcastInstance	getHazelcastInstance()
org.springframework.web.servlet.ModelAndView	getNode(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String nodeId) Pass in a Node Identifier and receive back the node structure.
org.springframework.web.servlet.ModelAndView	getNodeList(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Returns a list of nodes that have been registered with and approved by the DataONE infrastructure.
void	init() Initialize class scope variables immediately after the controller has been initialized by Spring
org.springframework.web.servlet.ModelAndView	register(org.springframework.web.multipart.MultipartHttpServletRequest fileRequest, javax.servlet.http.HttpServletResponse response)
void	setHazelcastInstance(com.hazelcast.core.HazelcastInstance hazelcastInstance)
void	setServletContext(javax.servlet.ServletContext sc)
void	updateNodeCapabilities(org.springframework.web.multipart.MultipartHttpServletRequest fileRequest, javax.servlet.http.HttpServletResponse response, String nodeId) For updating the capabilities of the specified node.

Methods inherited from class org.dataone.cn.rest.AbstractServiceController

debugRequest, extractPidFromRequestParam, extractPidFromRequestURI, extractSubjectFromRequestParam, extractValueFromRequestParam, handleBaseException, handleException, handleException, handleException, handleException, handleException, handleException, handleException, handleException, handleException, handleException, handleException, handleException, handleException, handleException, handleException, handleException

Methods inherited from class java.lang.Object

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

Constructor Detail

RegistryController

public RegistryController()

Method Detail

init

@PostConstruct
public void init()

Initialize class scope variables immediately after the controller has been initialized by Spring

getNodeList

@RequestMapping(value={"/v2/node","/v2/node/"},
                method=GET)
public org.springframework.web.servlet.ModelAndView getNodeList(javax.servlet.http.HttpServletRequest request,
                                                                                                                                            javax.servlet.http.HttpServletResponse response)
                                                                                                                                     throws org.dataone.service.exceptions.ServiceFailure,
                                                                                                                                            org.dataone.service.exceptions.NotImplemented

Returns a list of nodes that have been registered with and approved by the DataONE infrastructure. There is always an exception to the rule that makes order difficult. Trying to rig this up to the CoreController (listNodes is apart of the CN.Core API) will result in failure due to the fact that RegistryController maps the /v1/node URL path to itself due to the register node method. Two controllers can not map the same URL path, even though they have different HTTP Request methods

Parameters:

request -

response -

Returns:

ModelAndView

Throws:

org.dataone.service.exceptions.NotImplemented

org.dataone.service.exceptions.ServiceFailure

getNode

@RequestMapping(value="/v2/node/{nodeId}",
                method=GET)
public org.springframework.web.servlet.ModelAndView getNode(javax.servlet.http.HttpServletRequest request,
                                                                                                                                   javax.servlet.http.HttpServletResponse response,
                                                                                                                                   @PathVariable
                                                                                                                                   String nodeId)
                                                                                                                            throws org.dataone.service.exceptions.ServiceFailure,
                                                                                                                                   org.dataone.service.exceptions.NotFound

Pass in a Node Identifier and receive back the node structure.

Parameters:

request -

response -

nodeId -

Returns:

ModelAndView

Throws:

org.dataone.service.exceptions.NotFound

org.dataone.service.exceptions.ServiceFailure

updateNodeCapabilities

@RequestMapping(value="/v2/node/{nodeId}",
                method=PUT)
public void updateNodeCapabilities(org.springframework.web.multipart.MultipartHttpServletRequest fileRequest,
                                                                                                          javax.servlet.http.HttpServletResponse response,
                                                                                                          @PathVariable
                                                                                                          String nodeId)
                                                                                                   throws org.dataone.service.exceptions.InvalidToken,
                                                                                                          org.dataone.service.exceptions.ServiceFailure,
                                                                                                          org.dataone.service.exceptions.InvalidRequest,
                                                                                                          org.dataone.service.exceptions.IdentifierNotUnique,
                                                                                                          org.dataone.service.exceptions.NotAuthorized,
                                                                                                          org.dataone.service.exceptions.NotImplemented,
                                                                                                          org.dataone.service.exceptions.NotFound

For updating the capabilities of the specified node. Most information is replaced by information in the new node, however, the node identifier, nodeType, ping, syncrhonization.lastHarvested, and synchronization.lastCompleteHarvest are preserved from the existing entry. Services in the old record not included in the new Node will be removed. Successful completion of this operation is indicated by a HTTP response status code of 200. Unsuccessful completion of this operation MUST be indicated by returning an appropriate exception.

Parameters:

fileRequest -

response -

nodeId -

Throws:

org.dataone.service.exceptions.InvalidToken

org.dataone.service.exceptions.InvalidRequest

org.dataone.service.exceptions.IdentifierNotUnique

org.dataone.service.exceptions.NotAuthorized

org.dataone.service.exceptions.NotImplemented

org.dataone.service.exceptions.NotFound

org.dataone.service.exceptions.ServiceFailure

register

@RequestMapping(value={"/v2/node","/v2/node/"},
                method=POST)
public org.springframework.web.servlet.ModelAndView register(org.springframework.web.multipart.MultipartHttpServletRequest fileRequest,
                                                                                                                                          javax.servlet.http.HttpServletResponse response)
                                                                                                                                   throws org.dataone.service.exceptions.ServiceFailure,
                                                                                                                                          org.dataone.service.exceptions.NotImplemented,
                                                                                                                                          org.dataone.service.exceptions.InvalidRequest,
                                                                                                                                          org.dataone.service.exceptions.NotAuthorized,
                                                                                                                                          org.dataone.service.exceptions.IdentifierNotUnique,
                                                                                                                                          org.dataone.service.exceptions.InvalidToken

Throws:

org.dataone.service.exceptions.ServiceFailure

org.dataone.service.exceptions.NotImplemented

org.dataone.service.exceptions.InvalidRequest

org.dataone.service.exceptions.NotAuthorized

org.dataone.service.exceptions.IdentifierNotUnique

org.dataone.service.exceptions.InvalidToken

setServletContext

public void setServletContext(javax.servlet.ServletContext sc)

Specified by:

setServletContext in interface org.springframework.web.context.ServletContextAware

getHazelcastInstance

public com.hazelcast.core.HazelcastInstance getHazelcastInstance()

setHazelcastInstance

public void setHazelcastInstance(com.hazelcast.core.HazelcastInstance hazelcastInstance)