|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ServerConfig<T extends ServerConfig<?>>
ServerConfig Configuration used in Server creation and initialization
Field Summary | |
---|---|
static String |
PROP_KEY_BOOTSTRAP_HOME_URL
Property denoting the URL pointing to the home of the bootstrap (from which other properties may be defaulted) |
static String |
PROP_KEY_BOOTSTRAP_NAME
Property denoting the name of the bootstrap configuration |
static String |
PROP_KEY_BOOTSTRAP_URL
Property denoting the URL of the bootstrap configuration |
Method Summary | |
---|---|
T |
bootstrapHome(String bootstrapHome)
Sets the location of the bootstrap directory. |
T |
bootstrapHome(URL bootstrapHome)
Sets the location of the bootstrap directory. |
T |
bootstrapName(String name)
Sets the name of the bootstrap configuration file. |
T |
bootstrapUrl(String bootstrapUrl)
Sets the location of the bootstrap file. |
T |
bootstrapUrl(URL bootstrapLocation)
Sets the location of the bootstrap file. |
void |
freeze()
Freezes the configuration, marking it as immutable. |
URL |
getBootstrapHome()
Obtains the location of the bootstrap directory. |
String |
getBootstrapName()
Obtains the name of the bootstrap configuration. |
URL |
getBootstrapUrl()
Obtains the location of the bootstrap file. |
Map<String,String> |
getProperties()
Returns an immutable copy of the properties used in configuring the server |
String |
getProperty(String key)
Returns the configuration property for the specified key, or null if not present |
boolean |
isFrozen()
Returns whether or not this configuration is frozen and immutable |
T |
properties(Map<String,String> properties)
Sets the specified properties upon the configuration |
T |
properties(Properties properties)
Sets the specified properties upon the configuration. |
T |
property(String key,
String value)
Sets the property with the specified key to the specified value |
Field Detail |
---|
static final String PROP_KEY_BOOTSTRAP_HOME_URL
static final String PROP_KEY_BOOTSTRAP_NAME
static final String PROP_KEY_BOOTSTRAP_URL
Method Detail |
---|
URL getBootstrapHome()
PROP_KEY_BOOTSTRAP_HOME_URL
.
T bootstrapHome(URL bootstrapHome) throws IllegalArgumentException, IllegalStateException
PROP_KEY_BOOTSTRAP_HOME_URL
.
bootstrapHome
-
IllegalArgumentException
- If the bootstrap home location was not specified
IllegalStateException
- If the configuration has been frozenT bootstrapHome(String bootstrapHome) throws IllegalArgumentException, IllegalStateException
PROP_KEY_BOOTSTRAP_HOME_URL
.
bootstrapHome
-
IllegalArgumentException
- If the bootstrap home location was not specified,
or could not be assigned to a URL (ie. MalformedURLException
IllegalStateException
- If the configuration has been frozenURL getBootstrapUrl()
PROP_KEY_BOOTSTRAP_URL
.
T bootstrapUrl(URL bootstrapLocation) throws IllegalArgumentException, IllegalStateException
PROP_KEY_BOOTSTRAP_URL
.
bootstrapLocation
-
IllegalArgumentException
- If the location was not specified
IllegalStateException
- If the configuration has been frozenT bootstrapUrl(String bootstrapUrl) throws IllegalArgumentException, IllegalStateException
PROP_KEY_BOOTSTRAP_URL
.
bootstrapUrl
-
IllegalArgumentException
- If the bootstrap URL location was not specified,
or could not be assigned to a URL (ie. MalformedURLException
IllegalStateException
- If the configuration has been frozenString getBootstrapName()
PROP_KEY_BOOTSTRAP_NAME
.
T bootstrapName(String name) throws IllegalArgumentException, IllegalStateException
PROP_KEY_BOOTSTRAP_NAME
.
name
-
IllegalArgumentException
- If the name was not specified
IllegalStateException
- If the configuration has been frozenMap<String,String> getProperties()
String getProperty(String key) throws IllegalArgumentException
key
- The key
IllegalArgumentException
- If the key was not specifiedT property(String key, String value) throws IllegalArgumentException, IllegalStateException
key
- value
-
IllegalArgumentException
- If the key was not supplied
IllegalStateException
- If the configuration has been frozenT properties(Map<String,String> properties) throws IllegalArgumentException, IllegalStateException
properties
-
IllegalArgumentException
- If the properties are null
IllegalStateException
- If the configuration has been frozenT properties(Properties properties) throws IllegalArgumentException, IllegalStateException
properties(Map)
instead. This
is provided for compatibility with System.getProperties()
.
properties
-
IllegalArgumentException
- If the properties are null, or if any of the
properties are not String/String pairs.
IllegalStateException
- If the configuration has been frozenvoid freeze() throws IllegalStateException
IllegalStateException
boolean isFrozen()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |