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