# os-platform-finder

**Repository Path**: mamh-java/os-platform-finder

## Basic Information

- **Project Name**: os-platform-finder
- **Description**: https://github.com/mamh-java/os-platform-finder
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-10-20
- **Last Updated**: 2023-07-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

os-platform-finder
==================

Utility class to return the current OS Platform

The Problem?
------------
You can get OS information in java by using

```
    System.getProperty("os.name");
    System.getProperty("os.version");
    System.getProperty("os.arch");
```

Unfortunately you can not get the detail of the OS platform.
e.g. you can not get
```
Red Hat Enterprise Linux Server release 6.5 (Santiago)
```
or
```
OS X Mavericks (10.9.3)
```

The Solution?
-------------
The class **com.jsoftbiz.utils.OS** included in this project gives you the information of your OS platform

**Maven coordinates**

```
<dependency>
  <groupId>com.jsoftbiz</groupId>
  <artifactId>os-platform-finder</artifactId>
  <version>1.1</version>
</dependency>
```

**Gradle coordinates**

```
implementation 'com.jsoftbiz:os-platform-finder:1.1'
```

**Java example**

Just add this import:
```
    import static com.jsoftbiz.utils.OS.OS;
```

and you'll have access to the platform name, extra of the OS system properties:
```
    OS.getPlatformName()

    OS.getName()
    OS.getVersion()
    OS.getArch()
```

Wanna help?
-----------
I don't have access to all OSes, so if you want to help, look at the table below of tested platforms.
If you have access to one non-tested platform, just get this project, create a jar
```
   mvn clean package
```

it will be located in the target directory
```
   target/os-platform-finder-1.0.jar
```

copy the jar on your OS and execute it

```
   java -jar os-platform-finder-1.0.jar
```

If it is ok, you can do a pull request on this README.md with the updated info.

If it is not ok, then please open an issue, including the details of your OS and the output of the jar execution...

Thanks!


| OS            | Version       | Arch.     |  Platform  | Status                  |
| ------------- |:-------------:|:---------:|:----------:|:----------------------- |
| Windows       | all           | all       |  Windows   | OK                      |
| Mac OS        | all           | all       |   Mac OS   | OK                      |
| OS X          | all           | all       |    OS X    | OK                      |
| Linux         | all           | all       |   Alpine   | OK                      |
| Linux         | all           | all       | Arch Linux | OK |
| Linux         | all           | all       |   Debian   | IMPLEMENTED, NOT TESTED |
| Linux         | all           | all       |  FreeBSD   | IMPLEMENTED, NOT TESTED |
| Linux         | all           | all       |   RedHat   | OK                      |
| Linux         | all           | all       | Linux Mint | IMPLEMENTED, NOT TESTED |
| Linux         | all           | all       |   Ubuntu   | OK                      |
| Linux         | all           | all       |   Fedora   | OK                      |
| Linux         | all           | all       |  openSUS   | IMPLEMENTED, NOT TESTED |
| Linux         | all           | all       |   CentOS   | OK                      |
| Linux         | all           | all       | Slackware  | IMPLEMENTED, NOT TESTED |
| Solaris       | all           | all       |            | OK                      |
| AIX           | all           | all       |            | OK                      |
| HP-UX         | all           | all       |            | NOT IMPLEMENTED         |
| z/OS          | all           | all       |            | NOT IMPLEMENTED         |


Known issues with :

| OS            | Version       | Arch.     | Platform      | Status                  |
| ------------- |:-------------:|:---------:|:-------------:|:----------------------- |
|               |               |           |               |                         |
|               |               |           |               |                         |

Author
------
Aurélien Broszniowski  - [JSoftBiz.com](http://www.jsoftbiz.com)