org.gudy.azureus2.platform.dummy
Class PlatformManagerImpl

java.lang.Object
  extended by org.gudy.azureus2.platform.dummy.PlatformManagerImpl
All Implemented Interfaces:
PlatformManager

public class PlatformManagerImpl
extends java.lang.Object
implements PlatformManager

Version:
1.0

Field Summary
 
Fields inherited from interface org.gudy.azureus2.platform.PlatformManager
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
 
Fields inherited from interface org.gudy.azureus2.plugins.platform.PlatformManager
LOC_DOCUMENTS, LOC_MUSIC, LOC_USER_DATA, LOC_VIDEO
 
Method Summary
 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()
          Does nothing
 java.lang.String getApplicationCommandLine()
           
 java.lang.String getAzComputerID()
           
 java.lang.String getComputerName()
           
 java.lang.String[] getExplicitVMOptions()
           
 java.io.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()
           
 java.lang.String getUserDataDirectory()
          
 java.lang.String getVersion()
          
 java.io.File getVMOptionFile()
           
 boolean hasCapability(PlatformManagerCapabilities capability)
          Gets whether the platform manager supports a capability
 boolean isAdditionalFileTypeRegistered(java.lang.String name, java.lang.String type)
          Checks to see if the supplied file type is registered with this application
 boolean 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 method
 void performRecoverableFileDelete(java.lang.String file_name)
          
 void ping(java.net.InetAddress interface_address, java.net.InetAddress target, PlatformManagerPingCallback callback)
           
 void registerAdditionalFileType(java.lang.String name, java.lang.String description, java.lang.String type, java.lang.String content_type)
          Registers a file type with this application
 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 OSX
 void setExplicitVMOptions(java.lang.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(java.lang.String file_name)
          Reveals the file or directory with the platform's default browser
 void shutdown(int type)
           
 void startup(AzureusCore azureus_core)
           
 boolean testNativeAvailability(java.lang.String name)
           
 void traceRoute(java.net.InetAddress interface_address, java.net.InetAddress target, PlatformManagerPingCallback callback)
           
 void unregisterAdditionalFileType(java.lang.String name, java.lang.String type)
          Removes a file-type registration
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getSingleton

public static PlatformManager getSingleton()

getPlatformType

public int getPlatformType()


getUserDataDirectory

public java.lang.String getUserDataDirectory()
                                      throws PlatformManagerException

Throws:
PlatformManagerException

isApplicationRegistered

public boolean isApplicationRegistered()
                                throws PlatformManagerException

Throws:
PlatformManagerException

getApplicationCommandLine

public java.lang.String getApplicationCommandLine()
                                           throws PlatformManagerException
Throws:
PlatformManagerException

getComputerName

public java.lang.String getComputerName()
Specified by:
getComputerName in interface PlatformManager
Returns:
null if can't be found

getLocation

public java.io.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 java.io.File getVMOptionFile()
                             throws PlatformManagerException
Throws:
PlatformManagerException

getExplicitVMOptions

public java.lang.String[] getExplicitVMOptions()
                                        throws PlatformManagerException
Throws:
PlatformManagerException

getRunAtLogin

public boolean getRunAtLogin()
                      throws PlatformManagerException
Throws:
PlatformManagerException

setRunAtLogin

public void setRunAtLogin(boolean run)
                   throws PlatformManagerException
Throws:
PlatformManagerException

startup

public void startup(AzureusCore azureus_core)
             throws PlatformManagerException
Throws:
PlatformManagerException

getShutdownTypes

public int getShutdownTypes()

shutdown

public void shutdown(int type)
              throws PlatformManagerException
Throws:
PlatformManagerException

setPreventComputerSleep

public void setPreventComputerSleep(boolean b)
                             throws PlatformManagerException
Throws:
PlatformManagerException

getPreventComputerSleep

public boolean getPreventComputerSleep()

setExplicitVMOptions

public void setExplicitVMOptions(java.lang.String[] options)
                          throws PlatformManagerException
Throws:
PlatformManagerException

isAdditionalFileTypeRegistered

public boolean isAdditionalFileTypeRegistered(java.lang.String name,
                                              java.lang.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
Returns:
Throws:
PlatformManagerException

unregisterAdditionalFileType

public void unregisterAdditionalFileType(java.lang.String name,
                                         java.lang.String type)
                                  throws PlatformManagerException
Description copied from interface: PlatformManager
Removes a file-type registration

Specified by:
unregisterAdditionalFileType in interface PlatformManager
Throws:
PlatformManagerException

registerApplication

public void registerApplication()
                         throws PlatformManagerException

Throws:
PlatformManagerException

registerAdditionalFileType

public void registerAdditionalFileType(java.lang.String name,
                                       java.lang.String description,
                                       java.lang.String type,
                                       java.lang.String content_type)
                                throws PlatformManagerException
Description copied from interface: PlatformManager
Registers a file type with this application

Specified by:
registerAdditionalFileType in interface PlatformManager
Throws:
PlatformManagerException

createProcess

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

Throws:
PlatformManagerException

performRecoverableFileDelete

public void performRecoverableFileDelete(java.lang.String file_name)
                                  throws PlatformManagerException

Throws:
PlatformManagerException

getVersion

public java.lang.String getVersion()
                            throws PlatformManagerException

Throws:
PlatformManagerException

setTCPTOSEnabled

public void setTCPTOSEnabled(boolean enabled)
                      throws PlatformManagerException
enable or disable the platforms support for TCP TOS

Throws:
PlatformManagerException

copyFilePermissions

public void copyFilePermissions(java.lang.String from_file_name,
                                java.lang.String to_file_name)
                         throws PlatformManagerException
Throws:
PlatformManagerException

showFile

public void showFile(java.lang.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(java.lang.String name)
                               throws PlatformManagerException
Throws:
PlatformManagerException

traceRoute

public void traceRoute(java.net.InetAddress interface_address,
                       java.net.InetAddress target,
                       PlatformManagerPingCallback callback)
                throws PlatformManagerException
Throws:
PlatformManagerException

ping

public void ping(java.net.InetAddress interface_address,
                 java.net.InetAddress target,
                 PlatformManagerPingCallback callback)
          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'

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.

Parameters:
capability - A platform manager capability
Returns:
True if the manager supports the capability

dispose

public void dispose()
Does nothing


addListener

public void addListener(PlatformManagerListener listener)

removeListener

public void removeListener(PlatformManagerListener listener)

getAzComputerID

public java.lang.String getAzComputerID()
                                 throws PlatformManagerException
Throws:
PlatformManagerException

requestUserAttention

public void requestUserAttention(int type,
                                 java.lang.Object data)
                          throws PlatformManagerException
Description copied from interface: PlatformManager
Requests the user's attention such as bouncing the application icon on OSX

Throws:
PlatformManagerException

loadClass

public java.lang.Class<?> loadClass(java.lang.ClassLoader loader,
                                    java.lang.String class_name)
                             throws PlatformManagerException
Description copied from interface: PlatformManager
Gives a particular platform the ability to alter the class-loading method

Returns:
Throws:
PlatformManagerException