com.netease.cloud.util.VersionInfoUtils Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of nos-sdk-java-publiccloud Show documentation
nos java sdk to the Central Repository
The newest version!
package com.netease.cloud.util;

import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.InputStream;
import java.util.Properties;

/**
 * Utility class for accessing  SDK versioning information.
 */
public class VersionInfoUtils {
    
    /** The  SDK version info file with SDK versioning info */
    private static final String VERSION_INFO_FILE = "versionInfo.properties";
    
    /** SDK version info */
    private static String version = null;

    /** SDK platform info */
    private static String platform = null;

    /** User Agent info */
    private static String userAgent = null;

    /**
     * Returns the current version for the  SDK in which this class is
     * running. Version information is obtained from from the
     * versionInfo.properties file which the  Java SDK build process
     * generates.
     * 
     * @return The current version for the  SDK, if known, otherwise
     *         returns a string indicating that the version information is
     *         not available.
     */
    public static String getVersion() {
        if (version == null) {
            initializeVersion();
        }
        
        return version;
    }

    /**
     * Returns the current platform for the  SDK in which this class is
     * running. Version information is obtained from from the
     * versionInfo.properties file which the  Java SDK build process
     * generates.
     *
     * @return The current platform for the  SDK, if known, otherwise
     *         returns a string indicating that the platform information is
     *         not available.
     */
    public static String getPlatform() {
        if (platform == null) {
            initializeVersion();
        }
        
        return platform;
    }

     /**
     * @return Returns the User Agent string to be used when communicating with
	 * the  services.  The User Agent encapsulates SDK, Java, OS and
	 * region information.
     */
    public static String getUserAgent() {
        if (userAgent == null) {
            initializeUserAgent();
        }
        
        return userAgent;
    }

   /**
     * Loads the versionInfo.properties file from the  Java SDK and
     * stores the information so that the file doesn't have to be read the
     * next time the data is needed.
     */
    private static void initializeVersion() {
        InputStream inputStream = VersionInfoUtils.class.getClassLoader().getResourceAsStream(VERSION_INFO_FILE);
        Properties versionInfoProperties = new Properties();
        try {
            if (inputStream == null)
                throw new Exception(VERSION_INFO_FILE + " not found on classpath");
            
            versionInfoProperties.load(inputStream);
            version = versionInfoProperties.getProperty("version");
            platform = versionInfoProperties.getProperty("platform");
        } catch (Exception e) {
           // log.info("Unable to load version information for the running SDK: " + e.getMessage());
            version = "unknown-version";
            platform = "java";
        }
    }
			
   /**
     * Loads the versionInfo.properties file from the  Java SDK and
     * stores the information so that the file doesn't have to be read the
     * next time the data is needed.
     */
	private static void initializeUserAgent() {
		StringBuilder buffer = new StringBuilder( 1024 );
		buffer.append( "nos-sdk-" + VersionInfoUtils.getPlatform().toLowerCase() + "/" );
		buffer.append( VersionInfoUtils.getVersion() );
		buffer.append( " " );
		buffer.append( System.getProperty( "os.name" ).replace( ' ', '_' ) + "/" + System.getProperty( "os.version" ).replace( ' ', '_' ) );
		buffer.append( " " );
		buffer.append( System.getProperty( "java.vm.name" ).replace( ' ', '_' ) + "/" + System.getProperty( "java.vm.version" ).replace( ' ', '_' ) );
		
		String region = "";
		try {
			region = " " + System.getProperty( "user.language" ).replace( ' ', '_' ) + "_" + System.getProperty( "user.region" ).replace( ' ', '_' );
		}
		catch ( Exception exception ) {
		}
		
		buffer.append( region );
	
		userAgent = buffer.toString();
	}
}