Framework (Protoframework API)

java.lang.Object
- org.da.protoframework.model.core.Framework

public class Framework
extends java.lang.Object

Represents the framework instance.

Constructor Summary

Constructors
Constructor and Description
`Framework()`
`Framework(boolean noGUI)` Constructor.
`Framework(boolean noGUI, boolean starterGUI)` Constructor.
`Framework(FrameworkOwner owner)` Create the framework with an owner module.
`Framework(short guiState, boolean starterGUI)` Constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`attachServiceProvider(NamespaceKey serviceKey, Module module)` Attach a module as a Service Provider for a particular Service.
`boolean`	`attachServiceProvider(NamespaceKey serviceKey, ModuleIDKey moduleKey)` Attach a module as a Service Provider for a particular Service.
`Application`	`getApplication(long appliID)` Return an application by its associated long ID.
`Application`	`getApplication(java.lang.String name)` Return the Application of a specificed name.
`java.util.Set<java.lang.String>`	`getApplicationName()` Return the application names.
`java.util.SortedMap<java.lang.String,Application>`	`getApplications()` Return the applications.
`java.util.Map<java.lang.Long,Application>`	`getApplicationsByID()` Return the Applications.
`java.lang.ClassLoader`	`getClassLoader(boolean isEmbedded)` Return the framework ClassLoader.
`java.util.List<java.net.URL>`	`getConfigurationDirectories()` Return the configuration directories.
`FrameworkDefinition`	`getDefinition()` Return the Framework definition.
`javax.swing.JFrame`	`getGUIComponent()` Return the GUI component of the framework (if there is a GUI).
`Module`	`getModule(ModuleIDKey key)` Return a Module of a specified Module ID key.
`Module`	`getModule(ModuleKey key)` Return a Module of a specified Module key.
`FrameworkOwner`	`getOwner()` Return the FrameworkOwner or null if there is no owner.
`Service<?>`	`getService(NamespaceKey key)` Return the Service of a specified key.
`Service<?>`	`getService(java.lang.String name)` Return the Service of a specified name.
`java.util.Map<NamespaceKey,Service<?>>`	`getServices()` Return the Services.
`java.util.Map<java.lang.String,Service<?>>`	`getServicesByName()` Return the Services.
`long`	`getStartTimeStamp()` Return the time stamp at the start of the framework.
`Type`	`getType(NamespaceKey key)` Return the type of a specified key.
`Type`	`getType(java.lang.String name)` Return the type of a specified name.
`static void`	`hideStartLog()` Calling this method will hide the start Log.
`static boolean`	`isUnixPlatform()` Return true on Unix platforms.
`static void`	`main(java.lang.String[] args)` The main method of the class.
`static void`	`preventExit()` Calling this method will prevent further `System.exit()` calles to be made when exiting the application.
`void`	`setApplicationNames(java.util.Set<java.lang.String> applicationNames)` Set the application names.
`void`	`setLogger(org.da.protoframework.conf.FrameworkLogger logger)` Set the logger.
`void`	`setParserLogger(org.da.protoframework.parser.ParserLogger logger)` Set the parser logger.
`void`	`setup(java.net.URL config)` Setup the framework.
`void`	`setup(java.net.URL[] configs)` Setup the framework.
`void`	`shutdown()` Shutdown the framework.
`void`	`start()` Start the framework.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Framework
```
public Framework()
```
  - Framework
```
public Framework(FrameworkOwner owner)
```
    Create the framework with an owner module.
    
    Parameters:
    
    owner - the owner module
  - Framework
```
public Framework(boolean noGUI)
```
    Constructor.
    
    Parameters:
    
    noGUI - true if there should be no GUI for the Framework log
  - Framework
```
public Framework(short guiState,
                 boolean starterGUI)
```
    Constructor.
    
    Parameters:
    
    guiState - the GUI state
    
    starterGUI - true if there is a starter GUI to set the values for properties, if there are configuration properties
  - Framework
```
public Framework(boolean noGUI,
                 boolean starterGUI)
```
    Constructor.
    
    Parameters:
    
    noGUI - true if there should be no GUI for the Framework log
    
    starterGUI - true if there is a starter GUI to set the values for properties, if there are configuration properties
- Method Detail
  - isUnixPlatform
```
public static final boolean isUnixPlatform()
```
    Return true on Unix platforms.
    
    Returns:
    
    true if the platform is Unix
  - preventExit
```
public static void preventExit()
```
    Calling this method will prevent further System.exit() calles to be made when exiting the application. This is normally only useful in Unit tests.
  - hideStartLog
```
public static void hideStartLog()
```
    Calling this method will hide the start Log.
  - getGUIComponent
```
public javax.swing.JFrame getGUIComponent()
```
    Return the GUI component of the framework (if there is a GUI).
    
    Returns:
    
    the GUI component of the framework
  - getDefinition
```
public FrameworkDefinition getDefinition()
```
    Return the Framework definition.
    
    Returns:
    
    the Framework definition
  - getClassLoader
```
public java.lang.ClassLoader getClassLoader(boolean isEmbedded)
```
    Return the framework ClassLoader.
    
    Parameters:
    
    isEmbedded - true if the configuration is embedded as an entry in a zip or jar file
    
    Returns:
    
    the framework ClassLoader
  - getConfigurationDirectories
```
public java.util.List<java.net.URL> getConfigurationDirectories()
```
    Return the configuration directories.
    
    Returns:
    
    the configuration directories
  - setApplicationNames
```
public void setApplicationNames(java.util.Set<java.lang.String> applicationNames)
```
    Set the application names.
    
    Parameters:
    
    applicationNames - the application names
  - getApplicationName
```
public java.util.Set<java.lang.String> getApplicationName()
```
    Return the application names.
    
    Returns:
    
    the application names
  - setLogger
```
public void setLogger(org.da.protoframework.conf.FrameworkLogger logger)
```
    Set the logger.
    
    Parameters:
    
    logger - the logger
  - setParserLogger
```
public void setParserLogger(org.da.protoframework.parser.ParserLogger logger)
```
    Set the parser logger.
    
    Parameters:
    
    logger - the parser logger
  - getApplications
```
public java.util.SortedMap<java.lang.String,Application> getApplications()
```
    Return the applications.
    
    Returns:
    
    the applications
  - getModule
```
public Module getModule(ModuleIDKey key)
```
    Return a Module of a specified Module ID key.
    
    Parameters:
    
    key - the Module ID key
    
    Returns:
    
    the Module
  - getModule
```
public Module getModule(ModuleKey key)
```
    Return a Module of a specified Module key.
    
    Parameters:
    
    key - the Module key
    
    Returns:
    
    the Module
  - getApplication
```
public Application getApplication(java.lang.String name)
```
    Return the Application of a specificed name.
    
    Parameters:
    
    name - the Application name
    
    Returns:
    
    the Application
  - getServicesByName
```
public java.util.Map<java.lang.String,Service<?>> getServicesByName()
```
    Return the Services.
    
    Returns:
    
    the Services
  - getServices
```
public java.util.Map<NamespaceKey,Service<?>> getServices()
```
    Return the Services.
    
    Returns:
    
    the Services
  - getApplication
```
public Application getApplication(long appliID)
```
    Return an application by its associated long ID.
    
    Parameters:
    
    appliID - the application long ID
    
    Returns:
    
    the application
  - getApplicationsByID
```
public java.util.Map<java.lang.Long,Application> getApplicationsByID()
```
    Return the Applications.
    
    Returns:
    
    the Applications
  - getType
```
public Type getType(NamespaceKey key)
```
    Return the type of a specified key.
    
    Parameters:
    
    key - the type key
    
    Returns:
    
    the type
  - getType
```
public Type getType(java.lang.String name)
```
    Return the type of a specified name.
    
    Parameters:
    
    name - the type name
    
    Returns:
    
    the type
  - getService
```
public Service<?> getService(NamespaceKey key)
```
    Return the Service of a specified key.
    
    Parameters:
    
    key - the Service key
    
    Returns:
    
    the Service
  - getService
```
public Service<?> getService(java.lang.String name)
```
    Return the Service of a specified name.
    
    Parameters:
    
    name - the Service name
    
    Returns:
    
    the Service
  - attachServiceProvider
```
public boolean attachServiceProvider(NamespaceKey serviceKey,
                                     Module module)
```
    Attach a module as a Service Provider for a particular Service.
    
    Parameters:
    
    serviceKey - the service key
    
    module - the Module
    
    Returns:
    
    true if this Module could be attached as a Service provider to this Service
  - attachServiceProvider
```
public boolean attachServiceProvider(NamespaceKey serviceKey,
                                     ModuleIDKey moduleKey)
```
    Attach a module as a Service Provider for a particular Service.
    
    Parameters:
    
    serviceKey - the Service key
    
    moduleKey - the ModuleID Key
    
    Returns:
    
    true if this Module could be attached as a Service provider to this Service
  - getOwner
```
public FrameworkOwner getOwner()
```
    Return the FrameworkOwner or null if there is no owner.
    
    Returns:
    
    the FrameworkOwner
  - setup
```
public void setup(java.net.URL config)
           throws FrameworkException
```
    Setup the framework.
    
    Parameters:
    
    config - the configuration
    
    Throws:
    
    FrameworkException
  - setup
```
public void setup(java.net.URL[] configs)
           throws FrameworkException
```
    Setup the framework.
    
    Parameters:
    
    configs - the configuration files array
    
    Throws:
    
    FrameworkException
  - getStartTimeStamp
```
public long getStartTimeStamp()
```
    Return the time stamp at the start of the framework.
    
    Returns:
    
    the time stamp at the start of the framework
  - start
```
public void start()
```
    Start the framework.
  - shutdown
```
public void shutdown()
```
    Shutdown the framework.
  - main
```
public static void main(java.lang.String[] args)
```
    The main method of the class. The supported command-line properties are:
    - "config": the configuration xml file. This is the only mandatory property. See ConfigurationParser
    - "application": the application ID if only one application defined in the configuration is instanciated
    - "noGUI": if the errors and informations messages should be emitted
    - "methodHandles": if the module method invocations are using Java method handles
    Parameters:
    
    args - the arguments

Class Framework

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Framework

Framework

Framework

Framework

Framework

Method Detail

isUnixPlatform

preventExit

hideStartLog

getGUIComponent

getDefinition

getClassLoader

getConfigurationDirectories

setApplicationNames

getApplicationName

setLogger

setParserLogger

getApplications

getModule

getModule

getApplication

getServicesByName

getServices

getApplication

getApplicationsByID

getType

getType

getService

getService

attachServiceProvider

attachServiceProvider

getOwner

setup

setup

getStartTimeStamp

start

shutdown

main