org.glassfish.embeddable
Class BootstrapProperties

java.lang.Object
  extended by org.glassfish.embeddable.BootstrapProperties

public class BootstrapProperties
extends java.lang.Object

Encapsulates the set of properties required to bootstrap GlassFishRuntime.

Eg.., GlassFishRuntime.bootstrap(new BootstrapProperties());


Constructor Summary
BootstrapProperties()
          Create BootstrapProperties with default properties.
BootstrapProperties(java.util.Properties props)
          Create BootstrapProperties with custom properties.
 
Method Summary
 java.lang.String getInstallRoot()
          Get the location installation root set using setInstallRoot(java.lang.String)
 java.util.Properties getProperties()
          Get the underlying Properties object which backs this BootstrapProperties.
 java.lang.String getProperty(java.lang.String key)
          Get the value of the property with the specified key.
 void setInstallRoot(java.lang.String installRoot)
          Optionally set the installation root using which the GlassFish should run.
 void setProperty(java.lang.String key, java.lang.String value)
          Set any custom bootstrap property.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BootstrapProperties

public BootstrapProperties()
Create BootstrapProperties with default properties.


BootstrapProperties

public BootstrapProperties(java.util.Properties props)
Create BootstrapProperties with custom properties. This method does not take a copy of the passed in properties object; instead it just maintains a reference to it, so all semantics of "pass-by-reference" applies.

Custom properties can include GlassFish_Platform, com.sun.aas.installRoot, com.sun.aas.installRootURI

Custom properties can also include additional properties which are required for the plugged in RuntimeBuilder (if any)

Parameters:
props - Properties object which will back this BootstrapProperties object.
Method Detail

getProperties

public java.util.Properties getProperties()
Get the underlying Properties object which backs this BootstrapProperties.

If getProperties().setProperty(key,value) is called, then it will add a property to this bootstrap properties.

Returns:
The Properties object that is backing this BootstrapProperties.

setProperty

public void setProperty(java.lang.String key,
                        java.lang.String value)
Set any custom bootstrap property. May be required for the plugged in RuntimeBuilder (if any)

Parameters:
key - the key to be placed into this bootstrap properties.
value - the value corresponding to the key.

getProperty

public java.lang.String getProperty(java.lang.String key)
Get the value of the property with the specified key.

Parameters:
key - the property key
Returns:
value of the property for the specified key, null if there is no such property.

setInstallRoot

public void setInstallRoot(java.lang.String installRoot)
Optionally set the installation root using which the GlassFish should run.

Parameters:
installRoot - Location of installation root.

getInstallRoot

public java.lang.String getInstallRoot()
Get the location installation root set using setInstallRoot(java.lang.String)

Returns:
Location of installation root set using setInstallRoot(java.lang.String)