Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ on:

jobs:
build:
uses: sentrysoftware/workflows/.github/workflows/maven-build.yml@v3
uses: metricshub/workflows/.github/workflows/maven-build.yml@v2
with:
jdkVersion: "17"
debug: ${{ github.event_name == 'workflow_dispatch' && inputs.debug }}
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ on:

jobs:
deploy:
uses: sentrysoftware/workflows/.github/workflows/maven-central-deploy.yml@v3
uses: metricshub/workflows/.github/workflows/maven-central-deploy.yml@v2
with:
jdkVersion: "17"
secrets: inherit
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ on:

jobs:
release:
uses: sentrysoftware/workflows/.github/workflows/maven-central-release.yml@v3
uses: metricshub/workflows/.github/workflows/maven-central-release.yml@v2
with:
releaseVersion: ${{ inputs.releaseVersion }}
developmentVersion: ${{ inputs.developmentVersion }}
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# IPMI Java Client
![GitHub release (with filter)](https://img.shields.io/github/v/release/sentrysoftware/ipmi)
![Build](https://img.shields.io/github/actions/workflow/status/sentrysoftware/ipmi/deploy.yml)
![GitHub top language](https://img.shields.io/github/languages/top/sentrysoftware/ipmi)
![License](https://img.shields.io/github/license/sentrysoftware/ipmi)
![GitHub release (with filter)](https://img.shields.io/github/v/release/metricshub/ipmi-java)
![Build](https://img.shields.io/github/actions/workflow/status/metricshub/ipmi-java/deploy.yml)
![GitHub top language](https://img.shields.io/github/languages/top/metricshub/ipmi-java)
![License](https://img.shields.io/github/license/metricshub/ipmi-java)

This project is a fork of the excellent [IPMI Library for Java by Verax Systems](https://veraxsystems.com/ipmi-library-for-java/) ([see also](https://en.wikipedia.org/wiki/Verax_IPMI)). It is however not related to [another fork by rbuckland](https://github.com/rbuckland/ipmilib).

See **[Project Documentation](https://sentrysoftware.org/ipmi)** and the [Javadoc](https://sentrysoftware.org/ipmi/apidocs) for more information on how to use this library in your code.
See **[Project Documentation](https://metricshub.org/ipmi-java)** and the [Javadoc](https://metricshub.org/ipmi-java/apidocs) for more information on how to use this library in your code.

The IPMI Java Client is a library that communicates with the IPMI host, fetches Field Replaceable Units (FRUs) and Sensors information then reports these information as a text output.

Expand Down
238 changes: 73 additions & 165 deletions checkstyle.xml
Original file line number Diff line number Diff line change
Expand Up @@ -32,191 +32,99 @@
-->

<module name="Checker">
<!--
If you set the basedir property below, then all reported file
names will be relative to the specified directory. See
http://checkstyle.sourceforge.net/5.x/config.html#Checker

<property name="basedir" value="${basedir}"/>
-->

<!-- Checks that a package-info.java file exists for each package. -->
<!-- See http://checkstyle.sf.net/config_javadoc.html#JavadocPackage -->
<!--<module name="JavadocPackage"/>-->

<!-- Checks whether files end with a new line. -->
<!-- See http://checkstyle.sf.net/config_misc.html#NewlineAtEndOfFile -->
<!----><module name="NewlineAtEndOfFile"/>

<!-- Checks that property files contain the same keys. -->
<!-- See http://checkstyle.sf.net/config_misc.html#Translation -->
<module name="Translation"/>

<module name="Translation"/>
<!-- Checks for Size Violations. -->
<!-- See http://checkstyle.sf.net/config_sizes.html -->
<module name="FileLength"/>

<!-- Checks for tab indentation -->
<module name="RegexpSingleline">
<property name="format" value="^\s* +\s*[^*]" />
<property name="message" value="Indentation must use tab characters" />
</module>

<!-- Miscellaneous other checks. -->
<!-- See http://checkstyle.sf.net/config_misc.html -->
<module name="RegexpSingleline">
<property name="format" value="\s+$"/>
<property name="minimum" value="0"/>
<property name="maximum" value="0"/>
<property name="message" value="Line has trailing spaces."/>
</module>

<module name="TreeWalker">

<!-- Checks for Javadoc comments. -->
<!-- See http://checkstyle.sf.net/config_javadoc.html -->
<!--<module name="JavadocMethod">
<property name="scope" value="package"/>
</module>
<module name="JavadocType">
<property name="scope" value="package"/>
<property name="authorFormat" value=".*"/>
</module>
<module name="JavadocVariable">
<property name="scope" value="package"/>
</module>
<module name="JavadocStyle">
<property name="checkEmptyJavadoc" value="true"/>
</module>-->


<!-- Checks for Naming Conventions. -->
<!-- See http://checkstyle.sf.net/config_naming.html -->
<module name="ConstantName"/>
<module name="LocalFinalVariableName"/>
<module name="LocalVariableName"/>
<module name="MemberName"/>
<module name="MethodName"/>
<module name="PackageName"/>
<module name="ParameterName"/>
<module name="StaticVariableName"/>
<module name="TypeName"/>


<!-- Checks for Headers -->
<!-- See http://checkstyle.sf.net/config_header.html -->
<!--<module name="Header">-->
<!-- The follow property value demonstrates the ability -->
<!-- to have access to ANT configuration. In this case it uses -->
<!-- the ${basedir} property to allow Checkstyle to be run -->
<!-- from any directory within a project. See property -->
<!-- expansion, -->
<!-- http://checkstyle.sf.net/config.html#configuration -->
<!-- <property -->
<!-- name="headerFile" -->
<!-- value="${basedir}/java.header"/> -->
<!--</module>-->

<!-- Following interprets the header file as regular expressions. -->
<!--<module name="RegexpHeader"/>-->
<module name="FileLength"/>

<module name="TreeWalker">
<module name="TypeName">
<property name="format" value="^[A-Z][A-Za-z0-9_]*$"/>
</module>

<!-- Checks for Naming Conventions. -->
<!-- See http://checkstyle.sf.net/config_naming.html -->
<module name="LocalFinalVariableName"/>
<module name="LocalVariableName"/>
<module name="MemberName"/>
<module name="MethodName"/>
<module name="PackageName"/>
<module name="ParameterName"/>
<module name="StaticVariableName"/>

<!-- Checks for imports -->
<!-- See http://checkstyle.sf.net/config_import.html -->
<module name="AvoidStarImport"/>
<module name="IllegalImport"/> <!-- defaults to sun.* packages -->
<module name="RedundantImport"/>
<module name="UnusedImports"/>
<module name="IllegalImport"/>
<module name="RedundantImport"/>
<module name="UnusedImports"/>

<!-- Checks for Size Violations (MethodLength relaxed, e.g. max=700). -->
<!-- <module name="LineLength"/> -->
<module name="MethodLength">
<property name="max" value="700"/>
</module>

<!-- Checks for Size Violations. -->
<!-- Checks for Size Violations. -->
<!-- See http://checkstyle.sf.net/config_sizes.html -->
<!--<module name="LineLength"/>-->
<module name="MethodLength"/>
<module name="ParameterNumber">
<property name="tokens" value="METHOD_DEF"/>
</module>

<module name="ParameterNumber">
<property name="tokens" value="METHOD_DEF"/>
</module>

<!-- Checks for whitespace -->
<!-- Checks for whitespace -->
<!-- See http://checkstyle.sf.net/config_whitespace.html -->
<module name="EmptyForIteratorPad"/>
<module name="GenericWhitespace"/>
<module name="MethodParamPad"/>
<module name="NoWhitespaceAfter"/>
<module name="NoWhitespaceBefore"/>
<module name="OperatorWrap"/>
<!--<module name="ParenPad"/>-->
<module name="TypecastParenPad"/>
<module name="WhitespaceAfter">
<property name="tokens" value="COMMA, SEMI"/>
</module>
<module name="WhitespaceAround">
<property name="tokens" value="ASSIGN, BAND_ASSIGN, BOR_ASSIGN, BSR_ASSIGN, BXOR_ASSIGN, COLON, DIV_ASSIGN, EQUAL, GE, GT, LE, LITERAL_RETURN, LT, MINUS_ASSIGN, MOD_ASSIGN, NOT_EQUAL, PLUS_ASSIGN, QUESTION, SL_ASSIGN, SR_ASSIGN, STAR_ASSIGN"/>
</module>

<module name="EmptyForIteratorPad"/>
<module name="GenericWhitespace"/>
<module name="MethodParamPad"/>
<module name="TypecastParenPad"/>
<module name="WhitespaceAround">
<property name="tokens"
value="ASSIGN, BAND_ASSIGN, BOR_ASSIGN, BSR_ASSIGN, BXOR_ASSIGN, COLON, DIV_ASSIGN,
EQUAL, GE, GT, LE, LITERAL_RETURN, LT, MINUS_ASSIGN, MOD_ASSIGN, NOT_EQUAL,
PLUS_ASSIGN, QUESTION, SL_ASSIGN, SR_ASSIGN, STAR_ASSIGN"/>
</module>

<!-- Modifier Checks -->
<!-- See http://checkstyle.sf.net/config_modifiers.html -->
<module name="ModifierOrder"/>
<module name="RedundantModifier"/>
<module name="ModifierOrder"/>
<module name="RedundantModifier"/>


<!-- Checks for blocks. You know, those {}'s -->
<!-- Checks for blocks. You know, those {}'s -->
<!-- See http://checkstyle.sf.net/config_blocks.html -->
<module name="AvoidNestedBlocks"/>
<!--<module name="EmptyBlock"/>-->
<module name="LeftCurly">
<property name="option" value="nlow"/>
</module>
<module name="NeedBraces"/>
<!--<module name="RightCurly">
<property name="option" value="alone"/>
</module>-->


<!-- Checks for common coding problems -->
<module name="AvoidNestedBlocks"/>
<!-- <module name="EmptyBlock"/> -->
<module name="LeftCurly">
<property name="option" value="eol"/>
</module>
<!-- <module name="NeedBraces"/> -->

<!-- Checks for common coding problems -->
<!-- See http://checkstyle.sf.net/config_coding.html -->
<!--<module name="AvoidInlineConditionals"/>-->
<module name="EmptyStatement"/>
<module name="EqualsHashCode"/>
<module name="HiddenField">
<property name="ignoreConstructorParameter" value="true"/>
<property name="ignoreSetter" value="true"/>
</module>
<module name="IllegalInstantiation"/>
<module name="InnerAssignment"/>
<!--<module name="MagicNumber"/>-->
<module name="MissingSwitchDefault"/>
<module name="SimplifyBooleanExpression"/>
<module name="SimplifyBooleanReturn"/>

<!-- Checks for class design -->
<!-- See http://checkstyle.sf.net/config_design.html -->
<!--<module name="DesignForExtension"/>-->
<module name="FinalClass"/>
<module name="HideUtilityClassConstructor"/>
<module name="InterfaceIsType"/>
<module name="VisibilityModifier"/>


<!-- Miscellaneous other checks. -->
<!-- See http://checkstyle.sf.net/config_misc.html -->
<module name="ArrayTypeStyle"/>
<module name="FinalParameters"/>
<module name="TodoComment">
<property name="format" value="FIXME"/>
</module>
<module name="TodoComment">
<property name="format" value="TODO"/>
<property name="severity" value="warning"/>
</module>
<module name="TodoComment">
<property name="format" value="XXX"/>
<property name="severity" value="warning"/>
</module>
<module name="UpperEll"/>

</module>

<module name="EmptyStatement"/>
<module name="EqualsHashCode"/>
<!-- <module name="HiddenField"/> -->
<module name="IllegalInstantiation"/>
<module name="InnerAssignment"/>
<!-- <module name="MagicNumber"/> -->
<module name="MissingSwitchDefault"/>
<module name="SimplifyBooleanExpression"/>
<module name="SimplifyBooleanReturn"/>

<!-- Class design checks -->
<!-- <module name="FinalClass"/> -->
<module name="HideUtilityClassConstructor"/>
<module name="InterfaceIsType"/>
<!-- <module name="VisibilityModifier"/> -->

<!-- Misc. other checks -->
<module name="ArrayTypeStyle"/>
<!-- <module name="FinalParameters"/> -->
<!-- <module name="TodoComment" ...> -->
<!-- <module name="UpperEll"/> -->

</module>
</module>
28 changes: 10 additions & 18 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,23 @@
<modelVersion>4.0.0</modelVersion>

<parent>
<groupId>org.sentrysoftware</groupId>
<groupId>org.metricshub</groupId>
<artifactId>oss-parent</artifactId>
<version>2</version>
</parent>

<groupId>org.sentrysoftware</groupId>
<artifactId>ipmi</artifactId>
<artifactId>ipmi-java</artifactId>
<version>1.2.01-SNAPSHOT</version>

<name>IPMI Java Client</name>
<description>IPMI Client Library for Java</description>

<organization>
<name>Sentry Software</name>
<url>https://sentrysoftware.com</url>
<name>MetricsHub</name>
<url>https://metricshub.com</url>
</organization>

<url>https://sentrysoftware.org/ipmi</url>
<url>https://metricshub.org/ipmi-java</url>
<inceptionYear>2023</inceptionYear>

<licenses>
Expand All @@ -32,33 +31,26 @@

<issueManagement>
<system>GitHub</system>
<url>https://github.com/sentrysoftware/ipmi/issues/</url>
<url>https://github.com/metricshub/ipmi-java/issues/</url>
</issueManagement>

<scm>
<connection>scm:git:https://github.com/sentrysoftware/ipmi.git</connection>
<url>https://github.com/sentrysoftware/ipmi</url>
<connection>scm:git:https://github.com/metricshub/ipmi-java.git</connection>
<url>https://github.com/metricshub/ipmi-java</url>
<tag>HEAD</tag>
</scm>

<developers>
<developer>
<name>Bertrand Martin (@bertysentry)</name>
<email>bertrand@sentrysoftware.com</email>
<email>bertrand@metricshub.com</email>
<roles>
<role>maintainer</role>
</roles>
</developer>
<developer>
<name>Nassim Boutekedjiret (@NassimBtk)</name>
<email>nassim@sentrysoftware.com</email>
<roles>
<role>maintainer</role>
</roles>
</developer>
<developer>
<name>Kawtar Bakour (@KawtarBK9)</name>
<email>kawtar@sentrysoftware.com</email>
<email>nassim@metricshub.com</email>
<roles>
<role>maintainer</role>
</roles>
Expand Down
Loading
Loading