1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/src/main/java/de/uapcore/lightpit/Constants.java Sat May 09 14:26:31 2020 +0200
1.3 @@ -0,0 +1,106 @@
1.4 +/*
1.5 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
1.6 + *
1.7 + * Copyright 2018 Mike Becker. All rights reserved.
1.8 + *
1.9 + * Redistribution and use in source and binary forms, with or without
1.10 + * modification, are permitted provided that the following conditions are met:
1.11 + *
1.12 + * 1. Redistributions of source code must retain the above copyright
1.13 + * notice, this list of conditions and the following disclaimer.
1.14 + *
1.15 + * 2. Redistributions in binary form must reproduce the above copyright
1.16 + * notice, this list of conditions and the following disclaimer in the
1.17 + * documentation and/or other materials provided with the distribution.
1.18 + *
1.19 + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
1.20 + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
1.21 + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
1.22 + * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
1.23 + * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
1.24 + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
1.25 + * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
1.26 + * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
1.27 + * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
1.28 + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
1.29 + * POSSIBILITY OF SUCH DAMAGE.
1.30 + *
1.31 + */
1.32 +package de.uapcore.lightpit;
1.33 +
1.34 +import static de.uapcore.lightpit.Functions.fqn;
1.35 +
1.36 +/**
1.37 + * Contains all non-local scope constants used by the this application.
1.38 + *
1.39 + * Constants with (class) local scope are defined in their respective classes.
1.40 + */
1.41 +public final class Constants {
1.42 + public static final String JSP_PATH_PREFIX = "/WEB-INF/jsp/";
1.43 +
1.44 + public static final String JSPF_PATH_PREFIX = "/WEB-INF/jspf/";
1.45 +
1.46 + public static final String DYN_FRAGMENT_PATH_PREFIX = "/WEB-INF/dynamic_fragments/";
1.47 +
1.48 +
1.49 + /**
1.50 + * Name for the context parameter specifying the available languages.
1.51 + */
1.52 + public static final String CTX_ATTR_LANGUAGES = "available-languages";
1.53 +
1.54 + /**
1.55 + * Name for the context parameter optionally specifying the JNDI context;
1.56 + */
1.57 + public static final String CTX_ATTR_JNDI_CONTEXT = "jndi-context";
1.58 +
1.59 + /**
1.60 + * Name for the context parameter optionally specifying a database schema.
1.61 + */
1.62 + public static final String CTX_ATTR_DB_SCHEMA = "db-schema";
1.63 +
1.64 + /**
1.65 + * Name for the context parameter optionally specifying a database dialect.
1.66 + */
1.67 + public static final String CTX_ATTR_DB_DIALECT = "db-dialect";
1.68 +
1.69 + /**
1.70 + * Key for the request attribute containing the class name of the currently dispatching module.
1.71 + */
1.72 + public static final String REQ_ATTR_MODULE_CLASSNAME = fqn(AbstractLightPITServlet.class, "moduleClassname");
1.73 +
1.74 + /**
1.75 + * Key for the request attribute containing the {@link LightPITModule} information of the currently dispatching module.
1.76 + */
1.77 + public static final String REQ_ATTR_MODULE_INFO = fqn(AbstractLightPITServlet.class, "moduleInfo");
1.78 +
1.79 + /**
1.80 + * Key for the request attribute containing the menu list.
1.81 + */
1.82 + public static final String REQ_ATTR_MENU = fqn(AbstractLightPITServlet.class, "mainMenu");
1.83 +
1.84 + /**
1.85 + * Key for the request attribute containing the full path information (servlet path + path info).
1.86 + */
1.87 + public static final String REQ_ATTR_PATH = fqn(AbstractLightPITServlet.class, "path");
1.88 +
1.89 + /**
1.90 + * Key for the name of the fragment which should be rendered.
1.91 + */
1.92 + public static final String REQ_ATTR_FRAGMENT = fqn(AbstractLightPITServlet.class, "fragment");
1.93 +
1.94 + /**
1.95 + * Key for the name of the additional stylesheet used by a module.
1.96 + */
1.97 + public static final String REQ_ATTR_STYLESHEET = fqn(AbstractLightPITServlet.class, "extraCss");
1.98 +
1.99 +
1.100 + /**
1.101 + * Key for the current language selection within the session.
1.102 + */
1.103 + public static final String SESSION_ATTR_LANGUAGE = fqn(AbstractLightPITServlet.class, "language");
1.104 +
1.105 + /**
1.106 + * This class is not instantiatable.
1.107 + */
1.108 + private Constants() {}
1.109 +}
