Error: Macro BackLinksMenu(None) failed

compressed data is corrupt

Error: Macro TicketQuery(summary=PLUGIN_SUPPORT_LIB_BASE_R1, format=table, col=summary|owner|status|type|component|priority|effort|importance, rows=description|analysis_owners|analysis_reviewers|analysis_score|design_owners|design_reviewers|design_score|implementation_owners|implementation_reviewers|implementation_score|test_owners|test_reviewers|test_score|) failed

current transaction is aborted, commands ignored until end of transaction block

Analysis

Overview

The goal of this task is to solve the shared resources issue and to describe(and may be refactor) the way we get the class module instances.

Task requirements

• Create document(or write in the design section) how we set, get and use the instances of the module classes([module_name]Module).
• See which resources have to be shared and separate them in new src/main/resources/distrib folders.
• Think out a way to share the module resources and get them without problems. It must work with the fake and true launchers of the sophie2 platform.
• Create API in core.modularity which provides functionality for dealing with the resources.
• See if there are any static paths while getting the resources and change them with the newly created functions.

Task result

• classes in core.modularity
• information about the static instances
• new storage for the resources

Implementation idea

• When you write new module you must create static get() method which returns the instance of the class.
• Use ClassLoaders and streams while working with resources.

Related

PLUGIN_SUPPORT_LIB_BASE_R0
PLATFORM_DEPLOYMENT_BUILD_MAVEN_R1

How to demo

• Show the new classes and describe their functionality. Run tests if you manage to think out how to test the new API.
• Show the information about the instances.
• Show where the resources are stored.

Design

• When you create new Sophie module, first of all you should create instance of the module and get() method for getting it. The template is here:

trunk/sophie2-platform/dev-tools/eclipse_templates/module_templates/module_instance.xml. It is stored in PLATFORM_DEPLOYMENT_BUILD_ECLIPSE for now.

• Create distrib folders in src/main/resource folders where the modules should provide shared resources(for now may be book_templates and icons). After distribution they have to be separated in resources directory or just moved in the parent module folder.

• For the resource API
  • Create class in core.modularity which will represent the resource API.
  • It has to:
    • give resource for reading
    • give resource for modifying
    • give resources by specific extensions(for example only the .sjrb resources).
    • list the now available resources.
  • The main implementation can be separated in two parts. The differences between them are:
    1. Starting Sophie 2 using FakeAuthorMain launcher
       • The resource manager look for the wanted resources in the module resource folders.
       • The resource manager creates temp directory(can be default temp folder) in which it writes the given resources, if they are wanted for modifying.
    2. Starting Sophie 2 using TrueAuthorMain launcher(optional for this revision)
       • The resource manager reads the resources where they stored after assembling the project.
       • The resource manager writes the resources in the same place.
  • Note: To know weather the project is started under fake or true launchers use the SophieModule bundleContext(it should be null when fake starting) variable or FakeModuleRegistry instance.

• More specific things for the implementation:
  • In the resource loader class use Map structure which has to contain the started modules as keys and URLs to their resources(separated by comma for example) as values. To see which are the started modules use the FakeModuleRegistry.
  • The resource manager has to take the string variable with the wanted resource and return the whole URL to it.
  • In the second part of the implementation, when the resource is wanted and is not already shared(for example when the new plugin with resources is provided), the resource manager has to search in the jars of already started modules and extract the resource from them.

Implementation

^{(Implementation results should be described and linked here (from the wiki or the repository))}

Testing

Comments

^{(Write comments for this or later revisions here.)}