Class PlatformManagerImpl

java.lang.Object

com.biglybt.platform.dummy.PlatformManagerImpl

All Implemented Interfaces:

PlatformManager, PlatformManager

public class PlatformManagerImpl
extends Object
implements PlatformManager

Version:

1.0

Field Summary

Fields

Modifier and Type	Field	Description
private static PlatformManager	singleton

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
private	PlatformManagerImpl()

Method Summary

Modifier and Type	Method	Description
void	addListener(PlatformManagerListener listener)
void	copyFilePermissions(String from_file_name, String to_file_name)
void	createProcess(String command_line, boolean inherit_handles)
void	dispose()	Does nothing
String	getApplicationCommandLine()
String	getAzComputerID()
String	getComputerName()
String[]	getExplicitVMOptions()
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 PlatformManager	getSingleton()
String	getUserDataDirectory()
String	getVersion()
File	getVMOptionFile()
boolean	hasCapability(PlatformManagerCapabilities capability)	Gets whether the platform manager supports a capability
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	registerApplication()
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 b)
void	setRunAtLogin(boolean run)
void	setTCPTOSEnabled(boolean enabled)	enable or disable the platforms support for TCP TOS
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

Methods inherited from class Object

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

Methods inherited from interface PlatformManager

setUseSystemTheme

Field Details

singleton

private static PlatformManager singleton

Constructor Details

PlatformManagerImpl

private PlatformManagerImpl()

Method Details

getSingleton

public static PlatformManager getSingleton()

getPlatformType

public int getPlatformType()

Specified by:

getPlatformType in interface PlatformManager

getUserDataDirectory

public String getUserDataDirectory()
                            throws PlatformManagerException

Specified by:

getUserDataDirectory in interface PlatformManager

Throws:

PlatformManagerException

isApplicationRegistered

public boolean isApplicationRegistered()
                                throws PlatformManagerException

Specified by:

isApplicationRegistered in interface PlatformManager

Throws:

PlatformManagerException

getApplicationCommandLine

public String getApplicationCommandLine()
                                 throws PlatformManagerException

Specified by:

getApplicationCommandLine 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

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

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

startup

public void startup(Core core)
             throws PlatformManagerException

Specified by:

startup in interface PlatformManager

Throws:

PlatformManagerException

getShutdownTypes

public int getShutdownTypes()

Specified by:

getShutdownTypes in interface PlatformManager

shutdown

public void shutdown(int type)
              throws PlatformManagerException

Specified by:

shutdown in interface PlatformManager

Throws:

PlatformManagerException

setPreventComputerSleep

public void setPreventComputerSleep(boolean b)
                             throws PlatformManagerException

Specified by:

setPreventComputerSleep in interface PlatformManager

Throws:

PlatformManagerException

getPreventComputerSleep

public boolean getPreventComputerSleep()

Specified by:

getPreventComputerSleep in interface PlatformManager

setExplicitVMOptions

public void setExplicitVMOptions(String[] options)
                          throws PlatformManagerException

Specified by:

setExplicitVMOptions in interface PlatformManager

Throws:

PlatformManagerException

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

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

registerApplication

public void registerApplication()
                         throws PlatformManagerException

Specified by:

registerApplication in interface PlatformManager

Throws:

PlatformManagerException

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

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

getVersion

public String getVersion()
                  throws PlatformManagerException

Specified by:

getVersion in interface PlatformManager

Throws:

PlatformManagerException

setTCPTOSEnabled

public void setTCPTOSEnabled(boolean enabled)
                      throws PlatformManagerException

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

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

dispose

public void dispose()

Does nothing

Specified by:

dispose in interface PlatformManager

addListener

public void addListener(PlatformManagerListener listener)

Specified by:

addListener in interface PlatformManager

removeListener

public void removeListener(PlatformManagerListener listener)

Specified by:

removeListener in interface PlatformManager

getAzComputerID

public String getAzComputerID()
                       throws PlatformManagerException

Throws:

PlatformManagerException

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