Package org.opennms.web.rest.v2
Class IpInterfaceRestService
- java.lang.Object
-
- org.opennms.web.rest.v2.AbstractDaoRestServiceWithDTO<T,T,Q,K,I>
-
- org.opennms.web.rest.v2.AbstractDaoRestService<OnmsIpInterface,org.apache.cxf.jaxrs.ext.search.SearchBean,java.lang.Integer,java.lang.String>
-
- org.opennms.web.rest.v2.IpInterfaceRestService
-
@Component @Transactional public class IpInterfaceRestService extends AbstractDaoRestService<OnmsIpInterface,org.apache.cxf.jaxrs.ext.search.SearchBean,java.lang.Integer,java.lang.String>
Basic Web Service using REST forOnmsIpInterface
entity.This end-point exist to retrieve and update a set of IP interfaces, based on a given criteria.
-
-
Field Summary
-
Fields inherited from class org.opennms.web.rest.v2.AbstractDaoRestServiceWithDTO
DEFAULT_LIMIT
-
-
Constructor Summary
Constructors Constructor Description IpInterfaceRestService()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected JaxbListWrapper<OnmsIpInterface>
createListWrapper(java.util.Collection<OnmsIpInterface> list)
protected OnmsIpInterface
doGet(javax.ws.rs.core.UriInfo uriInfo, java.lang.String ipAddress)
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 IpInterfaceDao
getDao()
protected java.lang.Class<OnmsIpInterface>
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 andorderBy
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, doUpdateProperties, get, get, getCount, getCriteria, getException, getProperties, getPropertyValues, getSearchBeanPropertyMap, sendEvent, update, updateMany, updateProperties, writeLock, writeUnlock
-
-
-
-
Method Detail
-
getDao
protected IpInterfaceDao getDao()
- Specified by:
getDao
in classAbstractDaoRestServiceWithDTO<OnmsIpInterface,OnmsIpInterface,org.apache.cxf.jaxrs.ext.search.SearchBean,java.lang.Integer,java.lang.String>
-
getDaoClass
protected java.lang.Class<OnmsIpInterface> getDaoClass()
- Specified by:
getDaoClass
in classAbstractDaoRestServiceWithDTO<OnmsIpInterface,OnmsIpInterface,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<OnmsIpInterface,OnmsIpInterface,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<OnmsIpInterface,OnmsIpInterface,org.apache.cxf.jaxrs.ext.search.SearchBean,java.lang.Integer,java.lang.String>
-
createListWrapper
protected final JaxbListWrapper<OnmsIpInterface> createListWrapper(java.util.Collection<OnmsIpInterface> list)
- Specified by:
createListWrapper
in classAbstractDaoRestServiceWithDTO<OnmsIpInterface,OnmsIpInterface,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<OnmsIpInterface,OnmsIpInterface,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<OnmsIpInterface,OnmsIpInterface,org.apache.cxf.jaxrs.ext.search.SearchBean,java.lang.Integer,java.lang.String>
- Returns:
-
doGet
protected final OnmsIpInterface doGet(javax.ws.rs.core.UriInfo uriInfo, java.lang.String ipAddress)
- Specified by:
doGet
in classAbstractDaoRestServiceWithDTO<OnmsIpInterface,OnmsIpInterface,org.apache.cxf.jaxrs.ext.search.SearchBean,java.lang.Integer,java.lang.String>
-
-