Poseidon for UMLTM
  UMLdoc
 PREV  CLASSIFIER    NEXT  CLASSIFIER     FRAMES    NO FRAMES      
SUMMARY:   INNER | ATTR | ASSOC | CONSTR | METHOD     DETAIL:   INNER | ATTR | ASSOC | CONSTR | METHOD     DIAGRAMS:   COLLAB | SEQ | STATE | ACTIV

com.gentleware.poseidon.openapi

Class PoseidonCoreConnector

com.gentleware.poseidon.openapi.PoseidonCoreConnector

public final class PoseidonCoreConnector


Facade to Plugins that want to address Poseidon internals.

This class contains methods for accessing the UI of Poseidon and the settings. Other classes control resource loading and access to the project's run time data.

Please note that this class is preliminary, and we will probably extend this class to give access to more Poseidon features. Also, more Connector classes may be introduced in versions later than 1.2.

See also:
com.gentleware.poseidon.openapi.PoseidonResourceConnector


 Constructor Summary
private   PoseidonCoreConnector()
 
arrow_up
 

 Method Summary
public static void   enablePlugin(String name, String codebase, String filepath, boolean state)
Enables/disables a plugin, if it is installed. 
public static String[]   getCommandLineArguments()
 
public static File   getInstallationDirectory()
Finds the installation folder of the running Poseidon installation. 
public static String   getProductLine()
 
public static String   getProjectDirectory()
 
public static String   getSettingsDirectory()
 
public static String   getStartupDirectory()
 
public static String   getVersionNumber()
Gives you Poseidon's version number in format 'a.b'. 
public static boolean   isPluginEnabled(String name)
Checks if the named plugin is running. 
public static boolean   isPluginInstalled(String name)
Checks if the named plugin is installed in Poseidon. 
public static void   logMessage(String msg)
Logs to the Poseidon.log in the `getSettingsDirectory()` . 
arrow_up
 

Tagged Values
static false
gentleware-imported-line-number 33
gentleware-imported-package-statement-line-number 7
 

 Constructor Detail

PoseidonCoreConnector

private com.gentleware.poseidon.openapi.PoseidonCoreConnector PoseidonCoreConnector()

Returns:
arrow_up
 Method Detail

enablePlugin

public static void enablePlugin(String name, String codebase, String filepath, boolean state)


Enables/disables a plugin, if it is installed.

Does nothing if the plugin is not installed. To find out if a plugin is installed, call isPluginInstalled.

Currently, controlling plugins when non-standalone does not work really good.  

Parameters:
name - Not used.
codebase - The code name of the plug-in.
filepath - The path to the plug-in; only needed when Poseidon is not standalone.
state - The future state of the given plug-in.
arrow_up


getCommandLineArguments

public static String[] getCommandLineArguments()

Returns:
All command line arguments to Poseidon. Might be null if Poseidon is not started by main().
arrow_up


getInstallationDirectory

public static File getInstallationDirectory()


Finds the installation folder of the running Poseidon installation.  
Returns:
The file that points to the installation folder, and where you can find folders like 'lib', 'bin' etc.
Since:
2.0
arrow_up


getProductLine

public static String getProductLine()

Returns:
the type of Poseidon: 'CE', 'SE', 'PE', 'EmbEd', 'EE'.
arrow_up


getProjectDirectory

public static String getProjectDirectory()

Returns:
the path to the project directory.
arrow_up


getSettingsDirectory

public static String getSettingsDirectory()

Returns:
the path to the settings directory (something like '$HOME/poseidon/SE').
arrow_up


getStartupDirectory

public static String getStartupDirectory()

Returns:
the path to the startup directory.
arrow_up


getVersionNumber

public static String getVersionNumber()


Gives you Poseidon's version number in format 'a.b'.

Only the first two version string (major and minor) are returned, the third number (micro) is not printed.  

Returns:
arrow_up


isPluginEnabled

public static boolean isPluginEnabled(String name)


Checks if the named plugin is running.  
Parameters:
name -
Returns:
True if the plugin is running (ie, installed AND enabled).
arrow_up


isPluginInstalled

public static boolean isPluginInstalled(String name)


Checks if the named plugin is installed in Poseidon.  
Parameters:
name -
Returns:
True if the plugin is installed (no matter if enabled or not).
arrow_up


logMessage

public static void logMessage(String msg)


Logs to the Poseidon.log in the `getSettingsDirectory()` .  
Parameters:
msg -
arrow_up
Created  2004 - 12 - 1

    Poseidon for UMLTM
  UMLdoc
 PREV  CLASSIFIER    NEXT  CLASSIFIER     FRAMES    NO FRAMES      
SUMMARY:   INNER | ATTR | ASSOC | CONSTR | METHOD     DETAIL:   INNER | ATTR | ASSOC | CONSTR | METHOD     DIAGRAMS:   COLLAB | SEQ | STATE | ACTIV

Generated with Poseidon for UMLTM.
Poseidon is a registered trademark of Gentleware AG in Germany, USA and other countries. Copyright 2003-2004 Gentleware AG, Schanzenstr. 70, 20357 Hamburg, Germany. All Rights Reserved.

UML is a trademark or registered trademark of Object Management Group, Inc. in the U.S. and other countries.