Package org.opennms.features.scv.rest

Interface ScvRestService

All Known Implementing Classes:

DefaultScvRestService

@Path("/scv")
public interface ScvRestService

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	addCredentials(CredentialsDTO credentialsDTO)	Add Credentials to Scv
javax.ws.rs.core.Response	editCredentials(String alias, CredentialsDTO credentialsDTO)	Add Credentials to Scv
javax.ws.rs.core.Response	getAliases()	Get set of aliases
javax.ws.rs.core.Response	getCredentials(String alias)	Get Credentials for an alias.

Method Detail

getCredentials

@GET
@Produces("application/json")
@Path("{alias}")
javax.ws.rs.core.Response getCredentials(@PathParam("alias")
                                         String alias)

Get Credentials for an alias.

Parameters:

alias - alias for the credentials.

getAliases

@GET
@Produces("application/json")
javax.ws.rs.core.Response getAliases()

Get set of aliases

addCredentials

@POST
@Consumes("application/json")
javax.ws.rs.core.Response addCredentials(CredentialsDTO credentialsDTO)

Add Credentials to Scv

Parameters:

credentialsDTO - Credentials with an alias

editCredentials

@PUT
@Consumes("application/json")
@Path("{alias}")
javax.ws.rs.core.Response editCredentials(@PathParam("alias")
                                          String alias,
                                          CredentialsDTO credentialsDTO)

Add Credentials to Scv

Parameters:

credentialsDTO - Credentials with an alias