-
Notifications
You must be signed in to change notification settings - Fork 42
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Evinwilkins/osgi dev #35
Conversation
This one required (and probably still requires) extensive revision. Please go over it carefully to ensure I have not changed functionality. I listed some questions below although I feel more work is required (within a future revision if not now): Is it okay to put "the" before OSGi Container? I tried with this one but am honestly not sure how to reword without knowing OSGi Container. Thoughts? - To add a new bundle into OSGi container, you must include it in `server.bndrun`(also add it to `server-debug.bndrun`) in that part: Are Repos and Run labeled in the UI here? Wondering if they should be capitalized and/or bolded - Note: It is very helpful to use Eclipse BND tools to import bundles into `server.bndrun`. Simply drag and drop from Repos to Run bundles. Is "Run OSGi" in the UI? I'm just wondering if Run should be capitalized and/or bolded - ## OSGi GoGo Shell To run OSC with GoGo Shell, open in Eclipse `server-debug.bndrun` and Run OSGi. I am completely unsure as to how to change this verbiage without possibly changing the functionality - Note: if you will use some class i. e. `com.fasterxml.jackson.annotation.JsonIgnore;`, which is from bundle injected into OSGi container and forget to import `com.fasterxml.jackson.annotation`, annotation `@JsonIgnore` won't work in runtime and you will get an error on an endpoint where you have to use `@JsonIgnore`.
To answer some of your questions.. I would use "the" when referring to an OSGi container. A container is a general software term and there is no specific product, "OSGi Container" so I would not capitalize container and would use "the" or "an" depending on the context. "GoGo" is a product and a "shell" (textual UI for commands) is another general software term. Gogo has a shell. I am seeing other documents use "Gogo shell". Hope this helps! I will try to answer your other two questions in line since they are a little tricky... |
development/osgi/osgi-dev.md
Outdated
@@ -1,26 +1,26 @@ | |||
# OSC And OSGi Development Guide | |||
|
|||
In this article you can find information how is [OSGi](https://en.wikipedia.org/wiki/OSGi) integrated into project, and how to avoid and handle some typical OSGi troubles related to development. | |||
This article provides information on how [OSGi](https://en.wikipedia.org/wiki/OSGi) is integrated into a project, along with how to avoid and handle some typical OSGi troubles related to development. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
... integrated into the OSC project, along ...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
is integrated into a project -> is integrated into the OSC projects : reason - there is more than one OSC project
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
development/osgi/osgi-dev.md
Outdated
- `osc-uber` - contains `osc-common`, `osc-server` and dependencies from`pom.xml` not injected directly into OSGi container | ||
- `osc-domain` - data access object module | ||
- `osc-uber-jcloud` - contains all dependencies to integrate with Openstack | ||
- `osc-uber` - contains `osc-common`, `osc-server` and dependencies from`pom.xml` not injected directly into OSGi container. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
... , and dependencies from the POM file not injected into the OSGi container.
pom.xml is a single file so not sure if it should be like this
. I would replace pom.xml
with "the POM file"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
development/osgi/osgi-dev.md
Outdated
- `osc-uber-jcloud` - contains all dependencies to integrate with Openstack | ||
- `osc-uber` - contains `osc-common`, `osc-server` and dependencies from`pom.xml` not injected directly into OSGi container. | ||
- `osc-domain` - data access object module. | ||
- `osc-uber-jcloud` - contains all dependencies to integrate with Openstack. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Openstack -> OpenStack
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
development/osgi/osgi-dev.md
Outdated
|
||
|
||
|
||
## OSGi Container | ||
|
||
OSGi container is a place, where all OSGi compatible jars(aka bundle) should be placed. In `osc-export` you can find few important files: | ||
OSGi container is a place where all OSGi compatible jars (aka bundle) should be placed. In `osc-export` you can find few important files: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
-> The OSGi container is a place where all OSGi compatible JAR files, or bundles, should be placed. In the osc-export
module, you will find some important files:
@emanoelxavier is there only one OSGi container? or multiple? In the case of multiple, use "OSGi containers are a ..."
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@hmthomax I have implemented your new sentence.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@hmthomax in this context it is one.
development/osgi/osgi-dev.md
Outdated
- `server.bnd`- included into server*.bndrun files, defines run environment, requirements, properties etc. | ||
- `server.bndrun`- contains all bundles that are fundamental part of our application | ||
- `server-debug.bndrun`- contains bundles from `server.bndrun` and bundles to run OSGi [GoGo Shell](http://enroute.osgi.org/appnotes/gogo.html) | ||
- `server.bnd`- included into server. bndrun files, defines run environment, requirements, properties etc. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
included in server.bndrun
and defines the run environment, requirements, properties etc.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
development/osgi/osgi-dev.md
Outdated
|
||
#### Missing Non-Runtime Requirements | ||
|
||
In some situation, we would like to include some library but it's dependency force us to include also some other lib to our Uber bundle. In this situation we can exclude packages that requires other libs. | ||
In some situations, you may want to include some library however, its dependency may force the inclusion of some other lib to your Uber bundle. You can exclude packages that requires other libs in this situation as shown below: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lib -> library
.. to the osc-uber
bundle.
libs -> libraries in the situation shown below:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
development/osgi/osgi-dev.md
Outdated
|
||
1. Go to `osc-uber\bnd.bnd` and remove line `!org.apache.commons.beanutils,\`. Recompile and Run OSGi with GoGo Shell. | ||
1. Navigate to `osc-uber\bnd.bnd` and remove line `!org.apache.commons.beanutils,\`. Recompile and Run OSGi with GoGo Shell. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
.. remove the line...
Run OSGi
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
development/osgi/osgi-dev.md
Outdated
|
||
*Notice: excluding some packages is very helpful way to avoid big size of our bundle. We should always know what libs and packages we need inside our bundle.* | ||
>Note: It is helpful to exclude some packages to avoid a very large bundle. You should always be aware as to which libs and packages need be inside your bundle. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
libs -> libraries
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
development/osgi/osgi-dev.md
Outdated
|
||
|
||
|
||
## OSC-Control | ||
|
||
Inside `osc-core` you can find project named `osc-control` . This is just standalone jar application that run/stop/reset server and do few more things. However, in this paragraph we will discuss only the way it is build with BND Tools. | ||
You will find the project `osc-control`inside `osc-core`. This is a standalone jar application that runs, stops, resets, etc. the server. This section will cover the only the way it is built with BND Tools. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
jar -> JAR
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
development/osgi/osgi-dev.md
Outdated
>Note: Remember to ensure that `osc-control\bnd.bnd` is included if external lib from pom is added. Remember to also add a class from a package that is not included within the conditional package. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
... if an external library from the POM file is added.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
Thank you!
From: Hailee Thomas [mailto:notifications@github.com]
Sent: Thursday, April 27, 2017 2:15 PM
To: opensecuritycontroller/community <community@noreply.github.com>
Cc: Wilkins, EvinX <evinx.wilkins@intel.com>; Author <author@noreply.github.com>
Subject: Re: [opensecuritycontroller/community] Evinwilkins/osgi dev (#35)
To answer some of your questions..
I would use "the" when referring to an OSGi container. A container is a general software term and there is no specific product, "OSGi Container" so I would not capitalize container and would use "the" or "an" depending on the context.
"GoGo" is a product and a "shell" (textual UI for commands) is another general software term. Gogo has a shell. I am seeing other documents use "Gogo shell".
Hope this helps! I will try to answer your other two questions in line since they are a little tricky...
—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub<#35 (comment)>, or mute the thread<https://github.com/notifications/unsubscribe-auth/AZU2l7_Ju29G9t4B-zGbStS-zcL8JHa8ks5r0QVqgaJpZM4NI8JR>.
|
I am making these changes now. I am notating “done” at the end of each one as I go through them to ensure I do not leave anything out. I’ll notate at the bottom of the PR when every comment is addressed. Will be this morning so that you all can wrap everything up.
Thanks!
Evin
From: Hailee Thomas [mailto:notifications@github.com]
Sent: Thursday, April 27, 2017 4:28 PM
To: opensecuritycontroller/community <community@noreply.github.com>
Cc: Wilkins, EvinX <evinx.wilkins@intel.com>; Author <author@noreply.github.com>
Subject: Re: [opensecuritycontroller/community] Evinwilkins/osgi dev (#35)
@hmthomax requested changes on this pull request.
________________________________
In development/osgi/osgi-dev.md<#35 (comment)>:
@@ -1,26 +1,26 @@
# OSC And OSGi Development Guide
-In this article you can find information how is [OSGi](https://en.wikipedia.org/wiki/OSGi) integrated into project, and how to avoid and handle some typical OSGi troubles related to development.
+This article provides information on how [OSGi](https://en.wikipedia.org/wiki/OSGi) is integrated into a project, along with how to avoid and handle some typical OSGi troubles related to development.
... integrated into the OSC project, along ...
________________________________
In development/osgi/osgi-dev.md<#35 (comment)>:
## OSGi Modules in OSC
-- `osc-uber` - contains `osc-common`, `osc-server` and dependencies from`pom.xml` not injected directly into OSGi container
-- `osc-domain` - data access object module
-- `osc-uber-jcloud` - contains all dependencies to integrate with Openstack
+- `osc-uber` - contains `osc-common`, `osc-server` and dependencies from`pom.xml` not injected directly into OSGi container.
... , and dependencies from the POM file not injected into the OSGi container.
pom.xml is a single file so not sure if it should be like this. I would replace pom.xml with "the POM file"
________________________________
In development/osgi/osgi-dev.md<#35 (comment)>:
## OSGi Modules in OSC
-- `osc-uber` - contains `osc-common`, `osc-server` and dependencies from`pom.xml` not injected directly into OSGi container
-- `osc-domain` - data access object module
-- `osc-uber-jcloud` - contains all dependencies to integrate with Openstack
+- `osc-uber` - contains `osc-common`, `osc-server` and dependencies from`pom.xml` not injected directly into OSGi container.
+- `osc-domain` - data access object module.
+- `osc-uber-jcloud` - contains all dependencies to integrate with Openstack.
Openstack -> OpenStack
________________________________
In development/osgi/osgi-dev.md<#35 (comment)>:
## OSGi Container
-OSGi container is a place, where all OSGi compatible jars(aka bundle) should be placed. In `osc-export` you can find few important files:
+OSGi container is a place where all OSGi compatible jars (aka bundle) should be placed. In `osc-export` you can find few important files:
-> The OSGi container is a place where all OSGi compatible JAR files, or bundles, should be placed. In the osc-export module, you will find some important files:
@emanoelxavier<https://github.com/emanoelxavier> is there only one OSGi container? or multiple? In the case of multiple, use "OSGi containers are a ..."
________________________________
In development/osgi/osgi-dev.md<#35 (comment)>:
-- `server.bnd`- included into server*.bndrun files, defines run environment, requirements, properties etc.
-- `server.bndrun`- contains all bundles that are fundamental part of our application
-- `server-debug.bndrun`- contains bundles from `server.bndrun` and bundles to run OSGi [GoGo Shell](http://enroute.osgi.org/appnotes/gogo.html)
+- `server.bnd`- included into server. bndrun files, defines run environment, requirements, properties etc.
included in server.bndrun and defines the run environment, requirements, properties etc.
________________________________
In development/osgi/osgi-dev.md<#35 (comment)>:
-- `server.bnd`- included into server*.bndrun files, defines run environment, requirements, properties etc.
-- `server.bndrun`- contains all bundles that are fundamental part of our application
-- `server-debug.bndrun`- contains bundles from `server.bndrun` and bundles to run OSGi [GoGo Shell](http://enroute.osgi.org/appnotes/gogo.html)
+- `server.bnd`- included into server. bndrun files, defines run environment, requirements, properties etc.
+- `server.bndrun`- contains all bundles that are fundamental part of our application.
contains all bundles that are fundamental to running the OSC server.
________________________________
In development/osgi/osgi-dev.md<#35 (comment)>:
-- `server.bnd`- included into server*.bndrun files, defines run environment, requirements, properties etc.
-- `server.bndrun`- contains all bundles that are fundamental part of our application
-- `server-debug.bndrun`- contains bundles from `server.bndrun` and bundles to run OSGi [GoGo Shell](http://enroute.osgi.org/appnotes/gogo.html)
+- `server.bnd`- included into server. bndrun files, defines run environment, requirements, properties etc.
+- `server.bndrun`- contains all bundles that are fundamental part of our application.
+- `server-debug.bndrun`- contains bundles from `server.bndrun` and bundles to run OSGi [GoGo Shell](http://enroute.osgi.org/appnotes/gogo.html).
... and bundles to run OSGi's GoGo shell<http://enroute.osgi.org/appnotes/gogo.html>.
________________________________
In development/osgi/osgi-dev.md<#35 (comment)>:
-To add new bundle into OSGi container you have to include it in `server.bndrun`(also add it to `server-debug.bndrun`) in that part:
+To add a new bundle into OSGi container, you must include it in `server.bndrun`(also add it to `server-debug.bndrun`) in that part:
remove "in that part"
________________________________
In development/osgi/osgi-dev.md<#35 (comment)>:
@@ -93,54 +93,54 @@ To add new bundle into OSGi container you have to include it in `server.bndrun`(
com.fasterxml.jackson.module.jackson-module-jaxb-annotations;version='[2.8.5,2.8.6)',\
jclouds-compute;version='[2.0.0,2.0.1)',\
openstack-neutron;version='[2.0.0,2.0.1)',\
- openstack-nova;version='[2.0.0,2.0.1)'
+n openstack-nova;version='[2.0.0,2.0.1)'
remove the "n"
________________________________
In development/osgi/osgi-dev.md<#35 (comment)>:
-- You need to define a version of bundle/jar to include
-- In OSC order of bundles don't matter
-- Sometimes you include only by name, i. e. `openstack-nova;version='[2.0.0,2.0.1)'` but there are also cases where you have to specify bundle with it's groupId i. e. `com.fasterxml.jackson.core.jackson-annotations;version='[2.8.5,2.8.6)',\ `
+- You need to define a version of bundle/jar to include.
A version needs to be defined for the JAR/bundle file.
________________________________
In development/osgi/osgi-dev.md<#35 (comment)>:
-- You need to define a version of bundle/jar to include
-- In OSC order of bundles don't matter
-- Sometimes you include only by name, i. e. `openstack-nova;version='[2.0.0,2.0.1)'` but there are also cases where you have to specify bundle with it's groupId i. e. `com.fasterxml.jackson.core.jackson-annotations;version='[2.8.5,2.8.6)',\ `
+- You need to define a version of bundle/jar to include.
+- The order of the bundles doesn't matter in OSC.
doesn't -> does not
________________________________
In development/osgi/osgi-dev.md<#35 (comment)>:
-- You need to define a version of bundle/jar to include
-- In OSC order of bundles don't matter
-- Sometimes you include only by name, i. e. `openstack-nova;version='[2.0.0,2.0.1)'` but there are also cases where you have to specify bundle with it's groupId i. e. `com.fasterxml.jackson.core.jackson-annotations;version='[2.8.5,2.8.6)',\ `
+- You need to define a version of bundle/jar to include.
+- The order of the bundles doesn't matter in OSC.
+- Sometimes you include only by name, i. e. `openstack-nova;version='[2.0.0,2.0.1)'` but there are also cases where you have to specify the bundle with its groupId i. e. `com.fasterxml.jackson.core.jackson-annotations;version='[2.8.5,2.8.6)',\ `
Sometimes the bundle can be included by name, e.g., openstack-nova;version='[2.0.0,2.0.1)'. There are some cases where the bundled needs to be specified by its groupId, e.g., com.fasterxml.jackson.core.jackson-annotations;version='[2.8.5,2.8.6)',\.
________________________________
In development/osgi/osgi-dev.md<#35 (comment)>:
![](../images/bnd-osgi-add-bundle.png)
## OSGi GoGo Shell
-To run OSC with GoGo Shell just simply open in Eclipse `server-debug.bndrun` and Run OSGi. You should be able now to type in console. To list all bundles, type `lb`
+To run OSC with GoGo Shell, open in Eclipse `server-debug.bndrun` and **Run OSGi**. You should now be able to type within the console. To list all bundles, type `lb`.
.. open server-debug.bndrun in Eclipse and click Run OSGi.
________________________________
In development/osgi/osgi-dev.md<#35 (comment)>:
-- Adding new bundles to OSGi Conatiner - you can install them directly via GoGo Shell
-- If from any reason, bundle won't be active, you can try to reinstall it and see the reason why it failed
-- To see if your freshly added bundle via Eclipse BND Tools is installed and active
+- You can install directly via GoGo Shell to add new bundles to OSGi Container.
+- If a bundle is not active for any reason, you can attempt to reinstall it for the reason as to why it failed.
... to reinstall it to investigate the reason as to ....
________________________________
In development/osgi/osgi-dev.md<#35 (comment)>:
![](../images/bnd-osgi-gogo-shell.png)
-Situation when using GoGo Shell is helpful:
+A helpful situation to keep in mind when using GoGo Shell:
GoGo shell is helpful in the following situations:
________________________________
In development/osgi/osgi-dev.md<#35 (comment)>:
-To read more about bundle lifecycle go to [link](http://eclipsesource.com/blogs/2013/01/23/how-to-track-lifecycle-changes-of-osgi-bundles/).
+See [link](http://eclipsesource.com/blogs/2013/01/23/how-to-track-lifecycle-changes-of-osgi-bundles/) to read more about the bundle lifecycle.
View the OSGi bundle lifecycle<http://eclipsesource.com/blogs/2013/01/23/how-to-track-lifecycle-changes-of-osgi-bundles/> for more information.
________________________________
In development/osgi/osgi-dev.md<#35 (comment)>:
## OSC Bundles
-Every project mentioned in previous paragraph has `bnd.bnd` file inside which treats `pom.xml` like a repository. It is extremely important to correctly scope your dependencies in the `pom.xml`. You can read more about Maven dependency scope under [this](https://maven.apache.org/guides/introduction/introduction-to-dependency-mechanism.html) link.
+Every project mentioned in the sections above contains a `bnd.bnd` file inside which treats `pom.xml` like a repository. It is extremely important to correctly scope your dependencies in the `pom.xml`. Find out more about Maven dependency scope under [this](https://maven.apache.org/guides/introduction/introduction-to-dependency-mechanism.html) link.
View the Maven dependency scope<https://maven.apache.org/guides/introduction/introduction-to-dependency-mechanism.html> for more information.
________________________________
In development/osgi/osgi-dev.md<#35 (comment)>:
-Let us take a look at `osc-uber\bnd.bnd` . It is bundle that contains it's own java classes but also classes from dependencies selected to `bnd.bnd` from `pom.xml`.
+`osc-uber\bnd.bnd` is a bundle that contains not only its own java classes, but also those from dependencies selected to `bnd.bnd` from `pom.xml`.
java -> Java
________________________________
In development/osgi/osgi-dev.md<#35 (comment)>:
@@ -156,7 +156,7 @@ then we are able to include resources like below:
#### Excluding packages
-There are situations, when we include some resource to our bundle, but we don't want to use all packages from that jar. Then we are able to exclude package using exclamation mark. Let us consider `osc-uber\bnd.bnd` file again:
+There are situations when you may include some resources to your bundle, but don't want to use all packages from that jar. You are able to exclude those packages by using an exclamation mark (!). Consider the `osc-uber\bnd.bnd` file again:
jar -> JAR file
________________________________
In development/osgi/osgi-dev.md<#35 (comment)>:
```java
package com.mcafee.vmidc.server;
...
import javax.servlet.http.HttpSession;
...
-
+,
remove ,
________________________________
In development/osgi/osgi-dev.md<#35 (comment)>:
@@ -211,25 +211,23 @@ import-extra:\
com.fasterxml.jackson.core
```
-*Notice: if you will use some class i. e. `com.fasterxml.jackson.annotation.JsonIgnore;`, which is from bundle injected into OSGi container and forget to import `com.fasterxml.jackson.annotation`, annotation `@JsonIgnore` won't work in runtime and you will get an error on an endpoint where you have to use `@JsonIgnore`. Please take a look at [VersionUtil.java](https://github.com/opensecuritycontroller/osc-core/blob/master/osc-common/src/main/java/org/osc/core/util/VersionUtil.java#L100)*
+>Note: if you will use some class i. e. `com.fasterxml.jackson.annotation.JsonIgnore;`, which is from bundle injected into OSGi container and forget to import `com.fasterxml.jackson.annotation`, annotation `@JsonIgnore` won't work in runtime and you will get an error on an endpoint where you have to use `@JsonIgnore`. Please take a look at [VersionUtil.java](https://github.com/opensecuritycontroller/osc-core/blob/master/osc-common/src/main/java/org/osc/core/util/VersionUtil.java#L100)
@emanoelxavier<https://github.com/emanoelxavier> maybe you should tackle this paragraph because I don't quite understand it and don't want to change the meaning
________________________________
In development/osgi/osgi-dev.md<#35 (comment)>:
```java
osgi.wiring.package=com.fasterxml.jackson.jaxrs.json
```
- So in this situation we have to add `com.fasterxml.jackson.jaxrs.jackson-jaxrs-json-provider` which we use in OSC Rest API.
+ You must add `com.fasterxml.jackson.jaxrs.jackson-jaxrs-json-provider` which is used in OSC Rest API.
... OSC's REST API.
________________________________
In development/osgi/osgi-dev.md<#35 (comment)>:
@@ -333,9 +330,9 @@ Let us take a look at example below:
-3. In this case we are adding back `@${yavijava.dep},\` to our `osc-uber\bnd.bnd` file recompiling and then Run OSGi with GoGo Shelll.
+3. In this case we are adding back `@${yavijava.dep},\` to our `osc-uber\bnd.bnd` file, recompiling, and then completing Run OSGi with GoGo Shelll.
... and then starting OSGi by clicking Run OSGi with the GoGo shell.
________________________________
In development/osgi/osgi-dev.md<#35 (comment)>:
@@ -345,23 +342,22 @@ Let us take a look at example below:
...
```
-*Notice: remember that pom.xml file is just repository of your libs. You decide where you want lib to be: OSGi Container or inside some uber bundle i. e. `osc-uber`.*
+>Note: Remember that the pom.xml file is a repository of your libs. It is up to you to decide where you want your lib to be. An example would be within OSGi Container or inside some uber bundle, i. e. `osc-uber`.
libs -> libraries
lib -> library
..would be within the OSGi container or within the osc-uber bundle.
________________________________
In development/osgi/osgi-dev.md<#35 (comment)>:
#### Missing Non-Runtime Requirements
-In some situation, we would like to include some library but it's dependency force us to include also some other lib to our Uber bundle. In this situation we can exclude packages that requires other libs.
+In some situations, you may want to include some library however, its dependency may force the inclusion of some other lib to your Uber bundle. You can exclude packages that requires other libs in this situation as shown below:
lib -> library
.. to the osc-uber bundle.
libs -> libraries in the situation shown below:
________________________________
In development/osgi/osgi-dev.md<#35 (comment)>:
-1. Go to `osc-uber\bnd.bnd` and remove line `!org.apache.commons.beanutils,\`. Recompile and Run OSGi with GoGo Shell.
+1. Navigate to `osc-uber\bnd.bnd` and remove line `!org.apache.commons.beanutils,\`. Recompile and Run OSGi with GoGo Shell.
.. remove the line...
Run OSGi
________________________________
In development/osgi/osgi-dev.md<#35 (comment)>:
-*Notice: excluding some packages is very helpful way to avoid big size of our bundle. We should always know what libs and packages we need inside our bundle.*
+>Note: It is helpful to exclude some packages to avoid a very large bundle. You should always be aware as to which libs and packages need be inside your bundle.
libs -> libraries
________________________________
In development/osgi/osgi-dev.md<#35 (comment)>:
## OSC-Control
-Inside `osc-core` you can find project named `osc-control` . This is just standalone jar application that run/stop/reset server and do few more things. However, in this paragraph we will discuss only the way it is build with BND Tools.
+You will find the project `osc-control`inside `osc-core`. This is a standalone jar application that runs, stops, resets, etc. the server. This section will cover the only the way it is built with BND Tools.
jar -> JAR
________________________________
In development/osgi/osgi-dev.md<#35 (comment)>:
\ No newline at end of file
+>Note: Remember to ensure that `osc-control\bnd.bnd` is included if external lib from pom is added. Remember to also add a class from a package that is not included within the conditional package.
... if an external library from the POM file is added.
—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub<#35 (review)>, or mute the thread<https://github.com/notifications/unsubscribe-auth/AZU2l8rObBJHhAIGIiEL7nHtaOLO-vPOks5r0SSDgaJpZM4NI8JR>.
|
Changes are made and committed. Thank you! |
development/osgi/osgi-dev.md
Outdated
- `server.bnd`- included into server*.bndrun files, defines run environment, requirements, properties etc. | ||
- `server.bndrun`- contains all bundles that are fundamental part of our application | ||
- `server-debug.bndrun`- contains bundles from `server.bndrun` and bundles to run OSGi [GoGo Shell](http://enroute.osgi.org/appnotes/gogo.html) | ||
- included in `server.bndrun` and defines the run environment, requirements, properties etc. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this line should be:
server.bnd
- included inserver*.bndrun
and defines the run environment, requirements, properties etc.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
development/osgi/osgi-dev.md
Outdated
@@ -69,7 +69,7 @@ To add new bundle into OSGi container you have to include it in `server.bndrun`( | |||
org.glassfish.jersey.ext.jersey-entity-filtering;version='[2.25.0,2.25.1)',\ | |||
org.hibernate.validator;version='[5.1.3,5.1.4)',\ | |||
com.fasterxml.classmate;version='[1.3.0,1.3.1)',\ | |||
com.fasterxml.jackson.jaxrs.jackson-jaxrs-json-provider;version='[2.8.5,2.8.6)',\ | |||
com.fasterxml.vackson.jaxrs.jackson-jaxrs-json-provider;version='[2.8.5,2.8.6)',\ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
vackson -> jackson
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
development/osgi/osgi-dev.md
Outdated
|
||
Let us take a look at `osc-uber\bnd.bnd` . It is bundle that contains it's own java classes but also classes from dependencies selected to `bnd.bnd` from `pom.xml`. | ||
`osc-uber\bnd.bnd` is a bundle that contains not only its own Java classes, but also those from dependencies selected to `bnd.bnd` from `pom.xml`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We can improve this a bit more... To add dependencies in the OSC uber bundle you will need to modify the file osc-uber\bnd.bdn
. This file contains not only...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated with new suggested text on LN 134
development/osgi/osgi-dev.md
Outdated
@@ -156,7 +156,7 @@ then we are able to include resources like below: | |||
|
|||
#### Excluding packages |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Excluding Packages
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
development/osgi/osgi-dev.md
Outdated
@@ -156,7 +156,7 @@ then we are able to include resources like below: | |||
|
|||
#### Excluding packages |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also observe other headings for proper capitalization
development/osgi/osgi-dev.md
Outdated
@@ -303,25 +301,24 @@ Let us take a look at example below: | |||
|
|||
| |||
|
|||
*Notice: to know exactly what dependency should be added to OSGi Container while adding some new one, you need to look at dependency network of that bundle and provide all that are require. In Eclipse open `pom.xml` and go to Dependency Hierarchy tab:* | |||
>Note: To know the dependency that should be added to OSGi Container while adding a new one, you need to look at the dependency network of the specific bundle, and provide all that are required. In Eclipse, open `pom.xml` and navigate to the **Dependency Hierarchy** tab: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
open the pom.xml
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
development/osgi/osgi-dev.md
Outdated
|
||
#### BND.BND In OSC-Control | ||
|
||
Basically, this is build as a bundle and includes dependencies that are necessary to work without problems in runtime. Let us take a llok at `bnd.bnd` file: | ||
Basically, this is built as a bundle and includes dependencies that are necessary to work without problems in runtime. Below is an example of the `bnd.bnd` file: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
in runtime -> at runtime
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
development/osgi/osgi-dev.md
Outdated
|
||
1. It contains line that help us to work with `pom.xml` as a repository: | ||
1. It contains line that helps us to work with `pom.xml` as a repository: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Change to It contains the following line, allowing us to work with... :
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
development/osgi/osgi-dev.md
Outdated
|
||
```java | ||
-include target/depend.bnd | ||
``` | ||
|
||
2. We have conditional package section, that imports packages only from libs that are inside `pomx.ml`: | ||
2. We have an conditional package section that imports packages only from libs that are inside `pomx.ml`: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
an -> a
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
inside pom.xml
-> inside the pom.xml
development/osgi/osgi-dev.md
Outdated
>Note: Remember to ensure that `osc-control\bnd.bnd` is included if an external library from the POM file is added. Remember to also add a class from a package that is not included within the conditional package. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should be this Remember to ensure that any external library added in the POM file should also be included in the osc-control\bnd.bnd
. Remember to also add a class from a package that is not included within the conditional package.
development/osgi/osgi-dev.md
Outdated
@@ -211,25 +211,23 @@ import-extra:\ | |||
com.fasterxml.jackson.core | |||
``` | |||
|
|||
*Notice: if you will use some class i. e. `com.fasterxml.jackson.annotation.JsonIgnore;`, which is from bundle injected into OSGi container and forget to import `com.fasterxml.jackson.annotation`, annotation `@JsonIgnore` won't work in runtime and you will get an error on an endpoint where you have to use `@JsonIgnore`. Please take a look at [VersionUtil.java](https://github.com/opensecuritycontroller/osc-core/blob/master/osc-common/src/main/java/org/osc/core/util/VersionUtil.java#L100)* | |||
>Note: If you you are using a class from a bundle in the OSGi container and forget to import its package you will get an error at runtime. For instance, if you use com.fasterxml.jackson.annotation.JsonIgnore; and do not import com.fasterxml.jackson.annotation, the annotation @JsonIgnore will not work. Please take a look at [VersionUtil.java](https://github.com/opensecuritycontroller/osc-core/blob/master/osc-common/src/main/java/org/osc/core/util/VersionUtil.java#L100) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
you you -> you
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
com.fasterxml.jackson.annotation.JsonIgnore -> com.fasterxml.jackson.annotation.JsonIgnore
com.fasterxml.jackson.annotation -> com.fasterxml.jackson.annotation
@JsonIgnore -> @JsonIgnore
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
incorporated changes
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@HopkinRx these are not yet addressed:
com.fasterxml.jackson.annotation.JsonIgnore -> com.fasterxml.jackson.annotation.JsonIgnore
com.fasterxml.jackson.annotation -> com.fasterxml.jackson.annotation
@JsonIgnore -> @JsonIgnore
development/osgi/osgi-dev.md
Outdated
|
||
Let us take a look at example below: | ||
1. Remove all bundles from `server-debug.bndrun` with the groupID `com.fasterxml.jackson.jaxrs` groupID. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove the repeated groupId in the end of the line. Also for the first groupID -> groupId. So basically this line should be:
- Remove all bundles from
server-debug.bndrun
with the groupIdcom.fasterxml.jackson.jaxrs
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
development/osgi/osgi-dev.md
Outdated
|
||
1. It contains line that help us to work with `pom.xml` as a repository: | ||
1. It contains line the following line. allowing us to work with `pom.xml` as a repository: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
line the following line -> the following line
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
also remove the period in the middle of the sentence
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
development/osgi/osgi-dev.md
Outdated
|
||
```java | ||
-include target/depend.bnd | ||
``` | ||
|
||
2. We have conditional package section, that imports packages only from libs that are inside `pomx.ml`: | ||
2. We have aa conditional package section that imports packages only from libs that are inside the `pomx.ml`: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
aa -> an
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
libs -> libraries
pomx.ml
-> pom.xml
(i'm being lenient on the file extension formatting in this doc since it is on community and not osc.org just make sure it is conistent, there are some POM and some pom.xml
)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
development/osgi/osgi-dev.md
Outdated
>Note: Remember to ensure that any external library added in the POM file should also be included in the osc-control\bnd.bnd. Remember to also add a class from a package that is not included within the conditional package. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
osc-control\bnd.bnd -> osc-control\bnd.bnd
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
development/osgi/osgi-dev.md
Outdated
@@ -1,26 +1,26 @@ | |||
# OSC And OSGi Development Guide | |||
|
|||
In this article you can find information how is [OSGi](https://en.wikipedia.org/wiki/OSGi) integrated into project, and how to avoid and handle some typical OSGi troubles related to development. | |||
This article provides information on how [OSGi](https://en.wikipedia.org/wiki/OSGi) is integrated into a projects, along with how to avoid and handle some typical OSGi troubles related to development. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
-> ... is integrated into OSC projects, .....
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
previously corrected
development/osgi/osgi-dev.md
Outdated
- `osc-uber` - contains `osc-common`, `osc-server` and dependencies from`pom.xml` not injected directly into OSGi container | ||
- `osc-domain` - data access object module | ||
- `osc-uber-jcloud` - contains all dependencies to integrate with Openstack | ||
- `osc-uber` - contains `osc-common`, `osc-server` and dependencies from the POM file not injected directly into the OSGi container. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
osc-common
, osc-server
, and dependencies
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
development/osgi/osgi-dev.md
Outdated
|
||
To read more about bundle lifecycle go to [link](http://eclipsesource.com/blogs/2013/01/23/how-to-track-lifecycle-changes-of-osgi-bundles/). | ||
View the [OSGi bundle lifecycle](http://eclipsesource.com/blogs/2013/01/23/how-to-track-lifecycle-changes-of-osgi-bundles/) for more information. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
remove extra space after View
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removed
development/osgi/osgi-dev.md
Outdated
|
||
First of all, if we want to include resources based on `pom.xml` to our bundle we need to have that line in our `bnd.bnd` file: | ||
If you want to include resources based on `pom.xml` to your bundle, you must first include that line in your `bnd.bnd` file: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
you must first include the following line in your bnd.bnd
file:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Previously done
development/osgi/osgi-dev.md
Outdated
@@ -173,7 +173,7 @@ exclude-tomcat:\ | |||
... | |||
``` | |||
|
|||
In above fragment from `bnd.bnd` file we exclude `!javax.servlet.jsp` and `!javax.servlet.jsp.tagext`, however if you go to class `com.mcafee.vmidc.server.Server` you can notice that we use other packages from `javax.servlet`, i. e. : | |||
In the fragment from the `bnd.bnd` file, the `!javax.servlet.jsp` and `!javax.servlet.jsp.tagext` were excluded however, if you look at the `com.mcafee.vmidc.server.Server` class, you will notice that packages from `javax.servlet` are used: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Change to com.mcafee.vmidc.server.Server
org.osc.core.server
On line 179, change to package org.osc.core.server;
@emanoelxavier can you verify this
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done made both corrections on LN 176 and LN 179
development/osgi/osgi-dev.md
Outdated
|
||
![](../images/bnd-osgi-dependency-hierarchy.png) | ||
|
||
#### Missing Requirements in the OSC Uber Bundle | ||
|
||
Non OSGi dependencies being added to the OSC uber bundle may also have missing requirements. This situation gives us same log as that one before, but our intend is different. We want to include resource inside `osc-uber` bundle. | ||
Non-OSGi dependencies added to the OSC uber bundle may also have missing requirements. This situation provides the same log as the previous one, but with a different intent. You must include the resource inside the `osc-uber` bundle as shown below: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
.... to the osc-uber
bundle may .....
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
development/osgi/osgi-dev.md
Outdated
|
||
1. Remove ` @${yavijava.dep},\` from `osc-uber\bnd.bnd` and then recompile and Run OSGi with GoGo Shell. | ||
1. Remove ` @${yavijava.dep},\` from `osc-uber\bnd.bnd` and then recompile and Run OSGi with GoGo shell. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove extra space after ` in @${yavijava.dep},\
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
development/osgi/osgi-dev.md
Outdated
|
||
2. Look at console log: | ||
2. The console log should appear as: | ||
|
||
```java | ||
! Failed to start bundle osc-uber-1.0.0, exception Unable to resolve osc-uber [15](R 15.0): missing requirement [osc-uber [15](R 15.0)] osgi.wiring.package; (osgi.wiring.package=com.vmware.vim25) Unresolved requirements: [[osc-uber [15](R 15.0)] osgi.wiring.package; (osgi.wiring.package=com.vmware.vim25)] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@emanoelxavier should we not use this vmware example?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes we should replace that, @HopkinRx please replace as:
yavijava.dep -> xxx.dep (line 313)
com.vmware.vim25 -> xxx (on both places)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@hmthomax I have opened issue #40 to have addressed with appropriate values later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated per Emanuel's' email "yes we should replace that, @HopkinRx please replace as:
yavijava.dep -> xxx.dep (line 313)
com.vmware.vim25 -> xxx (on both places)"
development/osgi/osgi-dev.md
Outdated
|
||
1. It contains line that help us to work with `pom.xml` as a repository: | ||
1. It contains line the following line. allowing us to work with `pom.xml` as a repository: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
also remove the period in the middle of the sentence
development/osgi/osgi-dev.md
Outdated
|
||
```java | ||
-include target/depend.bnd | ||
``` | ||
|
||
2. We have conditional package section, that imports packages only from libs that are inside `pomx.ml`: | ||
2. We have aa conditional package section that imports packages only from libs that are inside the `pomx.ml`: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
libs -> libraries
pomx.ml
-> pom.xml
(i'm being lenient on the file extension formatting in this doc since it is on community and not osc.org just make sure it is conistent, there are some POM and some pom.xml
)
Done |
development/osgi/osgi-dev.md
Outdated
|
||
2. Look at console log: | ||
2. The console log should appear as: | ||
|
||
```java | ||
! Failed to start bundle osc-uber-1.0.0, exception Unable to resolve osc-uber [15](R 15.0): missing requirement [osc-uber [15](R 15.0)] osgi.wiring.package; (osgi.wiring.package=com.vmware.vim25) Unresolved requirements: [[osc-uber [15](R 15.0)] osgi.wiring.package; (osgi.wiring.package=com.vmware.vim25)] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes we should replace that, @HopkinRx please replace as:
yavijava.dep -> xxx.dep (line 313)
com.vmware.vim25 -> xxx (on both places)
development/osgi/osgi-dev.md
Outdated
|
||
```java | ||
-include target/depend.bnd | ||
``` | ||
|
||
2. We have aa conditional package section that imports packages only from libs that are inside the `pomx.ml`: | ||
2. We have an conditional package section that imports packages only from libraries that are inside the `pom.xml`: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
an -> a
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
development/osgi/osgi-dev.md
Outdated
@@ -434,4 +434,4 @@ Basically, this is built as a bundle and includes dependencies that are necessar | |||
|
|||
This set is a minimal requirement to work properly in runtime. | |||
|
|||
>Note: Remember to ensure that any external library added in the POM file should also be included in the osc-control\bnd.bnd. Remember to also add a class from a package that is not included within the conditional package. | |||
>Note: Remember to ensure that any external library added in the POM file should also be included in the `osc-control\bnd.bnd`. Remember to also add a class from a package that is not included within the conditional package. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please ensure the term POM/pom.xml is consistent. I think this is the only instance of "POM" so I would change this to pom.xml
like the rest of the doc
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One more! 😀
development/osgi/osgi-dev.md
Outdated
@@ -173,7 +173,7 @@ exclude-tomcat:\ | |||
... | |||
``` | |||
|
|||
In the fragment from the `bnd.bnd` file, the `!javax.servlet.jsp` and `!javax.servlet.jsp.tagext` were excluded however, if you look at the `com.mcafee.vmidc.server.Server` `org.osc.core.server` class, you will notice that packages from `javax.servlet` are used: | |||
In the fragment from the `bnd.bnd` file, the `!javax.servlet.jsp` and `!javax.servlet.jsp.tagext` were excluded however, if you look at the `com.mcafee.vmidc.server.Server org.osc.core.server` class, you will notice that packages from `javax.servlet` are used: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
remove com.mcafee.vmidc.server.Server
... look at the org.osc.core.server
class, ....
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@HopkinRx two remaining comments from me. Those were previous comments that were missed. After this I should be able to approve.
development/osgi/osgi-dev.md
Outdated
|
||
Let us take a look at example below: | ||
1. Remove all bundles from server-debug.bndrun with the groupId com.fasterxml.jackson.jaxrs. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@HopkinRx please bring back the format:
server-debug.bndrun -> server-debug.bndrun
and
com.fasterxml.jackson.jaxrs -> com.fasterxml.jackson.jaxrs
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
development/osgi/osgi-dev.md
Outdated
@@ -211,25 +211,23 @@ import-extra:\ | |||
com.fasterxml.jackson.core | |||
``` | |||
|
|||
*Notice: if you will use some class i. e. `com.fasterxml.jackson.annotation.JsonIgnore;`, which is from bundle injected into OSGi container and forget to import `com.fasterxml.jackson.annotation`, annotation `@JsonIgnore` won't work in runtime and you will get an error on an endpoint where you have to use `@JsonIgnore`. Please take a look at [VersionUtil.java](https://github.com/opensecuritycontroller/osc-core/blob/master/osc-common/src/main/java/org/osc/core/util/VersionUtil.java#L100)* | |||
>Note: If you are using a class from a bundle in the OSGi container and forget to import its package you will get an error at runtime. For instance, if you use com.fasterxml.jackson.annotation.JsonIgnore; and do not import com.fasterxml.jackson.annotation, the annotation @JsonIgnore will not work. Please take a look at [VersionUtil.java](https://github.com/opensecuritycontroller/osc-core/blob/master/osc-common/src/main/java/org/osc/core/util/VersionUtil.java#L100) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is from a previous comment that has not been addressed:
com.fasterxml.jackson.annotation.JsonIgnore -> com.fasterxml.jackson.annotation.JsonIgnore
com.fasterxml.jackson.annotation -> com.fasterxml.jackson.annotation
@JsonIgnore -> @JsonIgnore
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry about that
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry about that done.
Completed
Richard Hopkin, On-site Sr. Technical Writer & Lead for PTIGlobal Technical Communications Group
Cell: 623.203.1312 | Intel Office: CH6/4-A7/B8
richardx.hopkin@intel.com<mailto:richardx.hopkin@intel.com>
PTIGlobal main office: 503.297.2165 | Fax: 503.352.0729
[cid:image001.png@01D2C3EC.C9AA6010]
From: Emanoel Xavier [mailto:notifications@github.com]
Sent: Wednesday, May 03, 2017 7:18 AM
To: opensecuritycontroller/community <community@noreply.github.com>
Cc: Hopkin, RichardX <richardx.hopkin@intel.com>; Mention <mention@noreply.github.com>
Subject: Re: [opensecuritycontroller/community] Evinwilkins/osgi dev (#35)
@emanoelxavier requested changes on this pull request.
@HopkinRx<https://github.com/hopkinrx> two remaining comments from me. Those were previous comments that were missed. After this I should be able to approve.
________________________________
In development/osgi/osgi-dev.md<#35 (comment)>:
-Let us take a look at example below:
+1. Remove all bundles from server-debug.bndrun with the groupId com.fasterxml.jackson.jaxrs.
@HopkinRx<https://github.com/hopkinrx> please bring back the format:
server-debug.bndrun -> server-debug.bndrun
and
com.fasterxml.jackson.jaxrs -> com.fasterxml.jackson.jaxrs
________________________________
In development/osgi/osgi-dev.md<#35 (comment)>:
@@ -211,25 +211,23 @@ import-extra:\
com.fasterxml.jackson.core
```
-*Notice: if you will use some class i. e. `com.fasterxml.jackson.annotation.JsonIgnore;`, which is from bundle injected into OSGi container and forget to import `com.fasterxml.jackson.annotation`, annotation `@JsonIgnore` won't work in runtime and you will get an error on an endpoint where you have to use `@JsonIgnore`. Please take a look at [VersionUtil.java](https://github.com/opensecuritycontroller/osc-core/blob/master/osc-common/src/main/java/org/osc/core/util/VersionUtil.java#L100)*
+>Note: If you are using a class from a bundle in the OSGi container and forget to import its package you will get an error at runtime. For instance, if you use com.fasterxml.jackson.annotation.JsonIgnore; and do not import com.fasterxml.jackson.annotation, the annotation @JsonIgnore will not work. Please take a look at [VersionUtil.java](https://github.com/opensecuritycontroller/osc-core/blob/master/osc-common/src/main/java/org/osc/core/util/VersionUtil.java#L100)
This is from a previous comment that has not been addressed:
com.fasterxml.jackson.annotation.JsonIgnore -> com.fasterxml.jackson.annotation.JsonIgnore
com.fasterxml.jackson.annotation -> com.fasterxml.jackson.annotation
@JsonIgnore -> @JsonIgnore
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub<#35 (review)>, or mute the thread<https://github.com/notifications/unsubscribe-auth/Aa903Cnk3ANvtxHPfGuuJ0RLQFNG_vkZks5r2IyqgaJpZM4NI8JR>.
|
This one required some extensive revisions and I will need more I suspect (if not now, in the future). Please review carefully as a result. I believe I had more questions but my original list did not make it after I created the PR. I'll start with the following:
Should "the" be before OSGi Container when reference in sentences?
Should "Shell" be included in GoGo Shell? Is it a brand?
I am not sure how to reword this without possibly changing the functionality. Any suggestions? - To add a new bundle into OSGi container, you must include it in server.bndrun (also add it to server-debug.bndrun ) in that part
This really probably needs to be reworded yet again, I'm not certain how to do so without possibly changing the functionality - Note: if you will use some class i. e. com.fasterxml.jackson.annotation.JsonIgnore; , which is from bundle injected into OSGi container and forget to import com.fasterxml.jackson.annotation , annotation @JsonIgnore won't work in runtime and you will get an error on an endpoint where you have to use @JsonIgnore . Please take a look at VersionUtil.java