Mercurial > hg > LightPIT / file diff

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/main/kotlin/de/uapcore/lightpit/Constants.kt	Fri Nov 06 10:50:32 2020 +0100
@@ -0,0 +1,99 @@
+/*
+ * Copyright 2020 Mike Becker. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package de.uapcore.lightpit
+
+object Constants {
+    /**
+     * The path where the JSP files reside.
+     */
+    const val JSP_PATH_PREFIX = "/WEB-INF/jsp/"
+
+    /**
+     * The name of the generic JSP page that is displayed after a successful commit.
+     */
+    const val JSP_COMMIT_SUCCESSFUL = "commit-successful"
+
+    /**
+     * Name for the context parameter specifying the available languages.
+     */
+    const val CTX_ATTR_LANGUAGES = "available-languages"
+
+    /**
+     * Name for the context parameter optionally specifying a database schema.
+     */
+    const val CTX_ATTR_DB_SCHEMA = "db-schema"
+
+    /**
+     * Name for the context parameter optionally specifying a database dialect.
+     */
+    const val CTX_ATTR_DB_DIALECT = "db-dialect"
+
+    /**
+     * Key for the request attribute containing the resource bundle name.
+     */
+    const val REQ_ATTR_RESOURCE_BUNDLE = "bundleName"
+
+    /**
+     * Key for the request attribute containing the optional navigation menu jsp.
+     */
+    const val REQ_ATTR_NAVIGATION = "navMenu"
+
+    /**
+     * Key for the request attribute containing the base href.
+     */
+    const val REQ_ATTR_BASE_HREF = "base_href"
+
+    /**
+     * Key for the request attribute containing the full path information (servlet path + path info).
+     */
+    const val REQ_ATTR_PATH = "requestPath"
+
+    /**
+     * Key for the name of the page which should be rendered.
+     */
+    const val REQ_ATTR_CONTENT_PAGE = "contentPage"
+
+    /**
+     * Key for the view model object (the type depends on the rendered site).
+     */
+    const val REQ_ATTR_VIEWMODEL = "viewmodel"
+
+    /**
+     * Key for the name of the additional stylesheet used by a module.
+     */
+    const val REQ_ATTR_STYLESHEET = "extraCss"
+
+    /**
+     * Key for a location the page shall redirect to.
+     * Will be used in a meta element.
+     */
+    const val REQ_ATTR_REDIRECT_LOCATION = "redirectLocation"
+
+    /**
+     * Key for the current language selection within the session.
+     */
+    const val SESSION_ATTR_LANGUAGE = "language"
+}