com.sun.enterprise.config.serverbeans
Interface JavaConfig

All Superinterfaces:

org.jvnet.hk2.config.ConfigBeanProxy, org.jvnet.hk2.component.Injectable, JvmOptionBag, org.jvnet.hk2.config.types.PropertyBag

public interface JavaConfig
extends org.jvnet.hk2.config.ConfigBeanProxy, org.jvnet.hk2.component.Injectable, org.jvnet.hk2.config.types.PropertyBag, JvmOptionBag

Java Runtime environment configuration

Nested Class Summary

static class

JavaConfig.Duck

Method Summary

java.lang.String	getBytecodePreprocessors() Gets the value of the bytecodePreprocessors property.
java.lang.String	getClasspathPrefix() Gets the value of the classpathPrefix property.
java.lang.String	getClasspathSuffix() Gets the value of the classpathSuffix property.
java.lang.String	getDebugEnabled() Gets the value of the debugEnabled property.
java.lang.String	getDebugOptions() Gets the value of the debugOptions property.
java.lang.String	getEnvClasspathIgnored() Gets the value of the envClasspathIgnored property.
java.lang.String	getJavacOptions() Gets the value of the javacOptions property.
java.util.List<java.lang.String>	getJavacOptionsAsList() Returns the javac options for deployment.
java.lang.String	getJavaHome() Gets the value of the javaHome property.
java.lang.String	getNativeLibraryPathPrefix() Gets the value of the nativeLibraryPathPrefix property.
java.lang.String	getNativeLibraryPathSuffix() Gets the value of the nativeLibraryPathSuffix property.
Profiler	getProfiler() Gets the value of the profiler property.
java.util.List<org.jvnet.hk2.config.types.Property>	getProperty() Properties as per PropertyBag
java.lang.String	getRmicOptions() Gets the value of the rmicOptions property.
java.lang.String	getServerClasspath() Gets the value of the serverClasspath property.
java.lang.String	getSystemClasspath() Gets the value of the systemClasspath property.
void	setBytecodePreprocessors(java.lang.String value) Sets the value of the bytecodePreprocessors property.
void	setClasspathPrefix(java.lang.String value) Sets the value of the classpathPrefix property.
void	setClasspathSuffix(java.lang.String value) Sets the value of the classpathSuffix property.
void	setDebugEnabled(java.lang.String value) Sets the value of the debugEnabled property.
void	setDebugOptions(java.lang.String value) Sets the value of the debugOptions property.
void	setEnvClasspathIgnored(java.lang.String value) Sets the value of the envClasspathIgnored property.
void	setJavacOptions(java.lang.String value) Sets the value of the javacOptions property.
void	setJavaHome(java.lang.String value) Sets the value of the javaHome property.
void	setNativeLibraryPathPrefix(java.lang.String value) Sets the value of the nativeLibraryPathPrefix property.
void	setNativeLibraryPathSuffix(java.lang.String value) Sets the value of the nativeLibraryPathSuffix property.
void	setProfiler(Profiler value) Sets the value of the profiler property.
void	setRmicOptions(java.lang.String value) Sets the value of the rmicOptions property.
void	setServerClasspath(java.lang.String value) Sets the value of the serverClasspath property.
void	setSystemClasspath(java.lang.String value) Sets the value of the systemClasspath property.

Methods inherited from interface org.jvnet.hk2.component.Injectable

injectedInto

Methods inherited from interface org.jvnet.hk2.config.types.PropertyBag

getProperty, getPropertyValue, getPropertyValue

Methods inherited from interface com.sun.enterprise.config.serverbeans.JvmOptionBag

contains, getJvmOptions, getStartingWith, getXmsMegs, getXmxMegs, setJvmOptions

Methods inherited from interface org.jvnet.hk2.config.ConfigBeanProxy

createChild, deepCopy, getParent, getParent

Method Detail

getJavaHome

java.lang.String getJavaHome()

Gets the value of the javaHome property. Specifies the installation directory for Java runtime. JDK 1.4 or higher is supported.

Returns:

possible object is String

setJavaHome

void setJavaHome(java.lang.String value)
                 throws java.beans.PropertyVetoException

Sets the value of the javaHome property.

Parameters:

value - allowed object is String

Throws:

java.beans.PropertyVetoException

getDebugEnabled

java.lang.String getDebugEnabled()

Gets the value of the debugEnabled property. If set to true, the server starts up in debug mode ready for attaching with a JPDA based debugger

Returns:

possible object is String

setDebugEnabled

void setDebugEnabled(java.lang.String value)
                     throws java.beans.PropertyVetoException

Sets the value of the debugEnabled property.

Parameters:

value - allowed object is String

Throws:

java.beans.PropertyVetoException

getDebugOptions

java.lang.String getDebugOptions()

Gets the value of the debugOptions property. JPDA based debugging options string

Returns:

possible object is String

setDebugOptions

void setDebugOptions(java.lang.String value)
                     throws java.beans.PropertyVetoException

Sets the value of the debugOptions property.

Parameters:

value - allowed object is String

Throws:

java.beans.PropertyVetoException

getRmicOptions

java.lang.String getRmicOptions()

Gets the value of the rmicOptions property. Options string passed to RMI compiler, at application deployment time.

Returns:

possible object is String

setRmicOptions

void setRmicOptions(java.lang.String value)
                    throws java.beans.PropertyVetoException

Sets the value of the rmicOptions property.

Parameters:

value - allowed object is String

Throws:

java.beans.PropertyVetoException

getJavacOptions

java.lang.String getJavacOptions()

Gets the value of the javacOptions property. Options string passed to Java compiler, at application deployment time.

Returns:

possible object is String

setJavacOptions

void setJavacOptions(java.lang.String value)
                     throws java.beans.PropertyVetoException

Sets the value of the javacOptions property.

Parameters:

value - allowed object is String

Throws:

java.beans.PropertyVetoException

getClasspathPrefix

java.lang.String getClasspathPrefix()

Gets the value of the classpathPrefix property.

Returns:

possible object is String

setClasspathPrefix

void setClasspathPrefix(java.lang.String value)
                        throws java.beans.PropertyVetoException

Sets the value of the classpathPrefix property. A java classpath string that is prefixed to server-classpath

Parameters:

value - allowed object is String

Throws:

java.beans.PropertyVetoException

getClasspathSuffix

java.lang.String getClasspathSuffix()

Gets the value of the classpathSuffix property. A java classpath string that is appended to server-classpath

Returns:

possible object is String

setClasspathSuffix

void setClasspathSuffix(java.lang.String value)
                        throws java.beans.PropertyVetoException

Sets the value of the classpathSuffix property.

Parameters:

value - allowed object is String

Throws:

java.beans.PropertyVetoException

getServerClasspath

java.lang.String getServerClasspath()

Gets the value of the serverClasspath property. A java classpath string that specifies the classes needed by the Application server. Do not expect users to change this under normal conditions. The shared application server classloader forms the final classpath by concatenating classpath-prefix, ${INSTALL_DIR}/lib, server-classpath, and classpath-suffix

Returns:

possible object is String

setServerClasspath

void setServerClasspath(java.lang.String value)
                        throws java.beans.PropertyVetoException

Sets the value of the serverClasspath property.

Parameters:

value - allowed object is String

Throws:

java.beans.PropertyVetoException

getSystemClasspath

java.lang.String getSystemClasspath()

Gets the value of the systemClasspath property. This classpath string supplied to the jvm at server startup. Contains appserv-launch.jar by default. Users may add to this classpath.

Returns:

possible object is String

setSystemClasspath

void setSystemClasspath(java.lang.String value)
                        throws java.beans.PropertyVetoException

Sets the value of the systemClasspath property.

Parameters:

value - allowed object is String

Throws:

java.beans.PropertyVetoException

getNativeLibraryPathPrefix

java.lang.String getNativeLibraryPathPrefix()

Gets the value of the nativeLibraryPathPrefix property. Prepended to the native library path, which is constructed internally Internally, the native library path is automatically constructed to be a concatenation of Application Server installation relative path for its native shared libraries, standard JRE native library path, the shell environment setting (LD-LIBRARY-PATH on Unix) and any path that may be specified in the profile element.

Returns:

possible object is String

setNativeLibraryPathPrefix

void setNativeLibraryPathPrefix(java.lang.String value)
                                throws java.beans.PropertyVetoException

Sets the value of the nativeLibraryPathPrefix property.

Parameters:

value - allowed object is String

Throws:

java.beans.PropertyVetoException

getNativeLibraryPathSuffix

java.lang.String getNativeLibraryPathSuffix()

Gets the value of the nativeLibraryPathSuffix property. Appended to the native library path, which is constructed as described above

Returns:

possible object is String

setNativeLibraryPathSuffix

void setNativeLibraryPathSuffix(java.lang.String value)
                                throws java.beans.PropertyVetoException

Sets the value of the nativeLibraryPathSuffix property.

Parameters:

value - allowed object is String

Throws:

java.beans.PropertyVetoException

getBytecodePreprocessors

java.lang.String getBytecodePreprocessors()

Gets the value of the bytecodePreprocessors property. A comma separated list of classnames, each of which must implement the com.sun.appserv.BytecodePreprocessor interface. Each of the specified preprocessor class will be called in the order specified. At the moment the comelling use is for a 3rd party Performance Profiling tool.

Returns:

possible object is String

setBytecodePreprocessors

void setBytecodePreprocessors(java.lang.String value)
                              throws java.beans.PropertyVetoException

Sets the value of the bytecodePreprocessors property.

Parameters:

value - allowed object is String

Throws:

java.beans.PropertyVetoException

getEnvClasspathIgnored

java.lang.String getEnvClasspathIgnored()

Gets the value of the envClasspathIgnored property. If set to false, the CLASSPATH environment variable will be read and appended to the Application Server classpath, which is constructed as described above. The CLASSPATH environment variable will be added after the classpath-suffix, at the very end

Returns:

possible object is String

setEnvClasspathIgnored

void setEnvClasspathIgnored(java.lang.String value)
                            throws java.beans.PropertyVetoException

Sets the value of the envClasspathIgnored property.

Parameters:

value - allowed object is String

Throws:

java.beans.PropertyVetoException

getProfiler

Profiler getProfiler()

Gets the value of the profiler property.

Returns:

possible object is Profiler

setProfiler

void setProfiler(Profiler value)
                 throws java.beans.PropertyVetoException

Sets the value of the profiler property.

Parameters:

value - allowed object is Profiler

Throws:

java.beans.PropertyVetoException

getProperty

@ToDo(priority=IMPORTANT,
      details="Provide PropertyDesc for legal props")
@PropertiesDesc(props={})
java.util.List<org.jvnet.hk2.config.types.Property> getProperty()

Properties as per PropertyBag

Specified by:

getProperty in interface org.jvnet.hk2.config.types.PropertyBag

getJavacOptionsAsList

@DuckTyped
java.util.List<java.lang.String> getJavacOptionsAsList()

Returns the javac options for deployment. The options can be anything except "-d", "-classpath" and "-cp". It tokenizes the options by blank space between them. It does not to detect options like "-g -g -g" since javac handles it.

Returns:

javac options as of a list of java.lang.String