Package org.opennms.web.rest.v2

Class IfServiceRestService

java.lang.Object

org.opennms.web.rest.v2.AbstractDaoRestServiceWithDTO<T,T,Q,K,I>

org.opennms.web.rest.v2.AbstractDaoRestService<OnmsMonitoredService,org.apache.cxf.jaxrs.ext.search.SearchBean,java.lang.Integer,java.lang.String>

org.opennms.web.rest.v2.IfServiceRestService

@Component
@Transactional
public class IfServiceRestService
extends AbstractDaoRestService<OnmsMonitoredService,org.apache.cxf.jaxrs.ext.search.SearchBean,java.lang.Integer,java.lang.String>

Basic Web Service using REST for OnmsMonitoredService entity.

This end-point exist to retrieve and update a set of monitored services at once, based on a given criteria.

This facilitates moving services to maintenance mode (and restore the services to be online).

Author:

Alejandro Galue

Field Summary

Fields inherited from class org.opennms.web.rest.v2.AbstractDaoRestServiceWithDTO

DEFAULT_LIMIT

Constructor Summary

Constructors

Constructor	Description
IfServiceRestService()

Method Summary

Modifier and Type	Method	Description
protected JaxbListWrapper<OnmsMonitoredService>	createListWrapper(java.util.Collection<OnmsMonitoredService> list)
protected OnmsMonitoredService	doGet(javax.ws.rs.core.UriInfo uriInfo, java.lang.String serviceName)
protected javax.ws.rs.core.Response	doUpdateProperties(javax.ws.rs.core.SecurityContext securityContext, javax.ws.rs.core.UriInfo uriInfo, OnmsMonitoredService targetObject, MultivaluedMapImpl params)
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 MonitoredServiceDao	getDao()
protected java.lang.Class<OnmsMonitoredService>	getDaoClass()
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 and orderBy expressions.

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, doCreate, doDelete, doUpdate, get, get, getCount, getCriteria, getException, getProperties, getPropertyValues, getSearchBeanPropertyMap, sendEvent, update, updateMany, updateProperties, writeLock, writeUnlock

Methods inherited from class java.lang.Object

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

Constructor Detail

IfServiceRestService

public IfServiceRestService()

Method Detail

getDao

protected MonitoredServiceDao getDao()

Specified by:

getDao in class AbstractDaoRestServiceWithDTO<OnmsMonitoredService,OnmsMonitoredService,org.apache.cxf.jaxrs.ext.search.SearchBean,java.lang.Integer,java.lang.String>

getDaoClass

protected java.lang.Class<OnmsMonitoredService> getDaoClass()

Specified by:

getDaoClass in class AbstractDaoRestServiceWithDTO<OnmsMonitoredService,OnmsMonitoredService,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 class AbstractDaoRestServiceWithDTO<OnmsMonitoredService,OnmsMonitoredService,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 class AbstractDaoRestServiceWithDTO<OnmsMonitoredService,OnmsMonitoredService,org.apache.cxf.jaxrs.ext.search.SearchBean,java.lang.Integer,java.lang.String>

createListWrapper

protected JaxbListWrapper<OnmsMonitoredService> createListWrapper(java.util.Collection<OnmsMonitoredService> list)

Specified by:

createListWrapper in class AbstractDaoRestServiceWithDTO<OnmsMonitoredService,OnmsMonitoredService,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 class AbstractDaoRestServiceWithDTO<OnmsMonitoredService,OnmsMonitoredService,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 class AbstractDaoRestServiceWithDTO<OnmsMonitoredService,OnmsMonitoredService,org.apache.cxf.jaxrs.ext.search.SearchBean,java.lang.Integer,java.lang.String>

Returns:

doUpdateProperties

protected javax.ws.rs.core.Response doUpdateProperties(javax.ws.rs.core.SecurityContext securityContext,
                                                       javax.ws.rs.core.UriInfo uriInfo,
                                                       OnmsMonitoredService targetObject,
                                                       MultivaluedMapImpl params)

Overrides:

doUpdateProperties in class AbstractDaoRestServiceWithDTO<OnmsMonitoredService,OnmsMonitoredService,org.apache.cxf.jaxrs.ext.search.SearchBean,java.lang.Integer,java.lang.String>

doGet

protected OnmsMonitoredService doGet(javax.ws.rs.core.UriInfo uriInfo,
                                     java.lang.String serviceName)

Specified by:

doGet in class AbstractDaoRestServiceWithDTO<OnmsMonitoredService,OnmsMonitoredService,org.apache.cxf.jaxrs.ext.search.SearchBean,java.lang.Integer,java.lang.String>