1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/src/main/kotlin/de/uapcore/lightpit/Constants.kt Fri Nov 06 10:50:32 2020 +0100
1.3 @@ -0,0 +1,99 @@
1.4 +/*
1.5 + * Copyright 2020 Mike Becker. All rights reserved.
1.6 + *
1.7 + * Redistribution and use in source and binary forms, with or without
1.8 + * modification, are permitted provided that the following conditions are met:
1.9 + *
1.10 + * 1. Redistributions of source code must retain the above copyright
1.11 + * notice, this list of conditions and the following disclaimer.
1.12 + *
1.13 + * 2. Redistributions in binary form must reproduce the above copyright
1.14 + * notice, this list of conditions and the following disclaimer in the
1.15 + * documentation and/or other materials provided with the distribution.
1.16 + *
1.17 + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
1.18 + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
1.19 + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
1.20 + * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
1.21 + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
1.22 + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
1.23 + * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
1.24 + * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
1.25 + * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
1.26 + * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
1.27 + */
1.28 +
1.29 +package de.uapcore.lightpit
1.30 +
1.31 +object Constants {
1.32 + /**
1.33 + * The path where the JSP files reside.
1.34 + */
1.35 + const val JSP_PATH_PREFIX = "/WEB-INF/jsp/"
1.36 +
1.37 + /**
1.38 + * The name of the generic JSP page that is displayed after a successful commit.
1.39 + */
1.40 + const val JSP_COMMIT_SUCCESSFUL = "commit-successful"
1.41 +
1.42 + /**
1.43 + * Name for the context parameter specifying the available languages.
1.44 + */
1.45 + const val CTX_ATTR_LANGUAGES = "available-languages"
1.46 +
1.47 + /**
1.48 + * Name for the context parameter optionally specifying a database schema.
1.49 + */
1.50 + const val CTX_ATTR_DB_SCHEMA = "db-schema"
1.51 +
1.52 + /**
1.53 + * Name for the context parameter optionally specifying a database dialect.
1.54 + */
1.55 + const val CTX_ATTR_DB_DIALECT = "db-dialect"
1.56 +
1.57 + /**
1.58 + * Key for the request attribute containing the resource bundle name.
1.59 + */
1.60 + const val REQ_ATTR_RESOURCE_BUNDLE = "bundleName"
1.61 +
1.62 + /**
1.63 + * Key for the request attribute containing the optional navigation menu jsp.
1.64 + */
1.65 + const val REQ_ATTR_NAVIGATION = "navMenu"
1.66 +
1.67 + /**
1.68 + * Key for the request attribute containing the base href.
1.69 + */
1.70 + const val REQ_ATTR_BASE_HREF = "base_href"
1.71 +
1.72 + /**
1.73 + * Key for the request attribute containing the full path information (servlet path + path info).
1.74 + */
1.75 + const val REQ_ATTR_PATH = "requestPath"
1.76 +
1.77 + /**
1.78 + * Key for the name of the page which should be rendered.
1.79 + */
1.80 + const val REQ_ATTR_CONTENT_PAGE = "contentPage"
1.81 +
1.82 + /**
1.83 + * Key for the view model object (the type depends on the rendered site).
1.84 + */
1.85 + const val REQ_ATTR_VIEWMODEL = "viewmodel"
1.86 +
1.87 + /**
1.88 + * Key for the name of the additional stylesheet used by a module.
1.89 + */
1.90 + const val REQ_ATTR_STYLESHEET = "extraCss"
1.91 +
1.92 + /**
1.93 + * Key for a location the page shall redirect to.
1.94 + * Will be used in a meta element.
1.95 + */
1.96 + const val REQ_ATTR_REDIRECT_LOCATION = "redirectLocation"
1.97 +
1.98 + /**
1.99 + * Key for the current language selection within the session.
1.100 + */
1.101 + const val SESSION_ATTR_LANGUAGE = "language"
1.102 +}
