GigaSpaces XAP 8.0 API

org.openspaces.admin.gsa
Class GridServiceOptions

java.lang.Object
  extended by org.openspaces.admin.gsa.GridServiceOptions

public class GridServiceOptions
extends Object

A generic process options.

Author:
kimchy

Constructor Summary
GridServiceOptions(String type)
          Constructs a new grid service options with the given process type.
 
Method Summary
 GridServiceOptions argument(String argument)
          Will add a process level argument.
 GridServiceOptions environmentVariable(String name, String value)
          Sets an environment variable that will be passed to forked process.
 com.gigaspaces.grid.gsa.GSProcessOptions getOptions()
          Returns the agent process options that represents what was set on this generic service options.
 GridServiceOptions overrideArguments()
          Will cause the process arguments added using argument(String) to override any arguments defined in the process descriptor.
 GridServiceOptions overrideVmInputArguments()
          Will cause JVM options added using vmInputArgument(String) to override all the vm arguments that the JVM will start by default with.
 GridServiceOptions useScript()
          Will use a scipt to start the process, and not a pure JVM process.
 GridServiceOptions vmInputArgument(String vmInputArgument)
          Will add a JVM level argument when the process is executed using pure JVM.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GridServiceOptions

public GridServiceOptions(String type)
Constructs a new grid service options with the given process type. By default, will use JVM to start it.

Method Detail

useScript

public GridServiceOptions useScript()
Will use a scipt to start the process, and not a pure JVM process.


overrideVmInputArguments

public GridServiceOptions overrideVmInputArguments()
Will cause JVM options added using vmInputArgument(String) to override all the vm arguments that the JVM will start by default with.


vmInputArgument

public GridServiceOptions vmInputArgument(String vmInputArgument)
Will add a JVM level argument when the process is executed using pure JVM. For example, the memory can be controlled using -Xmx512m.


overrideArguments

public GridServiceOptions overrideArguments()
Will cause the process arguments added using argument(String) to override any arguments defined in the process descriptor.


argument

public GridServiceOptions argument(String argument)
Will add a process level argument.


environmentVariable

public GridServiceOptions environmentVariable(String name,
                                              String value)
Sets an environment variable that will be passed to forked process.


getOptions

public com.gigaspaces.grid.gsa.GSProcessOptions getOptions()
Returns the agent process options that represents what was set on this generic service options.


GigaSpaces XAP 8.0 API

Copyright © GigaSpaces.