Skip to content
This repository was archived by the owner on May 9, 2019. It is now read-only.

Overview

Jump to bottom
Steve Billings edited this page Aug 19, 2016 · 1 revision

Summary

The Common Framework (CF) makes development against the Black Duck SDK for Protex and Code Center easier and faster. Common functionality is made available through simple calls for routine tasks like authentication, project retrieval, reporting and others. In addition other common command line driven utility functionality is done for you so that tasks like configuration files, password encryption, writing reports, etc are easy and repeatable.

Design

The CF has two primary components. The base and the connectors.

Base

The base contains all non-sdk related code and houses the common functionality one would need for utility development. The base contains no dependencies directly to our SDK, but instead is used by the connectors to combine the configuration portion of the utility and the SDK connectivity.

Connectors

Connectors contain actual SDK connectivity and have dependencies on the Protex and Code Center SDK client/utility jars. Connectors are currently broken down by major versions of our products. Currently the 6.x and 7.x versions are separated due to significant differences between the two SDK versions.

Base common-framework package structure

The Common Framework is organized as follows:

  • Soleng.framework.core: GWT-client-compatible classes, including classes shared across GWT-client and other code.
  • Soleng.framework.core.gwt: GWT-client-specific classes (UI widgets, etc.)
  • Soleng.framework.standard: GWT-client-INcompatible classes

All classes added under soleng.framework.core must be GWT-client-compatible. In short, this means using the GWT-compatible subset of Java, documented here: http://www.gwtproject.org/doc/latest/DevGuideCodingBasicsCompatibility.html

Usage

As a user you specify which connector you wish to use, they are broken down by major version of our SDK, and the connectors themselves bring in the remaining transitive dependencies. Libraries for the base and connectors are available on the Black Duck Bintray site and JCenter.

If you do not wish to build the code directly, please use the following links to get the dependency information for your platform:

Connector for 6.x SDK: https://bintray.com/bds/tools/cf-6x-connector/view Connector for 7.x SDK: https://bintray.com/bds/tools/cf-7x-connector/view

Clone this wiki locally