/vt-ldap/branches/vt-ldap-3/src/main/java/edu/vt/middleware/ldap/servlets/ServletConstants.java

http://vt-middleware.googlecode.com/ · Java · 108 lines · 32 code · 23 blank · 53 comment · 0 complexity · 885ac96084be02bffc93d30950fd0a80 MD5 · raw file 

    

  1. /*
    2. 

  2.   $Id: ServletConstants.java 1330 2010-05-23 22:10:53Z dfisher $
    3. 

    4. 

  4.   Copyright (C) 2003-2010 Virginia Tech.
    5. 

  5.   All rights reserved.
    6. 

    7. 

  7.   SEE LICENSE FOR MORE INFORMATION
    8. 

    9. 

  9.   Author:  Middleware Services
    10. 

  10.   Email:   middleware@vt.edu
    11. 

  11.   Version: $Revision: 1330 $
    12. 

  12.   Updated: $Date: 2010-05-24 00:10:53 +0200 (Mon, 24 May 2010) $
    13. 

  13. */
    14. 

  14. package edu.vt.middleware.ldap.servlets;
    15. 

  15. 

  16. /**
    17. 

  17.  * <code>ServletConstants</code> contains all the constants needed by the ldap
    18. 

  18.  * servlet package.
    19. 

  19.  *
    20. 

  20.  * @author  Middleware Services
    21. 

  21.  * @version  $Revision: 1330 $ $Date: 2010-05-24 00:10:53 +0200 (Mon, 24 May 2010) $
    22. 

  22.  */
    23. 

  23. public final class ServletConstants
    24. 

  24. {
    25. 

  25. 

  26.   /** Domain to look for properties in, value is {@value}. */
    27. 

  27.   public static final String PROPERTIES_DOMAIN =
    28. 

  28.     "edu.vt.middleware.ldap.servlets.";
    29. 

  29. 

  30.   /** LDAP initialization properties file, value is {@value}. */
    31. 

  31.   public static final String PROPERTIES_FILE = PROPERTIES_DOMAIN +
    32. 

  32.     "propertiesFile";
    33. 

  33. 

  34.   /** LDAP pool initialization properties file, value is {@value}. */
    35. 

  35.   public static final String POOL_PROPERTIES_FILE = PROPERTIES_DOMAIN +
    36. 

  36.     "poolPropertiesFile";
    37. 

  37. 

  38.   /** Format of search output, value is {@value}. */
    39. 

  39.   public static final String OUTPUT_FORMAT = PROPERTIES_DOMAIN + "outputFormat";
    40. 

  40. 

  41.   /** Default format of search output, value is {@value}. */
    42. 

  42.   public static final String DEFAULT_OUTPUT_FORMAT = "DSML";
    43. 

  43. 

  44.   /** Type of pool used, value is {@value}. */
    45. 

  45.   public static final String POOL_TYPE = PROPERTIES_DOMAIN + "poolType";
    46. 

  46. 

  47.   /** Type of ldap bean factory, value is {@value}. */
    48. 

  48.   public static final String BEAN_FACTORY = PROPERTIES_DOMAIN + "beanFactory";
    49. 

  49. 

  50.   /**
    51. 

  51.    * Identifier to set in the session after valid authentication, value is
    52. 

  52.    * {@value}.
    53. 

  53.    */
    54. 

  54.   public static final String SESSION_ID = PROPERTIES_DOMAIN + "sessionId";
    55. 

  55. 

  56.   /**
    57. 

  57.    * Default identifier to set in the session after valid authentication, value
    58. 

  58.    * is {@value}.
    59. 

  59.    */
    60. 

  60.   public static final String DEFAULT_SESSION_ID = "user";
    61. 

  61. 

  62.   /** Whether to invalidate the user session at logout, value is {@value}. */
    63. 

  63.   public static final String INVALIDATE_SESSION = PROPERTIES_DOMAIN +
    64. 

  64.     "invalidateSession";
    65. 

  65. 

  66.   /**
    67. 

  67.    * Default behavior for invalidating the user session at logout, value is
    68. 

  68.    * {@value}.
    69. 

  69.    */
    70. 

  70.   public static final String DEFAULT_INVALIDATE_SESSION = "true";
    71. 

  71. 

  72.   /** URL of the page that collects user credentials, value is {@value}. */
    73. 

  73.   public static final String LOGIN_URL = PROPERTIES_DOMAIN + "loginUrl";
    74. 

  74. 

  75.   /**
    76. 

  76.    * Default URL of the page that does collects user credentials, value is
    77. 

  77.    * {@value}.
    78. 

  78.    */
    79. 

  79.   public static final String DEFAULT_LOGIN_URL = "/";
    80. 

  80. 

  81.   /** Error message to display if authentication fails, value is {@value}. */
    82. 

  82.   public static final String ERROR_MSG = PROPERTIES_DOMAIN + "errorMsg";
    83. 

  83. 

  84.   /** Class used to initialize http sessions. */
    85. 

  85.   public static final String SESSION_MANAGER = PROPERTIES_DOMAIN +
    86. 

  86.     "sessionManager";
    87. 

  87. 

  88.   /** Default session initializer, value is {@value}. */
    89. 

  89.   public static final String DEFAULT_SESSION_MANAGER =
    90. 

  90.     "edu.vt.middleware.ldap.servlets.session.DefaultSessionManager";
    91. 

  91. 

  92.   /** Default error message, value is {@value}. */
    93. 

  93.   public static final String DEFAULT_ERROR_MSG =
    94. 

  94.     "Could not authenticate or authorize user";
    95. 

  95. 

  96.   /** HTTP parameter used to transmit the user identifier, value is {@value}. */
    97. 

  97.   public static final String USER_PARAM = "user";
    98. 

  98. 

  99.   /** HTTP parameter used to transmit the user credential, value is {@value}. */
    100. 

  100.   public static final String CREDENTIAL_PARAM = "credential";
    101. 

  101. 

  102.   /** HTTP parameter used to transmit the redirect url, value is {@value}. */
    103. 

  103.   public static final String URL_PARAM = "url";
    104. 

  104. 

  105. 

  106.   /** Default constructor. */
    107. 

  107.   private ServletConstants() {}
    108. 

  108. }
    109.