https://github.com/qbicsoftware/core-utils-lib
Library containing core classes and utilities that are independent of a portal.
https://github.com/qbicsoftware/core-utils-lib
hacktoberfest
Last synced: 5 months ago
JSON representation
Library containing core classes and utilities that are independent of a portal.
- Host: GitHub
- URL: https://github.com/qbicsoftware/core-utils-lib
- Owner: qbicsoftware
- License: mit
- Created: 2018-06-14T17:06:33.000Z (about 8 years ago)
- Default Branch: main
- Last Pushed: 2024-10-24T15:53:07.000Z (over 1 year ago)
- Last Synced: 2024-10-25T21:46:24.173Z (over 1 year ago)
- Topics: hacktoberfest
- Language: Groovy
- Homepage:
- Size: 1.04 MB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.rst
- License: LICENSE
- Codeowners: .github/CODEOWNERS
- Authors: AUTHORS.rst
Awesome Lists containing this project
README
Core Utilities Library
-----------------------------------
A collection of non-Vaadin, non-Liferay utilities.
|maven-build| |maven-test| |codeql| |release|
|license| |java| |groovy|
How to Run
-----------------
To build this library use Maven and Java 8:
First compile the project and build an executable java archive:
.. code-block:: bash
mvn clean package
Note that you will need java 8.
The JAR file will be created in the /target folder:
.. code-block:: bash
|-target
|---core-utils-lib-1.0.0-SNAPSHOT.jar
|---...
How to Use
----------
This is a library and the most common way to use this library in particular is by including it in your `pom.xml` as a dependency:
.. code-block:: xml
life.qbic
core-utils-lib
X.Y.Z
Find QBiC services
------------------
Finding QBiC service instances from within an application is as easy as this:
.. code-block:: Groovy
// Example in Groovy
def serviceList = []
def serviceRegistryUrl = new Url("https://host-name-of-registry:/v1")
def connector = new ConsulConnector(serviceRegistryUrl)
connector.withCloseable {
ConsulServiceFactory factory = new ConsulServiceFactory(it)
serviceList.addAll(factory.getServicesOfType(ServiceType.SAMPLE_TRACKING))
}
.. code-block:: Java
// Example in Java
List serviceList = new ArrayList<>()
Url serviceRegistryUrl = new URL("https://host-name-of-registry:/v1")
try (ConsulConnector connector = new ConsulConnector(serviceRegistryUrl)) {
ConsulServiceFactory factory = new ConsulServiceFactory(connector)
serviceList.addAll(factory.getServicesOfType(ServiceType.SAMPLE_TRACKING))
}
License
-------
This work is licensed under the `MIT license `_.
**Note**: This work uses the `Micronaut Framework `_ and derivatives from the Micronaut framework family, its which are licensed under `Apache 2.0 `_.
.. |maven-build| image:: https://github.com/qbicsoftware/core-utils-lib/workflows/Build%20Maven%20Package/badge.svg
:target: https://github.com/qbicsoftware/core-utils-lib/actions/workflows/build_package.yml
:alt: Github Workflow Build Maven Package Status
.. |maven-test| image:: https://github.com/qbicsoftware/core-utils-lib/workflows/Run%20Maven%20Tests/badge.svg
:target: https://github.com/qbicsoftware/core-utils-lib/actions/workflows/run_tests.yml
:alt: Github Workflow Tests Status
.. |codeql| image:: https://github.com/qbicsoftware/core-utils-lib/workflows/CodeQL/badge.svg
:target: https://github.com/qbicsoftware/core-utils-lib/actions/workflows/codeql-analysis.yml
:alt: CodeQl Status
.. |license| image:: https://img.shields.io/github/license/qbicsoftware/core-utils-lib
:target: https://github.com/qbicsoftware/core-utils-lib/blob/master/LICENSE
:alt: Project Licence
.. |release| image:: https://img.shields.io/github/v/release/qbicsoftware/core-utils-lib.svg?include_prereleases
:target: https://github.com/qbicsoftware/core-utils-lib/releases
:alt: Release status
.. |java| image:: https://img.shields.io/badge/language-java-blue.svg
:alt: Written in Java
.. |groovy| image:: https://img.shields.io/badge/language-groovy-blue.svg
:alt: Written in Groovy