Class PlatformManagerImpl

java.lang.Object

com.biglybt.platform.PlatformManagerBase

com.biglybt.platform.win32.PlatformManagerImpl

All Implemented Interfaces:

AEDiagnosticsEvidenceGenerator, PlatformManager, PlatformManager, AEWin32AccessListener

public class PlatformManagerImpl
extends PlatformManagerBase
implements PlatformManager, AEWin32AccessListener, AEDiagnosticsEvidenceGenerator

Field Summary

Fields

Modifier and Type	Field	Description
private final AEWin32Access	access
private final String	app_exe_name
private final String	app_name
private File	az_exe
private boolean	az_exe_checked
static final String	BIGLYBY_ASSOC
private final Set<PlatformManagerCapabilities>	capabilitySet
private static AEMonitor	class_mon
static String	DLL_NAME
private static boolean	init_tried
private static boolean	initialising
private List	listeners
static final String	OLD_MAIN_ASS0C
private boolean	prevent_computer_sleep
private AEThread2	prevent_sleep_thread
static final int	RT_AZ
static final int	RT_NONE
static final int	RT_OTHER
private static PlatformManagerImpl	singleton

Fields inherited from interface AEWin32AccessListener

ET_RESUME, ET_SHUTDOWN, ET_SUSPEND, RT_SUSPEND_DENY

Fields inherited from interface PlatformManager

LOC_DOCUMENTS, LOC_DOWNLOADS, LOC_MUSIC, LOC_USER_DATA, LOC_VIDEO

Fields inherited from interface PlatformManager

ERR_UNSUPPORTED, PT_MACOSX, PT_OTHER, PT_UNIX, PT_WINDOWS, SD_ALL, SD_HIBERNATE, SD_SHUTDOWN, SD_SLEEP, USER_REQUEST_INFO, USER_REQUEST_QUESTION, USER_REQUEST_WARNING

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PlatformManagerImpl()

Method Summary

Modifier and Type	Method	Description
void	addListener(PlatformManagerListener listener)
protected void	applyPatches()
private boolean	canHibernate()
private File	checkAndGetLocalVMOptionFile()
private void	checkCapability(PlatformManagerCapabilities capability)
protected void	checkExeKey(int hkey, File exe)
protected void	checkExeKey(File exe)
void	copyFilePermissions(String from_file_name, String to_file_name)
protected boolean	createKey(int type, String key)
void	createProcess(String command_line, boolean inherit_handles)
void	dispose()	Does nothing
int	eventOccurred(int type)
protected void	fixPermissions(File parent, File dir)
void	generate(IndentWriter writer)
int	getAdditionalFileTypeRegistrationDetails(String name, String type)
String	getApplicationCommandLine()
protected File	getApplicationEXELocation()
String	getComputerName()
String[]	getExplicitVMOptions()
protected int	getIconIndex()
private UpdateInstaller	getInstaller(Core core)
private File[]	getJVMOptionFiles()
private String	getJVMOptionRedirect()
File	getLocation(long location_id)	Get a well-known location, if defined for the platform
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()
static PlatformManagerImpl	getSingleton()
String	getUserDataDirectory()
String	getVersion()
File	getVMOptionFile()
boolean	hasCapability(PlatformManagerCapabilities capability)	Gets whether the platform manager supports a capability
private boolean	informUpdateRequired()
private void	initializeCapabilities()
boolean	isAdditionalFileTypeRegistered(String name, String type)	Checks to see if the supplied file type is registered with this application
boolean	isApplicationRegistered()
Class<?>	loadClass(ClassLoader loader, String class_name)	Gives a particular platform the ability to alter the class-loading method
void	performRecoverableFileDelete(String file_name)
void	ping(InetAddress interface_address, InetAddress target, PlatformManagerPingCallback callback)
void	registerAdditionalFileType(String name, String description, String type, String content_type)	Registers a file type with this application
void	registerAdditionalFileType(String name, String description, String type, String content_type, boolean url_protocol)
void	registerApplication()
protected void	registerBC()
protected void	registerDHT()
protected void	registerMagnet(boolean force)
void	removeListener(PlatformManagerListener listener)
void	requestUserAttention(int type, Object data)	Requests the user's attention such as bouncing the application icon on OSX
void	setExplicitVMOptions(String[] options)
void	setPreventComputerSleep(boolean prevent_it)
void	setRunAtLogin(boolean run)
void	setTCPTOSEnabled(boolean enabled)	enable or disable the platforms support for TCP TOS
int	shellExecute(String operation, String file, String parameters, String directory, int SW_const)
void	showFile(String file_name)	Reveals the file or directory with the platform's default browser
void	shutdown(int type)
void	startup(Core core)
boolean	testNativeAvailability(String name)
void	traceRoute(InetAddress interface_address, InetAddress target, PlatformManagerPingCallback callback)
void	unregisterAdditionalFileType(String name, String type)	Removes a file-type registration
private void	writeStringToHKCRandHKCU(String subkey, String name, String value)

Methods inherited from class PlatformManagerBase

checkCanUseJVMOptions

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface PlatformManager

setUseSystemTheme

Field Details

RT_NONE

public static final int RT_NONE

See Also:

• Constant Field Values

RT_AZ

public static final int RT_AZ

See Also:

• Constant Field Values

RT_OTHER

public static final int RT_OTHER

See Also:

• Constant Field Values

DLL_NAME

public static String DLL_NAME

BIGLYBY_ASSOC

public static final String BIGLYBY_ASSOC

See Also:

• Constant Field Values

OLD_MAIN_ASS0C

public static final String OLD_MAIN_ASS0C

See Also:

• Constant Field Values

initialising

private static boolean initialising

init_tried

private static boolean init_tried

singleton

private static PlatformManagerImpl singleton

class_mon

private static AEMonitor class_mon

capabilitySet

private final Set<PlatformManagerCapabilities> capabilitySet

listeners

private List listeners

access

private final AEWin32Access access

app_name

private final String app_name

app_exe_name

private final String app_exe_name

az_exe

private File az_exe

az_exe_checked

private boolean az_exe_checked

prevent_computer_sleep

private boolean prevent_computer_sleep

prevent_sleep_thread

private AEThread2 prevent_sleep_thread

Constructor Details

PlatformManagerImpl

protected PlatformManagerImpl()
                       throws PlatformManagerException

Throws:

PlatformManagerException

Method Details

getSingleton

public static PlatformManagerImpl getSingleton()
                                        throws PlatformManagerException

Throws:

PlatformManagerException

initializeCapabilities

private void initializeCapabilities()

applyPatches

protected void applyPatches()

fixPermissions

protected void fixPermissions(File parent,
 File dir)
                       throws PlatformManagerException

Throws:

PlatformManagerException

getIconIndex

protected int getIconIndex()
                    throws PlatformManagerException

Throws:

PlatformManagerException

getVersion

public String getVersion()

Specified by:

getVersion in interface PlatformManager

getApplicationEXELocation

protected File getApplicationEXELocation()
                                  throws PlatformManagerException

Throws:

PlatformManagerException

getPlatformType

public int getPlatformType()

Specified by:

getPlatformType in interface PlatformManager

getUserDataDirectory

public String getUserDataDirectory()
                            throws PlatformManagerException

Specified by:

getUserDataDirectory in interface PlatformManager

Throws:

PlatformManagerException

getComputerName

public String getComputerName()

Specified by:

getComputerName in interface PlatformManager

Returns:

null if can't be found

getLocation

public File getLocation(long location_id)
                 throws PlatformManagerException

Description copied from interface: PlatformManager

Get a well-known location, if defined for the platform

Specified by:

getLocation in interface PlatformManager

Parameters:

location_id - from above LOC_constants

Returns:

Throws:

PlatformManagerException

getJVMOptionRedirect

private String getJVMOptionRedirect()

getJVMOptionFiles

private File[] getJVMOptionFiles()

checkAndGetLocalVMOptionFile

private File checkAndGetLocalVMOptionFile()
                                   throws PlatformManagerException

Throws:

PlatformManagerException

getVMOptionFile

public File getVMOptionFile()
                     throws PlatformManagerException

Specified by:

getVMOptionFile in interface PlatformManager

Throws:

PlatformManagerException

getExplicitVMOptions

public String[] getExplicitVMOptions()
                              throws PlatformManagerException

Specified by:

getExplicitVMOptions in interface PlatformManager

Throws:

PlatformManagerException

setExplicitVMOptions

public void setExplicitVMOptions(String[] options)
                          throws PlatformManagerException

Specified by:

setExplicitVMOptions in interface PlatformManager

Throws:

PlatformManagerException

getRunAtLogin

public boolean getRunAtLogin()
                      throws PlatformManagerException

Specified by:

getRunAtLogin in interface PlatformManager

Throws:

PlatformManagerException

setRunAtLogin

public void setRunAtLogin(boolean run)
                   throws PlatformManagerException

Specified by:

setRunAtLogin in interface PlatformManager

Throws:

PlatformManagerException

getShutdownTypes

public int getShutdownTypes()

Specified by:

getShutdownTypes in interface PlatformManager

getPreventComputerSleep

public boolean getPreventComputerSleep()

Specified by:

getPreventComputerSleep in interface PlatformManager

setPreventComputerSleep

public void setPreventComputerSleep(boolean prevent_it)

Specified by:

setPreventComputerSleep in interface PlatformManager

canHibernate

private boolean canHibernate()

startup

public void startup(Core core)
             throws PlatformManagerException

Specified by:

startup in interface PlatformManager

Throws:

PlatformManagerException

getInstaller

private UpdateInstaller getInstaller(Core core)
                              throws Exception

Throws:

Exception

informUpdateRequired

private boolean informUpdateRequired()

shutdown

public void shutdown(int type)
              throws PlatformManagerException

Specified by:

shutdown in interface PlatformManager

Throws:

PlatformManagerException

getApplicationCommandLine

public String getApplicationCommandLine()

Specified by:

getApplicationCommandLine in interface PlatformManager

isApplicationRegistered

public boolean isApplicationRegistered()
                                throws PlatformManagerException

Specified by:

isApplicationRegistered in interface PlatformManager

Throws:

PlatformManagerException

checkExeKey

protected void checkExeKey(File exe)

checkExeKey

protected void checkExeKey(int hkey,
 File exe)

isAdditionalFileTypeRegistered

public boolean isAdditionalFileTypeRegistered(String name,
 String type)
                                       throws PlatformManagerException

Description copied from interface: PlatformManager

Checks to see if the supplied file type is registered with this application

Specified by:

isAdditionalFileTypeRegistered in interface PlatformManager

Parameters:

name -

type -

Returns:

Throws:

PlatformManagerException

getAdditionalFileTypeRegistrationDetails

public int getAdditionalFileTypeRegistrationDetails(String name,
 String type)
                                             throws PlatformManagerException

Throws:

PlatformManagerException

registerApplication

public void registerApplication()
                         throws PlatformManagerException

Specified by:

registerApplication in interface PlatformManager

Throws:

PlatformManagerException

registerMagnet

protected void registerMagnet(boolean force)

createKey

protected boolean createKey(int type,
 String key)

registerDHT

protected void registerDHT()

registerBC

protected void registerBC()

registerAdditionalFileType

public void registerAdditionalFileType(String name,
 String description,
 String type,
 String content_type)
                                throws PlatformManagerException

Description copied from interface: PlatformManager

Registers a file type with this application

Specified by:

registerAdditionalFileType in interface PlatformManager

Parameters:

name -

description -

type -

content_type -

Throws:

PlatformManagerException

registerAdditionalFileType

public void registerAdditionalFileType(String name,
 String description,
 String type,
 String content_type,
 boolean url_protocol)
                                throws PlatformManagerException

Throws:

PlatformManagerException

writeStringToHKCRandHKCU

private void writeStringToHKCRandHKCU(String subkey,
 String name,
 String value)

unregisterAdditionalFileType

public void unregisterAdditionalFileType(String name,
 String type)
                                  throws PlatformManagerException

Description copied from interface: PlatformManager

Removes a file-type registration

Specified by:

unregisterAdditionalFileType in interface PlatformManager

Parameters:

name -

type -

Throws:

PlatformManagerException

createProcess

public void createProcess(String command_line,
 boolean inherit_handles)
                   throws PlatformManagerException

Specified by:

createProcess in interface PlatformManager

Throws:

PlatformManagerException

performRecoverableFileDelete

public void performRecoverableFileDelete(String file_name)
                                  throws PlatformManagerException

Specified by:

performRecoverableFileDelete in interface PlatformManager

Throws:

PlatformManagerException

setTCPTOSEnabled

public void setTCPTOSEnabled(boolean enabled)
                      throws PlatformManagerException

Description copied from interface: PlatformManager

enable or disable the platforms support for TCP TOS

Specified by:

setTCPTOSEnabled in interface PlatformManager

Parameters:

enabled -

Throws:

PlatformManagerException

copyFilePermissions

public void copyFilePermissions(String from_file_name,
 String to_file_name)
                         throws PlatformManagerException

Specified by:

copyFilePermissions in interface PlatformManager

Throws:

PlatformManagerException

showFile

public void showFile(String file_name)
              throws PlatformManagerException

Reveals the file or directory with the platform's default browser

Specified by:

showFile in interface PlatformManager

Parameters:

file_name - The full path to a file or directory

Throws:

PlatformManagerException - If this operation fails

testNativeAvailability

public boolean testNativeAvailability(String name)
                               throws PlatformManagerException

Specified by:

testNativeAvailability in interface PlatformManager

Throws:

PlatformManagerException

traceRoute

public void traceRoute(InetAddress interface_address,
 InetAddress target,
 PlatformManagerPingCallback callback)
                throws PlatformManagerException

Specified by:

traceRoute in interface PlatformManager

Throws:

PlatformManagerException

ping

public void ping(InetAddress interface_address,
 InetAddress target,
 PlatformManagerPingCallback callback)
          throws PlatformManagerException

Specified by:

ping in interface PlatformManager

Throws:

PlatformManagerException

shellExecute

public int shellExecute(String operation,
 String file,
 String parameters,
 String directory,
 int SW_const)
                 throws PlatformManagerException

Throws:

PlatformManagerException

getMaxOpenFiles

public int getMaxOpenFiles()
                    throws PlatformManagerException

Description copied from interface: PlatformManager

This max-open-files concept here is from linux/osx where network connections are treated as 'files'

Specified by:

getMaxOpenFiles in interface PlatformManager

Returns:

Throws:

PlatformManagerException

hasCapability

public 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.

Specified by:

hasCapability in interface PlatformManager

Parameters:

capability - A platform manager capability

Returns:

True if the manager supports the capability

checkCapability

private void checkCapability(PlatformManagerCapabilities capability)
                      throws PlatformManagerException

Throws:

PlatformManagerException

dispose

public void dispose()

Does nothing

Specified by:

dispose in interface PlatformManager

eventOccurred

public int eventOccurred(int type)

Specified by:

eventOccurred in interface AEWin32AccessListener

addListener

public void addListener(PlatformManagerListener listener)

Specified by:

addListener in interface PlatformManager

removeListener

public void removeListener(PlatformManagerListener listener)

Specified by:

removeListener in interface PlatformManager

requestUserAttention

public void requestUserAttention(int type,
 Object data)
                          throws PlatformManagerException

Description copied from interface: PlatformManager

Requests the user's attention such as bouncing the application icon on OSX

Specified by:

requestUserAttention in interface PlatformManager

Parameters:

type -

data -

Throws:

PlatformManagerException

loadClass

public Class<?> loadClass(ClassLoader loader,
 String class_name)
                   throws PlatformManagerException

Description copied from interface: PlatformManager

Gives a particular platform the ability to alter the class-loading method

Specified by:

loadClass in interface PlatformManager

Parameters:

loader -

class_name -

Returns:

Throws:

PlatformManagerException

generate

public void generate(IndentWriter writer)

Specified by:

generate in interface AEDiagnosticsEvidenceGenerator