Package org.opennms.web.rest.v2
Class NodeRestService
- java.lang.Object
-
- org.opennms.web.rest.v2.AbstractDaoRestServiceWithDTO<T,T,Q,K,I>
-
- org.opennms.web.rest.v2.AbstractDaoRestService<OnmsNode,org.apache.cxf.jaxrs.ext.search.SearchBean,java.lang.Integer,java.lang.String>
-
- org.opennms.web.rest.v2.NodeRestService
-
@Component @Transactional public class NodeRestService extends AbstractDaoRestService<OnmsNode,org.apache.cxf.jaxrs.ext.search.SearchBean,java.lang.Integer,java.lang.String>
Basic Web Service using REST forOnmsNode
entity- Author:
- Seth Leger, Alejandro Galue
-
-
Field Summary
-
Fields inherited from class org.opennms.web.rest.v2.AbstractDaoRestServiceWithDTO
DEFAULT_LIMIT
-
-
Constructor Summary
Constructors Constructor Description NodeRestService()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected JaxbListWrapper<OnmsNode>
createListWrapper(java.util.Collection<OnmsNode> list)
javax.ws.rs.core.Response
deleteMetaData(java.lang.String nodeCriteria, java.lang.String context)
javax.ws.rs.core.Response
deleteMetaData(java.lang.String nodeCriteria, java.lang.String context, java.lang.String key)
javax.ws.rs.core.Response
doCreate(javax.ws.rs.core.SecurityContext securityContext, javax.ws.rs.core.UriInfo uriInfo, OnmsNode object)
protected void
doDelete(javax.ws.rs.core.SecurityContext securityContext, javax.ws.rs.core.UriInfo uriInfo, OnmsNode node)
protected OnmsNode
doGet(javax.ws.rs.core.UriInfo uriInfo, java.lang.String id)
protected javax.ws.rs.core.Response
doUpdateProperties(javax.ws.rs.core.SecurityContext securityContext, javax.ws.rs.core.UriInfo uriInfo, OnmsNode targetObject, MultivaluedMapImpl params)
NodeCategoriesRestService
getCategoriesResource(javax.ws.rs.container.ResourceContext context)
protected java.util.Map<java.lang.String,CriteriaBehavior<?>>
getCriteriaBehaviors()
Map CXF query bean properties to Criteria property names, conversions, and actions.protected CriteriaBuilder
getCriteriaBuilder(javax.ws.rs.core.UriInfo uriInfo)
protected NodeDao
getDao()
protected java.lang.Class<OnmsNode>
getDaoClass()
NodeHardwareInventoryRestService
getHardwareInventoryResource(javax.ws.rs.container.ResourceContext context)
NodeIpInterfacesRestService
getIpInterfaceResource(javax.ws.rs.container.ResourceContext context)
OnmsMetaDataList
getMetaData(java.lang.String nodeCriteria)
OnmsMetaDataList
getMetaData(java.lang.String nodeCriteria, java.lang.String context)
OnmsMetaDataList
getMetaData(java.lang.String nodeCriteria, java.lang.String context, java.lang.String key)
protected java.lang.Class<org.apache.cxf.jaxrs.ext.search.SearchBean>
getQueryBeanClass()
protected java.util.Set<SearchProperty>
getQueryProperties()
Get a list of query properties that this endpoint supports for FIQL expressions andorderBy
expressions.NodeSnmpInterfacesRestService
getSnmpInterfaceResource(javax.ws.rs.container.ResourceContext context)
javax.ws.rs.core.Response
postMetaData(java.lang.String nodeCriteria, OnmsMetaData entity)
javax.ws.rs.core.Response
putMetaData(java.lang.String nodeCriteria, java.lang.String context, java.lang.String key, java.lang.String value)
-
Methods inherited from class org.opennms.web.rest.v2.AbstractDaoRestService
mapDTOToEntity, mapEntityToDTO
-
Methods inherited from class org.opennms.web.rest.v2.AbstractDaoRestServiceWithDTO
applyLimitOffsetOrderBy, create, createSpecific, delete, deleteMany, doUpdate, get, get, getCount, getCriteria, getException, getProperties, getPropertyValues, getSearchBeanPropertyMap, sendEvent, update, updateMany, updateProperties, writeLock, writeUnlock
-
-
-
-
Method Detail
-
getDao
protected NodeDao getDao()
- Specified by:
getDao
in classAbstractDaoRestServiceWithDTO<OnmsNode,OnmsNode,org.apache.cxf.jaxrs.ext.search.SearchBean,java.lang.Integer,java.lang.String>
-
getDaoClass
protected java.lang.Class<OnmsNode> getDaoClass()
- Specified by:
getDaoClass
in classAbstractDaoRestServiceWithDTO<OnmsNode,OnmsNode,org.apache.cxf.jaxrs.ext.search.SearchBean,java.lang.Integer,java.lang.String>
-
getQueryBeanClass
protected java.lang.Class<org.apache.cxf.jaxrs.ext.search.SearchBean> getQueryBeanClass()
- Specified by:
getQueryBeanClass
in classAbstractDaoRestServiceWithDTO<OnmsNode,OnmsNode,org.apache.cxf.jaxrs.ext.search.SearchBean,java.lang.Integer,java.lang.String>
-
getCriteriaBuilder
protected CriteriaBuilder getCriteriaBuilder(javax.ws.rs.core.UriInfo uriInfo)
- Specified by:
getCriteriaBuilder
in classAbstractDaoRestServiceWithDTO<OnmsNode,OnmsNode,org.apache.cxf.jaxrs.ext.search.SearchBean,java.lang.Integer,java.lang.String>
-
getQueryProperties
protected java.util.Set<SearchProperty> getQueryProperties()
Description copied from class:AbstractDaoRestServiceWithDTO
Get a list of query properties that this endpoint supports for FIQL expressions and
orderBy
expressions.- Overrides:
getQueryProperties
in classAbstractDaoRestServiceWithDTO<OnmsNode,OnmsNode,org.apache.cxf.jaxrs.ext.search.SearchBean,java.lang.Integer,java.lang.String>
- Returns:
-
getCriteriaBehaviors
protected java.util.Map<java.lang.String,CriteriaBehavior<?>> getCriteriaBehaviors()
Description copied from class:AbstractDaoRestServiceWithDTO
Map CXF query bean properties to Criteria property names, conversions, and actions. In the absence of a mapping, the query bean property will be specified directly as a Criteria property with the same name.
- Key: CXF query property name
- Value:
CriteriaBehavior
to execute when this search term is specified
- Overrides:
getCriteriaBehaviors
in classAbstractDaoRestServiceWithDTO<OnmsNode,OnmsNode,org.apache.cxf.jaxrs.ext.search.SearchBean,java.lang.Integer,java.lang.String>
- Returns:
-
createListWrapper
protected JaxbListWrapper<OnmsNode> createListWrapper(java.util.Collection<OnmsNode> list)
- Specified by:
createListWrapper
in classAbstractDaoRestServiceWithDTO<OnmsNode,OnmsNode,org.apache.cxf.jaxrs.ext.search.SearchBean,java.lang.Integer,java.lang.String>
-
doCreate
public javax.ws.rs.core.Response doCreate(javax.ws.rs.core.SecurityContext securityContext, javax.ws.rs.core.UriInfo uriInfo, OnmsNode object)
- Overrides:
doCreate
in classAbstractDaoRestServiceWithDTO<OnmsNode,OnmsNode,org.apache.cxf.jaxrs.ext.search.SearchBean,java.lang.Integer,java.lang.String>
-
doUpdateProperties
protected javax.ws.rs.core.Response doUpdateProperties(javax.ws.rs.core.SecurityContext securityContext, javax.ws.rs.core.UriInfo uriInfo, OnmsNode targetObject, MultivaluedMapImpl params)
- Overrides:
doUpdateProperties
in classAbstractDaoRestServiceWithDTO<OnmsNode,OnmsNode,org.apache.cxf.jaxrs.ext.search.SearchBean,java.lang.Integer,java.lang.String>
-
doDelete
protected void doDelete(javax.ws.rs.core.SecurityContext securityContext, javax.ws.rs.core.UriInfo uriInfo, OnmsNode node)
- Overrides:
doDelete
in classAbstractDaoRestServiceWithDTO<OnmsNode,OnmsNode,org.apache.cxf.jaxrs.ext.search.SearchBean,java.lang.Integer,java.lang.String>
-
doGet
protected OnmsNode doGet(javax.ws.rs.core.UriInfo uriInfo, java.lang.String id)
- Specified by:
doGet
in classAbstractDaoRestServiceWithDTO<OnmsNode,OnmsNode,org.apache.cxf.jaxrs.ext.search.SearchBean,java.lang.Integer,java.lang.String>
-
getIpInterfaceResource
public NodeIpInterfacesRestService getIpInterfaceResource(@Context javax.ws.rs.container.ResourceContext context)
-
getSnmpInterfaceResource
public NodeSnmpInterfacesRestService getSnmpInterfaceResource(@Context javax.ws.rs.container.ResourceContext context)
-
getHardwareInventoryResource
public NodeHardwareInventoryRestService getHardwareInventoryResource(@Context javax.ws.rs.container.ResourceContext context)
-
getCategoriesResource
public NodeCategoriesRestService getCategoriesResource(@Context javax.ws.rs.container.ResourceContext context)
-
getMetaData
public OnmsMetaDataList getMetaData(java.lang.String nodeCriteria)
-
getMetaData
public OnmsMetaDataList getMetaData(java.lang.String nodeCriteria, java.lang.String context)
-
getMetaData
public OnmsMetaDataList getMetaData(java.lang.String nodeCriteria, java.lang.String context, java.lang.String key)
-
deleteMetaData
public javax.ws.rs.core.Response deleteMetaData(java.lang.String nodeCriteria, java.lang.String context)
-
deleteMetaData
public javax.ws.rs.core.Response deleteMetaData(java.lang.String nodeCriteria, java.lang.String context, java.lang.String key)
-
postMetaData
public javax.ws.rs.core.Response postMetaData(java.lang.String nodeCriteria, OnmsMetaData entity)
-
putMetaData
public javax.ws.rs.core.Response putMetaData(java.lang.String nodeCriteria, java.lang.String context, java.lang.String key, java.lang.String value)
-
-