Package org.opennms.web.rest.v1

Class ForeignSourceConfigRestService

java.lang.Object

org.opennms.web.rest.v1.OnmsRestService

org.opennms.web.rest.v1.ForeignSourceConfigRestService

All Implemented Interfaces:

org.springframework.beans.factory.InitializingBean

@Component("foreignSourceConfigRestService")
@Path("foreignSourcesConfig")
public class ForeignSourceConfigRestService
extends OnmsRestService
implements org.springframework.beans.factory.InitializingBean

The Class ForeignSourceConfigRestService.

Author:

Alejandro Galue

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ForeignSourceConfigRestService.ElementList	The Class ElementList.
static class	ForeignSourceConfigRestService.ParameterComparator	The Class ParameterComparator.
static class	ForeignSourceConfigRestService.SimplePluginConfig	The Class SimplePluginConfig.
static class	ForeignSourceConfigRestService.SimplePluginConfigList	The Class SimplePluginConfigList.
static class	ForeignSourceConfigRestService.SimplePluginParameter	The Class SimplePluginParameter.

Nested classes/interfaces inherited from class org.opennms.web.rest.v1.OnmsRestService

OnmsRestService.ComparisonOperation

Field Summary

Fields

Modifier and Type	Field	Description
protected CollectdConfigFactory	m_collectdConfigFactory
protected ForeignSourceService	m_foreignSourceService	The foreign source service.
protected PollerConfig	m_pollerConfig	The poller configuration.

Fields inherited from class org.opennms.web.rest.v1.OnmsRestService

DEFAULT_LIMIT

Constructor Summary

Constructors

Constructor	Description
ForeignSourceConfigRestService()

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
ForeignSourceConfigRestService.ElementList	getAssets()	Gets the assets.
ForeignSourceConfigRestService.SimplePluginConfigList	getAvailableDetectors()	Gets the available detectors.
ForeignSourceConfigRestService.SimplePluginConfigList	getAvailablePolicies()	Gets the available policies.
ForeignSourceConfigRestService.ElementList	getCategories()	Gets the categories.
ForeignSourceConfigRestService.ElementList	getServices(String groupName)	Gets the services.

Methods inherited from class org.opennms.web.rest.v1.OnmsRestService

applyQueryFilters, applyQueryFilters, getBadRequestResponse, getBeanWrapperForClass, getException, getException, getNumericValue, getRedirectUri, readLock, readUnlock, removeParameter, removeParameter, setProperties, writeLock, writeUnlock

Methods inherited from class java.lang.Object

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

Field Detail

m_foreignSourceService

@Autowired
protected ForeignSourceService m_foreignSourceService

The foreign source service.

m_pollerConfig

@Autowired
protected PollerConfig m_pollerConfig

The poller configuration.

m_collectdConfigFactory

@Autowired
protected CollectdConfigFactory m_collectdConfigFactory

Constructor Detail

ForeignSourceConfigRestService

public ForeignSourceConfigRestService()

Method Detail

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

getAvailablePolicies

@GET
@Path("policies")
@Produces({"application/xml","application/json","application/atom+xml"})
public ForeignSourceConfigRestService.SimplePluginConfigList getAvailablePolicies()

Gets the available policies.

Returns:

the available policies

getAvailableDetectors

@GET
@Path("detectors")
@Produces({"application/xml","application/json","application/atom+xml"})
public ForeignSourceConfigRestService.SimplePluginConfigList getAvailableDetectors()

Gets the available detectors.

Returns:

the available detectors

getServices

@GET
@Path("services/{groupName}")
@Produces({"application/xml","application/json","application/atom+xml"})
public ForeignSourceConfigRestService.ElementList getServices(@PathParam("groupName")
                                                              String groupName)

Gets the services.

It will include all the configured service monitors from poller-configuration.xml.

If the groupName is not null, it will include the services defined on the foreign source.

Parameters:

groupName - the group name

Returns:

the services

getAssets

@GET
@Path("assets")
@Produces({"application/xml","application/json","application/atom+xml"})
public ForeignSourceConfigRestService.ElementList getAssets()

Gets the assets.

Returns:

the assets

getCategories

@GET
@Path("categories")
@Produces({"application/xml","application/json","application/atom+xml"})
public ForeignSourceConfigRestService.ElementList getCategories()

Gets the categories.

Returns:

the categories