Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bytemechanics/standalone-ignite
Library to reduce the code necessary to start and make a controlled shutdown of standalone applications
https://github.com/bytemechanics/standalone-ignite
boot java library standalone startup
Last synced: about 1 month ago
JSON representation
Library to reduce the code necessary to start and make a controlled shutdown of standalone applications
- Host: GitHub
- URL: https://github.com/bytemechanics/standalone-ignite
- Owner: bytemechanics
- License: apache-2.0
- Created: 2018-01-22T21:05:21.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2021-10-16T21:46:40.000Z (over 3 years ago)
- Last Synced: 2024-12-15T09:34:23.847Z (about 1 month ago)
- Topics: boot, java, library, standalone, startup
- Language: Java
- Homepage: https://standalone-ignite.bytemechanics.org
- Size: 857 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Standalone ignite
[](https://maven-badges.herokuapp.com/maven-central/org.bytemechanics/standalone-ignite/badge.svg)
[](https://sonarcloud.io/dashboard/index/org.bytemechanics%3Astandalone-ignite)
[](https://sonarcloud.io/dashboard/index/org.bytemechanics%3Astandalone-ignite)
[](https://opensource.org/licenses/Apache-2.0)
Library to reduce the code necessary to start and make a controlled shutdown of standalone applications. The scope of this library is to provide solutions for:
* Easy parse of command line parameters
* Easy start and stop daemons (standalone services) inside your standalone application
* Easy detection of O.S. stop requirement to make a graceful shutdown
## Motivation
Some times make something so simple as batch generates a lot of boilerplate source with this library we intend to make this startup easier and faster as well as keeping the control of all startup process.
## Requirements
JDK8
## Quick start
(Please read our [Javadoc](https://standalone-ignite.bytemechanics.org/javadoc/index.html) for further information)
1. First of all include the Jar file in your compile and execution classpath.
### Maven
```Maven
org.bytemechanics
standalone-ignite
X.X.X
```
### Graddle
```Gradle
dependencies {
compile 'org.bytemechanics:standalone-ignite:X.X.X'
}
```
2. Create the standalone application main class
```Java
package mypackage;
```
3. If some parameters are needed, create an enumerate with all necessary parameters
```Java
package mypackage;
import java.util.Optional;
import java.util.function.Function;
import org.bytemechanics.standalone.ignite.beans.DefaultParameterContainer;
public enum StandaloneAppTestParameter implements Parameter{
BOOLEANVALUE(boolean.class,"boolean value"),
INTVALUE(int.class,"int value"),
LONGVALUE(long.class,"long value"),
FLOATVALUE(float.class,"float value"),
DOUBLEVALUE(double.class,"double value"),
STRINGVALUE(String.class,"string value"),
;
private final DefaultParameterContainer container;
StandaloneAppTestParameter(final Class _type,final String _description){
this(_type,_description,null,null);
}
StandaloneAppTestParameter(final Class _type,final String _description,final String _default){
this(_type,_description,_default,null);
}
StandaloneAppTestParameter(final Class _type,final String _description,final String _default,final Function _parser){
this.container=DefaultParameterContainer.builder()
.name(name())
.type(_type)
.description(_description)
.defaultValue(_default)
.parser((Function)_parser)
.build();
}
@Override
public Class getType() {
return this.container.getType();
}
@Override
public Function getParser() {
return this.container.getParser();
}
@Override
public Optional getValue() {
return this.container.getValue();
}
@Override
public Parameter setValue(Object _value) {
return this.container.setValue(_value);
}
@Override
public Optional getDefaultValue() {
return this.container.getDefaultValue();
}
@Override
public String getDescription() {
return this.container.getDescription();
}
}
```
4. Into your main instantiate Standalone
* Option 1: Using `org.bytemechanics.standalone.ignite.Ignitable` interface
```Java
package mypackage;
import java.util.Optional;
import java.util.function.Function;
import org.bytemechanics.standalone.ignite.Ignitable;
import org.bytemechanics.standalone.ignite.beans.DefaultParameterContainer;
public final class StandaloneApp implements Ignitable{
@Override
public void startup() {
// start your application
}
@Override
public void shutdown() {
// shutdown your application (optional)
}
(...)
public static final void main(final String... _args){
Standalone.builder(StandaloneApp::new)
.arguments(_args)
(...)
.parameters(StandaloneAppTestParameter.class)
(...)
.build()
.ignite();
}
}
```
* Option 2: Using `org.bytemechanics.standalone.ignite.IgnitableAdapter` abstract class
```Java
package mypackage;
import java.util.Optional;
import java.util.function.Function;
import org.bytemechanics.standalone.ignite.IgnitableAdapter;
public final class StandaloneApp extends IgnitableAdapter{
@Override
public void startup() {
// start your application
}
@Override
public void shutdown() {
// shutdown your application (optional)
}
(...)
public static final void main(final String... _args){
Standalone.builder(StandaloneApp::new)
.arguments(_args)
(...)
.parameters(StandaloneAppTestParameter.class)
(...)
.build()
.ignite();
}
}
```