org.apache.felix.webconsole.internal.compendium
Class ConfigManager

java.lang.Object
  extended by javax.servlet.GenericServlet
      extended by javax.servlet.http.HttpServlet
          extended by org.apache.felix.webconsole.AbstractWebConsolePlugin
              extended by org.apache.felix.webconsole.SimpleWebConsolePlugin
                  extended by org.apache.felix.webconsole.internal.compendium.ConfigManager
All Implemented Interfaces:
Serializable, Servlet, ServletConfig, OsgiManagerPlugin

public class ConfigManager
extends SimpleWebConsolePlugin

The ConfigManager TODO

See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.apache.felix.webconsole.AbstractWebConsolePlugin
ATTR_FILEUPLOAD, GET_RESOURCE_METHOD_NAME
 
Constructor Summary
ConfigManager()
          Default constructor
 
Method Summary
protected  void doGet(HttpServletRequest request, HttpServletResponse response)
          Renders the web console page for the request.
protected  void doPost(HttpServletRequest request, HttpServletResponse response)
          Called by the server (via the service method) to allow a servlet to handle a POST request.
protected  Map getAttributeDefinitionMap(Configuration config, String locale)
           
protected  Bundle getBundle(String bundleLocation)
           
protected  ConfigurationAdmin getConfigurationAdmin()
           
protected  Collection getFactoryPidObjectClasses(String locale)
          Returns a map of factory PIDs and providing bundles of MetaType information.
protected  Locale getLocale(HttpServletRequest request)
           
protected  MetaTypeService getMetaTypeService()
           
protected  ObjectClassDefinition getObjectClassDefinition(Bundle bundle, String pid, String locale)
           
protected  ObjectClassDefinition getObjectClassDefinition(Configuration config, String locale)
           
protected  ObjectClassDefinition getObjectClassDefinition(String pid, String locale)
           
protected  Collection getPidObjectClasses(String locale)
          Returns a map of PIDs and providing bundles of MetaType information.
protected  void renderContent(HttpServletRequest request, HttpServletResponse response)
          This method is used to render the content of the plug-in.
 
Methods inherited from class org.apache.felix.webconsole.SimpleWebConsolePlugin
deactivate, getCssReferences, getLabel, getResource, getService, getTitle, register, unregister
 
Methods inherited from class org.apache.felix.webconsole.AbstractWebConsolePlugin
activate, endResponse, getBrandingPlugin, getBundle, getBundleContext, getParameter, getResourceProvider, getServletName, isHtmlRequest, log, log, readTemplateFile, renderTopNavigation, sendRedirect, setBrandingPlugin, setLogLevel, startResponse
 
Methods inherited from class javax.servlet.http.HttpServlet
doDelete, doHead, doOptions, doPut, doTrace, getLastModified, service, service
 
Methods inherited from class javax.servlet.GenericServlet
destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, init, init, log, log
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.felix.webconsole.internal.OsgiManagerPlugin
activate, deactivate
 

Constructor Detail

ConfigManager

public ConfigManager()
Default constructor

Method Detail

doPost

protected void doPost(HttpServletRequest request,
                      HttpServletResponse response)
               throws IOException
Description copied from class: HttpServlet
Called by the server (via the service method) to allow a servlet to handle a POST request. The HTTP POST method allows the client to send data of unlimited length to the Web server a single time and is useful when posting information such as credit card numbers.

When overriding this method, read the request data, write the response headers, get the response's writer or output stream object, and finally, write the response data. It's best to include content type and encoding. When using a PrintWriter object to return the response, set the content type before accessing the PrintWriter object.

The servlet container must write the headers before committing the response, because in HTTP the headers must be sent before the response body.

Where possible, set the Content-Length header (with the ServletResponse.setContentLength(int) method), to allow the servlet container to use a persistent connection to return its response to the client, improving performance. The content length is automatically set if the entire response fits inside the response buffer.

When using HTTP 1.1 chunked encoding (which means that the response has a Transfer-Encoding header), do not set the Content-Length header.

This method does not need to be either safe or idempotent. Operations requested through POST can have side effects for which the user can be held accountable, for example, updating stored data or buying items online.

If the HTTP POST request is incorrectly formatted, doPost returns an HTTP "Bad Request" message.

Overrides:
doPost in class HttpServlet
Parameters:
request - an HttpServletRequest object that contains the request the client has made of the servlet
response - an HttpServletResponse object that contains the response the servlet sends to the client
Throws:
IOException - if an input or output error is detected when the servlet handles the request
See Also:
HttpServlet.doPost(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

doGet

protected void doGet(HttpServletRequest request,
                     HttpServletResponse response)
              throws ServletException,
                     IOException
Description copied from class: AbstractWebConsolePlugin
Renders the web console page for the request. This consist of the following five parts called in order:
  1. Send back a requested resource
  2. AbstractWebConsolePlugin.startResponse(HttpServletRequest, HttpServletResponse)
  3. AbstractWebConsolePlugin.renderTopNavigation(HttpServletRequest, PrintWriter)
  4. AbstractWebConsolePlugin.renderContent(HttpServletRequest, HttpServletResponse)
  5. AbstractWebConsolePlugin.endResponse(PrintWriter)

Note: If a resource is sent back for the request only the first step is executed. Otherwise the first step is a null-operation actually and the latter four steps are executed in order.

Overrides:
doGet in class AbstractWebConsolePlugin
Parameters:
request - an HttpServletRequest object that contains the request the client has made of the servlet
response - an HttpServletResponse object that contains the response the servlet sends to the client
Throws:
ServletException - if the request for the GET could not be handled
IOException - if an input or output error is detected when the servlet handles the GET request
See Also:
AbstractWebConsolePlugin.doGet(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

renderContent

protected void renderContent(HttpServletRequest request,
                             HttpServletResponse response)
                      throws IOException
Description copied from class: AbstractWebConsolePlugin
This method is used to render the content of the plug-in. It is called internally from the Web Console.

Specified by:
renderContent in class AbstractWebConsolePlugin
Parameters:
request - the HTTP request send from the user
response - the HTTP response object, where to render the plugin data.
Throws:
IOException - if an input or output error is detected when the servlet handles the request
See Also:
AbstractWebConsolePlugin.renderContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

getConfigurationAdmin

protected ConfigurationAdmin getConfigurationAdmin()

getMetaTypeService

protected MetaTypeService getMetaTypeService()

getPidObjectClasses

protected Collection getPidObjectClasses(String locale)
Returns a map of PIDs and providing bundles of MetaType information. The map is indexed by PID and the value of each entry is the bundle providing the MetaType information for that PID.

Parameters:
locale - The name of the locale to get the meta data for.
Returns:
see the method description

getFactoryPidObjectClasses

protected Collection getFactoryPidObjectClasses(String locale)
Returns a map of factory PIDs and providing bundles of MetaType information. The map is indexed by factory PID and the value of each entry is the bundle providing the MetaType information for that factory PID.

Parameters:
locale - The name of the locale to get the meta data for.
Returns:
see the method description

getObjectClassDefinition

protected ObjectClassDefinition getObjectClassDefinition(Configuration config,
                                                         String locale)

getObjectClassDefinition

protected ObjectClassDefinition getObjectClassDefinition(Bundle bundle,
                                                         String pid,
                                                         String locale)

getObjectClassDefinition

protected ObjectClassDefinition getObjectClassDefinition(String pid,
                                                         String locale)

getAttributeDefinitionMap

protected Map getAttributeDefinitionMap(Configuration config,
                                        String locale)

getBundle

protected Bundle getBundle(String bundleLocation)

getLocale

protected Locale getLocale(HttpServletRequest request)


Copyright © 2013 The Apache Software Foundation. All Rights Reserved.