com.wewebu.ow.server.app
Class OwConfiguration

java.lang.Object
  extended by com.wewebu.ow.server.conf.OwBaseConfiguration
      extended by com.wewebu.ow.server.app.OwConfiguration
All Implemented Interfaces:
OwAttributeBag

public class OwConfiguration
extends OwBaseConfiguration
implements OwAttributeBag

Configuration class for the global application Configuration and Plugins.

NOTE: The Bootstrap Configuration and Plugin Descriptions will only be reloaded upon Application restart. Also, if several identical Applications are deployed in one application server, they need their own classloader, otherwise they will share the bootstrap Configuration and plugins.

Alfresco Workdesk
Copyright (c) Alfresco Software, Inc.
All rights reserved.

For licensing information read the license.txt file or
go to: http://wiki.alfresco.com


Nested Class Summary
protected  class OwConfiguration.OwErrorView
          simple message view class to display a exception when main plugin load failed
 class OwConfiguration.OwMasterPluginInstance
          plugin instance used as return value of createMasterPlugin function
 
Nested classes/interfaces inherited from class com.wewebu.ow.server.conf.OwBaseConfiguration
OwBaseConfiguration.OwPluginTypeDefinition
 
Field Summary
static String ECM_ADAPTER_ELEMENT
           
static int IMPLEMENTATION_FIXPACK_VERSION
          fixpack version number of the implementation
static int IMPLEMENTATION_MAJOR_VERSION
          major version number of the implementation
static int IMPLEMENTATION_MINOR_VERSION
          minor version number of the implementation
static String IMPLEMENTATION_RELEASE_TYPE
          release type (rc1,rc2,alpha,beta)
static int IMPLEMENTATION_UPDATE_VERSION
          update version number of the implementation
static int INTERFACE_MAJOR_VERSION
          major version number of the used Interface
static int INTERFACE_MINOR_VERSION
          minor version number of the used Interface
protected  List m_AllowedDocumentFunctionPluginList
          list of OwDocumentFunction plugins
protected  Map m_AllowedDocumentFunctionPluginMap
          backup map of OwDocumentFunction plugins
protected  List m_AllowedMasterPluginList
          list of the main plugins OwMasterPluginInstance instances
protected  Map m_AllowedMasterPluginMap
          backup map OwMasterPluginInstance plugins
protected  List m_AllowedRecordFunctionPluginList
          list OwRecordFunction plugins
protected  Map m_AllowedRecordFunctionPluginMap
          backup map OwRecordFunction plugins
protected  OwMainAppContext m_Context
          reference to the application context, used to read and write Configuration.
static String MAIN_PLUGIN_DOCUMENT_ID_EXTENSION
          ID extension for the document of a main plugin to be added to the plugin ID
static String MAIN_PLUGIN_VIEW_ID_EXTENSION
          ID extension for the document of a main plugin to be added to the plugin ID
static String MIME_TYPE_OPTION_PREFIX
          prefix for the option id's for MIME types for the mandator selective configuration
static String MIMETYPES_CUSTOM_FILE_NAME
          name of the properties file used to define own mimetypes, overriding the existing ones
static int PLUGINS_REQUIRE_CAN_MULTISELECT
          flag indicating that at least one plugin can handle multiselection, see getPluginRequirementFlags()
static int PLUGINS_REQUIRE_CONTEXT_MENU
          flag indicating that at least one plugin needs a context menu, see getPluginRequirementFlags()
static int SSL_MODE_NONE
          SSL mode to use for requests
static int SSL_MODE_SESSION
          SSL mode to use for requests
static String WORKDESK_APPLICATION_ID
           
 
Fields inherited from class com.wewebu.ow.server.conf.OwBaseConfiguration
m_pluginTypeDefinitions, PLUGIN_NODE_CLASSNAME, PLUGIN_NODE_DESCRIPTION, PLUGIN_NODE_HELP, PLUGIN_NODE_ID, PLUGIN_NODE_NAME, PLUGIN_NODE_SETTINGS_SET, PLUGIN_NODE_VENDOR, PLUGIN_NODE_VERSION, PLUGIN_NODE_VIEW_CLASSNAME, PLUGIN_SETATTR_DISPLAY_NAME, PLUGIN_SETATTR_EDIT, PLUGIN_SETATTR_LIST, PLUGIN_SETATTR_MAX_SIZE, PLUGIN_SETATTR_SCOPE, PLUGINTYPE_APPLICATION, PLUGINTYPE_DOCUMENT_FUNCTION, PLUGINTYPE_MASTER, PLUGINTYPE_RECORD_FUNCTION
 
Constructor Summary
OwConfiguration()
           
 
Method Summary
static void applicationInitalize(OwBaseInitializer initializer_p)
          Init application config data upon startup, make sure the servlet listener OwConfigurationInitialisingContextListener is configured for your application.
 int attributecount()
          get the number of attributes, or -1 if unknown
 OwFieldManager createFieldManager()
          create a new instance of the field manager
protected  OwConfiguration.OwMasterPluginInstance createMasterPlugin(OwXMLUtil pluginNodeWrapper_p)
          create a single main plugin of the given plugin node wrapper
protected  OwConfiguration.OwMasterPluginInstance createMasterPlugin(String strDocClassName, String strViewClassName, OwXMLUtil pluginNodeWrapper_p)
          create a single main plugin of the given plugin node wrapper
 boolean displayLanguageSelection()
          flag indication if language selection should be displayed
 OwPlugin getAllowedPluginInstance(String strID_p)
          get a plugin instance for the given ID
 List getAllowedPlugins(String strType_p)
          get a list of plugin description nodes by type
 OwSettingsSet getAppSettings()
          retrieve the app settings object for dynamic complex application settings NOTE: The OwSettings are used for complex settings for the plugins which are manually changed from time to time by the user or the Administrator.
 Object getAttribute(int index_p)
          get a object at the specified index or throws OwObjectNotFoundException
 Object getAttribute(String strName_p)
          get the attribute with the given name or throws OwObjectNotFoundException
 Collection getAttributeNames()
          get all attribute names in the bag
 List getAvailableLanguages()
          get the list of language IDs for the user
static OwXMLUtil getBootstrap(OwBaseInitializer initializer_p)
           
 OwXMLUtil getBootstrapConfiguration()
          get the bootstrap Configuration DOM node
static String getBuildNumber()
          Get a readable string for buildNumber
 Map getClientWildCardDefinitions()
          get the client wildcard definitions to translate client wildcards to repository wildcards
 String getComboboxRendererClassName()
          Get the combobox renderer class name.
 String getDefaultFolderClassName()
          name of the default class used to create simple folders
 String getDefaultLanguage()
          the default language to be used, see also getDetectBrowserLocale()
 OwXMLUtil getDefaultMIMENode(int iObjectType_p)
          get the default MIME XML Entry for the given object type.
 boolean getDetectBrowserLocale()
          flag indicating if we use the browser language and override the default locale, see also getDefaultLanguage()
 OwDocumentFunction getDocumentFunction(String strID_p)
          get a single document function by ID
 List getDocumentFunctionPlugins()
          get document function plugins plugins
static String getEditionString()
          Get key string of the core system edition
 OwXMLUtil getFieldManagerConfiguration()
          get the fieldmanager configuration DOM node
 OwHistoryManager getHistoryManager()
          retrieve the HistoryManager object
 OwXMLUtil getHistoryManagerConfiguration()
          get the rolemanager configuration DOM node
 org.springframework.jdbc.core.JdbcTemplate getJDBCTemplate()
          get a spring JDBC template for the default DataSource
 String getLayoutConfigurationBagPrefix()
          Get the layout configuration bag prefix
 String getLocalizedPluginDescription(OwXMLUtil pluginDescriptionNode_p)
          get the localized description of a plugin
 String getLocalizedPluginDescription(String strID_p)
          get the localized description of a plugin
 String getLocalizedPluginSettingTitle(Node settingDescriptionNode_p, String strPluginName_p)
          get the localized title of a plugin setting
 String getLocalizedPluginTitle(OwXMLUtil pluginDescriptionNode_p)
          get the localized title of a plugin
 String getLocalizedPluginTitle(String strID_p)
          get the localized title of a plugin
 OwMandatorManager getMandatorManager()
          retrieve the MandatorManager object
 OwXMLUtil getMandatorManagerConfiguration()
          get the mandatormanager configuration DOM node
 OwConfiguration.OwMasterPluginInstance getMasterPlugin(String strID_p)
          get a single record function by ID
 List getMasterPlugins(boolean fExcludeListeners_p)
          get a list of OwMasterPluginInstance
 boolean getMessageBoxOnUserError()
          the behavior for UI messages caused by user error
 OwXMLUtil getMIMENode(String strMIMEType_p)
          get the MIME XML Entry for the given MIMEType.
 OwNetwork getNetwork()
          retrieve the network object
 OwXMLUtil getNetworkAdaptorConfiguration()
          get the Network Adaptor Configuration DOM node
 OwXMLUtil getPlugin(String strID_p)
          get a plugin description by its key
 List getRecordClassNames()
          get the list of classnames that act as records
 OwRecordFunction getRecordFunction(String strID_p)
          get a single record function by ID
 List getRecordFunctionPlugins()
          get record function plugins plugins
 OwRoleManager getRoleManager()
          retrieve the RoleManager object
 OwXMLUtil getRoleManagerConfiguration()
          get the rolemanager configuration DOM node
 Object getSafeAttribute(String strName_p, Object default_p)
          get the attribute with the given name, returns default if not found.
 OwSettings getSettings()
          retrieve the settings object for dynamic complex plugin settings NOTE: The OwSettings are used for complex settings for the plugins which are manually changed from time to time by the user or the Administrator.
 int getSSLMode()
          get the SSL mode to use for requests
 String getTempDir()
          Get the temp dir defined in bootstrap configuration, that can be used for upload.
 OwAttributeBagWriteable getUserAttributeBag()
          get the application wide scalar settings specific for the current user.
 Set<OwContextBasedUOListenerFactory> getUserOperationListenerFactories()
          Get the cached user operation listener factories.
static String getVersionString()
          Return a string representing a version.
 boolean hasAttribute(String strName_p)
          check if attribute exists
 void init(OwMainAppContext context_p)
          Init called before login, creates a new instance of OwConfiguration optionally set a prefix to distinguish several different applications.
 boolean isDocmentFunctionRequirement(int iRequirement_p)
          check the plugin requirement flag for document functions
 boolean isDocumentFunctionAllowed(String strID_p)
          check if document function with given ID is allowed
 boolean isDynamicSplitInUse()
          Get the configuration flag for dynamic split
 boolean isMasterPluginAllowed(String strID_p)
          check if master plugin with given ID is allowed
 boolean isRecordFunctionAllowed(String strID_p)
          check if record function with given ID is allowed
 boolean isUseExtJsForDragAndDrop()
          Do we use ExtJS for DnD or not?
 void loginInit()
          init called AFTER the user has logged in.
 void refreshStaticConfiguration()
          update the configuration data
 boolean setMasterRole(String strRole_p)
          set the new master role without logout
 void updatePlugins()
          update the plugins after the role has changed called after plugins have been created with createPlugins();
 
Methods inherited from class com.wewebu.ow.server.conf.OwBaseConfiguration
getPluginTypeDefinitions, getPluginTypeDisplayName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

INTERFACE_MINOR_VERSION

public static int INTERFACE_MINOR_VERSION
minor version number of the used Interface


INTERFACE_MAJOR_VERSION

public static int INTERFACE_MAJOR_VERSION
major version number of the used Interface


IMPLEMENTATION_MAJOR_VERSION

public static final int IMPLEMENTATION_MAJOR_VERSION
major version number of the implementation

See Also:
Constant Field Values

IMPLEMENTATION_MINOR_VERSION

public static final int IMPLEMENTATION_MINOR_VERSION
minor version number of the implementation

See Also:
Constant Field Values

IMPLEMENTATION_UPDATE_VERSION

public static final int IMPLEMENTATION_UPDATE_VERSION
update version number of the implementation

See Also:
Constant Field Values

IMPLEMENTATION_FIXPACK_VERSION

public static final int IMPLEMENTATION_FIXPACK_VERSION
fixpack version number of the implementation

See Also:
Constant Field Values

IMPLEMENTATION_RELEASE_TYPE

public static final String IMPLEMENTATION_RELEASE_TYPE
release type (rc1,rc2,alpha,beta)

See Also:
Constant Field Values

MIME_TYPE_OPTION_PREFIX

public static final String MIME_TYPE_OPTION_PREFIX
prefix for the option id's for MIME types for the mandator selective configuration

See Also:
Constant Field Values

ECM_ADAPTER_ELEMENT

public static final String ECM_ADAPTER_ELEMENT
See Also:
Constant Field Values

WORKDESK_APPLICATION_ID

public static final String WORKDESK_APPLICATION_ID
See Also:
Constant Field Values

MIMETYPES_CUSTOM_FILE_NAME

public static final String MIMETYPES_CUSTOM_FILE_NAME
name of the properties file used to define own mimetypes, overriding the existing ones

See Also:
Constant Field Values

m_Context

protected OwMainAppContext m_Context
reference to the application context, used to read and write Configuration.


m_AllowedDocumentFunctionPluginList

protected List m_AllowedDocumentFunctionPluginList
list of OwDocumentFunction plugins


m_AllowedDocumentFunctionPluginMap

protected Map m_AllowedDocumentFunctionPluginMap
backup map of OwDocumentFunction plugins


m_AllowedRecordFunctionPluginList

protected List m_AllowedRecordFunctionPluginList
list OwRecordFunction plugins


m_AllowedRecordFunctionPluginMap

protected Map m_AllowedRecordFunctionPluginMap
backup map OwRecordFunction plugins


m_AllowedMasterPluginList

protected List m_AllowedMasterPluginList
list of the main plugins OwMasterPluginInstance instances


m_AllowedMasterPluginMap

protected Map m_AllowedMasterPluginMap
backup map OwMasterPluginInstance plugins


MAIN_PLUGIN_DOCUMENT_ID_EXTENSION

public static final String MAIN_PLUGIN_DOCUMENT_ID_EXTENSION
ID extension for the document of a main plugin to be added to the plugin ID

See Also:
Constant Field Values

MAIN_PLUGIN_VIEW_ID_EXTENSION

public static final String MAIN_PLUGIN_VIEW_ID_EXTENSION
ID extension for the document of a main plugin to be added to the plugin ID

See Also:
Constant Field Values

PLUGINS_REQUIRE_CONTEXT_MENU

public static final int PLUGINS_REQUIRE_CONTEXT_MENU
flag indicating that at least one plugin needs a context menu, see getPluginRequirementFlags()

See Also:
Constant Field Values

PLUGINS_REQUIRE_CAN_MULTISELECT

public static final int PLUGINS_REQUIRE_CAN_MULTISELECT
flag indicating that at least one plugin can handle multiselection, see getPluginRequirementFlags()

See Also:
Constant Field Values

SSL_MODE_NONE

public static final int SSL_MODE_NONE
SSL mode to use for requests

See Also:
Constant Field Values

SSL_MODE_SESSION

public static final int SSL_MODE_SESSION
SSL mode to use for requests

See Also:
Constant Field Values
Constructor Detail

OwConfiguration

public OwConfiguration()
Method Detail

getVersionString

public static String getVersionString()
Return a string representing a version.

Returns:
String

getEditionString

public static String getEditionString()
Get key string of the core system edition

Returns:
String key

getBuildNumber

public static String getBuildNumber()
Get a readable string for buildNumber

Returns:
String build number id

init

public void init(OwMainAppContext context_p)
          throws Exception
Init called before login, creates a new instance of OwConfiguration optionally set a prefix to distinguish several different applications. The rolemanager will filter the allowed plugins, MIME-settings and design with the prefix. The default is empty. e.g. used for the Zero-Install Desktop Integration (ZIDI) to display a different set of plugins, MIME table and design for the Zero-Install Desktop Integration (ZIDI)

Parameters:
context_p - OwMainAppContext
Throws:
Exception

getJDBCTemplate

public org.springframework.jdbc.core.JdbcTemplate getJDBCTemplate()
get a spring JDBC template for the default DataSource

Returns:
a JdbcTemplate

applicationInitalize

public static void applicationInitalize(OwBaseInitializer initializer_p)
                                 throws OwConfigurationException
Init application config data upon startup, make sure the servlet listener OwConfigurationInitialisingContextListener is configured for your application.

Parameters:
initializer_p -
Throws:
OwConfigurationException

loginInit

public void loginInit()
               throws Exception
init called AFTER the user has logged in. NOTE: This function is called only once after login to do special initialization, which can only be performed with valid credentials.

Throws:
Exception

setMasterRole

public boolean setMasterRole(String strRole_p)
                      throws Exception
set the new master role without logout

Returns:
boolean true = role changed, false = role did not change
Throws:
Exception

getUserAttributeBag

public OwAttributeBagWriteable getUserAttributeBag()
                                            throws Exception
get the application wide scalar settings specific for the current user. Unlike the OwSettings the AttributeBag allows simple scalar values but with high performance. NOTE: The OwSettings are used for complex settings for the plugins which are manually changed from time to time by the user or the Administrator. ==> Performance is negligible, but values are highly structured. ==> OwSettings are usually based on a XML document. (depends on adapter implementation) The OwAttributeBagWriteable is used by the application itself to persist state. ==> Structure is negligible, but performance is important ==> OwAttributeBagWriteable is usually based on a DB table. (depends on adapter implementation)

Returns:
OwAttributeBagWriteable to read and write scalars
Throws:
Exception

getSettings

public OwSettings getSettings()
retrieve the settings object for dynamic complex plugin settings NOTE: The OwSettings are used for complex settings for the plugins which are manually changed from time to time by the user or the Administrator. ==> Performance is negligible, but values are highly structured. ==> OwSettings are usually based on a XML document. (depends on adapter implementation) The OwAttributeBagWriteable is used by the application itself to persist state. ==> Structure is negligible, but performance is important ==> OwAttributeBagWriteable is usually based on a DB table. (depends on adapter implementation)

Returns:
OwSettings

getAppSettings

public OwSettingsSet getAppSettings()
                             throws Exception
retrieve the app settings object for dynamic complex application settings NOTE: The OwSettings are used for complex settings for the plugins which are manually changed from time to time by the user or the Administrator. ==> Performance is negligible, but values are highly structured. ==> OwSettings are usually based on a XML document. (depends on adapter implementation) The OwAttributeBagWriteable is used by the application itself to persist state. ==> Structure is negligible, but performance is important ==> OwAttributeBagWriteable is usually based on a DB table. (depends on adapter implementation)

Returns:
OwSettingsSet
Throws:
Exception

getNetwork

public OwNetwork getNetwork()
retrieve the network object


getMandatorManager

public OwMandatorManager getMandatorManager()
retrieve the MandatorManager object


getRoleManager

public OwRoleManager getRoleManager()
retrieve the RoleManager object


getHistoryManager

public OwHistoryManager getHistoryManager()
retrieve the HistoryManager object


createFieldManager

public OwFieldManager createFieldManager()
                                  throws Exception
create a new instance of the field manager

Throws:
Exception

updatePlugins

public void updatePlugins()
                   throws Exception
update the plugins after the role has changed called after plugins have been created with createPlugins();

Throws:
Exception

createMasterPlugin

protected OwConfiguration.OwMasterPluginInstance createMasterPlugin(String strDocClassName,
                                                                    String strViewClassName,
                                                                    OwXMLUtil pluginNodeWrapper_p)
                                                             throws Exception
create a single main plugin of the given plugin node wrapper

Parameters:
strDocClassName - Name of the document class for doc-view-model
strViewClassName - Name of the view class for doc-view-model
pluginNodeWrapper_p - OwXMLUtil containing the plugin configuration node from owplugins.xml
Returns:
OwMasterPluginInstance with instantiated plugin view
Throws:
Exception - if master plugin can't be instantiated
Since:
3.2.0.0

createMasterPlugin

protected OwConfiguration.OwMasterPluginInstance createMasterPlugin(OwXMLUtil pluginNodeWrapper_p)
                                                             throws Exception
create a single main plugin of the given plugin node wrapper

Parameters:
pluginNodeWrapper_p -
Returns:
OwMasterPluginInstance with instantiated plugin view
Throws:
Exception

isDocmentFunctionRequirement

public boolean isDocmentFunctionRequirement(int iRequirement_p)
check the plugin requirement flag for document functions

Parameters:
iRequirement_p - int flag as defined with PLUGINS_REQUIRE_...
Returns:
true = if required by at least one plugin

getMasterPlugins

public List getMasterPlugins(boolean fExcludeListeners_p)
get a list of OwMasterPluginInstance

Parameters:
fExcludeListeners_p - boolean true = do only return master plugins with views, false = return all plugins
Returns:
List of OwMasterPluginInstance

getDocumentFunctionPlugins

public List getDocumentFunctionPlugins()
get document function plugins plugins

Returns:
List of OwDocumentFunction instances

getDocumentFunction

public OwDocumentFunction getDocumentFunction(String strID_p)
                                       throws Exception
get a single document function by ID

Parameters:
strID_p - String ID of function as defined in plugin descriptor
Returns:
OwDocumentFunction
Throws:
Exception

isDocumentFunctionAllowed

public boolean isDocumentFunctionAllowed(String strID_p)
check if document function with given ID is allowed

Parameters:
strID_p - String ID of function as defined in plugin descriptor
Returns:
true = if document function is allowed

getRecordFunctionPlugins

public List getRecordFunctionPlugins()
get record function plugins plugins

Returns:
List of OwRecordFunction instances

getRecordFunction

public OwRecordFunction getRecordFunction(String strID_p)
                                   throws Exception
get a single record function by ID

Parameters:
strID_p - String ID of function as defined in plugin descriptor
Returns:
OwDocumentFunction
Throws:
Exception

isRecordFunctionAllowed

public boolean isRecordFunctionAllowed(String strID_p)
check if record function with given ID is allowed

Parameters:
strID_p - String ID of function as defined in plugin descriptor
Returns:
true = if record function is allowed

getMasterPlugin

public OwConfiguration.OwMasterPluginInstance getMasterPlugin(String strID_p)
                                                       throws Exception
get a single record function by ID

Parameters:
strID_p - String ID of function as defined in plugin descriptor
Returns:
OwDocumentFunction
Throws:
Exception

isMasterPluginAllowed

public boolean isMasterPluginAllowed(String strID_p)
check if master plugin with given ID is allowed

Parameters:
strID_p -
Returns:
a boolean

getAllowedPluginInstance

public OwPlugin getAllowedPluginInstance(String strID_p)
                                  throws Exception
get a plugin instance for the given ID

Parameters:
strID_p - String plugin ID
Returns:
OwPlugin instance
Throws:
Exception, - OwAccessDeniedException
Exception

getBootstrap

public static OwXMLUtil getBootstrap(OwBaseInitializer initializer_p)
Parameters:
initializer_p -
Returns:
a bootstrap XMUL utility for the given initialize (retrieved from its application attributes)
Since:
4.0.0.0

getBootstrapConfiguration

public OwXMLUtil getBootstrapConfiguration()
get the bootstrap Configuration DOM node

Returns:
DOM node of bootstrap Configuration
Since:
2.5.2.0 the method is public

getMandatorManagerConfiguration

public OwXMLUtil getMandatorManagerConfiguration()
                                          throws Exception
get the mandatormanager configuration DOM node

Returns:
DOM node of rolemanager configuration
Throws:
Exception

getNetworkAdaptorConfiguration

public OwXMLUtil getNetworkAdaptorConfiguration()
                                         throws Exception
get the Network Adaptor Configuration DOM node

Returns:
DOM node of Network Adaptor Configuration
Throws:
Exception

getHistoryManagerConfiguration

public OwXMLUtil getHistoryManagerConfiguration()
                                         throws Exception
get the rolemanager configuration DOM node

Returns:
DOM node of rolemanager configuration
Throws:
Exception

getRoleManagerConfiguration

public OwXMLUtil getRoleManagerConfiguration()
                                      throws Exception
get the rolemanager configuration DOM node

Returns:
DOM node of rolemanager configuration
Throws:
Exception

getFieldManagerConfiguration

public OwXMLUtil getFieldManagerConfiguration()
                                       throws Exception
get the fieldmanager configuration DOM node

Returns:
DOM node of fieldmanager configuration
Throws:
Exception

getAllowedPlugins

public List getAllowedPlugins(String strType_p)
                       throws Exception
get a list of plugin description nodes by type

Returns:
list of plugins for the given type, or null if not found
Throws:
Exception

getPlugin

public OwXMLUtil getPlugin(String strID_p)
                    throws Exception
get a plugin description by its key

Throws:
Exception

getClientWildCardDefinitions

public Map getClientWildCardDefinitions()
get the client wildcard definitions to translate client wildcards to repository wildcards

Returns:
Map of wildcard character (String) keyed by wildcard type (Integer)

getDefaultFolderClassName

public String getDefaultFolderClassName()
name of the default class used to create simple folders

Returns:
String classname/id of default folder class or null if not defined

getRecordClassNames

public List getRecordClassNames()
get the list of classnames that act as records

Returns:
List of Strings with classnames

getAvailableLanguages

public List getAvailableLanguages()
get the list of language IDs for the user

Returns:
List of OwXMLUtl

displayLanguageSelection

public boolean displayLanguageSelection()
flag indication if language selection should be displayed

Returns:
true = display language selection

getDefaultLanguage

public String getDefaultLanguage()
the default language to be used, see also getDetectBrowserLocale()

Returns:
String representing the Locale string
See Also:
getDetectBrowserLocale()

getDetectBrowserLocale

public boolean getDetectBrowserLocale()
flag indicating if we use the browser language and override the default locale, see also getDefaultLanguage()

Returns:
boolean (by default true)
See Also:
getDefaultLanguage()

getMessageBoxOnUserError

public boolean getMessageBoxOnUserError()
the behavior for UI messages caused by user error


getMIMENode

public OwXMLUtil getMIMENode(String strMIMEType_p)
                      throws Exception
get the MIME XML Entry for the given MIMEType. Lookup in MimeMap
 <?xml version="1.0" ?>
 <mimetable>
   <mime typ="text/xml">
        <icon>xml.png</icon>
        <viewerservlet>{dwlurl}</viewerservlet>
   </mime>
   <!-- further MIME entries-->
 </mimetable>
 

Parameters:
strMIMEType_p - OwObject MIMEType
Returns:
OwXMLUtil wrapped DOM Node of MIME entry from MIME table, or null if not found
Throws:
Exception

getDefaultMIMENode

public OwXMLUtil getDefaultMIMENode(int iObjectType_p)
                             throws Exception
get the default MIME XML Entry for the given object type.

Parameters:
iObjectType_p - Objecttype
Returns:
OwXMLUtil wrapped DOM Node of MIME entry from MIME table, or null if not found
Throws:
Exception

getSSLMode

public int getSSLMode()
get the SSL mode to use for requests


getTempDir

public String getTempDir()
                  throws OwConfigurationException
Get the temp dir defined in bootstrap configuration, that can be used for upload. If a temp folder is not defined in bootstrap configuration, this method returns by default the System/Server temp folder using System.getProperty("java.io.tmpdir").

Returns:
String containing path to the temp directory
Throws:
OwConfigurationException - if temp directory path can not be detected.

getLocalizedPluginSettingTitle

public String getLocalizedPluginSettingTitle(Node settingDescriptionNode_p,
                                             String strPluginName_p)
get the localized title of a plugin setting

Specified by:
getLocalizedPluginSettingTitle in class OwBaseConfiguration
Parameters:
settingDescriptionNode_p - Node
strPluginName_p - String

getLocalizedPluginTitle

public String getLocalizedPluginTitle(OwXMLUtil pluginDescriptionNode_p)
get the localized title of a plugin

Specified by:
getLocalizedPluginTitle in class OwBaseConfiguration
Parameters:
pluginDescriptionNode_p - OwXMLUtil wrapper

getLocalizedPluginTitle

public String getLocalizedPluginTitle(String strID_p)
get the localized title of a plugin

Specified by:
getLocalizedPluginTitle in class OwBaseConfiguration
Parameters:
strID_p - String plugin ID

getLocalizedPluginDescription

public String getLocalizedPluginDescription(OwXMLUtil pluginDescriptionNode_p)
get the localized description of a plugin

Specified by:
getLocalizedPluginDescription in class OwBaseConfiguration
Parameters:
pluginDescriptionNode_p - OwXMLUtil wrapper

getLocalizedPluginDescription

public String getLocalizedPluginDescription(String strID_p)
get the localized description of a plugin

Specified by:
getLocalizedPluginDescription in class OwBaseConfiguration
Parameters:
strID_p - String plugin ID

refreshStaticConfiguration

public void refreshStaticConfiguration()
                                throws OwConfigurationException
update the configuration data

Throws:
OwConfigurationException

attributecount

public int attributecount()
Description copied from interface: OwAttributeBag
get the number of attributes, or -1 if unknown

Specified by:
attributecount in interface OwAttributeBag

getAttribute

public Object getAttribute(int index_p)
                    throws Exception
Description copied from interface: OwAttributeBag
get a object at the specified index or throws OwObjectNotFoundException

Specified by:
getAttribute in interface OwAttributeBag
Parameters:
index_p - int index
Returns:
Object
Throws:
Exception

getAttribute

public Object getAttribute(String strName_p)
                    throws Exception
Description copied from interface: OwAttributeBag
get the attribute with the given name or throws OwObjectNotFoundException

Specified by:
getAttribute in interface OwAttributeBag
Throws:
Exception

getAttributeNames

public Collection getAttributeNames()
Description copied from interface: OwAttributeBag
get all attribute names in the bag

Specified by:
getAttributeNames in interface OwAttributeBag

getSafeAttribute

public Object getSafeAttribute(String strName_p,
                               Object default_p)
Description copied from interface: OwAttributeBag
get the attribute with the given name, returns default if not found.

Specified by:
getSafeAttribute in interface OwAttributeBag

hasAttribute

public boolean hasAttribute(String strName_p)
Description copied from interface: OwAttributeBag
check if attribute exists

Specified by:
hasAttribute in interface OwAttributeBag

getComboboxRendererClassName

public String getComboboxRendererClassName()
Get the combobox renderer class name.

Returns:
a String object representing the OwComboboxRenderer implementation class name.
Since:
3.0.0.0

isDynamicSplitInUse

public boolean isDynamicSplitInUse()
Get the configuration flag for dynamic split

Returns:
true if dynamic split flag is set on true
Since:
3.1.0.0

getLayoutConfigurationBagPrefix

public String getLayoutConfigurationBagPrefix()
Get the layout configuration bag prefix

Returns:
- the configured prefix for layout settings attribute bag
Since:
3.1.0.0

isUseExtJsForDragAndDrop

public boolean isUseExtJsForDragAndDrop()
Do we use ExtJS for DnD or not?

Returns:
the value of the UseExtJsForDragAndDrop configuration.
Since:
3.2.0.0

getUserOperationListenerFactories

public Set<OwContextBasedUOListenerFactory> getUserOperationListenerFactories()
                                                                       throws Exception
Get the cached user operation listener factories.

Returns:
- a set of OwContextBasedUOListenerFactory objects, or null if nothing is configured.
Throws:
Exception
Since:
3.1.0.3


Copyright © 2013 Alfresco Business Solutions. All Rights Reserved.