Application (Alfresco 5.3.a-SNAPSHOT API)

java.lang.Object
- org.alfresco.web.app.Application

```
public class Application
extends Object
```
Utilities class

Author:

gavinc

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`BEAN_CONFIG_SERVICE`
`static String`	`BEAN_DATA_DICTIONARY`
`static String`	`BEAN_IMPORTER_BOOTSTRAP`
`static String`	`MESSAGE_BUNDLE`

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static ResourceBundle`	`getBundle(FacesContext context)` Get the specified the default message bundle for this user
`static ResourceBundle`	`getBundle(HttpSession session)` Get the specified the default message bundle for this user
`static ClientConfigElement`	`getClientConfig(FacesContext context)` Helper to get the client config element from the config service
`static ClientConfigElement`	`getClientConfig(ServletContext context)` Helper to get the client config element from the config service
`static String`	`getCompanyRootId()` Deprecated. Replace with user-context-specific getCompanyRootId (e.g. could be tenant-specific)
`static String`	`getCompanyRootId(FacesContext context)`
`static org.springframework.extensions.config.ConfigService`	`getConfigService(FacesContext context)` Helper to get the ConfigService instance
`static org.springframework.extensions.config.ConfigService`	`getConfigService(ServletContext context)` Helper to get the ConfigService instance
`static String`	`getContentTemplatesFolderName(FacesContext context)`
`static String`	`getContentTemplatesFolderName(ServletContext context)`
`static User`	`getCurrentUser(FacesContext context)`
`static User`	`getCurrentUser(HttpSession session)`
`static DashboardManager`	`getDashboardManager()` Retrieves the DashboardManager managed bean
`static DialogManager`	`getDialogManager()` Retrieves the DialogManager managed bean
`static String`	`getEmailTemplatesFolderName(FacesContext context)`
`static String`	`getEmailTemplatesFolderName(ServletContext context)`
`static String`	`getErrorPage(org.springframework.context.ApplicationContext context)` Retrieves the configured error page for the application
`static String`	`getErrorPage(ServletContext servletContext)` Retrieves the configured error page for the application
`static String`	`getGlossaryFolderName(FacesContext context)`
`static String`	`getGlossaryFolderName(ServletContext context)`
`static String`	`getGuestHomeFolderName(FacesContext context)`
`static String`	`getGuestHomeFolderName(ServletContext context)`
`static String`	`getInviteEmailTemplatesFolderName(FacesContext context)`
`static String`	`getInviteEmailTemplatesFolderName(ServletContext context)`
`static Locale`	`getLanguage(org.springframework.context.ApplicationContext ctx)` Return the configured language Locale for the application context
`static Locale`	`getLanguage(FacesContext fc)` Return the language Locale for the current user context
`static Locale`	`getLanguage(HttpSession session, boolean useInterfaceLanguage)` Return the language Locale for the current user Session.
`static String`	`getLoginPage(org.springframework.context.ApplicationContext context)` Retrieves the configured login page for the application
`static String`	`getLoginPage(ServletContext servletContext)` Retrieves the configured login page for the application
`static String`	`getMessage(FacesContext context, String msg)` Get the specified I18N message string from the default message bundle for this user
`static String`	`getMessage(HttpSession session, String msg)` Get the specified I18N message string from the default message bundle for this user
`static String`	`getNotifyEmailTemplatesFolderName(FacesContext context)`
`static String`	`getNotifyEmailTemplatesFolderName(ServletContext context)`
`static org.alfresco.service.cmr.repository.StoreRef`	`getRepositoryStoreRef(FacesContext context)`
`static org.alfresco.service.cmr.repository.StoreRef`	`getRepositoryStoreRef(ServletContext context)`
`static String`	`getRootPath(FacesContext context)`
`static String`	`getRootPath(ServletContext context)`
`static String`	`getRSSTemplatesFolderName(FacesContext context)`
`static String`	`getRSSTemplatesFolderName(ServletContext context)`
`static String`	`getSavedSearchesFolderName(FacesContext context)`
`static String`	`getSavedSearchesFolderName(ServletContext context)`
`static String`	`getScriptsFolderName(FacesContext context)`
`static String`	`getScriptsFolderName(ServletContext context)`
`static SidebarBean`	`getSidebarBean()` Retrieves the SidebarBean
`static String`	`getSpaceTemplatesFolderName(FacesContext context)`
`static String`	`getSpaceTemplatesFolderName(ServletContext context)`
`static WizardManager`	`getWizardManager()` Retrieves the WizardManager managed bean
`static void`	`handleServletError(ServletContext servletContext, HttpServletRequest request, HttpServletResponse response, Throwable error, org.apache.commons.logging.Log logger, String returnPage)` Handles errors thrown from servlets
`static void`	`handleSystemError(ServletContext servletContext, HttpServletRequest request, HttpServletResponse response, String messageKey, int statusCode, org.apache.commons.logging.Log logger)` Handles error conditions detected by servlets.
`static boolean`	`inPortalServer()` Determines whether the server is running in a portal
`static boolean`	`isDynamicConfig(FacesContext context)`
`static void`	`logOut(FacesContext context)` Invalidate Alfresco ticket and Web/Portlet session and clear the Security context for this thread.
`static void`	`setCompanyRootId(String id)` Deprecated. Replace with user-context-specific getCompanyRootId (e.g. could be tenant-specific)
`static void`	`setCurrentUser(FacesContext context, User user)`
`static void`	`setInPortalServer(boolean inPortal)` Sets whether this application is running inside a portal server
`static void`	`setLanguage(FacesContext context, String code)` Set the language locale for the current user context
`static void`	`setLanguage(HttpSession session, String code)` Deprecated.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - BEAN_CONFIG_SERVICE
```
public static final String BEAN_CONFIG_SERVICE
```
    See Also:
    
    Constant Field Values
  - BEAN_DATA_DICTIONARY
```
public static final String BEAN_DATA_DICTIONARY
```
    See Also:
    
    Constant Field Values
  - BEAN_IMPORTER_BOOTSTRAP
```
public static final String BEAN_IMPORTER_BOOTSTRAP
```
    See Also:
    
    Constant Field Values
  - MESSAGE_BUNDLE
```
public static final String MESSAGE_BUNDLE
```
    See Also:
    
    Constant Field Values
- Method Detail
  - setInPortalServer
```
public static void setInPortalServer(boolean inPortal)
```
    Sets whether this application is running inside a portal server
    
    Parameters:
    
    inPortal - true to indicate the application is running as a portlet
  - inPortalServer
```
public static boolean inPortalServer()
```
    Determines whether the server is running in a portal
    
    Returns:
    
    true if we are running inside a portal server
  - handleServletError
```
public static void handleServletError(ServletContext servletContext,
                                      HttpServletRequest request,
                                      HttpServletResponse response,
                                      Throwable error,
                                      org.apache.commons.logging.Log logger,
                                      String returnPage)
                               throws IOException,
                                      ServletException
```
    Handles errors thrown from servlets
    
    Parameters:
    
    servletContext - The servlet context
    
    request - The HTTP request
    
    response - The HTTP response
    
    error - The exception
    
    logger - The logger
    
    Throws:
    
    IOException
    
    ServletException
  - handleSystemError
```
public static void handleSystemError(ServletContext servletContext,
                                     HttpServletRequest request,
                                     HttpServletResponse response,
                                     String messageKey,
                                     int statusCode,
                                     org.apache.commons.logging.Log logger)
                              throws IOException,
                                     ServletException
```
    Handles error conditions detected by servlets.
    
    Parameters:
    
    servletContext - The servlet context
    
    request - The HTTP request
    
    response - The HTTP response
    
    messageKey - the resource bundle key for the error mesage
    
    statusCode - the status code to set on the response
    
    logger - The logger
    
    Throws:
    
    IOException - Signals that an I/O exception has occurred.
    
    ServletException - the servlet exception
  - getDialogManager
```
public static DialogManager getDialogManager()
```
    Retrieves the DialogManager managed bean
    
    Returns:
    
    DialogManager bean
  - getWizardManager
```
public static WizardManager getWizardManager()
```
    Retrieves the WizardManager managed bean
    
    Returns:
    
    WizardManager bean
  - getDashboardManager
```
public static DashboardManager getDashboardManager()
```
    Retrieves the DashboardManager managed bean
    
    Returns:
    
    DashboardManager bean
  - getSidebarBean
```
public static SidebarBean getSidebarBean()
```
    Retrieves the SidebarBean
    
    Returns:
    
    SidebarBean bean
  - getErrorPage
```
public static String getErrorPage(ServletContext servletContext)
```
    Retrieves the configured error page for the application
    
    Parameters:
    
    servletContext - The servlet context
    
    Returns:
    
    The configured error page or null if the configuration is missing
  - getLoginPage
```
public static String getLoginPage(ServletContext servletContext)
```
    Retrieves the configured login page for the application
    
    Parameters:
    
    servletContext - The servlet context
    
    Returns:
    
    The configured login page or null if the configuration is missing
  - getCurrentUser
```
public static User getCurrentUser(HttpSession session)
```
    Returns:
    
    Returns the User object representing the currently logged in user
  - getCurrentUser
```
public static User getCurrentUser(FacesContext context)
```
    Returns:
    
    Returns the User object representing the currently logged in user
  - setCurrentUser
```
public static void setCurrentUser(FacesContext context,
                                  User user)
```
  - logOut
```
public static void logOut(FacesContext context)
```
    Invalidate Alfresco ticket and Web/Portlet session and clear the Security context for this thread.
    
    Parameters:
    
    context -
  - getRepositoryStoreRef
```
public static org.alfresco.service.cmr.repository.StoreRef getRepositoryStoreRef(ServletContext context)
```
    Returns:
    
    Returns the repository store URL (retrieved from config service)
  - getRepositoryStoreRef
```
public static org.alfresco.service.cmr.repository.StoreRef getRepositoryStoreRef(FacesContext context)
```
    Returns:
    
    Returns the repository store URL (retrieved from config service)
  - getCompanyRootId
```
public static String getCompanyRootId()
```
    Deprecated. Replace with user-context-specific getCompanyRootId (e.g. could be tenant-specific)
    
    Returns:
    
    Returns id of the company root
  - setCompanyRootId
```
public static void setCompanyRootId(String id)
```
    Deprecated. Replace with user-context-specific getCompanyRootId (e.g. could be tenant-specific)
    
    Sets the company root id. This is setup by the ContextListener.
    
    Parameters:
    
    id - The company root id
  - getCompanyRootId
```
public static String getCompanyRootId(FacesContext context)
```
    Returns:
    
    Returns id of the company root
  - getRootPath
```
public static String getRootPath(ServletContext context)
```
    Returns:
    
    Returns the root path for the application
  - getRootPath
```
public static String getRootPath(FacesContext context)
```
    Returns:
    
    Returns the root path for the application
  - getGlossaryFolderName
```
public static String getGlossaryFolderName(ServletContext context)
```
    Returns:
    
    Returns the glossary folder name
  - getGlossaryFolderName
```
public static String getGlossaryFolderName(FacesContext context)
```
    Returns:
    
    Returns the glossary folder name
  - getSpaceTemplatesFolderName
```
public static String getSpaceTemplatesFolderName(ServletContext context)
```
    Returns:
    
    Returns the Space templates folder name
  - getSpaceTemplatesFolderName
```
public static String getSpaceTemplatesFolderName(FacesContext context)
```
    Returns:
    
    Returns the Space templates folder name
  - getContentTemplatesFolderName
```
public static String getContentTemplatesFolderName(ServletContext context)
```
    Returns:
    
    Returns the Content templates folder name
  - getContentTemplatesFolderName
```
public static String getContentTemplatesFolderName(FacesContext context)
```
    Returns:
    
    Returns the Content templates folder name
  - getInviteEmailTemplatesFolderName
```
public static String getInviteEmailTemplatesFolderName(ServletContext context)
```
    Returns:
    
    Returns the Invite Email Templates folder name
  - getInviteEmailTemplatesFolderName
```
public static String getInviteEmailTemplatesFolderName(FacesContext context)
```
    Returns:
    
    Returns the Invite Email Templates folder name
  - getNotifyEmailTemplatesFolderName
```
public static String getNotifyEmailTemplatesFolderName(ServletContext context)
```
    Returns:
    
    Returns the Notify Email Templates folder name
  - getNotifyEmailTemplatesFolderName
```
public static String getNotifyEmailTemplatesFolderName(FacesContext context)
```
    Returns:
    
    Returns the Notify Email Templates folder name
  - getEmailTemplatesFolderName
```
public static String getEmailTemplatesFolderName(ServletContext context)
```
    Returns:
    
    Returns the Email templates folder name
  - getEmailTemplatesFolderName
```
public static String getEmailTemplatesFolderName(FacesContext context)
```
    Returns:
    
    Returns the Email templates folder name
  - getRSSTemplatesFolderName
```
public static String getRSSTemplatesFolderName(ServletContext context)
```
    Returns:
    
    Returns the RSS templates folder name
  - getRSSTemplatesFolderName
```
public static String getRSSTemplatesFolderName(FacesContext context)
```
    Returns:
    
    Returns the RSS templates folder name
  - getSavedSearchesFolderName
```
public static String getSavedSearchesFolderName(ServletContext context)
```
    Returns:
    
    Return the Saved Searches folder name
  - getSavedSearchesFolderName
```
public static String getSavedSearchesFolderName(FacesContext context)
```
    Returns:
    
    Return the Saved Searches folder name
  - getScriptsFolderName
```
public static String getScriptsFolderName(ServletContext context)
```
    Returns:
    
    Return the JavaScript scripts folder name
  - getScriptsFolderName
```
public static String getScriptsFolderName(FacesContext context)
```
    Returns:
    
    Return the JavaScript scripts folder name
  - getGuestHomeFolderName
```
public static String getGuestHomeFolderName(ServletContext context)
```
    Returns:
    
    Return the Guest Home folder name
  - getGuestHomeFolderName
```
public static String getGuestHomeFolderName(FacesContext context)
```
    Returns:
    
    Return the Guest Home folder name
  - setLanguage
```
public static void setLanguage(FacesContext context,
                               String code)
```
    Set the language locale for the current user context
    
    Parameters:
    
    context - FacesContext for current user
    
    code - The ISO locale code to set
  - setLanguage
```
@Deprecated
public static void setLanguage(HttpSession session,
                                           String code)
```
    Deprecated.
    
    Set the language locale for the current user session.
    
    Parameters:
    
    session - HttpSession for current user
    
    code - The ISO locale code to set
  - getLanguage
```
public static Locale getLanguage(FacesContext fc)
```
    Return the language Locale for the current user context
    
    Parameters:
    
    fc - FacesContext for the current user
    
    Returns:
    
    Current language Locale set or the VM default if none set - never null
  - getLanguage
```
public static Locale getLanguage(HttpSession session,
                                 boolean useInterfaceLanguage)
```
    Return the language Locale for the current user Session.
    
    Parameters:
    
    session - HttpSession for the current user
    
    useInterfaceLanguage - If the session language hasn't been established yet, should we base it on user preferences?
    
    Returns:
    
    Current language Locale set or the VM default if none set - never null
  - getLanguage
```
public static Locale getLanguage(org.springframework.context.ApplicationContext ctx)
```
    Return the configured language Locale for the application context
    
    Parameters:
    
    ctx - the application context
    
    Returns:
    
    Current language Locale set or the VM default if none set - never null
  - getMessage
```
public static String getMessage(FacesContext context,
                                String msg)
```
    Get the specified I18N message string from the default message bundle for this user
    
    Parameters:
    
    context - FacesContext
    
    msg - Message ID
    
    Returns:
    
    String from message bundle or $$msg$$ if not found
  - getMessage
```
public static String getMessage(HttpSession session,
                                String msg)
```
    Get the specified I18N message string from the default message bundle for this user
    
    Parameters:
    
    session - HttpSession
    
    msg - Message ID
    
    Returns:
    
    String from message bundle or $$msg$$ if not found
  - getBundle
```
public static ResourceBundle getBundle(HttpSession session)
```
    Get the specified the default message bundle for this user
    
    Parameters:
    
    session - HttpSession
    
    Returns:
    
    ResourceBundle for this user
  - getBundle
```
public static ResourceBundle getBundle(FacesContext context)
```
    Get the specified the default message bundle for this user
    
    Parameters:
    
    context - FacesContext
    
    Returns:
    
    ResourceBundle for this user
  - getConfigService
```
public static org.springframework.extensions.config.ConfigService getConfigService(FacesContext context)
```
    Helper to get the ConfigService instance
    
    Parameters:
    
    context - FacesContext
    
    Returns:
    
    ConfigService
  - getConfigService
```
public static org.springframework.extensions.config.ConfigService getConfigService(ServletContext context)
```
    Helper to get the ConfigService instance
    
    Parameters:
    
    context - ServletContext
    
    Returns:
    
    ConfigService
  - getClientConfig
```
public static ClientConfigElement getClientConfig(FacesContext context)
```
    Helper to get the client config element from the config service
    
    Parameters:
    
    context - FacesContext
    
    Returns:
    
    The ClientConfigElement
  - getClientConfig
```
public static ClientConfigElement getClientConfig(ServletContext context)
```
    Helper to get the client config element from the config service
    
    Parameters:
    
    context - ServletContext
    
    Returns:
    
    The ClientConfigElement
  - getErrorPage
```
public static String getErrorPage(org.springframework.context.ApplicationContext context)
```
    Retrieves the configured error page for the application
    
    Parameters:
    
    context - The Spring context
    
    Returns:
    
    The configured error page or null if the configuration is missing
  - getLoginPage
```
public static String getLoginPage(org.springframework.context.ApplicationContext context)
```
    Retrieves the configured login page for the application
    
    Parameters:
    
    context - The Spring contexr
    
    Returns:
    
    The configured login page or null if the configuration is missing
  - isDynamicConfig
```
public static boolean isDynamicConfig(FacesContext context)
```

Class Application

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BEAN_CONFIG_SERVICE

BEAN_DATA_DICTIONARY

BEAN_IMPORTER_BOOTSTRAP

MESSAGE_BUNDLE

Method Detail

setInPortalServer

inPortalServer

handleServletError

handleSystemError

getDialogManager

getWizardManager

getDashboardManager

getSidebarBean

getErrorPage

getLoginPage

getCurrentUser

getCurrentUser

setCurrentUser

logOut

getRepositoryStoreRef

getRepositoryStoreRef

getCompanyRootId

setCompanyRootId

getCompanyRootId

getRootPath

getRootPath

getGlossaryFolderName

getGlossaryFolderName

getSpaceTemplatesFolderName

getSpaceTemplatesFolderName

getContentTemplatesFolderName

getContentTemplatesFolderName

getInviteEmailTemplatesFolderName

getInviteEmailTemplatesFolderName

getNotifyEmailTemplatesFolderName

getNotifyEmailTemplatesFolderName

getEmailTemplatesFolderName

getEmailTemplatesFolderName

getRSSTemplatesFolderName

getRSSTemplatesFolderName

getSavedSearchesFolderName

getSavedSearchesFolderName

getScriptsFolderName

getScriptsFolderName

getGuestHomeFolderName

getGuestHomeFolderName

setLanguage

setLanguage

getLanguage

getLanguage

getLanguage

getMessage

getMessage

getBundle

getBundle

getConfigService

getConfigService

getClientConfig

getClientConfig

getErrorPage

getLoginPage

isDynamicConfig