|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.indexdata.masterkey.config.ModuleConfiguration
public class ModuleConfiguration
Field Summary | |
---|---|
String |
moduleName
|
Constructor Summary | |
---|---|
ModuleConfiguration(MasterkeyConfiguration mkConfigContext,
String moduleName)
|
Method Summary | |
---|---|
String |
get(String name)
Short-hand for getting a parameter value by name |
String |
get(String name,
String defaultValue)
Short-hand for getting a parameter value by name, while returning the provided defaultValue if the parameter is not found |
String |
getConfigFilePath()
Retrieves the location of this components property file. |
Map<String,String> |
getConfigMap()
Retrieves all the parameters for the module as a HashMap. |
String |
getConfigParameter(String name)
Retrieves a config parameter prefixed with a given module name (ie a servlet name) |
Properties |
getConfigProperties()
Retrieves all parameters for the module as a Properties |
String |
getContextKey()
|
String |
getHostName()
Host name intended for logging. |
String |
getMandatory(String name)
Gets a mandatory parameter value by name |
boolean |
hasParameter(String name)
Short-hand for checking for the existence of a parameter |
String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public String moduleName
Constructor Detail |
---|
public ModuleConfiguration(MasterkeyConfiguration mkConfigContext, String moduleName)
Method Detail |
---|
public String getConfigParameter(String name) throws IOException
name
- The name of the parameter, without the service name prefix.
javax.servlet.ServletException
IOException
public Map<String,String> getConfigMap() throws IOException
javax.servlet.ServletException
IOException
public Properties getConfigProperties() throws IOException
IOException
public String getContextKey()
public String getConfigFilePath()
public String getHostName()
public String get(String name)
name
-
public String get(String name, String defaultValue)
name
- defaultValue
-
public String getMandatory(String name) throws MissingMandatoryParameterException
name
- parameter key
Exception
- if mandatory parameter was not found
MissingMandatoryParameterException
public boolean hasParameter(String name)
name
-
public String toString()
toString
in class Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |