org.virtualbox_5_0
Class IUSBDeviceFilter

java.lang.Object
  extended by org.virtualbox_5_0.IUnknown
      extended by org.virtualbox_5_0.IUSBDeviceFilter
Direct Known Subclasses:
IHostUSBDeviceFilter

public class IUSBDeviceFilter
extends IUnknown

The IUSBDeviceFilter interface represents an USB device filter used to perform actions on a group of USB devices. This type of filters is used by running virtual machines to automatically capture selected USB devices once they are physically attached to the host computer. A USB device is matched to the given device filter if and only if all attributes of the device match the corresponding attributes of the filter (that is, attributes are joined together using the logical AND operation). On the other hand, all together, filters in the list of filters carry the semantics of the logical OR operation. So if it is desirable to create a match like "this vendor id OR this product id", one needs to create two filters and specify "any match" (see below) for unused attributes. All filter attributes used for matching are strings. Each string is an expression representing a set of values of the corresponding device attribute, that will match the given filter. Currently, the following filtering expressions are supported:

NOTE: On the Windows host platform, interval filters are not currently available. Also all string filter attributes (getManufacturer(),getProduct(),getSerialNumber()) are ignored, so they behave asany matchno matter what string expression is specified.

See Also:
IUSBDeviceFilters.getDeviceFilters(), Interface ID: {45587218-4289-EF4E-8E6A-E5B07816B631}

Field Summary
 
Fields inherited from class org.virtualbox_5_0.IUnknown
obj, port
 
Constructor Summary
IUSBDeviceFilter(java.lang.String wrapped, org.virtualbox_5_0.jaxws.VboxPortType port)
           
 
Method Summary
 java.lang.Boolean getActive()
          Whether this filter active or has been temporarily disabled.
 java.lang.String getManufacturer()
          IUSBDevice.getManufacturer()filter.
 java.lang.Long getMaskedInterfaces()
          This is an advanced option for hiding one or more USB interfaces from the guest.
 java.lang.String getName()
          Visible name for this filter.
 java.lang.String getPort()
          IUSBDevice.getPort()filter.
 java.lang.String getProduct()
          IUSBDevice.getProduct()filter.
 java.lang.String getProductId()
          IUSBDevice.getProductId()filter.
 java.lang.String getRemote()
          IUSBDevice.getRemote()filter.
 java.lang.String getRevision()
          IUSBDevice.getProductId()filter.
 java.lang.String getSerialNumber()
          IUSBDevice.getSerialNumber()filter.
 java.lang.String getVendorId()
          IUSBDevice.getVendorId()filter.
static IUSBDeviceFilter queryInterface(IUnknown obj)
           
 void setActive(java.lang.Boolean value)
          Whether this filter active or has been temporarily disabled.
 void setManufacturer(java.lang.String value)
          IUSBDevice.getManufacturer()filter.
 void setMaskedInterfaces(java.lang.Long value)
          This is an advanced option for hiding one or more USB interfaces from the guest.
 void setName(java.lang.String value)
          Visible name for this filter.
 void setPort(java.lang.String value)
          IUSBDevice.getPort()filter.
 void setProduct(java.lang.String value)
          IUSBDevice.getProduct()filter.
 void setProductId(java.lang.String value)
          IUSBDevice.getProductId()filter.
 void setRemote(java.lang.String value)
          IUSBDevice.getRemote()filter.
 void setRevision(java.lang.String value)
          IUSBDevice.getProductId()filter.
 void setSerialNumber(java.lang.String value)
          IUSBDevice.getSerialNumber()filter.
 void setVendorId(java.lang.String value)
          IUSBDevice.getVendorId()filter.
 
Methods inherited from class org.virtualbox_5_0.IUnknown
getRemoteWSPort, getWrapped, releaseRemote
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IUSBDeviceFilter

public IUSBDeviceFilter(java.lang.String wrapped,
                        org.virtualbox_5_0.jaxws.VboxPortType port)
Method Detail

getName

public java.lang.String getName()
Visible name for this filter. This name is used to visually distinguish one filter from another, so it can neither be null nor an empty string.

Returns:
String

setName

public void setName(java.lang.String value)
Visible name for this filter. This name is used to visually distinguish one filter from another, so it can neither be null nor an empty string.

Parameters:
value - String

getActive

public java.lang.Boolean getActive()
Whether this filter active or has been temporarily disabled.

Returns:
Boolean

setActive

public void setActive(java.lang.Boolean value)
Whether this filter active or has been temporarily disabled.

Parameters:
value - Boolean

getVendorId

public java.lang.String getVendorId()
IUSBDevice.getVendorId()filter. The string representation for theexact matchinghas the formXXXX, whereXis the hex digit (including leading zeroes).

Returns:
String

setVendorId

public void setVendorId(java.lang.String value)
IUSBDevice.getVendorId()filter. The string representation for theexact matchinghas the formXXXX, whereXis the hex digit (including leading zeroes).

Parameters:
value - String

getProductId

public java.lang.String getProductId()
IUSBDevice.getProductId()filter. The string representation for theexact matchinghas the formXXXX, whereXis the hex digit (including leading zeroes).

Returns:
String

setProductId

public void setProductId(java.lang.String value)
IUSBDevice.getProductId()filter. The string representation for theexact matchinghas the formXXXX, whereXis the hex digit (including leading zeroes).

Parameters:
value - String

getRevision

public java.lang.String getRevision()
IUSBDevice.getProductId()filter. The string representation for theexact matchinghas the formIIFF, whereIis the decimal digit of the integer part of the revision, andFis the decimal digit of its fractional part (including leading and trailing zeros). Note that for interval filters, it's best to use the hexadecimal form, because the revision is stored as a 16 bit packed BCD value; so the expressionint:0x0100-0x0199will match any revision from1.0to1.99.

Returns:
String

setRevision

public void setRevision(java.lang.String value)
IUSBDevice.getProductId()filter. The string representation for theexact matchinghas the formIIFF, whereIis the decimal digit of the integer part of the revision, andFis the decimal digit of its fractional part (including leading and trailing zeros). Note that for interval filters, it's best to use the hexadecimal form, because the revision is stored as a 16 bit packed BCD value; so the expressionint:0x0100-0x0199will match any revision from1.0to1.99.

Parameters:
value - String

getManufacturer

public java.lang.String getManufacturer()
IUSBDevice.getManufacturer()filter.

Returns:
String

setManufacturer

public void setManufacturer(java.lang.String value)
IUSBDevice.getManufacturer()filter.

Parameters:
value - String

getProduct

public java.lang.String getProduct()
IUSBDevice.getProduct()filter.

Returns:
String

setProduct

public void setProduct(java.lang.String value)
IUSBDevice.getProduct()filter.

Parameters:
value - String

getSerialNumber

public java.lang.String getSerialNumber()
IUSBDevice.getSerialNumber()filter.

Returns:
String

setSerialNumber

public void setSerialNumber(java.lang.String value)
IUSBDevice.getSerialNumber()filter.

Parameters:
value - String

getPort

public java.lang.String getPort()
IUSBDevice.getPort()filter.

Returns:
String

setPort

public void setPort(java.lang.String value)
IUSBDevice.getPort()filter.

Parameters:
value - String

getRemote

public java.lang.String getRemote()
IUSBDevice.getRemote()filter. NOTE: This filter makes sense only for machine USB filters, i.e. it is ignored by IHostUSBDeviceFilter objects.

Returns:
String

setRemote

public void setRemote(java.lang.String value)
IUSBDevice.getRemote()filter. NOTE: This filter makes sense only for machine USB filters, i.e. it is ignored by IHostUSBDeviceFilter objects.

Parameters:
value - String

getMaskedInterfaces

public java.lang.Long getMaskedInterfaces()
This is an advanced option for hiding one or more USB interfaces from the guest. The value is a bit mask where the bits that are set means the corresponding USB interface should be hidden, masked off if you like. This feature only works on Linux hosts.

Returns:
Long

setMaskedInterfaces

public void setMaskedInterfaces(java.lang.Long value)
This is an advanced option for hiding one or more USB interfaces from the guest. The value is a bit mask where the bits that are set means the corresponding USB interface should be hidden, masked off if you like. This feature only works on Linux hosts.

Parameters:
value - Long

queryInterface

public static IUSBDeviceFilter queryInterface(IUnknown obj)