Skip to content

Latest commit

 

History

History
310 lines (263 loc) · 9.9 KB

README.md

File metadata and controls

310 lines (263 loc) · 9.9 KB
Raw

metacfg4j

Build Status codecov.io Maven Central

The metacfg4j project (that stands for the meta configuration for java) is a library that can be used as the solution by creating a business abstraction or may extend an existed implementation to provide such software solutions as: various configuration (application, user's and etc.), CRUD services, DSL, MVP.

Architecture

This is a high-level abstraction based on the low-level API. It has been written without frameworks and delivered with one dependency:

⇒ JSON simple (https://cliftonlabs.github.io/json-simple/)

This library has the implementation of a simple web-client/server, repositories, services, controllers. The web-server provides implementation of REST methods. Data is persisted into a DB, by using any configured datasource.

The size of the library is ~200 Kb.

Configuration and Usage

Basic Configuration

Add a maven dependency into your project:

<dependency>
    <groupId>com.github.akarazhev</groupId>
    <artifactId>metacfg4j</artifactId>
    <version>2.4</version>
</dependency>

Instantiate the meta configuration class in your project with the default configuration:

public MetaConfig metaConfig() {
    return new MetaConfig.Builder().defaultConfig().build();
}

If you have the configured data source, you can use it:

public MetaConfig metaConfig() {
    return new MetaConfig.Builder().dataSource(getDataSource()).build();
}

NOTE: The web-server will not be started, since it requires the related configuration.

Advanced Configuration

You can instantiate the meta configuration with the custom configuration:

public MetaConfig metaConfig() {
    // Create the custom data mapping
    final Map<String, String> dataMapping = new HashMap<>();
    dataMapping.put(Constants.Mapping.CONFIGS_TABLE, "CONFIGS");
    dataMapping.put(Constants.Mapping.CONFIG_ATTRIBUTES_TABLE, "CONFIG_ATTRIBUTES");
    dataMapping.put(Constants.Mapping.PROPERTIES_TABLE, "PROPERTIES");
    dataMapping.put(Constants.Mapping.PROPERTY_ATTRIBUTES_TABLE, "PROPERTY_ATTRIBUTES");
    // Set a fetch size
    final Map<String, Object> settings = new HashMap<>();
    settings.put(FETCH_SIZE, 100);
    settings.put(DB_DIALECT, POSTGRE);
    // Create the web server config
    final Config webServer = new Config.Builder(Server.Settings.CONFIG_NAME,
        Arrays.asList(
            new Property.Builder(Server.Settings.HOSTNAME, "localhost").build(),
            new Property.Builder(Server.Settings.API_PATH, "/api/metacfg/").build(),
            new Property.Builder(Constants.Endpoints.ACCEPT_CONFIG, "accept_config").build(),
            new Property.Builder(Constants.Endpoints.CONFIG_NAMES, "config_names").build(),
            new Property.Builder(Constants.Endpoints.CONFIG, "config").build(),
            new Property.Builder(Server.Settings.PORT, 8000).build(),
            new Property.Builder(Server.Settings.BACKLOG, 0).build(),
            new Property.Builder(Server.Settings.KEY_STORE_FILE, "./data/metacfg4j.keystore").build(),
            new Property.Builder(Server.Settings.ALIAS, "alias").build(),
            new Property.Builder(Server.Settings.STORE_PASSWORD, "password").build(),
            new Property.Builder(Server.Settings.KEY_PASSWORD, "password").build())).build();
    // Create the meta configuration
    return new MetaConfig.Builder().webServer(webServer).dataSource(getDataSource()).dataMapping(dataMapping).dbSettings(settings).build();
}

It's possible to configure the meta configuration as a client:

public MetaConfig metaConfig() {
    // Create the web client config
    final Config webClient=new Config.Builder(WebClient.Settings.CONFIG_NAME,
        Arrays.asList(
            new Property.Builder(WebClient.Settings.URL, "https://localhost:8000/api/metacfg").build(),
            new Property.Builder(Constants.Endpoints.ACCEPT_CONFIG_ENDPOINT, "accept_config").build(),
            new Property.Builder(Constants.Endpoints.CONFIG_NAMES_ENDPOINT, "config_names").build(),
            new Property.Builder(Constants.Endpoints.CONFIG_ENDPOINT, "config").build(),
            new Property.Builder(WebClient.Settings.ACCEPT_ALL_HOSTS, true).build())).build();
    // Create the meta configuration
    return new MetaConfig.Builder().webClient(webClient).build();
}

NOTE: you need to call the close method at the end of processing.

Certificate generation

To generate a certificate, you need open a command line and and enter:

keytool -genkeypair -keyalg RSA -alias alias -keypass password -keystore metacfg4j.keystore -storepass password

If you have certificate that's signed by CA (Certificate Authority), please use it.

Settings

Web Server settings

The following settings are available:

  • config-server - the name of the configuration.
  • hostname - the server hostname.
  • port - the server port.
  • backlog - the server backlog.
  • key-store-file - the path to a certificate.
  • alias - the alias of a certificate.
  • store-password - the store password of a certificate.
  • key-password - the key password of a certificate.

Java Usage

The Java API is available:

/**
 * Provides service methods to create, read, update and delete operations.
 */
public interface ConfigService {
    /**
     * Updates configuration models.
     *
     * @param stream   a stream of configuration models.
     * @return a stream of updated configuration models.
     */
    Stream<Config> update(final Stream<Config> stream);

    /**
     * Returns all configuration names.
     *
     * @return a stream of configuration names.
     */
    Stream<String> getNames();

    /**
     * Returns selected configuration names by a config page request.
     *
     * @param request a configuration page request that has parameters: page, size, ascending.
     * @return a page with configuration names.
     */
    PageResponse getNames(final PageRequest request);

    /**
     * Returns all configuration models.
     *
     * @return a stream of configurations models.
     */
    Stream<Config> get();

    /**
     * Returns configuration models by names.
     *
     * @param stream a stream of names.
     * @return a stream of configurations models.
     */
    Stream<Config> get(final Stream<String> stream);

    /**
     * Removes configuration models by names.
     *
     * @param stream a stream of names.
     * @return a number of deleted models.
     */
    int remove(final Stream<String> stream);

    /**
     * Accepts a configuration model by names.
     *
     * @param stream a stream of names.
     */
    void accept(final Stream<String> stream);

    /**
     * Adds a consumer to provide an action.
     *
     * @param consumer an implementation of the consumer.
     */
    void addConsumer(final Consumer<Config> consumer);
}

REST Usage

The REST API is available via the https protocol:

POST api/metacfg/accept_config/ARRAY_OF_CONFIG_NAMES_IN_BASE64 - calls the logic for configs.
GET api/metacfg/config_names - returns a list of config names.
GET api/metacfg/config_names?page_request=ARRAY_OF_CONFIG_NAMES_IN_BASE64 - returns a page response based on a page request that has a list of config names and pagination settings.
GET api/metacfg/config?names=ARRAY_OF_CONFIG_NAMES_IN_BASE64 - returns a list of configs.
PUT api/metacfg/config - creates or updates a config, request body must have json with array of objects.
DELETE api/metacfg/config?names=ARRAY_OF_CONFIG_NAMES_IN_BASE64 - removes a list of configs.

ARRAY_OF_CONFIG_NAMES_IN_BASE64 means that every request param should be in the json format (with array of strings inside) encoded to base64 format.

For example:

["Name1","Name2"] encoded to the base64 format will be WyJOYW1lMSIsIk5hbWUyIl0=

GET api/metacfg/config?names=WyJOYW1lMSIsIk5hbWUyIl0= - returns a list of configs with names Name1, Name2.

JSON examples

An array with a config and property:

[
 {
  "name": "New Config",
  "description": "Description",
  "attributes": {
   "key_1": "value-1",
   "key_4": "value_4"
  },
  "properties": [
   {
    "name": "Value",
    "caption": "Caption",
    "description": "Description",
    "attributes": {
     "key_1": "value-1",
     "key_4": "value_4"
    },
    "type": "LONG",
    "value": "1000",
    "properties": []
   }
  ]
 }
]

Config new a property:

{
 "name": "New Config",
 "attributes": {
  "key_3": "value_3",
  "key_2": "value_2",
  "key_1": "value_1"
 },
 "properties": [
  {
   "name": "Property",
   "caption": "Caption",
   "description": "Description",
   "attributes": {
    "key": "value"
   },
   "type": "STRING",
   "value": "Value",
   "properties": [
    {
     "name": "Property-1",
     "attributes": {
      "key_1": "value_1"
     },
     "type": "STRING",
     "value": "Value-1",
     "properties": []
    },
    {
     "name": "Property-2",
     "attributes": {
      "key_2": "value_2"
     },
     "type": "STRING",
     "value": "Value-2",
     "properties": []
    },
    {
     "name": "Property-3",
     "attributes": {
      "key_3": "value_3"
     },
     "type": "STRING",
     "value": "Value-3",
     "properties": []
    }
   ]
  }
 ]
}

Build Requirements

⇒ Java 8+
⇒ Maven 3.6+

Contribution

Contribution is always welcome. Please perform changes and submit pull requests into this branch.
Please set your editor to use spaces instead of tabs, and adhere to the apparent style of the code you are editing.