Common Framework: Starting out

## Configuration Manager

To get connected to an existing Black Duck Protex or Code Center using a configuration file is a simple two line operation. You must first create a Configuration Manager which houses all your configuration options for the utility you are writing and then specify which type of Black Duck application you wish to connect to. The APPLICATION enumeration will let you choose.

APPLICATION appType = APPLICATION.PROTEX; ConfigurationManager cf = new ConfigurationManager(configFileLocation, appType);

Create a Protex Server Wrapper (same applies for Code Center) with the configuration manager.

boolean useAuth = true; ProtexServerWrapper psw = new ProtexServerWrapper(cf.getServerBean(), cf , useAuth );

That is it! If your specified configuration file contains the proper keys and values, you now have a fully connected Protex object that you can use to interact with the Protex SDK.

Configuration File

The actual configuration file must contain certain basic keys. The advantage of relying on the common framework for all the utilities is the standardization of property files. To start a very simple utility that performs a connection, create a property file with the following keys:

Protex

protex.server.name

protex.user.name

protex.password

Code Center

cc.server.name

cc.user.name

cc.password

You can specify both in one configuration file if your utility needs to connect to a Protex AND a Code Center server. See main page for working with multiple code center servers.