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, javax.servlet.Servlet, javax.servlet.ServletConfig, BasicRestConfig

@RestResource(path="/config",
              title="Configuration",
              description="Contents of configuration file.",
              htmldoc=)
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() [GET /] - Show contents of config file.
Form	getConfigEditForm(RestRequest req) [GET /edit] - Show config file edit page.
String	getConfigEntry(String section, String key) [GET /{section}/{key}] - Show config file entry.
ObjectMap	getConfigSection(String section) [GET /{section}] - Show config file section.
ObjectMap	setConfigContents(Reader contents) [PUT /] - Sets contents of config file.
ObjectMap	setConfigContentsFormPost(String contents) [POST /] - Sets contents of config file from a FORM post.
ObjectMap	setConfigSection(String section, Map<String,Object> contents) [PUT /{section}] - Add or overwrite a config file section.
String	setConfigSection(String section, String key, String value) [PUT /{section}/{key}] - Add or overwrite a config file entry.

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

getOptions

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

destroy, getContext, getProperties, getServletConfig, init, log, log, log, log, logObjects, service

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="/",
            description="Show contents of config file.")
public ObjectMap getConfig()
                                                                                                                           throws Exception

[GET /] - Show contents of config file.

Returns:

The config file.

Throws:

Exception

getConfigEditForm

@RestMethod(name="GET",
            path="/edit",
            description="Edit config file.")
public Form getConfigEditForm(RestRequest req)
                                                                                                                      throws Exception

[GET /edit] - Show config file edit page.

Parameters:

req - The HTTP request.

Returns:

The config file as a reader resource.

Throws:

Exception

getConfigSection

@RestMethod(name="GET",
            path="/{section}",
            description="Show config file section.",
            swagger={"parameters:[","{name:\'section\',in:\'path\',description:\'Section name.\'}","]"})
public ObjectMap getConfigSection(@Path(value="section")
                                                                                                                                                                                                                                                       String section)
                                                                                                                                                                                                                                                throws Exception

[GET /{section}] - Show config file section.

Parameters:

section - The section name.

Returns:

The config file section.

Throws:

Exception

getConfigEntry

@RestMethod(name="GET",
            path="/{section}/{key}",
            description="Show config file entry.",
            swagger={"parameters:[","{name:\'section\',in:\'path\',description:\'Section name.\'},","{name:\'key\',in:\'path\',description:\'Entry name.\'}","]"})
public String getConfigEntry(@Path(value="section")
                                                                                                                                                                                                                                                                                                                String section,
                                                                                                                                                                                                                                                                                                                @Path(value="key")
                                                                                                                                                                                                                                                                                                                String key)
                                                                                                                                                                                                                                                                                                         throws Exception

[GET /{section}/{key}] - Show config file entry.

Parameters:

section - The section name.

key - The section key.

Returns:

The value of the config file entry.

Throws:

Exception

setConfigContentsFormPost

@RestMethod(name="POST",
            path="/",
            description="Sets contents of config file from a FORM post.",
            swagger={"parameters:[","{name:\'contents\',in:\'formData\',description:\'New contents in INI file format.\'}","]"})
public ObjectMap setConfigContentsFormPost(@FormData(value="contents")
                                                                                                                                                                                                                                                                                                     String contents)
                                                                                                                                                                                                                                                                                              throws Exception

[POST /] - Sets contents of config file from a FORM post.

Parameters:

contents - The new contents of the config file.

Returns:

The new config file contents.

Throws:

Exception

setConfigContents

@RestMethod(name="PUT",
            path="/",
            description="Sets contents of config file.",
            swagger={"parameters:[","{in:\'body\',description:\'New contents in INI file format.\'}","]"})
public ObjectMap setConfigContents(@Body
                                                                                                                                                                                                                                                     Reader contents)
                                                                                                                                                                                                                                              throws Exception

[PUT /] - Sets contents of config file.

Parameters:

contents - The new contents of the config file.

Returns:

The new config file contents.

Throws:

Exception

setConfigSection

@RestMethod(name="PUT",
            path="/{section}",
            description="Add or overwrite a config file section.",
            swagger={"parameters:[","{name:\'section\',in:\'path\',description:\'Section name.\'}","{in:\'body\',description:\'New contents for section as a simple map with string keys and values.\'}","]"})
public ObjectMap setConfigSection(@Path(value="section")
                                                                                                                                                                                                                                                                                                                                                                           String section,
                                                                                                                                                                                                                                                                                                                                                                           @Body
                                                                                                                                                                                                                                                                                                                                                                           Map<String,Object> contents)
                                                                                                                                                                                                                                                                                                                                                                    throws Exception

[PUT /{section}] - Add or overwrite a config file section.

Parameters:

section - The section name.

contents - The new contents of the config file section.

Returns:

The new section.

Throws:

Exception

setConfigSection

@RestMethod(name="PUT",
            path="/{section}/{key}",
            description="Add or overwrite a config file entry.",
            swagger={"parameters:[","{name:\'section\',in:\'path\',description:\'Section name.\'}","{name:\'key\',in:\'path\',description:\'Entry name.\'}","{in:\'body\',description:\'New value as a string.\'}","]"})
public String setConfigSection(@Path(value="section")
                                                                                                                                                                                                                                                                                                                                                                                      String section,
                                                                                                                                                                                                                                                                                                                                                                                      @Path(value="key")
                                                                                                                                                                                                                                                                                                                                                                                      String key,
                                                                                                                                                                                                                                                                                                                                                                                      @Body
                                                                                                                                                                                                                                                                                                                                                                                      String value)
                                                                                                                                                                                                                                                                                                                                                                               throws Exception

[PUT /{section}/{key}] - Add or overwrite a config file entry.

Parameters:

section - The section name.

key - The section key.

value - The new value.

Returns:

The new value.

Throws:

Exception