Package org.opennms.features.config.rest.api

Interface ConfigManagerRestService

All Known Implementing Classes:

ConfigManagerRestServiceImpl

@Path("/cm")
@Produces("application/json")
@Consumes("application/json")
public interface ConfigManagerRestService

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	addConfig(String configName, String configId, String jsonStr)	add new config by
javax.ws.rs.core.Response	deleteConfig(String configName, String configId)	delete config by configName and configId
javax.ws.rs.core.Response	getAllOpenApiSchema(String acceptType, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	getConfig(String configName, String configId)	get config by configName and configId
javax.ws.rs.core.Response	getConfigIds(String configName)	get configIds
javax.ws.rs.core.Response	getOpenApiSchema(String configName, String acceptType, javax.servlet.http.HttpServletRequest request)	get filtered OpenApi schema
javax.ws.rs.core.Response	listConfigs()	list registered configNames
javax.ws.rs.core.Response	updateConfig(String configName, String configId, boolean isReplace, String jsonStr)

Method Detail

listConfigs

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

list registered configNames

Returns:

getAllOpenApiSchema

@GET
@Path("/schema")
javax.ws.rs.core.Response getAllOpenApiSchema(@HeaderParam("accept")
                                              String acceptType,
                                              @Context
                                              javax.servlet.http.HttpServletRequest request)

getOpenApiSchema

@GET
@Path("/schema/{configName}")
javax.ws.rs.core.Response getOpenApiSchema(@PathParam("configName")
                                           String configName,
                                           @HeaderParam("accept")
                                           String acceptType,
                                           @Context
                                           javax.servlet.http.HttpServletRequest request)

get filtered OpenApi schema

Parameters:

configName -

acceptType -

Returns:

getConfigIds

@GET
@Path("/{configName}")
javax.ws.rs.core.Response getConfigIds(@PathParam("configName")
                                       String configName)

get configIds

Parameters:

configName -

Returns:

getConfig

@GET
@Path("/{configName}/{configId}")
javax.ws.rs.core.Response getConfig(@PathParam("configName")
                                    String configName,
                                    @PathParam("configId")
                                    String configId)

get config by configName and configId

Parameters:

configName -

configId -

Returns:

addConfig

@POST
@Path("/{configName}/{configId}")
javax.ws.rs.core.Response addConfig(@PathParam("configName")
                                    String configName,
                                    @PathParam("configId")
                                    String configId,
                                    String jsonStr)

add new config by

Parameters:

configName -

configId -

jsonStr -

Returns:

updateConfig

@PUT
@Path("/{configName}/{configId}")
javax.ws.rs.core.Response updateConfig(@PathParam("configName")
                                       String configName,
                                       @PathParam("configId")
                                       String configId,
                                       @QueryParam("replace")
                                       boolean isReplace,
                                       String jsonStr)

Parameters:

configName -

configId -

jsonStr -

isReplace -

Returns:

deleteConfig

@DELETE
@Path("/{configName}/{configId}")
javax.ws.rs.core.Response deleteConfig(@PathParam("configName")
                                       String configName,
                                       @PathParam("configId")
                                       String configId)

delete config by configName and configId

Parameters:

configName -

configId -

Returns: