Interface JavaConfig

All Superinterfaces:
org.jvnet.hk2.config.ConfigBeanProxy, JvmOptionBag, org.jvnet.hk2.config.types.PropertyBag

public interface JavaConfig extends org.jvnet.hk2.config.ConfigBeanProxy, org.jvnet.hk2.config.types.PropertyBag, JvmOptionBag
Java Runtime environment configuration.
  • Method Details

    • getJavaHome

      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(String javaHome) throws PropertyVetoException
      Sets the value of the javaHome property.
      Parameters:
      javaHome - allowed object is String
      Throws:
      PropertyVetoException
    • getDebugEnabled

      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(String debugEnabled) throws PropertyVetoException
      Sets the value of the debugEnabled property.
      Parameters:
      debugEnabled - allowed object is String
      Throws:
      PropertyVetoException
    • getDebugOptions

      String getDebugOptions()
      Gets the value of the debugOptions property.

      JPDA based debugging options string.

      Returns:
      possible object is String
    • setDebugOptions

      void setDebugOptions(String debugOptions) throws PropertyVetoException
      Sets the value of the debugOptions property.
      Parameters:
      debugOptions - allowed object is String
      Throws:
      PropertyVetoException
    • getRmicOptions

      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(String rmicOptions) throws PropertyVetoException
      Sets the value of the rmicOptions property.
      Parameters:
      rmicOptions - allowed object is String
      Throws:
      PropertyVetoException
    • getJavacOptions

      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(String javacOptions) throws PropertyVetoException
      Sets the value of the javacOptions property.
      Parameters:
      javacOptions - allowed object is String
      Throws:
      PropertyVetoException
    • getClasspathPrefix

      String getClasspathPrefix()
      Gets the value of the classpathPrefix property.
      Returns:
      possible object is String
    • setClasspathPrefix

      void setClasspathPrefix(String classpathPrefix) throws PropertyVetoException
      Sets the value of the classpathPrefix property.

      A java classpath string that is prefixed to server-classpath.

      Parameters:
      classpathPrefix - allowed object is String
      Throws:
      PropertyVetoException
    • getClasspathSuffix

      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(String classpathSuffix) throws PropertyVetoException
      Sets the value of the classpathSuffix property.
      Parameters:
      classpathSuffix - allowed object is String
      Throws:
      PropertyVetoException
    • getServerClasspath

      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(String serverClasspath) throws PropertyVetoException
      Sets the value of the serverClasspath property.
      Parameters:
      serverClasspath - allowed object is String
      Throws:
      PropertyVetoException
    • getSystemClasspath

      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(String systemClasspath) throws PropertyVetoException
      Sets the value of the systemClasspath property.
      Parameters:
      systemClasspath - allowed object is String
      Throws:
      PropertyVetoException
    • getNativeLibraryPathPrefix

      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(String pathPrefix) throws PropertyVetoException
      Sets the value of the nativeLibraryPathPrefix property.
      Parameters:
      pathPrefix - allowed object is String
      Throws:
      PropertyVetoException
    • getNativeLibraryPathSuffix

      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(String pathSuffix) throws PropertyVetoException
      Sets the value of the nativeLibraryPathSuffix property.
      Parameters:
      pathSuffix - allowed object is String
      Throws:
      PropertyVetoException
    • getBytecodePreprocessors

      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 compelling use is for a 3rd party Performance Profiling tool.

      Returns:
      possible object is String
    • setBytecodePreprocessors

      void setBytecodePreprocessors(String bytecodePreprocessors) throws PropertyVetoException
      Sets the value of the bytecodePreprocessors property.
      Parameters:
      bytecodePreprocessors - allowed object is String
      Throws:
      PropertyVetoException
    • getEnvClasspathIgnored

      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(String envClasspathIgnored) throws PropertyVetoException
      Sets the value of the envClasspathIgnored property.
      Parameters:
      envClasspathIgnored - allowed object is String
      Throws:
      PropertyVetoException
    • getProfiler

      Profiler getProfiler()
      Gets the value of the profiler property.
      Returns:
      possible object is Profiler
    • setProfiler

      void setProfiler(Profiler profiler) throws PropertyVetoException
      Sets the value of the profiler property.
      Parameters:
      profiler - allowed object is Profiler
      Throws:
      PropertyVetoException
    • getProperty

      @ToDo(priority=IMPORTANT, details="Provide PropertyDesc for legal props") @PropertiesDesc(props={}) List<org.jvnet.hk2.config.types.Property> getProperty()
      Properties as per PropertyBag
      Specified by:
      getProperty in interface org.jvnet.hk2.config.types.PropertyBag
    • getJavacOptionsAsList

      default List<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 String