HowTo:Create UBIK Module - Revision history

MHM: /* Example */

2025-10-24T11:38:26Z

‎Example

NWE at 10:47, 28 February 2025

2025-02-28T10:47:06Z

NWE at 11:16, 25 November 2024

2024-11-25T11:16:18Z

ARU at 15:02, 7 October 2024

2024-10-07T15:02:51Z

ARU at 14:48, 7 October 2024

2024-10-07T14:48:16Z

ARU at 14:08, 7 October 2024

2024-10-07T14:08:41Z

NWE: /* Interface: IUbikModule */

2024-08-20T14:18:05Z

‎Interface: IUbikModule

KNO at 12:09, 3 August 2016

2016-08-03T12:09:43Z

KNO: /* Example */

2016-08-03T12:09:07Z

‎Example

KNO: Created page with "{{UBIK}} Modules are loaded dynamically into the {{UBIK}} Kernel by the {{UBIK}} Injection Management based on the [https://msdn.microsoft.com/de-de/l..."

2016-08-03T12:08:44Z

Created page with "{{UBIK}} Modules are loaded dynamically into the {{UBIK}} Kernel by the {{UBIK}} Injection Management based on the [https://msdn.microsoft.com/de-de/l..."

New page

{{UBIK}} Modules are loaded dynamically into the {{UBIK}} Kernel by the {{UBIK}} [[Injection_Management|Injection Management]] based on the [https://msdn.microsoft.com/de-de/library/dd460648%28v=vs.110%29.aspx Microsoft Extensibility Framework (MEF)].

= Introduction =
=== Basic Prerequisites ===
Creating an own plugin requires to add references to
* System.ComponentModel.Composition
* UBIK.Injection

{{UBIK}} Injection Management provides access to all the basic features used by the Kernel to identifiy and categorize the available plugins. This management is provided by a library called '''UBIK.Injection'''.

=== Interface: IUbikModule ===
The module must implement the <code>UBIK.Injection.IUbikModule</code> interface and has to be registered for MEF composition by defining the export contract via an attribute.
<source lang="csharp">
[Export(typeof(UBIK.Injection.IUbikModule))]

public class TestModule : UBIK.Injection.IUbikModule
{
}
</source>

=== Interface: IUbikInjectionMetaData ===
Managing modules correctly presumes the following information, as defined by the interface <code>UBIK.Injection.IUbikInjectionMetaData</code>.

<source lang="csharp">
[ExportMetadata("ID", "C149402E-BC86-46D6-8D1B-63C86894EA77")]
[ExportMetadata("Type", typeof(TestModule))]
[ExportMetadata("Name", "TestModule" )]
[ExportMetadata("Description", "Tests the injection management")]
[ExportMetadata("Version", 1)]
[ExportMetadata("Company", "Augmensys GmbH")]
</source>

==== Mandatory information ====
{| class="wikitable" | width = "100%"
|-
! Name !! Type !! Description
|-
| ID|| {{MSDN/String}} || Unique ID of the module
|-
| Type|| System.Type || Systemtype of the module; used for filtering the module during loading.
|-
|}

==== Optional information ====
{| class="wikitable" | width = "100%"
|-
! Name !! Type !! Description
|-
| Name|| {{MSDN/String}} || Name of the module (for UI Presentation)
|-
| Description|| {{MSDN/String}} || Descrirption of the module (for UI Presentation)
|-
| Version|| {{MSDN/Int32}} || Version of the module. As there are more modules with the same ID, only the module with the highest Version is available.
|-
| TargetApplication|| PluginTargetApplication|| Possibility to limit the module for a single type of application.
|-
| MinimumKernelVersion|| {{MSDN/String}} || Minimum required Kernel version: Format x.x.x.x
|-
| MinimumDatabaseVersion|| {{MSDN/String}} || Minimum required Database version: Format x.x.x.x
|-
| Company|| {{MSDN/String}} || Information about the Company (for UI Presentation)
|-
| Copyright|| {{MSDN/String}} || Copyright Information (for UI Presentation)
|-
|}

= Example =
<source lang="csharp">
[Export(typeof(UBIK.Injection.IUbikModule))]
[ExportMetadata("ID", "C149402E-BC86-46D6-8D1B-63C86894EA77")]
[ExportMetadata("Type", typeof(TestPlugin))]
[ExportMetadata("Name", "TestModule" )]
[ExportMetadata("Description", "Tests the injection management")]
[ExportMetadata("Version", 1)]
[ExportMetadata("MinimumKernelVersion", "2.4.0.0")]
[ExportMetadata("MinimumDatabaseVersion", "2.4.0.0")]
[ExportMetadata("Company", "Augmensys GmbH")]
[ExportMetadata("Copyright", "2014, Augmensys GmbH")]

public class TestModule : UBIK.Injection.IUbikModule
{

}
</source>

<headertabs />

== See also ==
* [[Injection_Management]]

@@ Line 139: / Line 139: @@
 * [[Injection_Management]]
 * [[HowTo:Provide_system_definitions_with_a_custom_plugin]]
 [[Category:Injecting|Create UBIK Module]]

@@ Line 106: / Line 106: @@
+         {
              get;
-         } = new List<ModuleInfo>();
+         } = new List<ModuleInfo>()
+     }
 </source>

@@ Line 113: / Line 113: @@
 {| class="wikitable" | width = "100%"
 |-
-! Name !! Type !! Description
+! Name !! Description
 |-
-| SystemDefinitionsProvider || ISystemDefinitionProvider  || The instance of the SystemDefinitions for the respective module is provided.
+| SystemDefinitionsProvider || The instance of the SystemDefinitions for the respective module is provided.
 |-
-| Initialize|| void || Initializes the UBIKEnvironment for the module.
+| Initialize || Initializes the module.
 |-
-| Initialized|| bool || Returns true or false, depending on whether the UBIKEnvironment is initialized or not.
+| Initialized || Returns true when the plugin is initialized
 |-
-| Terminate || void|| Terminates the UBIKEnvironment if it has been initialized.
+| Terminate || Terminates the UBIKEnvironment if it has been initialized.
 |-
-| DependencyModules || List<ModuleInfo> || Returns the module information for which it has a dependency.
+| DependencyModules || Returns the module information for which it has a dependency.
 |-
 |}

← Older revision		Revision as of 12:09, 3 August 2016
Line 88:		Line 88:
	== See also ==		== See also ==
	* [[Injection_Management]]		* [[Injection_Management]]
		+
		+	[[Category:Injecting\|Create UBIK Module]]

@@ Line 69: / Line 69: @@
 = Example =
 <source lang="csharp">
-     [Export(typeof(UBIK.Injection.IUbikModule))]
+     [Export(typeof(UBIK.Injection.IUbikPlugin))]
      [ExportMetadata("ID", "C149402E-BC86-46D6-8D1B-63C86894EA77")]
      [ExportMetadata("Type", typeof(TestModule))]

@@ Line 16: / Line 16: @@
      public class TestModule : UBIK.Injection.IUbikModule
+     {
+     }
 </source>
-[[Category:Injecting|Create UBIK Module]]
 === Interface: IUbikInjectionMetaData ===
@@ Line 83: / Line 82: @@
      public class TestModule : UBIK.Injection.IUbikModule
+     {
+     }
 </source>
 <headertabs />