Package com.biglybt.platform
Interface PlatformManager
-
- All Superinterfaces:
PlatformManager
- All Known Implementing Classes:
PlatformManagerImpl
,PlatformManagerImpl
,PlatformManagerImpl
,PlatformManagerImpl
public interface PlatformManager extends PlatformManager
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ERR_UNSUPPORTED
static int
PT_MACOSX
static int
PT_OTHER
static int
PT_UNIX
static int
PT_WINDOWS
static int[]
SD_ALL
static int
SD_HIBERNATE
static int
SD_SHUTDOWN
static int
SD_SLEEP
static int
USER_REQUEST_INFO
static int
USER_REQUEST_QUESTION
static int
USER_REQUEST_WARNING
-
Fields inherited from interface com.biglybt.pif.platform.PlatformManager
LOC_DOCUMENTS, LOC_DOWNLOADS, LOC_MUSIC, LOC_USER_DATA, LOC_VIDEO
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description void
addListener(PlatformManagerListener listener)
void
copyFilePermissions(java.lang.String from_file_name, java.lang.String to_file_name)
void
createProcess(java.lang.String command_line, boolean inherit_handles)
void
dispose()
Disposes system resources.java.lang.String
getApplicationCommandLine()
java.lang.String[]
getExplicitVMOptions()
int
getMaxOpenFiles()
This max-open-files concept here is from linux/osx where network connections are treated as 'files'int
getPlatformType()
boolean
getPreventComputerSleep()
boolean
getRunAtLogin()
int
getShutdownTypes()
java.lang.String
getUserDataDirectory()
java.lang.String
getVersion()
java.io.File
getVMOptionFile()
boolean
hasCapability(PlatformManagerCapabilities capability)
Gets whether the platform manager supports a capabilityboolean
isApplicationRegistered()
java.lang.Class<?>
loadClass(java.lang.ClassLoader loader, java.lang.String class_name)
Gives a particular platform the ability to alter the class-loading methodvoid
performRecoverableFileDelete(java.lang.String file_name)
void
ping(java.net.InetAddress interface_address, java.net.InetAddress target, PlatformManagerPingCallback callback)
void
registerApplication()
void
removeListener(PlatformManagerListener listener)
void
requestUserAttention(int type, java.lang.Object data)
Requests the user's attention such as bouncing the application icon on OSXvoid
setExplicitVMOptions(java.lang.String[] options)
void
setPreventComputerSleep(boolean prevent_it)
void
setRunAtLogin(boolean run)
void
setTCPTOSEnabled(boolean enabled)
enable or disable the platforms support for TCP TOSdefault boolean
setUseSystemTheme(boolean use_it)
void
shutdown(int type)
void
startup(Core core)
boolean
testNativeAvailability(java.lang.String name)
void
traceRoute(java.net.InetAddress interface_address, java.net.InetAddress target, PlatformManagerPingCallback callback)
-
Methods inherited from interface com.biglybt.pif.platform.PlatformManager
getComputerName, getLocation, isAdditionalFileTypeRegistered, registerAdditionalFileType, showFile, unregisterAdditionalFileType
-
-
-
-
Field Detail
-
PT_WINDOWS
static final int PT_WINDOWS
- See Also:
- Constant Field Values
-
PT_OTHER
static final int PT_OTHER
- See Also:
- Constant Field Values
-
PT_MACOSX
static final int PT_MACOSX
- See Also:
- Constant Field Values
-
PT_UNIX
static final int PT_UNIX
- See Also:
- Constant Field Values
-
USER_REQUEST_INFO
static final int USER_REQUEST_INFO
- See Also:
- Constant Field Values
-
USER_REQUEST_WARNING
static final int USER_REQUEST_WARNING
- See Also:
- Constant Field Values
-
USER_REQUEST_QUESTION
static final int USER_REQUEST_QUESTION
- See Also:
- Constant Field Values
-
SD_SHUTDOWN
static final int SD_SHUTDOWN
- See Also:
- Constant Field Values
-
SD_HIBERNATE
static final int SD_HIBERNATE
- See Also:
- Constant Field Values
-
SD_SLEEP
static final int SD_SLEEP
- See Also:
- Constant Field Values
-
SD_ALL
static final int[] SD_ALL
-
ERR_UNSUPPORTED
static final java.lang.String ERR_UNSUPPORTED
- See Also:
- Constant Field Values
-
-
Method Detail
-
getPlatformType
int getPlatformType()
-
getVersion
java.lang.String getVersion() throws PlatformManagerException
- Throws:
PlatformManagerException
-
startup
void startup(Core core) throws PlatformManagerException
- Throws:
PlatformManagerException
-
getUserDataDirectory
java.lang.String getUserDataDirectory() throws PlatformManagerException
- Throws:
PlatformManagerException
-
isApplicationRegistered
boolean isApplicationRegistered() throws PlatformManagerException
- Throws:
PlatformManagerException
-
registerApplication
void registerApplication() throws PlatformManagerException
- Throws:
PlatformManagerException
-
getApplicationCommandLine
java.lang.String getApplicationCommandLine() throws PlatformManagerException
- Throws:
PlatformManagerException
-
getVMOptionFile
java.io.File getVMOptionFile() throws PlatformManagerException
- Throws:
PlatformManagerException
-
getExplicitVMOptions
java.lang.String[] getExplicitVMOptions() throws PlatformManagerException
- Throws:
PlatformManagerException
-
setExplicitVMOptions
void setExplicitVMOptions(java.lang.String[] options) throws PlatformManagerException
- Throws:
PlatformManagerException
-
getRunAtLogin
boolean getRunAtLogin() throws PlatformManagerException
- Throws:
PlatformManagerException
-
setRunAtLogin
void setRunAtLogin(boolean run) throws PlatformManagerException
- Throws:
PlatformManagerException
-
getShutdownTypes
int getShutdownTypes()
-
shutdown
void shutdown(int type) throws PlatformManagerException
- Throws:
PlatformManagerException
-
setPreventComputerSleep
void setPreventComputerSleep(boolean prevent_it) throws PlatformManagerException
- Throws:
PlatformManagerException
-
getPreventComputerSleep
boolean getPreventComputerSleep()
-
createProcess
void createProcess(java.lang.String command_line, boolean inherit_handles) throws PlatformManagerException
- Throws:
PlatformManagerException
-
performRecoverableFileDelete
void performRecoverableFileDelete(java.lang.String file_name) throws PlatformManagerException
- Throws:
PlatformManagerException
-
setTCPTOSEnabled
void setTCPTOSEnabled(boolean enabled) throws PlatformManagerException
enable or disable the platforms support for TCP TOS- Parameters:
enabled
-- Throws:
PlatformManagerException
-
copyFilePermissions
void copyFilePermissions(java.lang.String from_file_name, java.lang.String to_file_name) throws PlatformManagerException
- Throws:
PlatformManagerException
-
testNativeAvailability
boolean testNativeAvailability(java.lang.String name) throws PlatformManagerException
- Throws:
PlatformManagerException
-
traceRoute
void traceRoute(java.net.InetAddress interface_address, java.net.InetAddress target, PlatformManagerPingCallback callback) throws PlatformManagerException
- Throws:
PlatformManagerException
-
ping
void ping(java.net.InetAddress interface_address, java.net.InetAddress target, PlatformManagerPingCallback callback) throws PlatformManagerException
- Throws:
PlatformManagerException
-
getMaxOpenFiles
int getMaxOpenFiles() throws PlatformManagerException
This max-open-files concept here is from linux/osx where network connections are treated as 'files'- Returns:
- Throws:
PlatformManagerException
-
setUseSystemTheme
default boolean setUseSystemTheme(boolean use_it) throws PlatformManagerException
- Parameters:
use_it
-- Returns:
- if changes were made then true is returned, otherwise false
- Throws:
PlatformManagerException
-
loadClass
java.lang.Class<?> loadClass(java.lang.ClassLoader loader, java.lang.String class_name) throws PlatformManagerException
Gives a particular platform the ability to alter the class-loading method- Parameters:
loader
-class_name
-- Returns:
- Throws:
PlatformManagerException
-
hasCapability
boolean hasCapability(PlatformManagerCapabilities capability)
Gets whether the platform manager supports a capability
Users of PlatformManager should check for supported capabilities before calling the corresponding methods
Note that support for a particular capability may change arbitrarily in the duration of the application session, but the manager will cache where necessary.
- Parameters:
capability
- A platform manager capability- Returns:
- True if the manager supports the capability
-
dispose
void dispose()
Disposes system resources. This method is optional.
-
addListener
void addListener(PlatformManagerListener listener)
-
removeListener
void removeListener(PlatformManagerListener listener)
-
requestUserAttention
void requestUserAttention(int type, java.lang.Object data) throws PlatformManagerException
Requests the user's attention such as bouncing the application icon on OSX- Parameters:
type
-data
-- Throws:
PlatformManagerException
-
-