org.opennms.web.rest

Class OnmsRestService

java.lang.Object

org.opennms.web.rest.OnmsRestService

Direct Known Subclasses:

AcknowledgmentRestService, AlarmRestServiceBase, AssetRecordResource, AvailabilityRestService, CategoryRestService, ConfigRestService, DataLinkInterfaceRestService, EventRestService, ForeignSourceRestService, GroupRestService, HardwareInventoryResource, IfServicesRestService, InfoRestService, KscRestService, MetricsResourceResource, NodeRestService, NotificationRestService, OnmsIpInterfaceResource, OnmsMapElementResource, OnmsMapRestService, OnmsMonitoredServiceResource, OnmsSnmpInterfaceResource, OutageRestService, RemotePollerAvailabilityService, RequisitionRestService, ScheduledOutagesRestService, SnmpConfigRestService, TimelineRestService, UserRestService

public class OnmsRestService
extends Object

OnmsRestService class.

Since:

1.8.1

Version:

$Id: $

Author:

ranger

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	OnmsRestService.ComparisonOperation

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	DEFAULT_LIMIT

Constructor Summary

Constructors

Constructor and Description
OnmsRestService() Constructor for OnmsRestService.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	applyQueryFilters(javax.ws.rs.core.MultivaluedMap<String,String> p, CriteriaBuilder builder)
protected void	applyQueryFilters(javax.ws.rs.core.MultivaluedMap<String,String> p, CriteriaBuilder builder, Integer defaultLimit)
static String	convertNameToPropertyName(String name) Convert a column name with underscores to the corresponding property name using "camel case".
protected org.springframework.beans.BeanWrapper	getBeanWrapperForClass(Class<?> criteriaClass)
protected <T> javax.ws.rs.WebApplicationException	getException(javax.ws.rs.core.Response.Status status, String msg, String... params) throwException
protected <T> javax.ws.rs.WebApplicationException	getException(javax.ws.rs.core.Response.Status status, Throwable t)
protected static URI	getRedirectUri(javax.ws.rs.core.UriInfo m_uriInfo, Object... pathComponents)
protected void	readLock()
protected void	readUnlock()
protected String	removeParameter(javax.ws.rs.core.MultivaluedMap<String,String> params, String key)
protected String	removeParameter(javax.ws.rs.core.MultivaluedMap<String,String> params, String key, String defaultValue)
protected void	setProperties(MultivaluedMapImpl params, Object req) setProperties
protected void	writeLock()
protected void	writeUnlock()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_LIMIT

protected static final int DEFAULT_LIMIT

See Also:

Constant Field Values

Constructor Detail

OnmsRestService

public OnmsRestService()

Constructor for OnmsRestService.

Method Detail

readLock

protected void readLock()

readUnlock

protected void readUnlock()

writeLock

protected void writeLock()

writeUnlock

protected void writeUnlock()

applyQueryFilters

protected void applyQueryFilters(javax.ws.rs.core.MultivaluedMap<String,String> p,
                     CriteriaBuilder builder)

applyQueryFilters

protected void applyQueryFilters(javax.ws.rs.core.MultivaluedMap<String,String> p,
                     CriteriaBuilder builder,
                     Integer defaultLimit)

getBeanWrapperForClass

protected org.springframework.beans.BeanWrapper getBeanWrapperForClass(Class<?> criteriaClass)

removeParameter

protected String removeParameter(javax.ws.rs.core.MultivaluedMap<String,String> params,
                     String key)

removeParameter

protected String removeParameter(javax.ws.rs.core.MultivaluedMap<String,String> params,
                     String key,
                     String defaultValue)

getException

protected <T> javax.ws.rs.WebApplicationException getException(javax.ws.rs.core.Response.Status status,
                                                   String msg,
                                                   String... params)
                                                    throws javax.ws.rs.WebApplicationException

throwException

Type Parameters:

T - a T object.

Parameters:

status - a Response.Status object.

msg - a String object.

Returns:

a T object.

Throws:

javax.ws.rs.WebApplicationException

getException

protected <T> javax.ws.rs.WebApplicationException getException(javax.ws.rs.core.Response.Status status,
                                                   Throwable t)
                                                    throws javax.ws.rs.WebApplicationException

Throws:

javax.ws.rs.WebApplicationException

convertNameToPropertyName

public static String convertNameToPropertyName(String name)

Convert a column name with underscores to the corresponding property name using "camel case". A name like "customer_number" would match a "customerNumber" property name.

Parameters:

name - the column name to be converted

Returns:

the name using "camel case"

getRedirectUri

protected static URI getRedirectUri(javax.ws.rs.core.UriInfo m_uriInfo,
                 Object... pathComponents)

setProperties

protected void setProperties(MultivaluedMapImpl params,
                 Object req)

setProperties

Parameters:

params - a MultivaluedMapImpl object.

req - a Object object.