org.virtualbox_4_2
Class IGuestSession

java.lang.Object
  extended by org.virtualbox_4_2.IUnknown
      extended by org.virtualbox_4_2.IGuestSession

public class IGuestSession
extends IUnknown


Field Summary
 
Fields inherited from class org.virtualbox_4_2.IUnknown
obj, port
 
Constructor Summary
IGuestSession(java.lang.String wrapped, org.virtualbox_4_2.jaxws.VboxPortType port)
           
 
Method Summary
 void close()
          TODO Expected result codes: @link ::VBOX_E_NOT_SUPPORTED VBOX_E_NOT_SUPPORTED TODO
 IProgress copyFrom(java.lang.String source, java.lang.String dest, java.util.List<CopyFileFlag> flags)
          TODO
 IProgress copyTo(java.lang.String source, java.lang.String dest, java.util.List<CopyFileFlag> flags)
          TODO
 IGuestDirectory directoryCreate(java.lang.String path, java.lang.Long mode, java.util.List<DirectoryCreateFlag> flags)
          TODO
 java.lang.String directoryCreateTemp(java.lang.String templateName, java.lang.Long mode, java.lang.String path, java.lang.Boolean secure)
          Create a temporary directory on the guest.
 java.lang.Boolean directoryExists(java.lang.String path)
          TODO
 IGuestDirectory directoryOpen(java.lang.String path, java.lang.String filter, java.util.List<DirectoryOpenFlag> flags)
          TODO
 IGuestFsObjInfo directoryQueryInfo(java.lang.String path)
          TODO
 void directoryRemove(java.lang.String path)
          TODO
 IProgress directoryRemoveRecursive(java.lang.String path, java.util.List<DirectoryRemoveRecFlag> flags)
          TODO
 void directoryRename(java.lang.String source, java.lang.String dest, java.util.List<PathRenameFlag> flags)
          TODO
 void directorySetACL(java.lang.String path, java.lang.String acl)
          TODO
 void environmentClear()
          TODO Expected result codes: @link ::VBOX_E_NOT_SUPPORTED VBOX_E_NOT_SUPPORTED TODO
 java.lang.String environmentGet(java.lang.String name)
          TODO
 void environmentSet(java.lang.String name, java.lang.String value)
          TODO
 void environmentUnset(java.lang.String name)
          TODO
 IGuestFile fileCreateTemp(java.lang.String templateName, java.lang.Long mode, java.lang.String path, java.lang.Boolean secure)
          Create a temporary file on the guest.
 java.lang.Boolean fileExists(java.lang.String path)
          TODO
 IGuestFile fileOpen(java.lang.String path, java.lang.String openMode, java.lang.String disposition, java.lang.Long creationMode, java.lang.Long offset)
          TODO
 IGuestFsObjInfo fileQueryInfo(java.lang.String path)
          TODO
 java.lang.Long fileQuerySize(java.lang.String path)
          TODO
 void fileRemove(java.lang.String path)
          Remove a single file on the guest.
 void fileRename(java.lang.String source, java.lang.String dest, java.util.List<PathRenameFlag> flags)
          TODO
 void fileSetACL(java.lang.String file, java.lang.String acl)
          TODO
 java.util.List<IGuestDirectory> getDirectories()
          TODO
 java.lang.String getDomain()
          TODO NOTE: TODO
 java.util.List<java.lang.String> getEnvironment()
          TODO
 java.util.List<IGuestFile> getFiles()
          TODO
 java.lang.Long getId()
          TODO NOTE: TODO
 java.lang.String getName()
          TODO NOTE: TODO
 java.util.List<IGuestProcess> getProcesses()
          TODO
 java.lang.Long getTimeout()
          TODO NOTE: TODO
 java.lang.String getUser()
          TODO NOTE: TODO
 IGuestProcess processCreate(java.lang.String command, java.util.List<java.lang.String> arguments, java.util.List<java.lang.String> environment, java.util.List<ProcessCreateFlag> flags, java.lang.Long timeoutMS)
          TODO
 IGuestProcess processCreateEx(java.lang.String command, java.util.List<java.lang.String> arguments, java.util.List<java.lang.String> environment, java.util.List<ProcessCreateFlag> flags, java.lang.Long timeoutMS, ProcessPriority priority, java.util.List<java.lang.Integer> affinity)
          TODO
 IGuestProcess processGet(java.lang.Long pid)
          TODO
static IGuestSession queryInterface(IUnknown obj)
           
 void setEnvironment(java.util.List<java.lang.String> value)
          TODO
 void setTimeout(java.lang.Long value)
          TODO NOTE: TODO
 void symlinkCreate(java.lang.String source, java.lang.String target, SymlinkType type)
          TODO
 java.lang.Boolean symlinkExists(java.lang.String symlink)
          TODO
 java.lang.String symlinkRead(java.lang.String symlink, java.util.List<SymlinkReadFlag> flags)
          TODO
 void symlinkRemoveDirectory(java.lang.String path)
          TODO
 void symlinkRemoveFile(java.lang.String file)
          TODO
 
Methods inherited from class org.virtualbox_4_2.IUnknown
getRemoteWSPort, getWrapped, releaseRemote
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IGuestSession

public IGuestSession(java.lang.String wrapped,
                     org.virtualbox_4_2.jaxws.VboxPortType port)
Method Detail

getUser

public java.lang.String getUser()
TODO NOTE: TODO

Returns:
String

getDomain

public java.lang.String getDomain()
TODO NOTE: TODO

Returns:
String

getName

public java.lang.String getName()
TODO NOTE: TODO

Returns:
String

getId

public java.lang.Long getId()
TODO NOTE: TODO

Returns:
Long

getTimeout

public java.lang.Long getTimeout()
TODO NOTE: TODO

Returns:
Long

setTimeout

public void setTimeout(java.lang.Long value)
TODO NOTE: TODO

Parameters:
value - Long

getEnvironment

public java.util.List<java.lang.String> getEnvironment()
TODO

Returns:
List

setEnvironment

public void setEnvironment(java.util.List<java.lang.String> value)
TODO

Parameters:
value - List

getProcesses

public java.util.List<IGuestProcess> getProcesses()
TODO

Returns:
List

getDirectories

public java.util.List<IGuestDirectory> getDirectories()
TODO

Returns:
List

getFiles

public java.util.List<IGuestFile> getFiles()
TODO

Returns:
List

queryInterface

public static IGuestSession queryInterface(IUnknown obj)

close

public void close()
TODO Expected result codes:
@link ::VBOX_E_NOT_SUPPORTED VBOX_E_NOT_SUPPORTED TODO


copyFrom

public IProgress copyFrom(java.lang.String source,
                          java.lang.String dest,
                          java.util.List<CopyFileFlag> flags)
TODO

Parameters:
source - TODO
dest - TODO
flags - TODO
Returns:
Progress object to track the operation completion. Expected result codes:
@link ::VBOX_E_NOT_SUPPORTED VBOX_E_NOT_SUPPORTED TODO

copyTo

public IProgress copyTo(java.lang.String source,
                        java.lang.String dest,
                        java.util.List<CopyFileFlag> flags)
TODO

Parameters:
source - TODO
dest - TODO
flags - TODO
Returns:
Progress object to track the operation completion. Expected result codes:
@link ::VBOX_E_NOT_SUPPORTED VBOX_E_NOT_SUPPORTED TODO

directoryCreate

public IGuestDirectory directoryCreate(java.lang.String path,
                                       java.lang.Long mode,
                                       java.util.List<DirectoryCreateFlag> flags)
TODO

Parameters:
path - TODO
mode - TODO
flags - TODO
Returns:
Optional. Expected result codes:
@link ::VBOX_E_NOT_SUPPORTED VBOX_E_NOT_SUPPORTED TODO

directoryCreateTemp

public java.lang.String directoryCreateTemp(java.lang.String templateName,
                                            java.lang.Long mode,
                                            java.lang.String path,
                                            java.lang.Boolean secure)
Create a temporary directory on the guest.

Parameters:
templateName - Template for the name of the directory to create. This must contain at least one 'X' character. The first group of consecutive 'X' characters in the template will be replaced by a random alphanumeric string to produce a unique name.
mode - The mode of the directory to create. Use 0700 unless there are reasons not to. This parameter is ignored if "secure" is specified.
path - The absolute path to create the temporary directory in.
secure - Whether to fail if the directory can not be securely created. Currently this means that another unprivileged user cannot manipulate the path specified or remove the temporary directory after it has been created. Also causes the mode specified to be ignored. May not be supported on all guest types.
Returns:
On success this will contain the name of the directory created with full path. Expected result codes:
@link ::VBOX_E_NOT_SUPPORTED VBOX_E_NOT_SUPPORTED The operation is not possible as requested on this particular guest type.
E_INVALIDARG Invalid argument. This includes an incorrectly formatted template, or a non-absolute path.
@link ::VBOX_E_IPRT_ERROR VBOX_E_IPRT_ERROR The temporary directory could not be created. Possible reasons include a non-existing path or an insecure path when the secure option was requested.

directoryExists

public java.lang.Boolean directoryExists(java.lang.String path)
TODO

Parameters:
path - TODO
Returns:
TODO Expected result codes:
@link ::VBOX_E_NOT_SUPPORTED VBOX_E_NOT_SUPPORTED TODO

directoryOpen

public IGuestDirectory directoryOpen(java.lang.String path,
                                     java.lang.String filter,
                                     java.util.List<DirectoryOpenFlag> flags)
TODO

Parameters:
path - TODO
filter - TODO
flags - TODO
Returns:
TODO Expected result codes:
@link ::VBOX_E_NOT_SUPPORTED VBOX_E_NOT_SUPPORTED TODO

directoryQueryInfo

public IGuestFsObjInfo directoryQueryInfo(java.lang.String path)
TODO

Parameters:
path - TODO
Returns:
TODO Expected result codes:
@link ::VBOX_E_NOT_SUPPORTED VBOX_E_NOT_SUPPORTED TODO

directoryRemove

public void directoryRemove(java.lang.String path)
TODO

Parameters:
path - TODO Expected result codes:
@link ::VBOX_E_NOT_SUPPORTED VBOX_E_NOT_SUPPORTED TODO

directoryRemoveRecursive

public IProgress directoryRemoveRecursive(java.lang.String path,
                                          java.util.List<DirectoryRemoveRecFlag> flags)
TODO

Parameters:
path - TODO
flags - TODO
Returns:
TODO Expected result codes:
@link ::VBOX_E_NOT_SUPPORTED VBOX_E_NOT_SUPPORTED TODO

directoryRename

public void directoryRename(java.lang.String source,
                            java.lang.String dest,
                            java.util.List<PathRenameFlag> flags)
TODO

Parameters:
source - TODO
dest - TODO
flags - TODO Expected result codes:
@link ::VBOX_E_NOT_SUPPORTED VBOX_E_NOT_SUPPORTED TODO

directorySetACL

public void directorySetACL(java.lang.String path,
                            java.lang.String acl)
TODO

Parameters:
path - TODO
acl - TODO Expected result codes:
@link ::VBOX_E_NOT_SUPPORTED VBOX_E_NOT_SUPPORTED TODO

environmentClear

public void environmentClear()
TODO Expected result codes:
@link ::VBOX_E_NOT_SUPPORTED VBOX_E_NOT_SUPPORTED TODO


environmentGet

public java.lang.String environmentGet(java.lang.String name)
TODO

Parameters:
name - TODO
Returns:
TODO Expected result codes:
@link ::VBOX_E_NOT_SUPPORTED VBOX_E_NOT_SUPPORTED TODO

environmentSet

public void environmentSet(java.lang.String name,
                           java.lang.String value)
TODO

Parameters:
name - TODO
value - TODO Expected result codes:
@link ::VBOX_E_NOT_SUPPORTED VBOX_E_NOT_SUPPORTED TODO

environmentUnset

public void environmentUnset(java.lang.String name)
TODO

Parameters:
name - TODO Expected result codes:
@link ::VBOX_E_NOT_SUPPORTED VBOX_E_NOT_SUPPORTED TODO

fileCreateTemp

public IGuestFile fileCreateTemp(java.lang.String templateName,
                                 java.lang.Long mode,
                                 java.lang.String path,
                                 java.lang.Boolean secure)
Create a temporary file on the guest.

Parameters:
templateName - Template for the name of the file to create. This must contain at least one 'X' character. The first group of consecutive 'X' characters in the template will be replaced by a random alphanumeric string to produce a unique name.
mode - The mode of the file to create. Use 0700 unless there are reasons not to. This parameter is ignored if "secure" is specified.
path - The absolute path to create the temporary file in.
secure - Whether to fail if the file can not be securely created. Currently this means that another unprivileged user cannot manipulate the path specified or remove the temporary file after it has been created. Also causes the mode specified to be ignored. May not be supported on all guest types.
Returns:
On success this will contain an open file object for the new temporary file. Expected result codes:
@link ::VBOX_E_NOT_SUPPORTED VBOX_E_NOT_SUPPORTED The operation is not possible as requested on this particular guest type.
E_INVALIDARG Invalid argument. This includes an incorrectly formatted template, or a non-absolute path.
@link ::VBOX_E_IPRT_ERROR VBOX_E_IPRT_ERROR The temporary file could not be created. Possible reasons include a non-existing path or an insecure path when the secure option was requested.

fileExists

public java.lang.Boolean fileExists(java.lang.String path)
TODO

Parameters:
path - TODO
Returns:
TODO Expected result codes:
@link ::VBOX_E_NOT_SUPPORTED VBOX_E_NOT_SUPPORTED TODO

fileRemove

public void fileRemove(java.lang.String path)
Remove a single file on the guest.

Parameters:
path - Path to the file to remove.

fileOpen

public IGuestFile fileOpen(java.lang.String path,
                           java.lang.String openMode,
                           java.lang.String disposition,
                           java.lang.Long creationMode,
                           java.lang.Long offset)
TODO

Parameters:
path - TODO
openMode - TODO
disposition - TODO
creationMode - TODO
offset - TODO
Returns:
TODO Expected result codes:
@link ::VBOX_E_NOT_SUPPORTED VBOX_E_NOT_SUPPORTED TODO

fileQueryInfo

public IGuestFsObjInfo fileQueryInfo(java.lang.String path)
TODO

Parameters:
path - TODO
Returns:
TODO Expected result codes:
@link ::VBOX_E_NOT_SUPPORTED VBOX_E_NOT_SUPPORTED TODO

fileQuerySize

public java.lang.Long fileQuerySize(java.lang.String path)
TODO

Parameters:
path - TODO
Returns:
TODO Expected result codes:
@link ::VBOX_E_NOT_SUPPORTED VBOX_E_NOT_SUPPORTED TODO

fileRename

public void fileRename(java.lang.String source,
                       java.lang.String dest,
                       java.util.List<PathRenameFlag> flags)
TODO

Parameters:
source - TODO
dest - TODO
flags - TODO Expected result codes:
@link ::VBOX_E_NOT_SUPPORTED VBOX_E_NOT_SUPPORTED TODO

fileSetACL

public void fileSetACL(java.lang.String file,
                       java.lang.String acl)
TODO

Parameters:
file - TODO
acl - TODO Expected result codes:
@link ::VBOX_E_NOT_SUPPORTED VBOX_E_NOT_SUPPORTED TODO

processCreate

public IGuestProcess processCreate(java.lang.String command,
                                   java.util.List<java.lang.String> arguments,
                                   java.util.List<java.lang.String> environment,
                                   java.util.List<ProcessCreateFlag> flags,
                                   java.lang.Long timeoutMS)
TODO

Parameters:
command - TODO
arguments - TODO
environment - TODO
flags - TODO
timeoutMS - TODO
Returns:
TODO Expected result codes:
@link ::VBOX_E_NOT_SUPPORTED VBOX_E_NOT_SUPPORTED TODO

processCreateEx

public IGuestProcess processCreateEx(java.lang.String command,
                                     java.util.List<java.lang.String> arguments,
                                     java.util.List<java.lang.String> environment,
                                     java.util.List<ProcessCreateFlag> flags,
                                     java.lang.Long timeoutMS,
                                     ProcessPriority priority,
                                     java.util.List<java.lang.Integer> affinity)
TODO

Parameters:
command - TODO
arguments - TODO
environment - TODO
flags - TODO
timeoutMS - TODO
priority - TODO
affinity - TODO
Returns:
TODO Expected result codes:
@link ::VBOX_E_NOT_SUPPORTED VBOX_E_NOT_SUPPORTED TODO

processGet

public IGuestProcess processGet(java.lang.Long pid)
TODO

Parameters:
pid - TODO
Returns:
TODO Expected result codes:
@link ::VBOX_E_NOT_SUPPORTED VBOX_E_NOT_SUPPORTED TODO

symlinkCreate

public void symlinkCreate(java.lang.String source,
                          java.lang.String target,
                          SymlinkType type)
TODO

Parameters:
source - TODO
target - TODO
type - TODO Expected result codes:
@link ::VBOX_E_NOT_SUPPORTED VBOX_E_NOT_SUPPORTED TODO

symlinkExists

public java.lang.Boolean symlinkExists(java.lang.String symlink)
TODO

Parameters:
symlink - TODO
Returns:
TODO Expected result codes:
@link ::VBOX_E_NOT_SUPPORTED VBOX_E_NOT_SUPPORTED TODO

symlinkRead

public java.lang.String symlinkRead(java.lang.String symlink,
                                    java.util.List<SymlinkReadFlag> flags)
TODO

Parameters:
symlink - TODO
flags - TODO
Returns:
TODO Expected result codes:
@link ::VBOX_E_NOT_SUPPORTED VBOX_E_NOT_SUPPORTED TODO

symlinkRemoveDirectory

public void symlinkRemoveDirectory(java.lang.String path)
TODO

Parameters:
path - TODO Expected result codes:
@link ::VBOX_E_NOT_SUPPORTED VBOX_E_NOT_SUPPORTED TODO

symlinkRemoveFile

public void symlinkRemoveFile(java.lang.String file)
TODO

Parameters:
file - TODO Expected result codes:
@link ::VBOX_E_NOT_SUPPORTED VBOX_E_NOT_SUPPORTED TODO