org.opennms.web.rest.v1

Class OnmsRestService

java.lang.Object

org.opennms.web.rest.v1.OnmsRestService

Direct Known Subclasses:

AcknowledgmentRestService, AlarmRestServiceBase, AssetRecordResource, AssetSuggestionsRestService, AvailabilityRestService, CategoryRestService, ConfigRestService, EmailNorthbounderConfigurationResource, EventRestService, ForeignSourceConfigRestService, ForeignSourceRestService, GraphRestService, GroupRestService, HardwareInventoryResource, HeatMapRestService, IfServicesRestService, InfoRestService, JavamailConfigurationResource, KscRestService, MinionRestService, MonitoringLocationsRestService, NodeRestService, NotificationRestService, OnmsIpInterfaceResource, OnmsMonitoredServiceResource, OnmsSnmpInterfaceResource, OutageRestService, RemotePollerAvailabilityService, RequisitionNamesRestService, RequisitionRestService, ResourceRestService, ScheduledOutagesRestService, SnmpConfigRestService, SnmpTrapNorthbounderConfigurationResource, SyslogNorthbounderConfigurationResource, TimelineRestService, UserRestService, WebAssetsRestService

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

Modifier and Type	Method and Description
protected static void	applyQueryFilters(javax.ws.rs.core.MultivaluedMap<String,String> p, CriteriaBuilder builder)
protected static void	applyQueryFilters(javax.ws.rs.core.MultivaluedMap<String,String> p, CriteriaBuilder builder, Integer defaultLimit)
protected javax.ws.rs.core.Response	getBadRequestResponse(String message)
protected static org.springframework.beans.BeanWrapper	getBeanWrapperForClass(Class<?> criteriaClass)
protected static <T> javax.ws.rs.WebApplicationException	getException(javax.ws.rs.core.Response.Status status, String msg, String... params) throwException
protected static <T> javax.ws.rs.WebApplicationException	getException(javax.ws.rs.core.Response.Status status, Throwable t)
protected Integer	getNumericValue(String number)
protected static URI	getRedirectUri(javax.ws.rs.core.UriInfo uriInfo, Object... pathComponents)
protected void	readLock()
protected void	readUnlock()
protected static String	removeParameter(javax.ws.rs.core.MultivaluedMap<String,String> params, String key)
protected static String	removeParameter(javax.ws.rs.core.MultivaluedMap<String,String> params, String key, String defaultValue)
protected static 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 final void readLock()

readUnlock

protected final void readUnlock()

writeLock

protected final void writeLock()

writeUnlock

protected final void writeUnlock()

applyQueryFilters

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

applyQueryFilters

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

getBeanWrapperForClass

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

removeParameter

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

removeParameter

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

getException

protected static <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 static <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

getRedirectUri

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

setProperties

protected static void setProperties(MultivaluedMapImpl params,
                                    Object req)

setProperties

Parameters:

params - a MultivaluedMapImpl object.

req - a Object object.

getBadRequestResponse

protected javax.ws.rs.core.Response getBadRequestResponse(String message)

getNumericValue

protected Integer getNumericValue(String number)