net.sf.portions.controller
Class ConfigHelper

java.lang.Object
  extended bynet.sf.portions.controller.ConfigHelper

public final class ConfigHelper
extends java.lang.Object

Clase de utilidad que permite obtener los datos de configuración de la aplicación indicados a través del fichero "portlet-config.xml".

Version:
1.0 01 Jan 2007
Author:
Raúl Herranz

Field Summary
private static java.util.Map actions
          Datos de configuración de las actions
private static java.util.Map formBeans
          Datos de configuración de los formBeans
private static java.util.Map globalForwards
          Datos de configuración de los forward globales
private static org.apache.commons.logging.Log log
          Log de la clase
private static java.lang.String messageResources
          Datos de configuración del fichero de messageResources
private static java.util.Map plugins
          Datos de configuración de los plugins
 
Constructor Summary
private ConfigHelper()
          Constructor de la clase con visibilidad "private" para impedir la creación de instancias.
 
Method Summary
private static java.util.Map extractActions(org.apache.commons.configuration.Configuration config, java.lang.String root)
          Extrae los datos de configuración de las actions del fichero de configuración
private static java.util.Map extractFormBeans(org.apache.commons.configuration.Configuration config, java.lang.String root)
          Extrae los datos de configuración de los formBeans del fichero de configuración
private static java.util.Map extractForwards(org.apache.commons.configuration.Configuration config, java.lang.String root)
          Extrae los datos de configuración de los forwards globales del fichero de configuración
private static java.lang.String extractMessageResources(org.apache.commons.configuration.Configuration config, java.lang.String root)
          Extrae los datos de configuración del messageResources del fichero de configuración
private static java.util.Map extractPlugins(org.apache.commons.configuration.Configuration config, java.lang.String root)
          Extrae los datos de configuración de los plug-ins del fichero de configuración
static Action getAction(java.lang.String actionName)
          Retorna los datos de configuración de la action de nombre "actionName"
static java.lang.String getActionContent(java.lang.String actionName)
          Retorna el valor de la propiedad content de la action de nombre "actionName"
static java.lang.String getActionFormName(java.lang.String actionName)
          Retorna el valor de la propiedad formName de la action de nombre "actionName"
static java.util.Map getActionForwards(java.lang.String actionName)
          Retorna un Map con la información de los forwards de la action de nombre "actionName"
static java.lang.String getActionInput(java.lang.String actionName)
          Retorna el valor de la propiedad input de la action de nombre "actionName"
static java.lang.String getActionParameter(java.lang.String actionName)
          Retorna el valor de la propiedad parameter de la action de nombre "actionName"
static java.lang.String getActionScope(java.lang.String actionName)
          Retorna el valor de la propiedad scope de la action de nombre "actionName"
static java.lang.String getActionType(java.lang.String actionName)
          Retorna el valor de la propiedad type de la action de nombre "actionName"
static Forward getDefaultForward(java.lang.String forwardName, java.lang.String forwardMode)
          Retorna los datos de configuración del forward global identificado por el nombre "forwardName" y el modo "forwardMode"
static java.lang.String getDefaultForwardContent(java.lang.String forwardName, java.lang.String forwardMode)
          Retorna el valor de la propiedad content del forward global de nombre "forwardName" y modo "forwardMode"
static java.lang.String getDefaultForwardPath(java.lang.String forwardName, java.lang.String forwardMode)
          Retorna el valor de la propiedad path del forward global de nombre "forwardName" y modo "forwardMode"
static FormBean getForm(java.lang.String formName)
          Retorna los datos de configuración del form identificado por el nombre "formName"
static java.lang.String getFormType(java.lang.String formName)
          Retorna el valor de la propiedad type del form de nombre "formName"
static Forward getForward(java.lang.String actionName, java.lang.String forwardName, java.lang.String forwardMode)
          Retorna los datos de configuración del forward identificado por el nombre de la action "actionName", y el nombre y modo del forward "forwardName" y "forwardMode"
static java.lang.String getForwardContent(java.lang.String actionName, java.lang.String forwardName, java.lang.String forwardMode)
          Retorna el valor de la propiedad content del forward de nombre "forwardName" y modo "forwardMode" correspondiente a la action de nombre "actionName"
static java.lang.String getForwardPath(java.lang.String actionName, java.lang.String forwardName, java.lang.String forwardMode)
          Retorna el valor de la propiedad path del forward de nombre "forwardName" y modo "forwardMode" correspondiente a la action de nombre "actionName"
static java.lang.String getMessageResources()
          Retorna los datos de configuración correspondientes al messageResources
static java.util.List getPluginNames()
          Retorna una lista de los nombres de los plug-ins configurados
static java.lang.String getPluginParam(java.lang.String pluginName, java.lang.String paramName)
          Retorna el valor del parámetro "paramName" del plug-in "pluginName"
(package private) static void init(java.net.URL configURL)
          Inicializa las propiedades de la clase a partir de un InputStream al fichero de configuración.
private static Action setActionProperties(org.apache.commons.configuration.Configuration config)
          Crea e inicializa una instancia de la clase Action con los datos pasados
private static FormBean setFormBeanProperties(org.apache.commons.configuration.Configuration config)
          Crea e inicializa una instancia de la clase FormBean con los datos pasados
private static Forward setForwardProperties(org.apache.commons.configuration.Configuration config)
          Crea e inicializa una instancia de la clase Forward con los datos pasados
private static java.util.Map setPluginsProperties(org.apache.commons.configuration.Configuration config)
          Crea e inicializa un Map con los datos de un plug-in pasados
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

log

private static org.apache.commons.logging.Log log
Log de la clase


actions

private static java.util.Map actions
Datos de configuración de las actions


globalForwards

private static java.util.Map globalForwards
Datos de configuración de los forward globales


formBeans

private static java.util.Map formBeans
Datos de configuración de los formBeans


messageResources

private static java.lang.String messageResources
Datos de configuración del fichero de messageResources


plugins

private static java.util.Map plugins
Datos de configuración de los plugins

Constructor Detail

ConfigHelper

private ConfigHelper()
Constructor de la clase con visibilidad "private" para impedir la creación de instancias.

Method Detail

init

static void init(java.net.URL configURL)
          throws java.lang.Exception
Inicializa las propiedades de la clase a partir de un InputStream al fichero de configuración.

Parameters:
configURL - URL al fichero de configuración portlet-config.xml
Throws:
java.lang.Exception - En caso de que se produzca algún error durante las tareas de inicialización

getAction

public static Action getAction(java.lang.String actionName)
Retorna los datos de configuración de la action de nombre "actionName"

Parameters:
actionName - Nombre de la action
Returns:
Instancia de la clase Action con los datos de configuración correspondientes a la action referenciada

getActionType

public static java.lang.String getActionType(java.lang.String actionName)
Retorna el valor de la propiedad type de la action de nombre "actionName"

Parameters:
actionName - Nombre de la action
Returns:
Valor de la propiedad type de la action referenciada

getActionInput

public static java.lang.String getActionInput(java.lang.String actionName)
Retorna el valor de la propiedad input de la action de nombre "actionName"

Parameters:
actionName - Nombre de la action
Returns:
Valor de la propiedad input de la action referenciada

getActionContent

public static java.lang.String getActionContent(java.lang.String actionName)
Retorna el valor de la propiedad content de la action de nombre "actionName"

Parameters:
actionName - Nombre de la action
Returns:
Valor de la propiedad content de la action referenciada

getActionScope

public static java.lang.String getActionScope(java.lang.String actionName)
Retorna el valor de la propiedad scope de la action de nombre "actionName"

Parameters:
actionName - Nombre de la action
Returns:
Valor de la propiedad scope de la action referenciada

getActionFormName

public static java.lang.String getActionFormName(java.lang.String actionName)
Retorna el valor de la propiedad formName de la action de nombre "actionName"

Parameters:
actionName - Nombre de la action
Returns:
Valor de la propiedad formName de la action referenciada

getActionParameter

public static java.lang.String getActionParameter(java.lang.String actionName)
Retorna el valor de la propiedad parameter de la action de nombre "actionName"

Parameters:
actionName - Nombre de la action
Returns:
Valor de la propiedad parameter de la action referenciada

getActionForwards

public static java.util.Map getActionForwards(java.lang.String actionName)
Retorna un Map con la información de los forwards de la action de nombre "actionName"

Parameters:
actionName - Nombre de la action
Returns:
Map con la información de los forwards de la action referenciada

getForward

public static Forward getForward(java.lang.String actionName,
                                 java.lang.String forwardName,
                                 java.lang.String forwardMode)
Retorna los datos de configuración del forward identificado por el nombre de la action "actionName", y el nombre y modo del forward "forwardName" y "forwardMode"

Parameters:
actionName - Nombre de la action
forwardName - Nombre del forward
forwardMode - Modo del forward
Returns:
Instancia de la clase Forward con los datos de configuración correspondientes al forward referenciado

getForwardPath

public static java.lang.String getForwardPath(java.lang.String actionName,
                                              java.lang.String forwardName,
                                              java.lang.String forwardMode)
Retorna el valor de la propiedad path del forward de nombre "forwardName" y modo "forwardMode" correspondiente a la action de nombre "actionName"

Parameters:
actionName - Nombre de la action
forwardName - Nombre del forward
forwardMode - Modo del forward
Returns:
Valor de la propiedad path del forward referenciado

getForwardContent

public static java.lang.String getForwardContent(java.lang.String actionName,
                                                 java.lang.String forwardName,
                                                 java.lang.String forwardMode)
Retorna el valor de la propiedad content del forward de nombre "forwardName" y modo "forwardMode" correspondiente a la action de nombre "actionName"

Parameters:
actionName - Nombre de la action
forwardName - Nombre del forward
forwardMode - Modo del forward
Returns:
Valor de la propiedad content del forward referenciado

getForm

public static FormBean getForm(java.lang.String formName)
Retorna los datos de configuración del form identificado por el nombre "formName"

Parameters:
formName - Nombre del form
Returns:
Instancia de la clase FormBean con los datos de configuración correspondientes al form referenciado

getFormType

public static java.lang.String getFormType(java.lang.String formName)
Retorna el valor de la propiedad type del form de nombre "formName"

Parameters:
formName - Nombre del form
Returns:
Valor de la propiedad type del form referenciado

getDefaultForward

public static Forward getDefaultForward(java.lang.String forwardName,
                                        java.lang.String forwardMode)
Retorna los datos de configuración del forward global identificado por el nombre "forwardName" y el modo "forwardMode"

Parameters:
forwardName - Nombre del forward global
forwardMode - Modo del forward global
Returns:
Instancia de la clase Forward con los datos de configuración correspondientes al forward global referenciado

getDefaultForwardPath

public static java.lang.String getDefaultForwardPath(java.lang.String forwardName,
                                                     java.lang.String forwardMode)
Retorna el valor de la propiedad path del forward global de nombre "forwardName" y modo "forwardMode"

Parameters:
forwardName - Nombre del forward global
forwardMode - Modo del forward global
Returns:
Valor de la propiedad path del forward global referenciado

getDefaultForwardContent

public static java.lang.String getDefaultForwardContent(java.lang.String forwardName,
                                                        java.lang.String forwardMode)
Retorna el valor de la propiedad content del forward global de nombre "forwardName" y modo "forwardMode"

Parameters:
forwardName - Nombre del forward global
forwardMode - Modo del forward global
Returns:
Valor de la propiedad content del forward global referenciado

getMessageResources

public static java.lang.String getMessageResources()
Retorna los datos de configuración correspondientes al messageResources

Returns:
Datos de configuración del messageResources

getPluginNames

public static java.util.List getPluginNames()
Retorna una lista de los nombres de los plug-ins configurados

Returns:
Lista de nombres de plug-ins

getPluginParam

public static java.lang.String getPluginParam(java.lang.String pluginName,
                                              java.lang.String paramName)
Retorna el valor del parámetro "paramName" del plug-in "pluginName"

Parameters:
pluginName - Nombre del plug-in
paramName - Nombre del parámetro
Returns:
Valor del parámetro referenciado

extractActions

private static java.util.Map extractActions(org.apache.commons.configuration.Configuration config,
                                            java.lang.String root)
Extrae los datos de configuración de las actions del fichero de configuración

Parameters:
config - Datos de configuración
root - raiz de las propiedades de las actions
Returns:
Instancia de la clase Map con los datos de configuración de las actions

setActionProperties

private static Action setActionProperties(org.apache.commons.configuration.Configuration config)
Crea e inicializa una instancia de la clase Action con los datos pasados

Parameters:
config - Datos de configuración de una Action
Returns:
Instancia de la clase Action cargada con los datos pasados

extractForwards

private static java.util.Map extractForwards(org.apache.commons.configuration.Configuration config,
                                             java.lang.String root)
Extrae los datos de configuración de los forwards globales del fichero de configuración

Parameters:
config - Datos de configuración
root - raiz de las propiedades de los forwards
Returns:
Instancia de la clase Map con los datos de configuración de los forward globales

setForwardProperties

private static Forward setForwardProperties(org.apache.commons.configuration.Configuration config)
Crea e inicializa una instancia de la clase Forward con los datos pasados

Parameters:
config - Datos de configuración de una Forward
Returns:
Instancia de la clase Forward cargada con los datos pasados

extractFormBeans

private static java.util.Map extractFormBeans(org.apache.commons.configuration.Configuration config,
                                              java.lang.String root)
Extrae los datos de configuración de los formBeans del fichero de configuración

Parameters:
config - Datos de configuración
root - raiz de las propiedades de los formBeans
Returns:
Instancia de la clase Map con los datos de configuración de los formBeans

setFormBeanProperties

private static FormBean setFormBeanProperties(org.apache.commons.configuration.Configuration config)
Crea e inicializa una instancia de la clase FormBean con los datos pasados

Parameters:
config - Datos de configuración de una FormBean
Returns:
Instancia de la clase FormBean cargada con los datos pasados

extractMessageResources

private static java.lang.String extractMessageResources(org.apache.commons.configuration.Configuration config,
                                                        java.lang.String root)
Extrae los datos de configuración del messageResources del fichero de configuración

Parameters:
config - Datos de configuración
root - raiz de las propiedades del MessageResources
Returns:
String con los datos de configuración del messageResources

extractPlugins

private static java.util.Map extractPlugins(org.apache.commons.configuration.Configuration config,
                                            java.lang.String root)
Extrae los datos de configuración de los plug-ins del fichero de configuración

Parameters:
config - Datos de configuración
root - raiz de las propiedades de los plug-ins
Returns:
Instancia de la clase Map con los datos de configuración de los plug-ins

setPluginsProperties

private static java.util.Map setPluginsProperties(org.apache.commons.configuration.Configuration config)
Crea e inicializa un Map con los datos de un plug-in pasados

Parameters:
config - Datos de configuración de un plug-in
Returns:
Instancia de la clase Map cargada con los datos del plug-in pasados