org.virtualbox_7_0
Class ISharedFolder

java.lang.Object
  extended by org.virtualbox_7_0.IUnknown
      extended by org.virtualbox_7_0.ISharedFolder

public class ISharedFolder
extends IUnknown

The ISharedFolder interface represents a folder in the host computer's file system accessible from the guest OS running inside a virtual machine using an associated logical name. There are three types of shared folders:

Logical names of shared folders must be unique within the given scope (global, permanent or transient). However, they do not need to be unique across scopes. In this case, the definition of the shared folder in a more specific scope takes precedence over definitions in all other scopes. The order of precedence is (more specific to more general):
  1. Transient definitions
  2. Permanent definitions
  3. Global definitions
For example, if MyMachine has a shared folder namedC_DRIVE(that points toC:\\), then creating a transient shared folder namedC_DRIVE(that points toC:\\\\WINDOWS) will change the definition ofC_DRIVEin the guest OS so that\\\\VBOXSVR\\C_DRIVEwill give access toC:\\WINDOWSinstead ofC:\\on the host PC. Removing the transient shared folderC_DRIVEwill restore the previous (permanent) definition ofC_DRIVEthat points toC:\\if it still exists. Note that permanent and transient shared folders of different machines are in different name spaces, so they don't overlap and don't need to have unique logical names. NOTE: Global shared folders are not implemented in the current version of the product. Interface ID: {9622225A-5409-414B-BD16-77DF7BA3451E}


Field Summary
 
Fields inherited from class org.virtualbox_7_0.IUnknown
obj, objMgr, port
 
Constructor Summary
ISharedFolder(java.lang.String wrapped, org.virtualbox_7_0.ObjectRefManager objMgr, org.virtualbox_7_0.jaxws.VboxPortType port)
           
 
Method Summary
 java.lang.Boolean getAccessible()
          Whether the folder defined by the host path is currently accessible or not.
 java.lang.Boolean getAutoMount()
          Whether the folder gets automatically mounted by the guest or not.
 java.lang.String getAutoMountPoint()
          Desired mount point in the guest for automatically mounting the folder whengetAutoMount()is set.
 java.lang.String getHostPath()
          Full path to the shared folder in the host file system.
 java.lang.String getLastAccessError()
          Text message that represents the result of the last accessibility check.
 java.lang.String getName()
          Logical name of the shared folder.
 java.lang.Boolean getWritable()
          Whether the folder defined by the host path is writable or not.
static ISharedFolder queryInterface(IUnknown obj)
           
 void setAutoMount(java.lang.Boolean value)
          Whether the folder gets automatically mounted by the guest or not.
 void setAutoMountPoint(java.lang.String value)
          Desired mount point in the guest for automatically mounting the folder whengetAutoMount()is set.
 void setWritable(java.lang.Boolean value)
          Whether the folder defined by the host path is writable or not.
 
Methods inherited from class org.virtualbox_7_0.IUnknown
getObjMgr, getRemoteWSPort, getWrapped, releaseRemote
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ISharedFolder

public ISharedFolder(java.lang.String wrapped,
                     org.virtualbox_7_0.ObjectRefManager objMgr,
                     org.virtualbox_7_0.jaxws.VboxPortType port)
Method Detail

getName

public java.lang.String getName()
Logical name of the shared folder.

Returns:
String

getHostPath

public java.lang.String getHostPath()
Full path to the shared folder in the host file system.

Returns:
String

getAccessible

public java.lang.Boolean getAccessible()
Whether the folder defined by the host path is currently accessible or not. For example, the folder can be inaccessible if it is placed on the network share that is not available by the time this property is read.

Returns:
Boolean

getWritable

public java.lang.Boolean getWritable()
Whether the folder defined by the host path is writable or not.

Returns:
Boolean

setWritable

public void setWritable(java.lang.Boolean value)
Whether the folder defined by the host path is writable or not.

Parameters:
value - Boolean

getAutoMount

public java.lang.Boolean getAutoMount()
Whether the folder gets automatically mounted by the guest or not.

Returns:
Boolean

setAutoMount

public void setAutoMount(java.lang.Boolean value)
Whether the folder gets automatically mounted by the guest or not.

Parameters:
value - Boolean

getAutoMountPoint

public java.lang.String getAutoMountPoint()
Desired mount point in the guest for automatically mounting the folder whengetAutoMount()is set. For Windows and OS/2 guests this should be a drive letter, while other guests it should be a absolute directory. It is possible to combine the two, e.g. "T:/mnt/testrsrc" will be attached to "T:" by windows and OS/2 while the unixy guests will mount it at "/mnt/testrsrc". When empty the guest will choose a mount point. The guest may do so too should the specified mount point be in use or otherwise unusable.

Returns:
String

setAutoMountPoint

public void setAutoMountPoint(java.lang.String value)
Desired mount point in the guest for automatically mounting the folder whengetAutoMount()is set. For Windows and OS/2 guests this should be a drive letter, while other guests it should be a absolute directory. It is possible to combine the two, e.g. "T:/mnt/testrsrc" will be attached to "T:" by windows and OS/2 while the unixy guests will mount it at "/mnt/testrsrc". When empty the guest will choose a mount point. The guest may do so too should the specified mount point be in use or otherwise unusable.

Parameters:
value - String

getLastAccessError

public java.lang.String getLastAccessError()
Text message that represents the result of the last accessibility check. Accessibility checks are performed each time thegetAccessible()attribute is read. An empty string is returned if the last accessibility check was successful. A non-empty string indicates a failure and should normally describe a reason of the failure (for example, a file read error).

Returns:
String

queryInterface

public static ISharedFolder queryInterface(IUnknown obj)