com.arsdigita.kernel.security
Class Initializer

java.lang.Object
  extended bycom.arsdigita.kernel.security.Initializer
All Implemented Interfaces:
Initializer

public class Initializer
extends Object
implements Initializer

Initializes security properties.

Deprecated feature: Provides access to URLs for standard pages.

Since:
ACS 4.5
Author:
Sameer Ajmani

Field Summary
static String AUTO_REGISTRATION_ON_PARAM
          When this is on new users get automatically redirected to the create new user form
static String CHANGE_PAGE_KEY
          Key for the change-password page.
static String COOKIES_PAGE_KEY
          Key for the explain-cookies page.
static String EDIT_PAGE_KEY
          Key for the user edit page.
static String EXCLUDED_EXTENSIONS_PARAM
          Parameter name for excluded URI extensions.
static String EXPIRED_PAGE_KEY
          Key for the login-expired page.
static String LOGIN_CONFIG_PARAM
          Parameter name for login configuration.
static String LOGIN_PAGE_KEY
          Key for the login page.
static String LOGIN_REDIRECT_PAGE_KEY
          Key for the login redirect url.
static String LOGOUT_PAGE_KEY
          Key for the logout page.
static String NEWUSER_PAGE_KEY
          Key for the new user page.
static String PERM_SINGLE_PAGE_KEY
          Key for the single-permission page.
static String PERMISSION_PAGE_KEY
          Key for the admin-permission page.
static String RECOVER_PAGE_KEY
          Key for the recover-password page.
static String ROOT_PAGE_KEY
          Key for the root page of the site.
static int SECRET_KEY_BYTES
          Size of secret key in bytes.
static String SECURITY_HELPER_PARAM
          Parameter name for security helper class name.
static String SESSION_TRACKING_PARAM
          Obsolete parameter name for session tracking method.
static String versionId
           
static String WORKSPACE_PAGE_KEY
          Key for the workspace page.
 
Constructor Summary
Initializer()
           
 
Method Summary
static boolean getAutoRegistrationOn()
           
 Configuration getConfiguration()
          Returns the configuration object used by this initializer.
static Iterator getExcludedExtensions()
          Deprecated. To be moved into a utility class.
static String getFullURL(String key, javax.servlet.http.HttpServletRequest req)
          Returns the absolute URL associated with the given key.
static SecurityHelper getSecurityHelper()
          Deprecated. Moved into Util
static String getURL(String key)
          Deprecated. To be replaced by package parameters.
 void shutdown()
          Called on shutdown.
 void startup()
          Called on startup.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

versionId

public static final String versionId
See Also:
Constant Field Values

SESSION_TRACKING_PARAM

public static String SESSION_TRACKING_PARAM
Obsolete parameter name for session tracking method.


LOGIN_CONFIG_PARAM

public static String LOGIN_CONFIG_PARAM
Parameter name for login configuration.


SECURITY_HELPER_PARAM

public static String SECURITY_HELPER_PARAM
Parameter name for security helper class name.


EXCLUDED_EXTENSIONS_PARAM

public static String EXCLUDED_EXTENSIONS_PARAM
Parameter name for excluded URI extensions.


SECRET_KEY_BYTES

public static int SECRET_KEY_BYTES
Size of secret key in bytes.


AUTO_REGISTRATION_ON_PARAM

public static String AUTO_REGISTRATION_ON_PARAM
When this is on new users get automatically redirected to the create new user form


ROOT_PAGE_KEY

public static String ROOT_PAGE_KEY
Key for the root page of the site.


EDIT_PAGE_KEY

public static String EDIT_PAGE_KEY
Key for the user edit page.


LOGIN_PAGE_KEY

public static String LOGIN_PAGE_KEY
Key for the login page.


NEWUSER_PAGE_KEY

public static String NEWUSER_PAGE_KEY
Key for the new user page.


LOGOUT_PAGE_KEY

public static String LOGOUT_PAGE_KEY
Key for the logout page.


COOKIES_PAGE_KEY

public static String COOKIES_PAGE_KEY
Key for the explain-cookies page.


EXPIRED_PAGE_KEY

public static String EXPIRED_PAGE_KEY
Key for the login-expired page.


CHANGE_PAGE_KEY

public static String CHANGE_PAGE_KEY
Key for the change-password page.


RECOVER_PAGE_KEY

public static String RECOVER_PAGE_KEY
Key for the recover-password page.


WORKSPACE_PAGE_KEY

public static String WORKSPACE_PAGE_KEY
Key for the workspace page.


LOGIN_REDIRECT_PAGE_KEY

public static String LOGIN_REDIRECT_PAGE_KEY
Key for the login redirect url.


PERMISSION_PAGE_KEY

public static String PERMISSION_PAGE_KEY
Key for the admin-permission page.


PERM_SINGLE_PAGE_KEY

public static String PERM_SINGLE_PAGE_KEY
Key for the single-permission page.

Constructor Detail

Initializer

public Initializer()
            throws InitializationException
Method Detail

getConfiguration

public Configuration getConfiguration()
Description copied from interface: Initializer
Returns the configuration object used by this initializer.

Specified by:
getConfiguration in interface Initializer

getAutoRegistrationOn

public static boolean getAutoRegistrationOn()

startup

public void startup()
             throws InitializationException
Description copied from interface: Initializer
Called on startup.

Specified by:
startup in interface Initializer
Throws:
InitializationException

getExcludedExtensions

public static Iterator getExcludedExtensions()
Deprecated. To be moved into a utility class.

Returns an iterator over the list of excluded extensions.

Returns:
an iterator over the list of excluded extensions.

getSecurityHelper

public static SecurityHelper getSecurityHelper()
Deprecated. Moved into Util

Returns the security helper instance.

Returns:
the security helper instance.

getURL

public static String getURL(String key)
Deprecated. To be replaced by package parameters.

Returns the relative URL associated with the given key. This is the value of the URL in the page map for the given key.

Returns:
the relative URL associated with the given key, or null if it does not exist.
See Also:
getFullURL(String, HttpServletRequest)

getFullURL

public static String getFullURL(String key,
                                javax.servlet.http.HttpServletRequest req)
Returns the absolute URL associated with the given key. This is the root URL for the system (the mount point) prepended to the result of getURL(key).

Returns:
the absolute URL associated with the given key, or null if it does not exist.
See Also:
getURL(String)

shutdown

public void shutdown()
              throws InitializationException
Description copied from interface: Initializer
Called on shutdown. It's probably not a good idea to depend on this being called.

Specified by:
shutdown in interface Initializer
Throws:
InitializationException


Copyright (c) 2004 Red Hat, Inc. Corporation. All Rights Reserved. Generated at July 21 2004:2337 UTC