Oracle Java Wireless Client

com.sun.ams
Interface AppInstaller

All Superinterfaces:
SuiteInstaller

public interface AppInstaller
extends SuiteInstaller

Application installer interface ApplicationInstaller should be initialized before using SuiteInstaller methods. Otherwise IllegalStateException will be thrown.


Method Summary
 SuiteInfo initialize(java.lang.String locationUrl, AppInstallerProgressListener listener)
          Initializes an installer with an address of an resource where an application descriptor or jar file can be found and installation progress listener.
 SuiteInfo initialize(java.lang.String locationUrl, AppInstallerProgressListener listener, boolean ignoreUpdateLock)
          Initializes an installer with an address of an resource where an application descriptor or jar file can be found and installation progress listener.
 SuiteInfo initialize(java.lang.String locationUrl, byte[] iconBytes, AppInstallerProgressListener listener)
          Initializes an installer with an address of an resource where an application descriptor or jar file can be found and installation progress listener.
 SuiteInfo initialize(java.lang.String jadUrl, java.lang.String jarUrl, AppInstallerProgressListener listener)
          Initializes an installer with an address of an resource where an application descriptor can be found, an URL of the application body and installation progress listener.
 SuiteInfo initialize(java.lang.String jadUrl, java.lang.String jarUrl, byte[] iconBytes, AppInstallerProgressListener listener)
          Initializes an installer with an address of an resource where an application descriptor can be found, an URL of the application body and installation progress listener.
 SuiteInfo initialize(SuiteInfo suiteInfo, AppInstallerProgressListener listener)
          Initializes an installer with an Link object and installation progress listener.
 
Methods inherited from interface com.sun.ams.SuiteInstaller
cancel, start
 

Method Detail

initialize

SuiteInfo initialize(java.lang.String locationUrl,
                     AppInstallerProgressListener listener)
Initializes an installer with an address of an resource where an application descriptor or jar file can be found and installation progress listener.

The function can result in network access for the application descriptor acquiring.

The installation progress listener must be present and ready to handle callback requests. It may be used for login/password querying.

Parameters:
locationUrl - URL indicating the network location where the jad/jar files can be retrieved from
listener - the installation progress listener
Returns:
application information acquired from application descriptor.
NB: Returned SuiteInfo has no suite management methods implementation, so calling to any of SuiteInfo.getIcon(), SuiteInfo.remove(), SuiteInfo.getState(), SuiteInfo.setState(int state, boolean value) or SuiteInfo.getSettings() method will result in RuntimeException. If descriptor was not provided (locationUrl points to jar file) then in returned SuiteInfo all methods except com.sun.ams.SuiteInfo#.getDownloadUrl() are returning null values.

initialize

SuiteInfo initialize(java.lang.String locationUrl,
                     AppInstallerProgressListener listener,
                     boolean ignoreUpdateLock)
Initializes an installer with an address of an resource where an application descriptor or jar file can be found and installation progress listener.

The function can result in network access for the application descriptor acquiring.

The installation progress listener must be present and ready to handle callback requests. It may be used for login/password querying.

Parameters:
locationUrl - URL indicating the network location where the jad/jar files can be retrieved from
listener - the installation progress listener
ignoreUpdateLock - if true the MIDlet suite components will be updated even if lock for update is set
ignoreUpdateLock - if true then suite will be updated event if it is locked for update. This option should be used with caution and never initiated by user.
Returns:
application information acquired from application descriptor.
NB: Returned SuiteInfo has no suite management methods implementation, so calling to any of SuiteInfo.getIcon(), SuiteInfo.remove(), SuiteInfo.getState(), SuiteInfo.setState(int state, boolean value) or SuiteInfo.getSettings() method will result in RuntimeException. If descriptor was not provided (locationUrl points to jar file) then in returned SuiteInfo all methods except com.sun.ams.SuiteInfo#.getDownloadUrl() are returning null values.

initialize

SuiteInfo initialize(java.lang.String locationUrl,
                     byte[] iconBytes,
                     AppInstallerProgressListener listener)
Initializes an installer with an address of an resource where an application descriptor or jar file can be found and installation progress listener.

The function can result in network access for the application descriptor acquiring.

The installation progress listener must be present and ready to handle callback requests. It may be used for login/password querying.

Parameters:
locationUrl - URL indicating the network location where the jad/jar file can be retrieved from
listener - the installation progress listener
iconBytes - the icon to be associated with the installed Suite.
Returns:
application information acquired from application descriptor.
NB: Returned SuiteInfo has no suite management methods implementation, so calling to any of SuiteInfo.getIcon(), SuiteInfo.remove(), SuiteInfo.getState(), SuiteInfo.setState(int state, boolean value) or SuiteInfo.getSettings() method will result in RuntimeException. If descriptor was not provided (locationUrl points to jar file) then in returned SuiteInfo all methods except com.sun.ams.SuiteInfo#.getDownloadUrl() are returning null values.

initialize

SuiteInfo initialize(java.lang.String jadUrl,
                     java.lang.String jarUrl,
                     AppInstallerProgressListener listener)
Initializes an installer with an address of an resource where an application descriptor can be found, an URL of the application body and installation progress listener.

The function is intended to use for installation from local storage but is not limited by such use case.

The function can result in network access for the application descriptor acquiring.

The AppInstallerProgressListener must be present and ready to handle callback requests. It may be used for login/password querying.

Parameters:
jadUrl - the address where to find the application descriptor
jarUrl - the address where to find the application jar file (is ignored currently)
listener - the installation progress listener
Returns:
application information acquired from application descriptor.
NB: Returned SuiteInfo has no suite management methods implementation, so calling to any of SuiteInfo.getIcon(), SuiteInfo.remove(), SuiteInfo.getState(), SuiteInfo.setState(int state, boolean value) or SuiteInfo.getSettings() method will result in RuntimeException.

initialize

SuiteInfo initialize(java.lang.String jadUrl,
                     java.lang.String jarUrl,
                     byte[] iconBytes,
                     AppInstallerProgressListener listener)
Initializes an installer with an address of an resource where an application descriptor can be found, an URL of the application body and installation progress listener.

The function is intended to use for installation from local storage but is not limited by such use case.

The function can result in network access for the application descriptor acquiring.

The AppInstallerProgressListener must be present and ready to handle callback requests. It may be used for login/password querying.

Parameters:
jadUrl - the address where to find the application descriptor
jarUrl - the address where to find the application jar file (is ignored currently)
iconBytes - the icon to be associated with the installed Suite.
listener - the installation progress listener
Returns:
application information acquired from application descriptor.
NB: Returned SuiteInfo has no suite management methods implementation, so calling to any of SuiteInfo.getIcon(), SuiteInfo.remove(), SuiteInfo.getState(), SuiteInfo.setState(int state, boolean value) or SuiteInfo.getSettings() method will result in RuntimeException.

initialize

SuiteInfo initialize(SuiteInfo suiteInfo,
                     AppInstallerProgressListener listener)
                     throws UnsupportedServiceException
Initializes an installer with an Link object and installation progress listener.

The function can result in network access.

The AppInstallerProgressListener must be present and ready to handle callback requests. It may be used for login/password querying.

NB: this functionality is not supported yet (throws UnsupportedServiceException)

Parameters:
suiteInfo - the SuiteInfo for Suite Link for which MIDlet Suite should be installed
listener - the installation progress listener
Returns:
application information acquired from application descriptor.
NB: Returned SuiteInfo has no suite management methods implementation, so calling to any of SuiteInfo.getIcon(), SuiteInfo.remove(), SuiteInfo.getState(), SuiteInfo.setState(int state, boolean value) or SuiteInfo.getSettings() method will result in RuntimeException.
Throws:
UnsupportedServiceException - always, as this functionality is not supported currently

Oracle Java Wireless Client

Copyright (c) 1990, 2012, Oracle and/or its affiliates. All rights reserved.