|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectedu.uoc.pfc.j2ee.jalonsod.mtp.config.Configurator
public class Configurator
File: Configurator.java
Created: 2012-04-21
Main object for configuration of the MTP Framework. Works as a singleton instance.
Usage:
Get singleton (first time loads with default config file):
Configurator.getInstance()
Load configuration with user provided config file & obtain singleton):
Configurator.getInstance(String configFile)
Use getters to obtain configuration objects.
main method is for testing purposes
The class has the inner class SimpleErrorHandler
. This is an error handler for
loading documents.
Nested Class Summary | |
---|---|
class |
Configurator.SimpleErrorHandler
Error handler for loading documents. |
Field Summary | |
---|---|
private static java.lang.String |
configFile
|
static java.lang.String |
DATATYPE_BOOLEAN
|
static java.lang.String |
DATATYPE_DATE
|
static java.lang.String |
DATATYPE_DOUBLE
|
static java.lang.String |
DATATYPE_INTEGER
|
static java.lang.String |
DATATYPE_STRING
|
private java.lang.String |
defaultDateFormat
Default date format mask for date parameters. |
private java.lang.String |
defaultErrorView
Framework redirects to this view when an exception is thrown to the Controller during the request process. |
private Language |
defaultLanguage
Default language for application user interface. |
private Model |
defaultModel
Framework redirects to this model when cannot map to any model. |
private java.lang.String |
defaultSecurityErrorView
Framework redirects to this view when a security error is thrown and model has no related. |
private java.lang.String |
defaultValidationErrorView
Framework redirects to this view when a validation error is thrown and model has no related. |
private java.lang.String |
defaultView
Framework redirects to this view when cannot map to any view. |
private java.util.Hashtable<java.lang.String,Form> |
forms
Forms supported by application. |
private static Configurator |
instance
|
private java.util.Hashtable<java.lang.String,Language> |
languages
Languages supported by application. |
private static java.util.logging.Logger |
logger
|
private java.lang.String |
modelMapperClass
Class used for mapping models. |
private java.lang.Class<ModelMapper> |
modelMapperClassReference
A reference to the modelMapper class. |
private java.util.Hashtable<java.lang.String,Model> |
models
Models implemented by application. |
private java.lang.String |
packageModel
Name of the default package for storing Model objects. |
private java.util.Hashtable<java.lang.String,Role> |
roles
Security roles of application. |
static java.lang.String |
SCHEMA_FILE
|
static java.lang.String |
TAG_FORM_ATTR_NAME
|
static java.lang.String |
TAG_FORM_ELEMENT
|
static java.lang.String |
TAG_FORM_PARAMETER_ATTR_COPY_TO_MODEL
|
static java.lang.String |
TAG_FORM_PARAMETER_ATTR_DATATYPE
|
static java.lang.String |
TAG_FORM_PARAMETER_ATTR_DATE_FORMAT
|
static java.lang.String |
TAG_FORM_PARAMETER_ATTR_DEFAULT_VALUE
|
static java.lang.String |
TAG_FORM_PARAMETER_ATTR_MODEL_ATTRIBUTE
|
static java.lang.String |
TAG_FORM_PARAMETER_ATTR_NAME
|
static java.lang.String |
TAG_FORM_PARAMETER_ATTR_REQUIRED
|
static java.lang.String |
TAG_FORM_PARAMETER_ATTR_VALIDATE_METHOD
|
static java.lang.String |
TAG_FORM_PARAMETER_ELEMENT
|
static java.lang.String |
TAG_LANGUAGE_ATTR_LONG_NAME
|
static java.lang.String |
TAG_LANGUAGE_ATTR_MESSAGE_FILE
|
static java.lang.String |
TAG_LANGUAGE_ATTR_NAME
|
static java.lang.String |
TAG_LANGUAGE_ELEMENT
|
static java.lang.String |
TAG_MODEL_ATTR_CLASS_NAME
|
static java.lang.String |
TAG_MODEL_ATTR_DEFAULT_RESULT
|
static java.lang.String |
TAG_MODEL_ATTR_FORM
|
static java.lang.String |
TAG_MODEL_ATTR_NAME
|
static java.lang.String |
TAG_MODEL_ATTR_RESULT_NO_VALIDATE
|
static java.lang.String |
TAG_MODEL_ATTR_RESULT_SECURITY_ERROR
|
static java.lang.String |
TAG_MODEL_ATTR_RUN_METHOD
|
static java.lang.String |
TAG_MODEL_ATTR_SEND_REQUEST_DATA
|
static java.lang.String |
TAG_MODEL_ATTR_VALIDATE_METHOD
|
static java.lang.String |
TAG_MODEL_ELEMENT
|
static java.lang.String |
TAG_MODEL_GRANTEDROLE_ATTR_NAME
|
static java.lang.String |
TAG_MODEL_GRANTEDROLE_ELEMENT
|
static java.lang.String |
TAG_MODEL_RESULT_ATTR_NAME
|
static java.lang.String |
TAG_MODEL_RESULT_ATTR_NEXT_VIEW
|
static java.lang.String |
TAG_MODEL_RESULT_ELEMENT
|
static java.lang.String |
TAG_ROLE_ATTR_DEFAULT_ROLE
|
static java.lang.String |
TAG_ROLE_ATTR_NAME
|
static java.lang.String |
TAG_ROLE_ELEMENT
|
static java.lang.String |
TAG_ROOT_ATTR_DEFAULT_ERROR_VIEW
|
static java.lang.String |
TAG_ROOT_ATTR_DEFAULT_LANGUAGE
|
static java.lang.String |
TAG_ROOT_ATTR_DEFAULT_MODEL
|
static java.lang.String |
TAG_ROOT_ATTR_DEFAULT_VIEW
|
static java.lang.String |
TAG_ROOT_ATTR_MODEL_MAPPER_CLASS
|
static java.lang.String |
TAG_ROOT_ATTR_PACKAGE_MODEL
|
static java.lang.String |
TAG_ROOT_ATTR_SECURITY_ERROR_VIEW
|
static java.lang.String |
TAG_ROOT_ATTR_VALIDATION_ERROR_VIEW
|
static java.lang.String |
TAG_ROOT_ATTR_VIEW_DEFAULT_DATE_FORMAT
|
static java.lang.String |
TAG_ROOT_ATTR_VIEW_MAPPER_CLASS
|
static java.lang.String |
TAG_ROOT_ELEMENT
|
static java.lang.String |
TAG_VALIDATION_ATTR_CLASSNAME
|
static java.lang.String |
TAG_VALIDATION_ATTR_DATATYPE
|
static java.lang.String |
TAG_VALIDATION_ATTR_METHODNAME
|
static java.lang.String |
TAG_VALIDATION_ATTR_NAME
|
static java.lang.String |
TAG_VALIDATION_ELEMENT
|
private java.util.Hashtable<java.lang.String,Validation> |
validations
Field validations implemented by application. |
private java.lang.String |
viewMapperClass
Class used for mapping views. |
private java.lang.Class<ViewMapper> |
viewMapperClassReference
A reference to the viewMapper class. |
Constructor Summary | |
---|---|
private |
Configurator()
Constructor must be called only from singleton creation method getInstance. |
Method Summary | |
---|---|
private void |
addFormElement(org.w3c.dom.Node n)
Loads a form and its parameters from supplied node & child nodes. |
private void |
addLanguageElement(org.w3c.dom.Node n)
Loads a language from supplied node. |
private void |
addModelElement(org.w3c.dom.Node n)
Loads a model, its role-grants and results from supplied node & child nodes. |
private void |
addRoleElement(org.w3c.dom.Node n)
Loads a role from supplied node. |
private void |
addValidationElement(org.w3c.dom.Node n)
Loads a validation from supplied node. |
private java.lang.String |
getAttributeValue(org.w3c.dom.NamedNodeMap nnm,
java.lang.String attrName)
Obtains the value of the supplied attribute from the nodemap. |
static java.lang.String |
getConfigFile()
|
java.lang.String |
getDefaultDateFormat()
|
java.lang.String |
getDefaultErrorView()
|
Language |
getDefaultLanguage()
|
Model |
getDefaultModel()
|
java.util.Hashtable<java.lang.String,Role> |
getDefaultRoles()
Get roles marked as default. |
java.lang.String |
getDefaultSecurityErrorView()
|
java.lang.String |
getDefaultValidationErrorView()
|
java.lang.String |
getDefaultView()
|
Form |
getFormByKey(java.lang.String key)
|
java.util.Hashtable<java.lang.String,Form> |
getForms()
|
static Configurator |
getInstance()
Returns the singleton (also creates & loads configuration the first time). |
static Configurator |
getInstance(java.lang.String configFile)
Returns the singleton loaded with configFile. |
Language |
getLanguageByKey(java.lang.String key)
|
java.util.Hashtable<java.lang.String,Language> |
getLanguages()
|
Model |
getModelByKey(java.lang.String key)
|
java.lang.String |
getModelMapperClass()
|
java.lang.Class<ModelMapper> |
getModelMapperClassReference()
|
java.util.Hashtable<java.lang.String,Model> |
getModels()
|
java.lang.String |
getPackageModel()
|
Role |
getRoleByKey(java.lang.String key)
|
java.util.Hashtable<java.lang.String,Role> |
getRoles()
|
Validation |
getValidationByKey(java.lang.String key)
|
java.util.Hashtable<java.lang.String,Validation> |
getValidations()
|
java.lang.String |
getViewMapperClass()
|
java.lang.Class<ViewMapper> |
getViewMapperClassReference()
|
private void |
loadConfig()
Main method for loading configuration. |
private void |
loadList(org.w3c.dom.NodeList nl,
java.lang.reflect.Method loadMethod)
Walks through a list of nodes and call supplied method of this object type for appropriate loading. |
static void |
main(java.lang.String[] args)
main method for testing purposes. |
private void |
resetAttributes()
Initialize attribute values, prior to load configuration values. |
private static void |
setConfigFile(java.lang.String configFile)
|
void |
setDefaultDateFormat(java.lang.String defaultDateFormat)
|
void |
setDefaultErrorView(java.lang.String defaultErrorView)
|
void |
setDefaultLanguage(Language defaultLanguage)
|
void |
setDefaultModel(Model defaultModel)
|
void |
setDefaultSecurityErrorView(java.lang.String defaultSecurityErrorView)
|
void |
setDefaultValidationErrorView(java.lang.String defaultValidationErrorView)
|
void |
setDefaultView(java.lang.String defaultView)
|
void |
setForms(java.util.Hashtable<java.lang.String,Form> forms)
|
void |
setLanguages(java.util.Hashtable<java.lang.String,Language> languages)
|
void |
setModelMapperClass(java.lang.String modelMapperClass)
|
void |
setModels(java.util.Hashtable<java.lang.String,Model> models)
|
void |
setPackageModel(java.lang.String packageModel)
|
void |
setRoles(java.util.Hashtable<java.lang.String,Role> roles)
|
void |
setValidations(java.util.Hashtable<java.lang.String,Validation> validations)
|
void |
setViewMapperClass(java.lang.String viewMapperClass)
|
java.lang.String |
toString()
|
private org.w3c.dom.Document |
validateConfigFile()
Validate and load the config file. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
private static final java.util.logging.Logger logger
public static final java.lang.String TAG_ROOT_ELEMENT
public static final java.lang.String TAG_ROOT_ATTR_PACKAGE_MODEL
public static final java.lang.String TAG_ROOT_ATTR_SECURITY_ERROR_VIEW
public static final java.lang.String TAG_ROOT_ATTR_VALIDATION_ERROR_VIEW
public static final java.lang.String TAG_ROOT_ATTR_DEFAULT_ERROR_VIEW
public static final java.lang.String TAG_ROOT_ATTR_DEFAULT_VIEW
public static final java.lang.String TAG_ROOT_ATTR_DEFAULT_MODEL
public static final java.lang.String TAG_ROOT_ATTR_DEFAULT_LANGUAGE
public static final java.lang.String TAG_ROOT_ATTR_MODEL_MAPPER_CLASS
public static final java.lang.String TAG_ROOT_ATTR_VIEW_MAPPER_CLASS
public static final java.lang.String TAG_ROOT_ATTR_VIEW_DEFAULT_DATE_FORMAT
public static final java.lang.String TAG_FORM_ELEMENT
public static final java.lang.String TAG_FORM_ATTR_NAME
public static final java.lang.String TAG_FORM_PARAMETER_ELEMENT
public static final java.lang.String TAG_FORM_PARAMETER_ATTR_NAME
public static final java.lang.String TAG_FORM_PARAMETER_ATTR_DATATYPE
public static final java.lang.String TAG_FORM_PARAMETER_ATTR_REQUIRED
public static final java.lang.String TAG_FORM_PARAMETER_ATTR_VALIDATE_METHOD
public static final java.lang.String TAG_FORM_PARAMETER_ATTR_COPY_TO_MODEL
public static final java.lang.String TAG_FORM_PARAMETER_ATTR_MODEL_ATTRIBUTE
public static final java.lang.String TAG_FORM_PARAMETER_ATTR_DEFAULT_VALUE
public static final java.lang.String TAG_FORM_PARAMETER_ATTR_DATE_FORMAT
public static final java.lang.String TAG_LANGUAGE_ELEMENT
public static final java.lang.String TAG_LANGUAGE_ATTR_NAME
public static final java.lang.String TAG_LANGUAGE_ATTR_LONG_NAME
public static final java.lang.String TAG_LANGUAGE_ATTR_MESSAGE_FILE
public static final java.lang.String TAG_MODEL_ELEMENT
public static final java.lang.String TAG_MODEL_ATTR_NAME
public static final java.lang.String TAG_MODEL_ATTR_CLASS_NAME
public static final java.lang.String TAG_MODEL_ATTR_FORM
public static final java.lang.String TAG_MODEL_ATTR_RUN_METHOD
public static final java.lang.String TAG_MODEL_ATTR_SEND_REQUEST_DATA
public static final java.lang.String TAG_MODEL_ATTR_VALIDATE_METHOD
public static final java.lang.String TAG_MODEL_ATTR_RESULT_NO_VALIDATE
public static final java.lang.String TAG_MODEL_ATTR_RESULT_SECURITY_ERROR
public static final java.lang.String TAG_MODEL_ATTR_DEFAULT_RESULT
public static final java.lang.String TAG_MODEL_GRANTEDROLE_ELEMENT
public static final java.lang.String TAG_MODEL_GRANTEDROLE_ATTR_NAME
public static final java.lang.String TAG_MODEL_RESULT_ELEMENT
public static final java.lang.String TAG_MODEL_RESULT_ATTR_NAME
public static final java.lang.String TAG_MODEL_RESULT_ATTR_NEXT_VIEW
public static final java.lang.String TAG_ROLE_ELEMENT
public static final java.lang.String TAG_ROLE_ATTR_NAME
public static final java.lang.String TAG_ROLE_ATTR_DEFAULT_ROLE
public static final java.lang.String TAG_VALIDATION_ELEMENT
public static final java.lang.String TAG_VALIDATION_ATTR_NAME
public static final java.lang.String TAG_VALIDATION_ATTR_CLASSNAME
public static final java.lang.String TAG_VALIDATION_ATTR_METHODNAME
public static final java.lang.String TAG_VALIDATION_ATTR_DATATYPE
public static final java.lang.String DATATYPE_STRING
public static final java.lang.String DATATYPE_BOOLEAN
public static final java.lang.String DATATYPE_INTEGER
public static final java.lang.String DATATYPE_DOUBLE
public static final java.lang.String DATATYPE_DATE
public static final java.lang.String SCHEMA_FILE
private static java.lang.String configFile
private static Configurator instance
private java.lang.String packageModel
private java.lang.String defaultSecurityErrorView
private java.lang.String defaultValidationErrorView
private java.lang.String defaultErrorView
private java.lang.String defaultView
private Model defaultModel
private Language defaultLanguage
private java.lang.String modelMapperClass
modelMapper
interface.
private java.lang.Class<ModelMapper> modelMapperClassReference
modelMapper
class.
private java.lang.String viewMapperClass
private java.lang.Class<ViewMapper> viewMapperClassReference
viewMapper
class.
private java.lang.String defaultDateFormat
private java.util.Hashtable<java.lang.String,Form> forms
private java.util.Hashtable<java.lang.String,Language> languages
private java.util.Hashtable<java.lang.String,Model> models
private java.util.Hashtable<java.lang.String,Role> roles
private java.util.Hashtable<java.lang.String,Validation> validations
Constructor Detail |
---|
private Configurator() throws ConfiguratorException
ConfiguratorException
- throws when failed to load configuration.Method Detail |
---|
private void loadConfig() throws ConfiguratorException
ConfiguratorException
- throws when failed to load configuration.private org.w3c.dom.Document validateConfigFile() throws ConfiguratorException
ConfiguratorException
- when an error loading or validating the XML schema or the XML file.private void resetAttributes()
private void loadList(org.w3c.dom.NodeList nl, java.lang.reflect.Method loadMethod) throws ConfiguratorException
nl
- List of nodes to load.loadMethod
- the method of this object to call for loading each node.
ConfiguratorException
- throws when load method throws any exception or when a there
is a problem invoking method.private void addFormElement(org.w3c.dom.Node n) throws ConfiguratorException
n
- Node to load, it must be a Form.
ConfiguratorException
- throws when there is a problem creating parameter object.private void addLanguageElement(org.w3c.dom.Node n) throws ConfiguratorException
n
- Node to load, it must be a Language.
ConfiguratorException
- throws when there is a problem creating the language.private void addModelElement(org.w3c.dom.Node n) throws ConfiguratorException
n
- Node to load, it must be a Language.
ConfiguratorException
- throws when there is a problem loading model and subordinate elements.private void addRoleElement(org.w3c.dom.Node n) throws ConfiguratorException
n
- Node to load, it must be a Role.
ConfiguratorException
- throws when there is a problem creating the role object.private void addValidationElement(org.w3c.dom.Node n) throws ConfiguratorException
n
- Node to load, it must be a Validation.
ConfiguratorException
- throws when there is a problem creating the validation object.private java.lang.String getAttributeValue(org.w3c.dom.NamedNodeMap nnm, java.lang.String attrName)
nnm
- the map
with attributes of a node.attrName
- the name of the attribute to get.
null
if attribute is empty or not present.public static Configurator getInstance() throws ConfiguratorException
ConfiguratorException
- throws when failed to load configuration.public static Configurator getInstance(java.lang.String configFile) throws ConfiguratorException
configFile
- the configuration file name for loading the configuration.
singleton
instance
ConfiguratorException
- throws when there is a problem loading the configuration.public java.util.Hashtable<java.lang.String,Form> getForms()
public void setForms(java.util.Hashtable<java.lang.String,Form> forms)
public java.util.Hashtable<java.lang.String,Language> getLanguages()
public void setLanguages(java.util.Hashtable<java.lang.String,Language> languages)
public java.util.Hashtable<java.lang.String,Model> getModels()
public void setModels(java.util.Hashtable<java.lang.String,Model> models)
public java.util.Hashtable<java.lang.String,Role> getRoles()
public void setRoles(java.util.Hashtable<java.lang.String,Role> roles)
public java.util.Hashtable<java.lang.String,Validation> getValidations()
public void setValidations(java.util.Hashtable<java.lang.String,Validation> validations)
public static java.lang.String getConfigFile()
private static void setConfigFile(java.lang.String configFile)
public java.lang.String getPackageModel()
public void setPackageModel(java.lang.String packageModel)
public java.lang.String getDefaultSecurityErrorView()
public void setDefaultSecurityErrorView(java.lang.String defaultSecurityErrorView)
public java.lang.String getDefaultValidationErrorView()
public void setDefaultValidationErrorView(java.lang.String defaultValidationErrorView)
public java.lang.String getDefaultErrorView()
public void setDefaultErrorView(java.lang.String defaultErrorView)
public java.lang.String getDefaultView()
public void setDefaultView(java.lang.String defaultView)
public Model getDefaultModel()
public void setDefaultModel(Model defaultModel)
public Language getDefaultLanguage()
public void setDefaultLanguage(Language defaultLanguage)
public java.lang.String getModelMapperClass()
public void setModelMapperClass(java.lang.String modelMapperClass) throws ConfiguratorException
ConfiguratorException
public java.lang.Class<ModelMapper> getModelMapperClassReference()
public java.lang.String getViewMapperClass()
public void setViewMapperClass(java.lang.String viewMapperClass) throws ConfiguratorException
ConfiguratorException
public java.lang.Class<ViewMapper> getViewMapperClassReference()
public java.lang.String getDefaultDateFormat()
public void setDefaultDateFormat(java.lang.String defaultDateFormat)
public Form getFormByKey(java.lang.String key)
public Language getLanguageByKey(java.lang.String key)
public Model getModelByKey(java.lang.String key)
public Role getRoleByKey(java.lang.String key)
public Validation getValidationByKey(java.lang.String key)
public java.util.Hashtable<java.lang.String,Role> getDefaultRoles()
public java.lang.String toString()
toString
in class java.lang.Object
public static void main(java.lang.String[] args)
args
-
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |