From 9781df093452e3123bcc679aa58302ad2a630fcd Mon Sep 17 00:00:00 2001 From: hzosym <165779141+hzosym@users.noreply.github.com> Date: Tue, 6 Aug 2024 09:48:48 +0200 Subject: [PATCH] include Arun's changes --- README.md | 26 ++++++++++++++++---------- 1 file changed, 16 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 4f9c216..bb473c8 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # README # This repository hosts the CS Commons Library for TIBCO EBX®. -This library includes utility methods and components destined to speed up a TIBCO EBX® project implementation and is based on the experience of Professional Services and Customer Success teams of TIBCO Orchestra Networks (part of Cloud Software Group). +This library includes utility methods and components destined to speed up a TIBCO EBX® project implementation and is based on the experience of the Professional Services and Customer Success teams of TIBCO Orchestra Networks (part of Cloud Software Group). Three main versions of CS Commons Library are hosted: * branch "ebx6-javax" - EBX 6.0 and 6.1 compatible version based on Javax Servlet API @@ -17,7 +17,7 @@ Three main versions of CS Commons Library are hosted: ## Integration ## -To add CS Commons Library into your project you need to add its jars and war as dependency. +To add CS Commons Library into your project you need to add its jars and war as dependencies. Note that you only need the war file deployed if you want to use the Java Beans generator that the CS Commons Library provide. ## Third-party libraries ## @@ -29,17 +29,17 @@ CS Commons Library project relies on the following third-party dependencies: - [Apache Commons Exec](https://commons.apache.org/proper/commons-exec/) - [Javax JMS](https://mvnrepository.com/artifact/javax.jms) - [Javax Servlet API](https://mvnrepository.com/artifact/javax.servlet/javax.servlet-api) - +Javax JMS and Javax Servlet API both libraries are under dual licenses CDDL and GPL. TIBCO chose to opt for CDDL instead of GPL. ## Project structure ## The project is structured into 7 maven modules hosting different types of utilities: - ebx-cs-commons-addons - the module hosting utilities method extending functionalities of the official add-ons for TIBCO EBX®. - ebx-cs-commons-beans - the module hosting Java Beans parent classes and definitions. -- ebx-cs-commons-lib - the module hostring common utilities methods to work with TIBCO EBX® objects. +- ebx-cs-commons-lib - the module hosting common utilities methods to work with TIBCO EBX® objects. - ebx-cs-commons-components - the module hosting different data model components, such as Triggers, ValueFunction, Constraints, AccessRules etc. - ebx-cs-commons-query - the module implementing utility methods to simplify writing TIBCO EBX® SQL Queries in your Java code. -- ebx-cs-commons-ui - the module hosting UI extensions such as Widget, UIForm, UserService. +- ebx-cs-commons-ui - the module hosting UI extensions such as Widget, UIForm and UserService. - ebx-cs-commons-web - the web application of the CS Commons Library including Java Beans generator. All projects have Javadoc available to help you use CS Commons Library utilities in your projects. @@ -48,14 +48,14 @@ All projects have Javadoc available to help you use CS Commons Library utilities In this module you can find utilities for two TIBCO EBX® add-ons: -- Digital Asset manager - DamaUtils.java - simplifies accessing Digital Assets from Java API -- Information Search - SearchAjaxComponent - provides a visual Ajax component to display results of TESE search. +- Digital Asset Manager - DamaUtils.java - simplifies accessing Digital Assets from Java API +- Information Search - SearchAjaxComponent - provides a visual Ajax component to display the results of the Information search addon. ### ebx-cs-commons-beans ### -This module include parent classes and model for two approaches to the Java Bean generation for TIBCO EBX® data models. -1. com.tibco.ebx.cs.commons.beans.adapter package and its subpackages provides an implementation for annotations based Java beans that load data from the EBX object with an eager loader. -2. com.tibco.ebx.cs.commons.beans.generator package and its subpackages provides implementation related to the CS Commons Java Bean Generator where all layers of Java accessors are generated per TIBCO EBX® table based on the configuration done inside CS Commons Library technical dataset. +This module includes parent classes and models for two approaches to the Java Bean generation for TIBCO EBX® data models. +1. com.tibco.ebx.cs.commons.beans.adapter package and its sub packages provide an implementation for annotations based Java beans that load data from the EBX object with an eager loader. +2. com.tibco.ebx.cs.commons.beans.generator package and its sub packages provide implementation related to the CS Commons Java Bean Generator where all layers of Java accessors are generated per TIBCO EBX® table based on the configuration done inside CS Commons Library technical dataset. ### ebx-cs-commons-components ### @@ -88,3 +88,9 @@ This is the main web application for the CS Commons Library. This package is needed if you want to use the Java accessors genarator service to create Java accessor layers for your data model to work with Java native objects rather than with TIBCO EBX® internal API. In other cases you don't need to deploy the war file for the module - jar files are sufficient for API usage. + +## License ## +This project is licensed under the Apache license. The text can be found in the LICENSE file. + +Copyright © 2024. Cloud Software Group, Inc. All Rights Reserved. +