org.virtualbox_7_0
Class IUpdateAgent

java.lang.Object
  extended by org.virtualbox_7_0.IUnknown
      extended by org.virtualbox_7_0.IUpdateAgent
Direct Known Subclasses:
IHostUpdateAgent

public class IUpdateAgent
extends IUnknown

Abstract parent interface for handling updateable software components. Interface ID: {C4B1B5F4-8CDF-4923-9EF6-B92476A84109}


Field Summary
 
Fields inherited from class org.virtualbox_7_0.IUnknown
obj, objMgr, port
 
Constructor Summary
IUpdateAgent(java.lang.String wrapped, org.virtualbox_7_0.ObjectRefManager objMgr, org.virtualbox_7_0.jaxws.VboxPortType port)
           
 
Method Summary
 IProgress checkFor()
          Checks for an update.
 IProgress download()
          Downloads the update.
 UpdateChannel getChannel()
          Update channel to use for checking for updates.
 java.lang.Long getCheckCount()
          How many times the update check has happened already.
 java.lang.Long getCheckFrequency()
          The update check frequency (in seconds).
 java.util.List<java.lang.String> getDependsOn()
          Array of other update component names this component depends on before being able to get installed.
 java.lang.String getDownloadUrl()
          Download URL of the update.
 java.lang.Boolean getEnabled()
          Enables or disables the update component.
 IEventSource getEventSource()
          Event source for update agent events.
 java.lang.Boolean getHidden()
          Whether the update component shall be hidden from the user or not.
 java.lang.Boolean getIsCheckNeeded()
          Returns TRUE if an update check is needed, or FALSE if not.
 java.lang.String getLastCheckDate()
          Date of last update check.
 java.lang.String getName()
          Name of the update component.
 java.lang.Long getOrder()
          Order hint the update component needs to run at, in conjunction with other update components.
 java.lang.String getReleaseNotes()
          Release notes of the update.
 java.lang.String getRepositoryURL()
          Update repository URL to use for retrieving the update.
 UpdateState getState()
          Returns the current update state.
 java.util.List<UpdateChannel> getSupportedChannels()
          Returns a safe array of all supported update channels this agents offers.
 java.lang.String getVersion()
          Version the update contains.
 java.lang.String getWebUrl()
          Web URL of the update.
 IProgress install()
          Installs the update.
static IUpdateAgent queryInterface(IUnknown obj)
           
 void rollback()
          Rolls back installing the update.
 void setChannel(UpdateChannel value)
          Update channel to use for checking for updates.
 void setCheckFrequency(java.lang.Long value)
          The update check frequency (in seconds).
 void setEnabled(java.lang.Boolean value)
          Enables or disables the update component.
 void setRepositoryURL(java.lang.String value)
          Update repository URL to use for retrieving the update.
 
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

IUpdateAgent

public IUpdateAgent(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()
Name of the update component.

Returns:
String

getEventSource

public IEventSource getEventSource()
Event source for update agent events.

Returns:
org.virtualbox_7_0.IEventSource

getOrder

public java.lang.Long getOrder()
Order hint the update component needs to run at, in conjunction with other update components.

Returns:
Long

getDependsOn

public java.util.List<java.lang.String> getDependsOn()
Array of other update component names this component depends on before being able to get installed.

Returns:
List<String>

getVersion

public java.lang.String getVersion()
Version the update contains.

Returns:
String

getDownloadUrl

public java.lang.String getDownloadUrl()
Download URL of the update.

Returns:
String

getWebUrl

public java.lang.String getWebUrl()
Web URL of the update.

Returns:
String

getReleaseNotes

public java.lang.String getReleaseNotes()
Release notes of the update.

Returns:
String

getEnabled

public java.lang.Boolean getEnabled()
Enables or disables the update component.

Returns:
Boolean

setEnabled

public void setEnabled(java.lang.Boolean value)
Enables or disables the update component.

Parameters:
value - Boolean

getHidden

public java.lang.Boolean getHidden()
Whether the update component shall be hidden from the user or not.

Returns:
Boolean

getState

public UpdateState getState()
Returns the current update state.

Returns:
org.virtualbox_7_0.UpdateState

getCheckFrequency

public java.lang.Long getCheckFrequency()
The update check frequency (in seconds).

Returns:
Long

setCheckFrequency

public void setCheckFrequency(java.lang.Long value)
The update check frequency (in seconds).

Parameters:
value - Long

getChannel

public UpdateChannel getChannel()
Update channel to use for checking for updates.

Returns:
org.virtualbox_7_0.UpdateChannel

setChannel

public void setChannel(UpdateChannel value)
Update channel to use for checking for updates.

Parameters:
value - org.virtualbox_7_0.UpdateChannel

getRepositoryURL

public java.lang.String getRepositoryURL()
Update repository URL to use for retrieving the update.

Returns:
String

setRepositoryURL

public void setRepositoryURL(java.lang.String value)
Update repository URL to use for retrieving the update.

Parameters:
value - String

getLastCheckDate

public java.lang.String getLastCheckDate()
Date of last update check.

Returns:
String

getCheckCount

public java.lang.Long getCheckCount()
How many times the update check has happened already.

Returns:
Long

getIsCheckNeeded

public java.lang.Boolean getIsCheckNeeded()
Returns TRUE if an update check is needed, or FALSE if not. NOTE: Compares the system's current date with the last update check date and currently set check frequency.

Returns:
Boolean

getSupportedChannels

public java.util.List<UpdateChannel> getSupportedChannels()
Returns a safe array of all supported update channels this agents offers.

Returns:
List<org.virtualbox_7_0.UpdateChannel>

queryInterface

public static IUpdateAgent queryInterface(IUnknown obj)

checkFor

public IProgress checkFor()
Checks for an update.

Returns:
Progress object to track operation completion.

download

public IProgress download()
Downloads the update.

Returns:
Progress object to track operation completion.

install

public IProgress install()
Installs the update.

Returns:
Progress object to track operation completion.

rollback

public void rollback()
Rolls back installing the update.