com.synopsys.integration.blackduck.useragent.BlackDuckCommon Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of blackduck-common Show documentation

A library for using various capabilities of Black Duck, notably the REST API and signature scanning.

There is a newer version: 66.2.19

/**
 * blackduck-common
 *
 * Copyright (c) 2020 Synopsys, Inc.
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package com.synopsys.integration.blackduck.useragent;

import java.io.IOException;
import java.io.InputStream;
import java.nio.charset.StandardCharsets;
import java.util.Arrays;
import java.util.List;
import java.util.function.Function;
import java.util.stream.Collectors;

import org.apache.commons.io.IOUtils;
import org.apache.commons.lang3.StringUtils;

import com.synopsys.integration.util.NameVersion;

public class BlackDuckCommon {
    public static final String NAME = "BlackDuckCommon";
    public static final String VERSION_RESOURCE_PATH = "com/synopsys/integration/blackduck/version.txt";
    public static final List JAVA_PROPERTIES = Arrays.asList("java.vendor", "java.version", "os.arch", "os.name", "os.version");

    public static UserAgentItem createUserAgentItem() {
        String version = null;
        try (InputStream inputStream = BlackDuckCommon.class.getClassLoader().getResourceAsStream(VERSION_RESOURCE_PATH)) {
            if (inputStream != null) {
                version = IOUtils.toString(inputStream, StandardCharsets.UTF_8);
            }
        } catch (IOException ignored) {
            // version will just be 'unknown'
        }

        BlackDuckCommon blackDuckCommon = new BlackDuckCommon();
        return blackDuckCommon.createUserAgentItem(version, System::getProperty);
    }

    public UserAgentItem createUserAgentItem(String version, Function valueLookup) {
        version = StringUtils.defaultString(StringUtils.trimToNull(version), UserAgentItem.UNKNOWN);
        NameVersion nameVersion = new NameVersion(NAME, version);

        String comments = JAVA_PROPERTIES
                              .stream()
                              .map(valueLookup)
                              .collect(Collectors.joining(" "));

        return new UserAgentItem(nameVersion, comments);
    }

}