Package org.opennms.web.rest.v1.config

Class EmailNorthbounderConfigurationResource

java.lang.Object

org.opennms.web.rest.v1.OnmsRestService

org.opennms.web.rest.v1.config.EmailNorthbounderConfigurationResource

All Implemented Interfaces:

org.springframework.beans.factory.InitializingBean

@Component
public class EmailNorthbounderConfigurationResource
extends OnmsRestService
implements org.springframework.beans.factory.InitializingBean

The Class EmailNorthbounderConfigurationResource.

Author:

Alejandro Galue

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EmailNorthbounderConfigurationResource.EmailDestinationList	The Class EmailDestinationList.

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

OnmsRestService.ComparisonOperation

Field Summary

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

DEFAULT_LIMIT

Constructor Summary

Constructors

Constructor	Description
EmailNorthbounderConfigurationResource()

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
javax.ws.rs.core.Response	getConfiguration()	Gets the configuration.
EmailDestination	getEmailDestination(String destinationName)	Gets an email destination.
javax.ws.rs.core.Response	getEmailDestinations()	Gets all the email destinations.
javax.ws.rs.core.Response	getStatus()	Gets the status.
javax.ws.rs.core.Response	getStatus(Boolean enabled)	Gets the status.
javax.ws.rs.core.Response	removeEmailDestination(String destinationName)	Removes a specific email destination.
javax.ws.rs.core.Response	setConfiguration(EmailNorthbounderConfig config)	Sets the configuration.
javax.ws.rs.core.Response	setEmailDestination(EmailDestination destination)	Sets an email destination.
javax.ws.rs.core.Response	updateEmailDestination(String destinationName, MultivaluedMapImpl params)	Updates a specific email destination.

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

Constructor Detail

EmailNorthbounderConfigurationResource

public EmailNorthbounderConfigurationResource()

Method Detail

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

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

Throws:

Exception

getConfiguration

@GET
@Produces({"application/xml","application/json","application/atom+xml"})
public javax.ws.rs.core.Response getConfiguration()

Gets the configuration.

Returns:

the configuration

setConfiguration

@POST
public javax.ws.rs.core.Response setConfiguration(EmailNorthbounderConfig config)

Sets the configuration.

Parameters:

config - the full configuration object

Returns:

the response

getStatus

@GET
@Path("status")
@Produces("text/plain")
public javax.ws.rs.core.Response getStatus()

Gets the status.

Returns:

the status

getStatus

@PUT
@Path("status")
@Produces("text/plain")
public javax.ws.rs.core.Response getStatus(@QueryParam("enabled")
                                           Boolean enabled)
                                    throws javax.ws.rs.WebApplicationException

Gets the status.

Parameters:

enabled - the enabled

Returns:

the status

Throws:

javax.ws.rs.WebApplicationException - the web application exception

getEmailDestinations

@GET
@Path("destinations")
@Produces({"application/xml","application/json","application/atom+xml"})
public javax.ws.rs.core.Response getEmailDestinations()

Gets all the email destinations.

Returns:

the email destinations

getEmailDestination

@GET
@Path("destinations/{destinationName}")
@Produces({"application/xml","application/json","application/atom+xml"})
public EmailDestination getEmailDestination(@PathParam("destinationName")
                                            String destinationName)

Gets an email destination.

Parameters:

destinationName - the destination name

Returns:

the email destination

setEmailDestination

@POST
@Path("destinations")
@Consumes({"application/xml","application/json","application/atom+xml"})
public javax.ws.rs.core.Response setEmailDestination(EmailDestination destination)

Sets an email destination.

If there is a destination with the same name, the existing one will be overridden.

Parameters:

destination - the destination

Returns:

the response

updateEmailDestination

@PUT
@Consumes("application/x-www-form-urlencoded")
@Path("destinations/{destinationName}")
public javax.ws.rs.core.Response updateEmailDestination(@PathParam("destinationName")
                                                        String destinationName,
                                                        MultivaluedMapImpl params)

Updates a specific email destination.

Parameters:

destinationName - the destination name

params - the parameters map

Returns:

the response

removeEmailDestination

@DELETE
@Path("destinations/{destinationName}")
@Produces({"application/xml","application/json","application/atom+xml"})
public javax.ws.rs.core.Response removeEmailDestination(@PathParam("destinationName")
                                                        String destinationName)

Removes a specific email destination.

Parameters:

destinationName - the destination name

Returns:

the response