org.apache.juneau.microservice.resources

Class ConfigResource

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.apache.juneau.rest.RestServlet

org.apache.juneau.rest.BasicRestServlet

org.apache.juneau.microservice.resources.ConfigResource

All Implemented Interfaces:

Serializable, Servlet, ServletConfig, BasicRestConfig

@Rest(path="/config",
      title="Configuration",
      description="Contents of configuration file.")
 @HtmlDocConfig(navlinks={"up: request:/..","options: servlet:/?method=OPTIONS","edit: servlet:/edit"})
public class ConfigResource
extends BasicRestServlet

Shows contents of the microservice configuration file.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ConfigResource()

Method Summary

Modifier and Type	Method and Description
ObjectMap	getConfig()
Form	getConfigEditForm()
String	getConfigEntry(String section, String key)
ObjectMap	getConfigSection(String section)
ObjectMap	setConfigContents(Reader contents)
ObjectMap	setConfigContentsFormPost(String contents)
ObjectMap	setConfigSection(String section, Map<String,Object> contents)
String	setConfigValue(String section, String key, String value)

Methods inherited from class org.apache.juneau.rest.BasicRestServlet

getOptions

Methods inherited from class org.apache.juneau.rest.RestServlet

destroy, getContext, getPath, getProperties, getRequest, getResponse, getServletConfig, init, log, log, log, log, logObjects, service, setContext, setRestResourceResolver

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doGet, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service

Methods inherited from class javax.servlet.GenericServlet

getInitParameter, getInitParameterNames, getServletContext, getServletInfo, getServletName, init

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigResource

public ConfigResource()

Method Detail

getConfig

@RestMethod(name="GET",
            path="/",
            summary="Get config file contents",
            description="Show contents of config file as an ObjectMap.",
            swagger=)
public ObjectMap getConfig()

getConfigEditForm

@RestMethod(name="GET",
            path="/edit",
            summary="Render form entry page for editing config file",
            description="Renders a form entry page for editing the raw text of a config file.")
public Form getConfigEditForm()

getConfigSection

@RestMethod(name="GET",
            path="/{section}",
            summary="Get config file section contents",
            description="Show contents of config file section as an ObjectMap.",
            swagger=)
public ObjectMap getConfigSection(@Path(name="section",description="Section name in config file.",example="REST")
                                                                                                                                                                                                                                                        String section)
                                                                                                                                                                                                                                                 throws org.apache.juneau.microservice.resources.ConfigResource.SectionNotFound,
                                                                                                                                                                                                                                                        org.apache.juneau.microservice.resources.ConfigResource.BadConfig

Throws:

org.apache.juneau.microservice.resources.ConfigResource.SectionNotFound

org.apache.juneau.microservice.resources.ConfigResource.BadConfig

getConfigEntry

@RestMethod(name="GET",
            path="/{section}/{key}",
            summary="Get config file entry value",
            description="Show value of config file entry as a simple string.",
            swagger=)
public String getConfigEntry(@Path(name="section",description="Section name in config file.",example="REST")
                                                                                                                                                                                                                                                  String section,
                                                                                                                                                                                                                                                  @Path(name="key",description="Key name in section.",example="theme")
                                                                                                                                                                                                                                                  String key)
                                                                                                                                                                                                                                           throws org.apache.juneau.microservice.resources.ConfigResource.SectionNotFound,
                                                                                                                                                                                                                                                  org.apache.juneau.microservice.resources.ConfigResource.BadConfig

Throws:

org.apache.juneau.microservice.resources.ConfigResource.SectionNotFound

org.apache.juneau.microservice.resources.ConfigResource.BadConfig

setConfigContentsFormPost

@RestMethod(name="POST",
            path="/",
            summary="Update config file contents",
            description="Update the contents of the config file from a FORM post.",
            swagger=)
public ObjectMap setConfigContentsFormPost(@FormData(name="contents",description="New contents in INI file format.")
                                                                                                                                                                                                                                                       String contents)
                                                                                                                                                                                                                                                throws Exception

Throws:

Exception

setConfigContents

@RestMethod(name="PUT",
            path="/",
            summary="Update config file contents",
            description="Update the contents of the config file from raw text.",
            swagger=)
public ObjectMap setConfigContents(@Body(description="New contents in INI file format.")
                                                                                                                                                                                                                                           Reader contents)
                                                                                                                                                                                                                                    throws Exception

Throws:

Exception

setConfigSection

@RestMethod(name="PUT",
            path="/{section}",
            summary="Update config section contents",
            description="Add or overwrite a config file section.",
            swagger=)
public ObjectMap setConfigSection(@Path(name="section",description="Section name in config file.",example="REST")
                                                                                                                                                                                                                                        String section,
                                                                                                                                                                                                                                        @Body(description="New contents of config section as a simple map of key/value pairs.",example="{theme:\'servlet:/htdocs/themes/dark.css\'}")
                                                                                                                                                                                                                                        Map<String,Object> contents)
                                                                                                                                                                                                                                 throws Exception

Throws:

Exception

setConfigValue

@RestMethod(name="PUT",
            path="/{section}/{key}",
            summary="Update config entry value",
            description="Add or overwrite a config file entry.",
            swagger=)
public String setConfigValue(@Path(name="section",description="Section name in config file.",example="REST")
                                                                                                                                                                                                                                  String section,
                                                                                                                                                                                                                                  @Path(name="key",description="Key name in section.",example="theme")
                                                                                                                                                                                                                                  String key,
                                                                                                                                                                                                                                  @Body(description="New value for entry.",example="servlet:/htdocs/themes/dark.css")
                                                                                                                                                                                                                                  String value)
                                                                                                                                                                                                                           throws org.apache.juneau.microservice.resources.ConfigResource.SectionNotFound,
                                                                                                                                                                                                                                  org.apache.juneau.microservice.resources.ConfigResource.BadConfig

Throws:

org.apache.juneau.microservice.resources.ConfigResource.SectionNotFound

org.apache.juneau.microservice.resources.ConfigResource.BadConfig