ro.sync.ecss.extensions.api.webapp.plugin

Class PluginConfigExtension

java.lang.Object

ro.sync.ecss.extensions.api.webapp.plugin.WebappServletPluginExtension

ro.sync.ecss.extensions.api.webapp.plugin.PluginConfigExtension

All Implemented Interfaces:

PluginExtension

@API(type=EXTENDABLE,
     src=PUBLIC)
public abstract class PluginConfigExtension
extends WebappServletPluginExtension

This class should be extended when creating a web-app plugin with a configuration page.

Make sure to call super.init() in the extended class otherwise you won't be able to manipulate the options.

This class exposes the following HTTP api to the web-app admin page.

GET with Accept: text/html responds with the html/css/js of the configuration page.

GET with Accept: application/json responds with the current options of a plugin as a JSON object.

PUT with a JSON object of key-value pairs representing the options to set as request body. Will set the options for a plugin and save them to disk.

DELETE will reset a plugins options to their default values.

Since:

17.1

Field Summary

Fields inherited from class ro.sync.ecss.extensions.api.webapp.plugin.WebappServletPluginExtension

config

Constructor Summary

Constructors

Constructor and Description
PluginConfigExtension() In the derived class make sure to set the default options.

Method Summary

Modifier and Type	Method and Description
void	doDelete(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp) This method should return a plugin to its default options.
void	doGet(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp) This method responds with the plugin configuration page (html/css/js).
void	doPut(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp) The request body of this request should contain a JSON object of the options to set, containing only key-value pairs with value being a string and not an object.
java.util.Map<java.lang.String,java.lang.String>	getDefaultOptions()
protected java.lang.String	getOption(java.lang.String key, java.lang.String defaultValue) Returns the option for the given key or the default value if the key doesn't exist.
abstract java.lang.String	getOptionsForm() Implement this method to return an HTML form containing the options which should be modified using the administration page.
abstract java.lang.String	getOptionsJson() Returns the options available of the client-side in JSON format.
abstract java.lang.String	getPath() Should be implemented to return the relative path handled by this plugin.
void	init() Derived classes should make sure to call this method.
boolean	requiresAuthorization() PluginConfigExtensions will only serve content if the user is authenticated.
protected void	saveOptions() Saves the set options to disk.
java.lang.String	serializeMapToJSON(java.util.Map<java.lang.String,java.lang.Object> map) Serializes a map to a JSON string.
void	setDefaultOptions(java.util.Map<java.lang.String,java.lang.String> defaultOptions) Sets the default options for this plugin configuration extension.
protected void	setOption(java.lang.String key, java.lang.String value) Sets the value of an option referenced by its key.

Methods inherited from class ro.sync.ecss.extensions.api.webapp.plugin.WebappServletPluginExtension

doPost, getServletConfig, init, service

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginConfigExtension

public PluginConfigExtension()

In the derived class make sure to set the default options.

Method Detail

getPath

public abstract java.lang.String getPath()

Should be implemented to return the relative path handled by this plugin. The path should be unique among other webapp servlet plugins paths and not an empty String. and should contain only lower case letters or the '-' sign. Example: "plugin-path".

Specified by:

getPath in class WebappServletPluginExtension

Returns:

The path at which the servlet will be accessed.

init

public void init()
          throws javax.servlet.ServletException

Derived classes should make sure to call this method.

Overrides:

init in class WebappServletPluginExtension

Throws:

javax.servlet.ServletException - Thrown to respect the interface

doGet

public void doGet(javax.servlet.http.HttpServletRequest req,
                  javax.servlet.http.HttpServletResponse resp)
           throws javax.servlet.ServletException,
                  java.io.IOException

This method responds with the plugin configuration page (html/css/js).

Overrides:

doGet in class WebappServletPluginExtension

Parameters:

req - The HTTP request

resp - The HTTP response

Throws:

javax.servlet.ServletException - To respect the interface

java.io.IOException - Thrown by getWriter

doPut

public void doPut(javax.servlet.http.HttpServletRequest req,
                  javax.servlet.http.HttpServletResponse resp)
           throws javax.servlet.ServletException,
                  java.io.IOException

The request body of this request should contain a JSON object of the options to set, containing only key-value pairs with value being a string and not an object. Derived methods should use setOption in this method. And afterwards call saveOptions().

Overrides:

doPut in class WebappServletPluginExtension

Parameters:

req - The HTTP request object

resp - The HTTP response object

Throws:

javax.servlet.ServletException - To respect the interface

java.io.IOException - If the options file is not found or storing the options encounters an error

doDelete

public void doDelete(javax.servlet.http.HttpServletRequest req,
                     javax.servlet.http.HttpServletResponse resp)
              throws javax.servlet.ServletException,
                     java.io.IOException

This method should return a plugin to its default options.

It sets the options back to their defaults and saves them on disk.

In derived classes return your plugin to the default options and call the super method to set the options to the default values and save them on disk.

Overrides:

doDelete in class WebappServletPluginExtension

Parameters:

req - The HTTP request object

resp - The HTTP response object

Throws:

javax.servlet.ServletException - To respect the interface

java.io.IOException - When the options file is not found or storing options encounters an error

getOption

protected java.lang.String getOption(java.lang.String key,
                                     java.lang.String defaultValue)

Returns the option for the given key or the default value if the key doesn't exist.

Parameters:

key - The key for the option to return

defaultValue - The value to return if the key doesn't exist

Returns:

The option for the given key or the default value if the key doesn't exist

setOption

protected void setOption(java.lang.String key,
                         java.lang.String value)

Sets the value of an option referenced by its key.

Parameters:

key - The key of the option to set

value - The value of the option to set

saveOptions

protected void saveOptions()
                    throws java.io.IOException

Saves the set options to disk.

Throws:

java.io.IOException - Couldn't save options.

getDefaultOptions

public java.util.Map<java.lang.String,java.lang.String> getDefaultOptions()

Returns:

the defaultOptions

setDefaultOptions

public void setDefaultOptions(java.util.Map<java.lang.String,java.lang.String> defaultOptions)

Sets the default options for this plugin configuration extension.

If you want the default values for your options to be empty/null make sure to set them as empty/null, don't leave them out of the defaultOptions map.

Parameters:

defaultOptions - the defaultOptions to set

getOptionsForm

public abstract java.lang.String getOptionsForm()

Implement this method to return an HTML form containing the options which should be modified using the administration page. The form inputs name attribute should be the option name.

Returns:

The options form representing an html form with inputs where every input's name attribute represents the name of the option which we want to set.

getOptionsJson

public abstract java.lang.String getOptionsJson()

Returns the options available of the client-side in JSON format. These options will be available for all type of users so you should not include sensitive options that should require authorization.

Returns:

the options available on client formated as JSON.

requiresAuthorization

public final boolean requiresAuthorization()

PluginConfigExtensions will only serve content if the user is authenticated.

Overrides:

requiresAuthorization in class WebappServletPluginExtension

Returns:

True to require authorization

serializeMapToJSON

public java.lang.String serializeMapToJSON(java.util.Map<java.lang.String,java.lang.Object> map)

Serializes a map to a JSON string.

Parameters:

map - the map to serialize to JSON string.

Returns:

the map serialized as a JSON.