Package org.opencms.workplace.tools.sites

Class CmsSitesWebserverDialog

java.lang.Object

org.opencms.workplace.CmsWorkplace

org.opencms.workplace.tools.CmsToolDialog

org.opencms.workplace.CmsDialog

org.opencms.workplace.CmsWidgetDialog

org.opencms.workplace.tools.sites.CmsSitesWebserverDialog

All Implemented Interfaces:

org.opencms.widgets.I_CmsWidgetDialog

public class CmsSitesWebserverDialog
extends CmsWidgetDialog

A dialog that allows to write the sites configured in OpenCms into a web server configuration file, using a template.

Since:

9.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_NAME_LINUX_SCRIPT	Linux script name.
static final String	DEFAULT_NAME_WEBSERVER_CONFIG	Default web server configuration template file.
static final String	DEFAULT_NAME_WINDOWS_SCRIPT	Windows script name.
static final String	MODULE_NAME	The module name constant.
static final String	MODULE_PATH	Module path.
static final String[]	PAGES	Defines which pages are valid for this dialog.
static final String	PARAM_CONFIG_TEMPLATE	Module parameter constant for the web server configuration template file.
static final String	PARAM_FILENAME_PREFIX	A module parameter name for the prefix used for web server configuration files.
static final String	PARAM_LOGGING_DIR	The parameter name for the logging directory.
static final String	PARAM_SECURE_TEMPLATE	The parameter name of the template file for secure sites.
static final String	PARAM_TARGET_PATH	Module parameter constant for the target path.
static final String	PARAM_WEBSERVER_SCRIPT	Module parameter constant for the web server script.
static final String	PATH_WEBSERVER_EXPORT	The working directory for this tool.
static final String	TEMPLATE_FILES	Sample files folder name.

Fields inherited from class org.opencms.workplace.CmsWidgetDialog

ACTION_ELEMENT_ADD, ACTION_ELEMENT_REMOVE, ACTION_ERROR, ACTION_SAVE, DIALOG_SAVE, EDITOR_ACTION_ELEMENT_ADD, EDITOR_ACTION_ELEMENT_REMOVE, HIDDEN_PARAM_PREFIX, m_commitErrors, m_dialogObject, m_pages, m_paramPage, m_validationErrorList, m_widgetParamValues, m_widgets

Fields inherited from class org.opencms.workplace.CmsDialog

ACTION_CANCEL, ACTION_CLOSEPOPUP, ACTION_CLOSEPOPUP_SAVE, ACTION_CONFIRMED, ACTION_CONTINUE, ACTION_DEFAULT, ACTION_LOCKS_CONFIRMED, ACTION_OK, ACTION_REPORT_BEGIN, ACTION_REPORT_END, ACTION_REPORT_UPDATE, ACTION_SET, ACTION_WAIT, ATTRIBUTE_THROWABLE, BUTTON_ADVANCED, BUTTON_BACK, BUTTON_CANCEL, BUTTON_CLOSE, BUTTON_CONTINUE, BUTTON_DETAILS, BUTTON_DISCARD, BUTTON_EDIT, BUTTON_OK, BUTTON_OK_NO_SUBMIT, BUTTON_SET, DIALOG_BACK, DIALOG_CANCEL, DIALOG_CONFIRMED, DIALOG_CONTINUE, DIALOG_INITIAL, DIALOG_LOCKS_CONFIRMED, DIALOG_OK, DIALOG_SET, DIALOG_WAIT, PARAM_ACTION, PARAM_ACTION_VALUE_FOR_CHANGED_INDEX, PARAM_CLOSELINK, PARAM_DIALOGTYPE, PARAM_ERRORSTACK, PARAM_FILE, PARAM_FRAMENAME, PARAM_ISPOPUP, PARAM_LOCK, PARAM_MESSAGE, PARAM_ORIGINALPARAMS, PARAM_PREACTIONDONE, PARAM_REDIRECT, PARAM_RESOURCE, PARAM_TARGET, PARAM_THREAD, PARAM_THREAD_HASNEXT, PARAM_TITLE, REPORT_BEGIN, REPORT_END, REPORT_UPDATE

Fields inherited from class org.opencms.workplace.tools.CmsToolDialog

PARAM_ADMIN_PROJECT, PARAM_BASE, PARAM_FORCE, PARAM_PATH, PARAM_ROOT, PARAM_STYLE, STYLE_NEW

Fields inherited from class org.opencms.workplace.CmsWorkplace

DEBUG, DEFAULT_DATE_STRING, DEFAULT_LANGUAGE, DEFAULT_LOCALE, DIALOG_PATH_COMMON, FILE_DIALOG_CLOSE, FILE_DIALOG_SCREEN_CONFIRM, FILE_DIALOG_SCREEN_ERROR, FILE_DIALOG_SCREEN_ERRORPAGE, FILE_DIALOG_SCREEN_WAIT, FILE_EXPLORER_FILELIST, FILE_REPORT_OUTPUT, HTML_END, HTML_START, INPUT_DEFAULT, INPUT_NONE, JSP_WORKPLACE_URI, PARAM_DIRECTPUBLISH, PARAM_MODELFILE, PARAM_NEWRESOURCETYPE, PARAM_PUBLISHSIBLINGS, PARAM_RELATEDRESOURCES, PARAM_RESOURCELIST, PARAM_SUBRESOURCES, PARAM_WP_EXPLORER_RESOURCE, PARAM_WP_PROJECT, PARAM_WP_SITE, PARAM_WP_START, PARAM_WP_VIEW, PATH_DIALOGS, PATH_WORKPLACE, REQUEST_ATTRIBUTE_MULTIPART, REQUEST_ATTRIBUTE_RELOADTREE, RES_PATH_FILETYPES, RFS_PATH_RESOURCES, SESSION_WORKPLACE_CLASS, VFS_DIR_DEFAULTBODIES, VFS_DIR_TEMPLATES, VFS_PATH_COMMONS, VFS_PATH_EDITORS, VFS_PATH_GALLERIES, VFS_PATH_LOCALES, VFS_PATH_MODELDIALOG, VFS_PATH_MODULES, VFS_PATH_NEWRESOURCEDIALOG, VFS_PATH_RESOURCES, VFS_PATH_SITES, VFS_PATH_SYSTEM, VFS_PATH_VIEWS, VFS_PATH_WORKPLACE, VIEW_ADMIN, VIEW_DIRECT_EDIT, VIEW_EXPLORER, VIEW_GALLERY, VIEW_LIST, VIEW_WORKPLACE

Constructor Summary

Constructors

Constructor	Description
CmsSitesWebserverDialog(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)	Public constructor with JSP variables.
CmsSitesWebserverDialog(org.opencms.jsp.CmsJspActionElement jsp)	Public constructor with JSP action element.

Method Summary

Modifier and Type	Method	Description
void	actionCommit()	Commits the edited object after pressing the "OK" button.
protected String	createDialogHtml(String dialog)	Creates the dialog HTML for all defined widgets of the named dialog (page).
protected void	defineWidgets()	Defines the list of parameters for this dialog.
String	getConfigtemplate()	Returns the configuration file source.
String	getFilenameprefix()	Returns the file name prefix.
String	getLoggingdir()	Returns the loggingdir.
protected String[]	getPageArray()	Returns the allowed pages for this dialog.
String	getSecuretemplate()	Returns the securetemplate.
String	getTargetpath()	Returns the target path.
String	getWebserverscript()	Returns the web server script.
protected void	initMembers(Map<String,String> params)	Initializes the values of the members.
void	setConfigtemplate(String configtemplate)	Sets the configuration template.
void	setFilenameprefix(String filenameprefix)	Sets the file name prefix.
void	setLoggingdir(String loggingdir)	Sets the loggingdir.
void	setSecuretemplate(String securetemplate)	Sets the securetemplate.
void	setTargetpath(String targetpath)	Sets the target path.
void	setWebserverscript(String webserverscript)	Sets the web server script.

Methods inherited from class org.opencms.workplace.CmsWidgetDialog

actionCancel, actionToggleElement, addCommitError, addWidget, buildAddElement, buildDialogForm, buildRemoveElement, clearDialogObject, closeDialogOnCommit, commitWidgetValues, commitWidgetValues, createDialogHtml, createDialogRowHtml, createDialogRowsHtml, createWidgetBlockEnd, createWidgetBlockStart, createWidgetErrorHeader, createWidgetTableEnd, createWidgetTableStart, defaultActionHtml, defaultActionHtmlContent, defaultActionHtmlEnd, defaultActionHtmlStart, dialogBlockEnd, dialogBlockStart, dialogButtonsCustom, displayDialog, displayDialog, fillWidgetValues, getButtonStyle, getCommitErrors, getDialogObject, getDialogTitle, getHelpMessageIds, getPages, getParamElementIndex, getParamElementName, getParameterDefinition, getParameters, getParamPage, getParamValue, getParamValue, getUserAgent, getValidationErrorList, getWidget, getWidgetHtmlEnd, getWidgetIncludes, getWidgetInitCalls, getWidgetInitMethods, getWidgets, hasCommitErrors, hasValidationErrors, initWorkplaceRequestValues, paramsAsHidden, setCommitErrors, setDialogObject, setKeyPrefix, setPages, setParamElementIndex, setParamElementName, setParamPage, setValidationErrorList, validateParamaters, widgetParamsAsHidden, widgetParamsAsHidden, writeDialog

Methods inherited from class org.opencms.workplace.CmsDialog

actionCloseDialog, appendDelimiter, buildAjaxResultContainer, buildAjaxWaitMessage, buildLockAdditionalOptions, buildLockConfirmationMessageJS, buildLockHeaderBox, checkResourcePermissions, checkResourcePermissions, computeCurrentFolder, dialog, dialogBlock, dialogButtonRow, dialogButtonRowEnd, dialogButtonRowStart, dialogButtons, dialogButtonsClose, dialogButtonsClose, dialogButtonsCloseDetails, dialogButtonsHtml, dialogButtonsOk, dialogButtonsOk, dialogButtonsOkCancel, dialogButtonsOkCancel, dialogButtonsOkCancelAdvanced, dialogButtonsSetOkCancel, dialogContent, dialogContentEnd, dialogContentStart, dialogEnd, dialogHead, dialogHorizontalSpacer, dialogLockButtons, dialogRow, dialogRowEnd, dialogRowStart, dialogScriptSubmit, dialogSeparator, dialogSpacer, dialogStart, dialogStart, dialogSubheadline, dialogToggleStart, dialogWhiteBox, dialogWhiteBoxEnd, dialogWhiteBoxStart, getAction, getAdministrationBackLink, getCancelAction, getDialogRealUri, getDialogUri, getOnlineHelpUriCustom, getParamAction, getParamCloseLink, getParamDialogtype, getParamFramename, getParamIsPopup, getParamMessage, getParamOriginalParams, getParamPreActionDone, getParamRedirect, getParamResource, getParamTitle, getState, hasCorrectLockstate, hasSiblings, htmlStart, htmlStart, htmlStart, htmlStartStyle, includeErrorpage, initCmsDialog, isPopup, isPreEditor, openLaunchpad, openWorkplaceLink, pageHtml, pageHtml, setAction, setOnlineHelpUriCustom, setParamAction, setParamCloseLink, setParamDialogtype, setParamFramename, setParamIsPopup, setParamMessage, setParamOriginalParams, setParamPreActionDone, setParamRedirect, setParamResource, setParamTitle

Methods inherited from class org.opencms.workplace.tools.CmsToolDialog

computeUpLevelLink, dialogTitle, getAdminTool, getCurrentToolPath, getParamBase, getParamForce, getParamPath, getParamRoot, getParamStyle, getParentPath, getToolManager, iconsBlockArea, iconsBlockAreaEnd, iconsBlockAreaStart, initAdminTool, pageBody, pageHtmlStyle, setParamBase, setParamForce, setParamPath, setParamRoot, setParamStyle, useNewStyle

Methods inherited from class org.opencms.workplace.CmsWorkplace

addMessages, addMessages, allParamsAsHidden, allParamsAsRequest, allParamValues, bodyEnd, bodyStart, bodyStart, buildSelect, buildSelect, button, button, buttonBar, buttonBar, buttonBarHorizontalLine, buttonBarLabel, buttonBarLabel, buttonBarLine, buttonBarLineSpacer, buttonBarSeparator, buttonBarSpacer, buttonBarStartTab, canEditPermissionsForRoles, checkLock, checkLock, checkRole, decodeParamValue, fillParamValues, fillParamValues, generateCssStyle, generatePageEndExtended, generatePageEndSimple, generatePageStartExtended, generatePageStartSimple, getBroadcastMessageString, getCms, getEncoding, getExplorerFileListFullUri, getFrameSource, getJsp, getLocale, getMacroResolver, getMessages, getMultiPartFileItems, getParameterMap, getResourceUri, getResourceUri, getSession, getSettings, getSkinUri, getStartSiteRoot, getStartSiteRoot, getStaticResourceUri, getStaticResourceUri, getStyleUri, getStyleUri, getStyleUri, getTemporaryFileName, getWorkplaceExplorerLink, getWorkplaceExplorerLink, getWorkplaceSettings, htmlEnd, initMessages, initSettings, initTimeWarp, initUserSettings, initWorkplaceMembers, initWorkplaceMembers, initWorkplaceSettings, isForwarded, isHelpEnabled, isSubElement, isTemporaryFile, key, key, keyDefault, nullToEmpty, paramsAsHidden, paramsAsParameterMap, paramsAsRequest, paramValues, resolveMacros, sendCmsRedirect, sendForward, setForwarded, shortKey, substituteSiteTitle, substituteSiteTitleStatic, switchToCurrentProject, switchToTempProject, updateUserPreferences

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opencms.widgets.I_CmsWidgetDialog

button, buttonBar, buttonBarHorizontalLine, buttonBarSeparator, buttonBarSpacer, buttonBarStartTab, dialogHorizontalSpacer, getLocale, getMessages, useNewStyle

Field Details

DEFAULT_NAME_LINUX_SCRIPT

public static final String DEFAULT_NAME_LINUX_SCRIPT

Linux script name.

See Also:

• Constant Field Values

DEFAULT_NAME_WEBSERVER_CONFIG

public static final String DEFAULT_NAME_WEBSERVER_CONFIG

Default web server configuration template file.

See Also:

• Constant Field Values

DEFAULT_NAME_WINDOWS_SCRIPT

public static final String DEFAULT_NAME_WINDOWS_SCRIPT

Windows script name.

See Also:

• Constant Field Values

MODULE_NAME

public static final String MODULE_NAME

The module name constant.

See Also:

• Constant Field Values

MODULE_PATH

public static final String MODULE_PATH

Module path.

See Also:

• Constant Field Values

PAGES

public static final String[] PAGES

Defines which pages are valid for this dialog.

PARAM_CONFIG_TEMPLATE

public static final String PARAM_CONFIG_TEMPLATE

Module parameter constant for the web server configuration template file.

See Also:

• Constant Field Values

PARAM_FILENAME_PREFIX

public static final String PARAM_FILENAME_PREFIX

A module parameter name for the prefix used for web server configuration files.

See Also:

• Constant Field Values

PARAM_LOGGING_DIR

public static final String PARAM_LOGGING_DIR

The parameter name for the logging directory.

See Also:

• Constant Field Values

PARAM_SECURE_TEMPLATE

public static final String PARAM_SECURE_TEMPLATE

The parameter name of the template file for secure sites.

See Also:

• Constant Field Values

PARAM_TARGET_PATH

public static final String PARAM_TARGET_PATH

Module parameter constant for the target path.

See Also:

• Constant Field Values

PARAM_WEBSERVER_SCRIPT

public static final String PARAM_WEBSERVER_SCRIPT

Module parameter constant for the web server script.

See Also:

• Constant Field Values

PATH_WEBSERVER_EXPORT

public static final String PATH_WEBSERVER_EXPORT

The working directory for this tool.

TEMPLATE_FILES

public static final String TEMPLATE_FILES

Sample files folder name.

See Also:

• Constant Field Values

Constructor Details

CmsSitesWebserverDialog

public CmsSitesWebserverDialog(org.opencms.jsp.CmsJspActionElement jsp)

Public constructor with JSP action element.

Parameters:

jsp - an initialized JSP action element

CmsSitesWebserverDialog

public CmsSitesWebserverDialog(javax.servlet.jsp.PageContext context,
 javax.servlet.http.HttpServletRequest req,
 javax.servlet.http.HttpServletResponse res)

Public constructor with JSP variables.

Parameters:

context - the JSP page context

req - the JSP request

res - the JSP response

Method Details

actionCommit

public void actionCommit()
                  throws IOException,
javax.servlet.ServletException

Description copied from class: CmsWidgetDialog

Commits the edited object after pressing the "OK" button.

Specified by:

actionCommit in class CmsWidgetDialog

Throws:

IOException - in case of errors forwarding to the required result page

javax.servlet.ServletException - in case of errors forwarding to the required result page

See Also:

• CmsWidgetDialog.actionCommit()

getConfigtemplate

public String getConfigtemplate()

Returns the configuration file source.

Returns:

the configuration file source

getFilenameprefix

public String getFilenameprefix()

Returns the file name prefix.

Returns:

the file name prefix

getLoggingdir

public String getLoggingdir()

Returns the loggingdir.

Returns:

the loggingdir

getSecuretemplate

public String getSecuretemplate()

Returns the securetemplate.

Returns:

the securetemplate

getTargetpath

public String getTargetpath()

Returns the target path.

Returns:

the target path

getWebserverscript

public String getWebserverscript()

Returns the web server script.

Returns:

the web server script

setConfigtemplate

public void setConfigtemplate(String configtemplate)

Sets the configuration template.

Parameters:

configtemplate - the configuration file source to set

setFilenameprefix

public void setFilenameprefix(String filenameprefix)

Sets the file name prefix.

Parameters:

filenameprefix - the file name prefix to set

setLoggingdir

public void setLoggingdir(String loggingdir)

Sets the loggingdir.

Parameters:

loggingdir - the loggingdir to set

setSecuretemplate

public void setSecuretemplate(String securetemplate)

Sets the securetemplate.

Parameters:

securetemplate - the securetemplate to set

setTargetpath

public void setTargetpath(String targetpath)

Sets the target path.

Parameters:

targetpath - the target path to set

setWebserverscript

public void setWebserverscript(String webserverscript)

Sets the web server script.

Parameters:

webserverscript - the web server script to set

createDialogHtml

protected String createDialogHtml(String dialog)

Description copied from class: CmsWidgetDialog

Creates the dialog HTML for all defined widgets of the named dialog (page).

To get a more complex layout variation, you have to overwrite this method in your dialog class.

Overrides:

createDialogHtml in class CmsWidgetDialog

Parameters:

dialog - the dialog (page) to get the HTML for

Returns:

the dialog HTML for all defined widgets of the named dialog (page)

See Also:

• CmsWidgetDialog.createDialogHtml(java.lang.String)

defineWidgets

protected void defineWidgets()

Description copied from class: CmsWidgetDialog

Defines the list of parameters for this dialog.

Specified by:

defineWidgets in class CmsWidgetDialog

See Also:

• CmsWidgetDialog.defineWidgets()

getPageArray

protected String[] getPageArray()

Description copied from class: CmsWidgetDialog

Returns the allowed pages for this dialog.

Specified by:

getPageArray in class CmsWidgetDialog

Returns:

the allowed pages for this dialog

See Also:

• CmsWidgetDialog.getPageArray()

initMembers

protected void initMembers(Map<String,String> params)

Initializes the values of the members.

Parameters:

params - the parameter map to get a value from