Class PlatformManagerImpl

java.lang.Object

com.biglybt.platform.PlatformManagerBase

com.biglybt.platform.macosx.PlatformManagerImpl

All Implemented Interfaces:

AEDiagnosticsEvidenceGenerator, PlatformManager, PlatformManager

public class PlatformManagerImpl
extends PlatformManagerBase
implements PlatformManager, AEDiagnosticsEvidenceGenerator

Performs platform-specific operations with Mac OS X

Version:

1.0 Initial Version

See Also:

• PlatformManager

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	BUNDLE_ID
private final HashSet	capabilitySet
private Class<?>	claFileManager
protected static AEMonitor	class_mon
private String	computer_name
private boolean	computer_name_tried
private Core	core
private static final String[]	EXTENSIONS
private static String	fileBrowserName
private static final LogIDs	LOGID
private static final String[]	MIMETYPES
private Process	prevent_computer_proc
private boolean	prevent_computer_sleep
private boolean	prevent_computer_sleep_pending
private static final String[]	SCHEMES
protected static PlatformManagerImpl	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

Constructor	Description
PlatformManagerImpl()	Creates a new PlatformManager and initializes its capabilities

Method Summary

Modifier and Type	Method	Description
void	addListener(PlatformManagerListener listener)
private File	checkAndGetLocalVMOptionFile()
private void	checkCapability(PlatformManagerCapabilities capability)
protected static boolean	compileOSAScript(CharSequence[] cmds, File destination)	Compiles a new AppleScript instance to the specified location
protected static boolean	compileOSAScript(CharSequence cmd, File destination)	Compiles a new AppleScript instance to the specified location
private boolean	containsTag(String line, String tag)
private void	convertToXML(File file)
void	copyFilePermissions(String from_file_name, String to_file_name)
void	createProcess(String cmd, boolean inheritsHandles)
void	dispose()	Disposes system resources.
private String	findCommand(String name)
void	generate(IndentWriter writer)
private File	getAbsoluteBundleFile()	Bundle Path is the .app file that launched vuze, usually /Applications/Vuze.app
String	getApplicationCommandLine()	command to launch Vuze
String	getAzComputerID()
private String	getBundlePath()	Bundle Path is the .app file that launched vuze, usually /Applications/Vuze.app
String	getComputerName()
String[]	getExplicitVMOptions()
private static String	getFileBrowserName()	Gets the preferred file browser name
private Class<?>	getFileManagerClass()
private File[]	getJVMOptionFiles()
private String	getJVMOptionRedirect()
File	getLocation(long location_id)	Get a well-known location, if defined for the platform
private File	getLoginPList()
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()	Gets the platform manager singleton, which was already initialized
String	getUserDataDirectory()
String	getVersion()
File	getVMOptionFile()
boolean	hasCapability(PlatformManagerCapabilities capability)	Gets whether the platform manager supports a capability
private boolean	hasVMOptions()
private static void	initializeSingleton()	Instantiates the singleton
boolean	isAdditionalFileTypeRegistered(String name, String type)	Checks to see if the supplied file type is registered with this application
boolean	isApplicationRegistered()
private boolean	isOurExt(String ext)
private boolean	isOurMimeType(String mimetype)
private boolean	isOurScheme(String scheme)
Class<?>	loadClass(ClassLoader loader, String class_name)	Gives a particular platform the ability to alter the class-loading method
static void	main(String[] args)
protected static String	performOSAScript(File script)	Compiles a new AppleScript instance and runs it
protected static String	performOSAScript(CharSequence cmd)	Compiles a new AppleScript instance and runs it
protected static String	performOSAScript(CharSequence[] cmds)	Compiles a new AppleScript instance and runs it
void	performRecoverableFileDelete(String path)
protected static Process	performRuntimeExec(String[] cmdargs)
void	ping(InetAddress interface_address, InetAddress target, PlatformManagerPingCallback callback)
void	playSystemAlert()	Plays the system alert (the jingle is specified by the user in System Preferences)
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)	If the application is not active causes the application icon at the bottom to bounce until the application becomes active If the application is already active then this method does nothing.
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
boolean	setUseSystemTheme(boolean use_it)
void	showFile(String path)	Reveals the file or directory with the platform's default browser
void	showInFinder(File path)	Shows the given file or directory in Finder
void	showInTerminal(File path)	Shows the given file or directory in Terminal by executing cd /absolute/path/to
void	showInTerminal(String path)	Shows the given file or directory in Terminal by executing cd /absolute/path/to
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 PlatformManagerBase

checkCanUseJVMOptions

Methods inherited from class Object

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

Field Details

LOGID

private static final LogIDs LOGID

BUNDLE_ID

private static final String BUNDLE_ID

See Also:

• Constant Field Values

SCHEMES

private static final String[] SCHEMES

MIMETYPES

private static final String[] MIMETYPES

EXTENSIONS

private static final String[] EXTENSIONS

singleton

protected static PlatformManagerImpl singleton

class_mon

protected static AEMonitor class_mon

fileBrowserName

private static String fileBrowserName

capabilitySet

private final HashSet capabilitySet

computer_name

private volatile String computer_name

computer_name_tried

private volatile boolean computer_name_tried

claFileManager

private Class<?> claFileManager

core

private Core core

prevent_computer_sleep_pending

private boolean prevent_computer_sleep_pending

prevent_computer_sleep

private boolean prevent_computer_sleep

prevent_computer_proc

private Process prevent_computer_proc

Constructor Details

PlatformManagerImpl

public PlatformManagerImpl()

Creates a new PlatformManager and initializes its capabilities

Method Details

getSingleton

public static PlatformManagerImpl getSingleton()

Gets the platform manager singleton, which was already initialized

initializeSingleton

private static void initializeSingleton()

Instantiates the singleton

getPlatformType

public int getPlatformType()

Specified by:

getPlatformType in interface PlatformManager

getVersion

public String getVersion()
                  throws PlatformManagerException

Specified by:

getVersion in interface PlatformManager

Throws:

PlatformManagerException

setUseSystemTheme

public boolean setUseSystemTheme(boolean use_it)
                          throws PlatformManagerException

Specified by:

setUseSystemTheme in interface PlatformManager

Parameters:

use_it -

Returns:

if changes were made then true is returned, otherwise false

Throws:

PlatformManagerException

getVMOptionFile

public File getVMOptionFile()
                     throws PlatformManagerException

Specified by:

getVMOptionFile in interface PlatformManager

Throws:

PlatformManagerException

checkCapability

private void checkCapability(PlatformManagerCapabilities capability)
                      throws PlatformManagerException

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

checkAndGetLocalVMOptionFile

private File checkAndGetLocalVMOptionFile()
                                   throws PlatformManagerException

Throws:

PlatformManagerException

getJVMOptionRedirect

private String getJVMOptionRedirect()

hasVMOptions

private boolean hasVMOptions()

getJVMOptionFiles

private File[] getJVMOptionFiles()

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 prevent_it)
                             throws PlatformManagerException

Specified by:

setPreventComputerSleep in interface PlatformManager

Throws:

PlatformManagerException

getPreventComputerSleep

public boolean getPreventComputerSleep()

Specified by:

getPreventComputerSleep in interface PlatformManager

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

convertToXML

private void convertToXML(File file)
                   throws PlatformManagerException

Throws:

PlatformManagerException

findCommand

private String findCommand(String name)

containsTag

private boolean containsTag(String line,
 String tag)

getLoginPList

private File getLoginPList()
                    throws PlatformManagerException

Throws:

PlatformManagerException

getUserDataDirectory

public String getUserDataDirectory()
                            throws PlatformManagerException

Specified by:

getUserDataDirectory in interface PlatformManager

Throws:

PlatformManagerException

See Also:

• SystemProperties.getUserPath()

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

isApplicationRegistered

public boolean isApplicationRegistered()
                                throws PlatformManagerException

Specified by:

isApplicationRegistered in interface PlatformManager

Throws:

PlatformManagerException

isOurExt

private boolean isOurExt(String ext)

isOurScheme

private boolean isOurScheme(String scheme)

isOurMimeType

private boolean isOurMimeType(String mimetype)

getBundlePath

private String getBundlePath()

Bundle Path is the .app file that launched vuze, usually /Applications/Vuze.app

getAbsoluteBundleFile

private File getAbsoluteBundleFile()

Bundle Path is the .app file that launched vuze, usually /Applications/Vuze.app

getApplicationCommandLine

public String getApplicationCommandLine()
                                 throws PlatformManagerException

command to launch Vuze

Specified by:

getApplicationCommandLine 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

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

registerApplication

public void registerApplication()
                         throws PlatformManagerException

Specified by:

registerApplication in interface PlatformManager

Throws:

PlatformManagerException

createProcess

public void createProcess(String cmd,
 boolean inheritsHandles)
                   throws PlatformManagerException

Specified by:

createProcess in interface PlatformManager

Throws:

PlatformManagerException

getFileManagerClass

private Class<?> getFileManagerClass()

performRecoverableFileDelete

public void performRecoverableFileDelete(String path)
                                  throws PlatformManagerException

Specified by:

performRecoverableFileDelete in interface PlatformManager

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

Disposes system resources. This method is optional.

Specified by:

dispose in interface PlatformManager

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 path)
              throws PlatformManagerException

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

Specified by:

showFile in interface PlatformManager

Parameters:

path - The full path to a file or directory

Throws:

PlatformManagerException - If this operation fails

playSystemAlert

public void playSystemAlert()

Plays the system alert (the jingle is specified by the user in System Preferences)

showInFinder

public void showInFinder(File path)

Shows the given file or directory in Finder

Parameters:

path - Absolute path to the file or directory

showInTerminal

public void showInTerminal(String path)

Shows the given file or directory in Terminal by executing cd /absolute/path/to

Parameters:

path - Absolute path to the file or directory

showInTerminal

public void showInTerminal(File path)

Shows the given file or directory in Terminal by executing cd /absolute/path/to

Parameters:

path - Absolute path to the file or directory

performOSAScript

protected static String performOSAScript(CharSequence cmd)
                                  throws IOException

Compiles a new AppleScript instance and runs it

Parameters:

cmd - AppleScript command to execute; do not surround command with extra quotation marks

Returns:

Output of the script

Throws:

IOException - If the script failed to execute

performOSAScript

protected static String performOSAScript(CharSequence[] cmds)
                                  throws IOException

Compiles a new AppleScript instance and runs it

Parameters:

cmds - AppleScript Sequence of commands to execute; do not surround command with extra quotation marks

Returns:

Output of the script

Throws:

IOException - If the script failed to execute

performOSAScript

protected static String performOSAScript(File script)
                                  throws IOException

Compiles a new AppleScript instance and runs it

Parameters:

script - AppleScript file (.scpt) to execute

Returns:

Output of the script

Throws:

IOException - If the script failed to execute

compileOSAScript

protected static boolean compileOSAScript(CharSequence cmd,
 File destination)

Compiles a new AppleScript instance to the specified location

Parameters:

cmd - Command to compile; do not surround command with extra quotation marks

destination - Destination location of the AppleScript file

Returns:

True if compiled successfully

compileOSAScript

protected static boolean compileOSAScript(CharSequence[] cmds,
 File destination)

Compiles a new AppleScript instance to the specified location

Parameters:

cmds - Sequence of commands to compile; do not surround command with extra quotation marks

destination - Destination location of the AppleScript file

Returns:

True if compiled successfully

performRuntimeExec

protected static Process performRuntimeExec(String[] cmdargs)
                                     throws IOException

Throws:

IOException

See Also:

• Runtime.exec(String[])

getFileBrowserName

private static String getFileBrowserName()

Gets the preferred file browser name

Currently supported browsers are Path Finder and Finder. If Path Finder is currently running (not just installed), then "Path Finder is returned; else, "Finder" is returned.

Returns:

"Path Finder" if it is currently running; else "Finder"

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

addListener

public void addListener(PlatformManagerListener listener)

Specified by:

addListener in interface PlatformManager

removeListener

public void removeListener(PlatformManagerListener listener)

Specified by:

removeListener in interface PlatformManager

generate

public void generate(IndentWriter writer)

Specified by:

generate in interface AEDiagnosticsEvidenceGenerator

getAzComputerID

public String getAzComputerID()
                       throws PlatformManagerException

Throws:

PlatformManagerException

requestUserAttention

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

If the application is not active causes the application icon at the bottom to bounce until the application becomes active If the application is already active then this method does nothing. Note: This is an undocumented feature from Apple so it's behavior may change without warning

Specified by:

requestUserAttention in interface PlatformManager

Parameters:

type - one of USER_REQUEST_INFO, USER_REQUEST_WARNING

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

main

public static void main(String[] args)