|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ConfigurationPrinter
The ConfigurationPrinter
is a service interface to be used by
providers which want to hook into the display of the current configuration
of the OSGi framework.
A configuration printer is currently used in three modes: displayed in
a tab of the configuration web console plugin, included in a downloadable
zip of the configuration or a downloadable txt file.
With the WebConsoleConstants.CONFIG_PRINTER_MODES
property this
service can specify when it should be included.
The default mode is MODE_ALWAYS
.
Field Summary | |
---|---|
static String |
MODE_ALWAYS
The default mode - this printer is used in the web console and the zip. |
static String |
MODE_TXT
The txt mode - this printer is used in the txt. |
static String |
MODE_WEB
The web mode - this printer is used in the web console. |
static String |
MODE_ZIP
The zip mode - this printer is used in the zip. |
static String |
PROPERTY_MODES
Deprecated. Use WebConsoleConstants.CONFIG_PRINTER_MODES |
static String |
SERVICE
The service name under which services of this class must be registered to be picked for inclusion in the configuration report. |
Method Summary | |
---|---|
String |
getTitle()
Returns a human readable title string to be placed in front of the configuration report generated by the printConfiguration(PrintWriter) method. |
void |
printConfiguration(PrintWriter printWriter)
Prints the configuration report to the given printWriter . |
Field Detail |
---|
static final String SERVICE
static final String MODE_ALWAYS
static final String MODE_WEB
Output of the configuration printer is HTML-escaped unless the
WebConsoleConstants.CONFIG_PRINTER_WEB_UNESCAPED
service
registration property is set to true
.
static final String MODE_ZIP
static final String MODE_TXT
static final String PROPERTY_MODES
WebConsoleConstants.CONFIG_PRINTER_MODES
MODE_ALWAYS
is used.
The value of this property is either a single string or an
array of strings.
Method Detail |
---|
String getTitle()
printConfiguration(PrintWriter)
method.
void printConfiguration(PrintWriter printWriter)
printWriter
.
Implementations are free to print whatever information they deem useful.
printWriter
- where to write the configuration data. It might be flushed,
but must not be closed.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |