emmanuel/gclc-core
emmanuel/gclc-core
1
0
Fork 0
Code Issues 2 Pull Requests Projects 1 Releases Wiki Activity

Update versions, configuration, license, refactor package

Browse Source 
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
This commit is contained in:
Emmanuel Bigeon 2018-10-08 15:04:22 -04:00
parent a69c4a777f
commit 7a7bf0b019
17 changed files with 2645 additions and 1630 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

517
gclc-process/LICENSE.txt Normal file
View File

@ -0,0 +1,517 @@
CeCILL FREE SOFTWARE LICENSE AGREEMENT
Version 2.1 dated 2013-06-21
Notice
This Agreement is a Free Software license agreement that is the result
of discussions between its authors in order to ensure compliance with
the two main principles guiding its drafting:
* firstly, compliance with the principles governing the distribution
of Free Software: access to source code, broad rights granted to users,
* secondly, the election of a governing law, French law, with which it
is conformant, both as regards the law of torts and intellectual
property law, and the protection that it offers to both authors and
holders of the economic rights over software.
The authors of the CeCILL (for Ce[a] C[nrs] I[nria] L[ogiciel] L[ibre])
license are:
Commissariat à l'énergie atomique et aux énergies alternatives - CEA, a
public scientific, technical and industrial research establishment,
having its principal place of business at 25 rue Leblanc, immeuble Le
Ponant D, 75015 Paris, France.
Centre National de la Recherche Scientifique - CNRS, a public scientific
and technological establishment, having its principal place of business
at 3 rue Michel-Ange, 75794 Paris cedex 16, France.
Institut National de Recherche en Informatique et en Automatique -
Inria, a public scientific and technological establishment, having its
principal place of business at Domaine de Voluceau, Rocquencourt, BP
105, 78153 Le Chesnay cedex, France.
Preamble
The purpose of this Free Software license agreement is to grant users
the right to modify and redistribute the software governed by this
license within the framework of an open source distribution model.
The exercising of this right is conditional upon certain obligations for
users so as to preserve this status for all subsequent redistributions.
In consideration of access to the source code and the rights to copy,
modify and redistribute granted by the license, users are provided only
with a limited warranty and the software's author, the holder of the
economic rights, and the successive licensors only have limited liability.
In this respect, the risks associated with loading, using, modifying
and/or developing or reproducing the software by the user are brought to
the user's attention, given its Free Software status, which may make it
complicated to use, with the result that its use is reserved for
developers and experienced professionals having in-depth computer
knowledge. Users are therefore encouraged to load and test the
suitability of the software as regards their requirements in conditions
enabling the security of their systems and/or data to be ensured and,
more generally, to use and operate it in the same conditions of
security. This Agreement may be freely reproduced and published,
provided it is not altered, and that no provisions are either added or
removed herefrom.
This Agreement may apply to any or all software for which the holder of
the economic rights decides to submit the use thereof to its provisions.
Frequently asked questions can be found on the official website of the
CeCILL licenses family (http://www.cecill.info/index.en.html) for any
necessary clarification.
Article 1 - DEFINITIONS
For the purpose of this Agreement, when the following expressions
commence with a capital letter, they shall have the following meaning:
Agreement: means this license agreement, and its possible subsequent
versions and annexes.
Software: means the software in its Object Code and/or Source Code form
and, where applicable, its documentation, "as is" when the Licensee
accepts the Agreement.
Initial Software: means the Software in its Source Code and possibly its
Object Code form and, where applicable, its documentation, "as is" when
it is first distributed under the terms and conditions of the Agreement.
Modified Software: means the Software modified by at least one
Contribution.
Source Code: means all the Software's instructions and program lines to
which access is required so as to modify the Software.
Object Code: means the binary files originating from the compilation of
the Source Code.
Holder: means the holder(s) of the economic rights over the Initial
Software.
Licensee: means the Software user(s) having accepted the Agreement.
Contributor: means a Licensee having made at least one Contribution.
Licensor: means the Holder, or any other individual or legal entity, who
distributes the Software under the Agreement.
Contribution: means any or all modifications, corrections, translations,
adaptations and/or new functions integrated into the Software by any or
all Contributors, as well as any or all Internal Modules.
Module: means a set of sources files including their documentation that
enables supplementary functions or services in addition to those offered
by the Software.
External Module: means any or all Modules, not derived from the
Software, so that this Module and the Software run in separate address
spaces, with one calling the other when they are run.
Internal Module: means any or all Module, connected to the Software so
that they both execute in the same address space.
GNU GPL: means the GNU General Public License version 2 or any
subsequent version, as published by the Free Software Foundation Inc.
GNU Affero GPL: means the GNU Affero General Public License version 3 or
any subsequent version, as published by the Free Software Foundation Inc.
EUPL: means the European Union Public License version 1.1 or any
subsequent version, as published by the European Commission.
Parties: mean both the Licensee and the Licensor.
These expressions may be used both in singular and plural form.
Article 2 - PURPOSE
The purpose of the Agreement is the grant by the Licensor to the
Licensee of a non-exclusive, transferable and worldwide license for the
Software as set forth in Article 5 <#scope> hereinafter for the whole
term of the protection granted by the rights over said Software.
Article 3 - ACCEPTANCE
3.1 The Licensee shall be deemed as having accepted the terms and
conditions of this Agreement upon the occurrence of the first of the
following events:
* (i) loading the Software by any or all means, notably, by
downloading from a remote server, or by loading from a physical medium;
* (ii) the first time the Licensee exercises any of the rights granted
hereunder.
3.2 One copy of the Agreement, containing a notice relating to the
characteristics of the Software, to the limited warranty, and to the
fact that its use is restricted to experienced users has been provided
to the Licensee prior to its acceptance as set forth in Article 3.1
<#accepting> hereinabove, and the Licensee hereby acknowledges that it
has read and understood it.
Article 4 - EFFECTIVE DATE AND TERM
4.1 EFFECTIVE DATE
The Agreement shall become effective on the date when it is accepted by
the Licensee as set forth in Article 3.1 <#accepting>.
4.2 TERM
The Agreement shall remain in force for the entire legal term of
protection of the economic rights over the Software.
Article 5 - SCOPE OF RIGHTS GRANTED
The Licensor hereby grants to the Licensee, who accepts, the following
rights over the Software for any or all use, and for the term of the
Agreement, on the basis of the terms and conditions set forth hereinafter.
Besides, if the Licensor owns or comes to own one or more patents
protecting all or part of the functions of the Software or of its
components, the Licensor undertakes not to enforce the rights granted by
these patents against successive Licensees using, exploiting or
modifying the Software. If these patents are transferred, the Licensor
undertakes to have the transferees subscribe to the obligations set
forth in this paragraph.
5.1 RIGHT OF USE
The Licensee is authorized to use the Software, without any limitation
as to its fields of application, with it being hereinafter specified
that this comprises:
1. permanent or temporary reproduction of all or part of the Software
by any or all means and in any or all form.
2. loading, displaying, running, or storing the Software on any or all
medium.
3. entitlement to observe, study or test its operation so as to
determine the ideas and principles behind any or all constituent
elements of said Software. This shall apply when the Licensee
carries out any or all loading, displaying, running, transmission or
storage operation as regards the Software, that it is entitled to
carry out hereunder.
5.2 ENTITLEMENT TO MAKE CONTRIBUTIONS
The right to make Contributions includes the right to translate, adapt,
arrange, or make any or all modifications to the Software, and the right
to reproduce the resulting software.
The Licensee is authorized to make any or all Contributions to the
Software provided that it includes an explicit notice that it is the
author of said Contribution and indicates the date of the creation thereof.
5.3 RIGHT OF DISTRIBUTION
In particular, the right of distribution includes the right to publish,
transmit and communicate the Software to the general public on any or
all medium, and by any or all means, and the right to market, either in
consideration of a fee, or free of charge, one or more copies of the
Software by any means.
The Licensee is further authorized to distribute copies of the modified
or unmodified Software to third parties according to the terms and
conditions set forth hereinafter.
5.3.1 DISTRIBUTION OF SOFTWARE WITHOUT MODIFICATION
The Licensee is authorized to distribute true copies of the Software in
Source Code or Object Code form, provided that said distribution
complies with all the provisions of the Agreement and is accompanied by:
1. a copy of the Agreement,
2. a notice relating to the limitation of both the Licensor's warranty
and liability as set forth in Articles 8 and 9,
and that, in the event that only the Object Code of the Software is
redistributed, the Licensee allows effective access to the full Source
Code of the Software for a period of at least three years from the
distribution of the Software, it being understood that the additional
acquisition cost of the Source Code shall not exceed the cost of the
data transfer.
5.3.2 DISTRIBUTION OF MODIFIED SOFTWARE
When the Licensee makes a Contribution to the Software, the terms and
conditions for the distribution of the resulting Modified Software
become subject to all the provisions of this Agreement.
The Licensee is authorized to distribute the Modified Software, in
source code or object code form, provided that said distribution
complies with all the provisions of the Agreement and is accompanied by:
1. a copy of the Agreement,
2. a notice relating to the limitation of both the Licensor's warranty
and liability as set forth in Articles 8 and 9,
and, in the event that only the object code of the Modified Software is
redistributed,
3. a note stating the conditions of effective access to the full source
code of the Modified Software for a period of at least three years
from the distribution of the Modified Software, it being understood
that the additional acquisition cost of the source code shall not
exceed the cost of the data transfer.
5.3.3 DISTRIBUTION OF EXTERNAL MODULES
When the Licensee has developed an External Module, the terms and
conditions of this Agreement do not apply to said External Module, that
may be distributed under a separate license agreement.
5.3.4 COMPATIBILITY WITH OTHER LICENSES
The Licensee can include a code that is subject to the provisions of one
of the versions of the GNU GPL, GNU Affero GPL and/or EUPL in the
Modified or unmodified Software, and distribute that entire code under
the terms of the same version of the GNU GPL, GNU Affero GPL and/or EUPL.
The Licensee can include the Modified or unmodified Software in a code
that is subject to the provisions of one of the versions of the GNU GPL,
GNU Affero GPL and/or EUPL and distribute that entire code under the
terms of the same version of the GNU GPL, GNU Affero GPL and/or EUPL.
Article 6 - INTELLECTUAL PROPERTY
6.1 OVER THE INITIAL SOFTWARE
The Holder owns the economic rights over the Initial Software. Any or
all use of the Initial Software is subject to compliance with the terms
and conditions under which the Holder has elected to distribute its work
and no one shall be entitled to modify the terms and conditions for the
distribution of said Initial Software.
The Holder undertakes that the Initial Software will remain ruled at
least by this Agreement, for the duration set forth in Article 4.2 <#term>.
6.2 OVER THE CONTRIBUTIONS
The Licensee who develops a Contribution is the owner of the
intellectual property rights over this Contribution as defined by
applicable law.
6.3 OVER THE EXTERNAL MODULES
The Licensee who develops an External Module is the owner of the
intellectual property rights over this External Module as defined by
applicable law and is free to choose the type of agreement that shall
govern its distribution.
6.4 JOINT PROVISIONS
The Licensee expressly undertakes:
1. not to remove, or modify, in any manner, the intellectual property
notices attached to the Software;
2. to reproduce said notices, in an identical manner, in the copies of
the Software modified or not.
The Licensee undertakes not to directly or indirectly infringe the
intellectual property rights on the Software of the Holder and/or
Contributors, and to take, where applicable, vis-à-vis its staff, any
and all measures required to ensure respect of said intellectual
property rights of the Holder and/or Contributors.
Article 7 - RELATED SERVICES
7.1 Under no circumstances shall the Agreement oblige the Licensor to
provide technical assistance or maintenance services for the Software.
However, the Licensor is entitled to offer this type of services. The
terms and conditions of such technical assistance, and/or such
maintenance, shall be set forth in a separate instrument. Only the
Licensor offering said maintenance and/or technical assistance services
shall incur liability therefor.
7.2 Similarly, any Licensor is entitled to offer to its licensees, under
its sole responsibility, a warranty, that shall only be binding upon
itself, for the redistribution of the Software and/or the Modified
Software, under terms and conditions that it is free to decide. Said
warranty, and the financial terms and conditions of its application,
shall be subject of a separate instrument executed between the Licensor
and the Licensee.
Article 8 - LIABILITY
8.1 Subject to the provisions of Article 8.2, the Licensee shall be
entitled to claim compensation for any direct loss it may have suffered
from the Software as a result of a fault on the part of the relevant
Licensor, subject to providing evidence thereof.
8.2 The Licensor's liability is limited to the commitments made under
this Agreement and shall not be incurred as a result of in particular:
(i) loss due the Licensee's total or partial failure to fulfill its
obligations, (ii) direct or consequential loss that is suffered by the
Licensee due to the use or performance of the Software, and (iii) more
generally, any consequential loss. In particular the Parties expressly
agree that any or all pecuniary or business loss (i.e. loss of data,
loss of profits, operating loss, loss of customers or orders,
opportunity cost, any disturbance to business activities) or any or all
legal proceedings instituted against the Licensee by a third party,
shall constitute consequential loss and shall not provide entitlement to
any or all compensation from the Licensor.
Article 9 - WARRANTY
9.1 The Licensee acknowledges that the scientific and technical
state-of-the-art when the Software was distributed did not enable all
possible uses to be tested and verified, nor for the presence of
possible defects to be detected. In this respect, the Licensee's
attention has been drawn to the risks associated with loading, using,
modifying and/or developing and reproducing the Software which are
reserved for experienced users.
The Licensee shall be responsible for verifying, by any or all means,
the suitability of the product for its requirements, its good working
order, and for ensuring that it shall not cause damage to either persons
or properties.
9.2 The Licensor hereby represents, in good faith, that it is entitled
to grant all the rights over the Software (including in particular the
rights set forth in Article 5 <#scope>).
9.3 The Licensee acknowledges that the Software is supplied "as is" by
the Licensor without any other express or tacit warranty, other than
that provided for in Article 9.2 <#good-faith> and, in particular,
without any warranty as to its commercial value, its secured, safe,
innovative or relevant nature.
Specifically, the Licensor does not warrant that the Software is free
from any error, that it will operate without interruption, that it will
be compatible with the Licensee's own equipment and software
configuration, nor that it will meet the Licensee's requirements.
9.4 The Licensor does not either expressly or tacitly warrant that the
Software does not infringe any third party intellectual property right
relating to a patent, software or any other property right. Therefore,
the Licensor disclaims any and all liability towards the Licensee
arising out of any or all proceedings for infringement that may be
instituted in respect of the use, modification and redistribution of the
Software. Nevertheless, should such proceedings be instituted against
the Licensee, the Licensor shall provide it with technical and legal
expertise for its defense. Such technical and legal expertise shall be
decided on a case-by-case basis between the relevant Licensor and the
Licensee pursuant to a memorandum of understanding. The Licensor
disclaims any and all liability as regards the Licensee's use of the
name of the Software. No warranty is given as regards the existence of
prior rights over the name of the Software or as regards the existence
of a trademark.
Article 10 - TERMINATION
10.1 In the event of a breach by the Licensee of its obligations
hereunder, the Licensor may automatically terminate this Agreement
thirty (30) days after notice has been sent to the Licensee and has
remained ineffective.
10.2 A Licensee whose Agreement is terminated shall no longer be
authorized to use, modify or distribute the Software. However, any
licenses that it may have granted prior to termination of the Agreement
shall remain valid subject to their having been granted in compliance
with the terms and conditions hereof.
Article 11 - MISCELLANEOUS
11.1 EXCUSABLE EVENTS
Neither Party shall be liable for any or all delay, or failure to
perform the Agreement, that may be attributable to an event of force
majeure, an act of God or an outside cause, such as defective
functioning or interruptions of the electricity or telecommunications
networks, network paralysis following a virus attack, intervention by
government authorities, natural disasters, water damage, earthquakes,
fire, explosions, strikes and labor unrest, war, etc.
11.2 Any failure by either Party, on one or more occasions, to invoke
one or more of the provisions hereof, shall under no circumstances be
interpreted as being a waiver by the interested Party of its right to
invoke said provision(s) subsequently.
11.3 The Agreement cancels and replaces any or all previous agreements,
whether written or oral, between the Parties and having the same
purpose, and constitutes the entirety of the agreement between said
Parties concerning said purpose. No supplement or modification to the
terms and conditions hereof shall be effective as between the Parties
unless it is made in writing and signed by their duly authorized
representatives.
11.4 In the event that one or more of the provisions hereof were to
conflict with a current or future applicable act or legislative text,
said act or legislative text shall prevail, and the Parties shall make
the necessary amendments so as to comply with said act or legislative
text. All other provisions shall remain effective. Similarly, invalidity
of a provision of the Agreement, for any reason whatsoever, shall not
cause the Agreement as a whole to be invalid.
11.5 LANGUAGE
The Agreement is drafted in both French and English and both versions
are deemed authentic.
Article 12 - NEW VERSIONS OF THE AGREEMENT
12.1 Any person is authorized to duplicate and distribute copies of this
Agreement.
12.2 So as to ensure coherence, the wording of this Agreement is
protected and may only be modified by the authors of the License, who
reserve the right to periodically publish updates or new versions of the
Agreement, each with a separate number. These subsequent versions may
address new issues encountered by Free Software.
12.3 Any Software distributed under a given version of the Agreement may
only be subsequently distributed under the same version of the Agreement
or a subsequent version, subject to the provisions of Article 5.3.4
<#compatibility>.
Article 13 - GOVERNING LAW AND JURISDICTION
13.1 The Agreement is governed by French law. The Parties agree to
endeavor to seek an amicable solution to any disagreements or disputes
that may arise during the performance of the Agreement.
13.2 Failing an amicable solution within two (2) months as from their
occurrence, and unless emergency proceedings are necessary, the
disagreements or disputes shall be referred to the Paris Courts having
jurisdiction, by the more diligent Party.

75
gclc-process/pom.xml
View File

@ -29,41 +29,10 @@
<!-- The fact that you are presently reading this means that you have had --> <!-- The fact that you are presently reading this means that you have had -->
<!-- knowledge of the CeCILL license and that you accept its terms. --> <!-- knowledge of the CeCILL license and that you accept its terms. -->
<!-- process, Distribution repositories and basic setup for Emmanuel Bigeon projects -->
<!-- Copyright (C) 2014-2017 E. Bigeon -->
<!-- mailto:emmanuel@bigeon.fr -->
<!-- -->
<!-- This software is governed by the CeCILL license under French law and -->
<!-- abiding by the rules of distribution of free software. You can use, -->
<!-- modify and/or redistribute the software under the terms of the CeCILL -->
<!-- license as circulated by CEA, CNRS and INRIA at the following URL -->
<!-- "http://www.cecill.info". -->
<!-- -->
<!-- As a counterpart to the access to the source code and rights to copy, -->
<!-- modify and redistribute granted by the license, users are provided only -->
<!-- with a limited warranty and the software's author, the holder of the -->
<!-- economic rights, and the successive licensors have only limited -->
<!-- liability. -->
<!-- -->
<!-- In this respect, the user's attention is drawn to the risks associated -->
<!-- with loading, using, modifying and/or developing or reproducing the -->
<!-- software by the user in light of its specific status of free software, -->
<!-- that may mean that it is complicated to manipulate, and that also -->
<!-- therefore means that it is reserved for developers and experienced -->
<!-- professionals having in-depth computer knowledge. Users are therefore -->
<!-- encouraged to load and test the software's suitability as regards their -->
<!-- requirements in conditions enabling the security of their systems and/or -->
<!-- data to be ensured and, more generally, to use and operate it in the -->
<!-- same conditions as regards security. -->
<!-- -->
<!-- The fact that you are presently reading this means that you have had -->
<!-- knowledge of the CeCILL license and that you accept its terms. -->
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion> <modelVersion>4.0.0</modelVersion>
<groupId>fr.bigeon.gclc</groupId> <groupId>net.bigeon.gclc</groupId>
<artifactId>process</artifactId> <artifactId>process</artifactId>
<version>0.0.3-SNAPSHOT</version> <version>0.0.3-SNAPSHOT</version>
<packaging>jar</packaging> <packaging>jar</packaging>
@ -73,21 +42,55 @@
<properties> <properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<copyright.email>emmanuel@bigeon.fr</copyright.email>
<license.licenseName>cecill_2.1</license.licenseName>
</properties> </properties>
<parent> <parent>
<groupId>fr.bigeon.config</groupId> <groupId>net.bigeon.config</groupId>
<artifactId>ebigeon-config</artifactId> <artifactId>ebigeon-config</artifactId>
<version>1.8.2</version> <version>1.8.4</version>
</parent> </parent>
<dependencies> <dependencies>
<dependency> <dependency>
<groupId>fr.bigeon</groupId> <groupId>net.bigeon</groupId>
<artifactId>gclc</artifactId> <artifactId>gclc</artifactId>
<version>2.0.5</version> <version>2.0.7</version>
</dependency> </dependency>
</dependencies> </dependencies>
<licenses>
<license>
<distribution>manual</distribution>
<name>CeCILL 2.1</name>
<url>https://cecill.info/licences/Licence_CeCILL_V2.1-en.html</url>
</license>
</licenses>
<reporting>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.10.3</version>
</plugin>
<plugin>
<groupId>com.github.sevntu-checkstyle</groupId>
<artifactId>dsm-maven-plugin</artifactId>
<version>2.2.0</version>
</plugin>
</plugins>
</reporting>
<developers>
<developer>
<email>emmanuel@bigeon.fr</email>
<name>Emmanuel Bigeon</name>
<url>bigeon.net</url>
<roles>
<role>PM</role>
</roles>
</developer>
</developers>
<scm> <scm>
<tag>process-0.0.1</tag> <tag>process-0.0.1</tag>
<developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection> <developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection>

311
gclc-process/src/main/java/fr/bigeon/gclc/process/CommandForeground.java → gclc-process/src/main/java/net/bigeon/gclc/process/CommandForeground.java
View File

@ -1,139 +1,172 @@
/* /*
* process, Distribution repositories and basic setup for Emmanuel Bigeon projects * process, Distribution repositories and basic setup for Emmanuel Bigeon projects
* Copyright (C) 2014-2018 E. Bigeon * Copyright (C) 2014-2018 E. Bigeon
* mailto:emmanuel@bigeon.fr * mailto:emmanuel@bigeon.fr
* *
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/or redistribute the software under the terms of the CeCILL * modify and/or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
* As a counterpart to the access to the source code and rights to copy, * As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only * modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the * with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited * economic rights, and the successive licensors have only limited
* liability. * liability.
* *
* In this respect, the user's attention is drawn to the risks associated * In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the * with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software, * software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also * that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced * therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore * professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their * encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or * requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the * data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security. * same conditions as regards security.
* *
* The fact that you are presently reading this means that you have had * The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc-process:fr.bigeon.gclc.process.CommandFork.java * gclc-process:net.bigeon.gclc.process.CommandFork.java
* Created on: Nov 13, 2017 * Created on: Nov 13, 2017
*/ */
package fr.bigeon.gclc.process; package net.bigeon.gclc.process;
import java.util.List; /*-
* #%L
import fr.bigeon.gclc.command.CommandParameters; * process
import fr.bigeon.gclc.command.ParametrizedCommand; * %%
import fr.bigeon.gclc.exception.CommandRunException; * Copyright (C) 2014 - 2018 Bigeon
import fr.bigeon.gclc.exception.CommandRunExceptionType; * %%
import fr.bigeon.gclc.exception.InvalidParameterException; * This software is governed by the CeCILL license under French law and
import fr.bigeon.gclc.manager.ConsoleInput; * abiding by the rules of distribution of free software. You can use,
import fr.bigeon.gclc.manager.ConsoleOutput; * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
/** A command that is launched inside an internal terminal. * "http://www.cecill.info".
* <p> *
* Several things are to be considered before adding this command to an * As a counterpart to the access to the source code and rights to copy,
* application: * modify and redistribute granted by the license, users are provided only
* <ul> * with a limited warranty and the software's author, the holder of the
* <li>The commands will be able to run in parallel. * economic rights, and the successive licensors have only limited
* <li>The managing of the commands will be handled through piped systems and * liability.
* buffered in so switching to a forked command will actually print again all *
* the command history to the output console. * In this respect, the user's attention is drawn to the risks associated
* </ul> * with loading, using, modifying and/or developing or reproducing the
* * software by the user in light of its specific status of free software,
* @author Emmanuel Bigeon */ * that may mean that it is complicated to manipulate, and that also
public class CommandForeground extends ParametrizedCommand { * therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
private final TaskPool pool; * encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
/** Add the fork command. * data to be ensured and, more generally, to use and operate it in the
* * same conditions as regards security.
* @param name the command name *
* @param pool The pool to get joinable tasks from */ * The fact that you are presently reading this means that you have had
public CommandForeground(final String name, TaskPool pool) { * knowledge of the CeCILL license and that you accept its terms.
super(name, false); * #L%
this.pool = pool; */
addParameters(); import java.util.List;
}
import net.bigeon.gclc.command.CommandParameters;
/** import net.bigeon.gclc.command.ParametrizedCommand;
* import net.bigeon.gclc.exception.CommandRunException;
*/ import net.bigeon.gclc.exception.CommandRunExceptionType;
private void addParameters() { import net.bigeon.gclc.exception.InvalidParameterException;
try { import net.bigeon.gclc.manager.ConsoleInput;
addStringParameter("pid", false); import net.bigeon.gclc.manager.ConsoleOutput;
addStringParameter("delai", false);
} catch (final InvalidParameterException e) { /** A command that is launched inside an internal terminal.
// TODO Auto-generated catch block * <p>
e.printStackTrace(); * Several things are to be considered before adding this command to an
} * application:
} * <ul>
* <li>The commands will be able to run in parallel.
/* (non-Javadoc) * <li>The managing of the commands will be handled through piped systems and
* @see fr.bigeon.gclc.command.ParametrizedCommand#doExecute(fr.bigeon.gclc. * buffered in so switching to a forked command will actually print again all
* manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput, * the command history to the output console.
* fr.bigeon.gclc.command.CommandParameters) */ * </ul>
@Override *
protected void doExecute(final ConsoleOutput out, final ConsoleInput in, * @author Emmanuel Bigeon */
final CommandParameters parameters) throws CommandRunException { public class CommandForeground extends ParametrizedCommand {
String string = parameters.get("pid");
final List<String> additionals = parameters.getAdditionals(); private final TaskPool pool;
if (string == null && !additionals.isEmpty()) {
string = additionals.get(0); /** Add the fork command.
} *
if (string == null) { * @param name the command name
throw new CommandRunException(CommandRunExceptionType.USAGE, * @param pool The pool to get joinable tasks from */
"Missing process id", this); public CommandForeground(final String name, TaskPool pool) {
} super(name, false);
// Join the command. this.pool = pool;
final Task cmd = pool.get(string); addParameters();
if (!(cmd instanceof ForkTask)) { }
throw new CommandRunException("No such forked process", this);
} /**
long delai = 0; *
final String delaiOpt = parameters.get("delai"); */
if (delaiOpt != null) { private void addParameters() {
delai = Long.parseLong(delaiOpt) * 1000; try {
} addStringParameter("pid", false);
if (delai < 0) { addStringParameter("delai", false);
throw new CommandRunException("Join delai cannot be negative", this); } catch (final InvalidParameterException e) {
} // TODO Auto-generated catch block
((ForkTask) cmd).join(out, in, delai); e.printStackTrace();
} }
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#tip() */ /* (non-Javadoc)
@Override * @see fr.bigeon.gclc.command.ParametrizedCommand#doExecute(fr.bigeon.gclc.
public String tip() { * manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
return "Join the execution of a command, for a given amount of time"; * fr.bigeon.gclc.command.CommandParameters) */
} @Override
protected void doExecute(final ConsoleOutput out, final ConsoleInput in,
/* (non-Javadoc) final CommandParameters parameters) throws CommandRunException {
* @see fr.bigeon.gclc.command.Command#usageDetail() */ String string = parameters.get("pid");
@Override final List<String> additionals = parameters.getAdditionals();
protected String usageDetail() { if (string == null && !additionals.isEmpty()) {
return ""; string = additionals.get(0);
} }
if (string == null) {
/* (non-Javadoc) throw new CommandRunException(CommandRunExceptionType.USAGE,
* @see fr.bigeon.gclc.command.Command#usagePattern() */ "Missing process id");
@Override }
protected String usagePattern() { // Join the command.
return super.usagePattern() + " [(-pid) <id>] ([-delai <delai>])"; final Task cmd = pool.get(string);
} if (!(cmd instanceof ForkTask)) {
} throw new CommandRunException("No such forked process");
}
long delai = 0;
final String delaiOpt = parameters.get("delai");
if (delaiOpt != null) {
delai = Long.parseLong(delaiOpt) * 1000;
}
if (delai < 0) {
throw new CommandRunException("Join delai cannot be negative");
}
((ForkTask) cmd).join(out, in, delai);
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#tip() */
@Override
public String tip() {
return "Join the execution of a command, for a given amount of time";
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#usageDetail() */
@Override
protected String usageDetail() {
return "";
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#usagePattern() */
@Override
protected String usagePattern() {
return super.usagePattern() + " [(-pid) <id>] ([-delai <delai>])";
}
}

271
gclc-process/src/main/java/fr/bigeon/gclc/process/CommandFork.java → gclc-process/src/main/java/net/bigeon/gclc/process/CommandFork.java
View File

@ -1,119 +1,152 @@
/* /*
* process, Distribution repositories and basic setup for Emmanuel Bigeon projects * process, Distribution repositories and basic setup for Emmanuel Bigeon projects
* Copyright (C) 2014-2018 E. Bigeon * Copyright (C) 2014-2018 E. Bigeon
* mailto:emmanuel@bigeon.fr * mailto:emmanuel@bigeon.fr
* *
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/or redistribute the software under the terms of the CeCILL * modify and/or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
* As a counterpart to the access to the source code and rights to copy, * As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only * modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the * with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited * economic rights, and the successive licensors have only limited
* liability. * liability.
* *
* In this respect, the user's attention is drawn to the risks associated * In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the * with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software, * software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also * that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced * therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore * professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their * encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or * requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the * data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security. * same conditions as regards security.
* *
* The fact that you are presently reading this means that you have had * The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc-process:fr.bigeon.gclc.process.CommandFork.java * gclc-process:net.bigeon.gclc.process.CommandFork.java
* Created on: Nov 13, 2017 * Created on: Nov 13, 2017
*/ */
package fr.bigeon.gclc.process; package net.bigeon.gclc.process;
import java.util.Arrays; /*-
* #%L
import fr.bigeon.gclc.command.Command; * process
import fr.bigeon.gclc.command.ICommand; * %%
import fr.bigeon.gclc.command.ICommandProvider; * Copyright (C) 2014 - 2018 Bigeon
import fr.bigeon.gclc.exception.CommandRunException; * %%
import fr.bigeon.gclc.manager.ConsoleInput; * This software is governed by the CeCILL license under French law and
import fr.bigeon.gclc.manager.ConsoleOutput; * abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
/** A command that is launched inside an internal terminal. * license as circulated by CEA, CNRS and INRIA at the following URL
* <p> * "http://www.cecill.info".
* Several things are to be considered before adding this command to an *
* application: * As a counterpart to the access to the source code and rights to copy,
* <ul> * modify and redistribute granted by the license, users are provided only
* <li>The commands will be able to run in parallel. * with a limited warranty and the software's author, the holder of the
* <li>The managing of the commands will be handled through piped systems and * economic rights, and the successive licensors have only limited
* buffered in so switching to a forked command will actually print again all * liability.
* the command history to the output console. *
* </ul> * In this respect, the user's attention is drawn to the risks associated
* * with loading, using, modifying and/or developing or reproducing the
* @author Emmanuel Bigeon */ * software by the user in light of its specific status of free software,
public class CommandFork extends Command { * that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
private final TaskPool pool; * professionals having in-depth computer knowledge. Users are therefore
private final ICommandProvider provider; * encouraged to load and test the software's suitability as regards their
private final int lines; * requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
/** Add the fork command. * same conditions as regards security.
* *
* @param name the command name * The fact that you are presently reading this means that you have had
* @param provider the allowed command collection */ * knowledge of the CeCILL license and that you accept its terms.
public CommandFork(final String name, ICommandProvider provider, TaskPool pool) { * #L%
this(name, provider, pool, -1); */
} import java.util.Arrays;
/** Add the fork command. import net.bigeon.gclc.command.Command;
* import net.bigeon.gclc.command.ICommand;
* @param name the command name import net.bigeon.gclc.command.ICommandProvider;
* @param provider the allowed command collection */ import net.bigeon.gclc.exception.CommandRunException;
public CommandFork(final String name, ICommandProvider provider, TaskPool pool, import net.bigeon.gclc.manager.ConsoleInput;
int lines) { import net.bigeon.gclc.manager.ConsoleOutput;
super(name);
this.provider = provider; /** A command that is launched inside an internal terminal.
this.pool = pool; * <p>
this.lines = lines; * Several things are to be considered before adding this command to an
} * application:
* <ul>
@Override * <li>The commands will be able to run in parallel.
public void execute(final ConsoleOutput out, final ConsoleInput in, String... args) * <li>The managing of the commands will be handled through piped systems and
throws CommandRunException { * buffered in so switching to a forked command will actually print again all
if (args.length < 1) { * the command history to the output console.
throw new CommandRunException("No command to fork", this); * </ul>
} *
final ICommand cmd = provider.get(args[0]); * @author Emmanuel Bigeon */
final String[] inner = Arrays.copyOfRange(args, 1, args.length); public class CommandFork extends Command {
final ForkTask task = new ForkCommandTask(cmd, inner, lines);
final Thread th = new Thread(task); private final TaskPool pool;
pool.add(task); private final ICommandProvider provider;
th.start(); private final int lines;
}
/** Add the fork command.
/* (non-Javadoc) *
* @see fr.bigeon.gclc.command.ICommand#tip() */ * @param name the command name
@Override * @param provider the allowed command collection */
public String tip() { public CommandFork(final String name, ICommandProvider provider, TaskPool pool) {
return "Command background launch"; this(name, provider, pool, -1);
} }
/* (non-Javadoc) /** Add the fork command.
* @see fr.bigeon.gclc.command.Command#usageDetail() */ *
@Override * @param name the command name
protected String usageDetail() { * @param provider the allowed command collection */
return ""; public CommandFork(final String name, ICommandProvider provider, TaskPool pool,
} int lines) {
super(name);
/* (non-Javadoc) this.provider = provider;
* @see fr.bigeon.gclc.command.Command#usagePattern() */ this.pool = pool;
@Override this.lines = lines;
protected String usagePattern() { }
return super.usagePattern() + " <command>";
} @Override
} public void execute(final ConsoleOutput out, final ConsoleInput in, String... args)
throws CommandRunException {
if (args.length < 1) {
throw new CommandRunException("No command to fork");
}
final ICommand cmd = provider.get(args[0]);
final String[] inner = Arrays.copyOfRange(args, 1, args.length);
final ForkTask task = new ForkCommandTask(cmd, inner, lines);
final Thread th = new Thread(task);
pool.add(task);
th.start();
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#tip() */
@Override
public String tip() {
return "Command background launch";
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#usageDetail() */
@Override
protected String usageDetail() {
return "";
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#usagePattern() */
@Override
protected String usagePattern() {
return super.usagePattern() + " <command>";
}
}

179
gclc-process/src/main/java/fr/bigeon/gclc/process/ForkCommandTask.java → gclc-process/src/main/java/net/bigeon/gclc/process/ForkCommandTask.java
View File

@ -1,73 +1,106 @@
/* /*
* process, Distribution repositories and basic setup for Emmanuel Bigeon projects * process, Distribution repositories and basic setup for Emmanuel Bigeon projects
* Copyright (C) 2014-2018 E. Bigeon * Copyright (C) 2014-2018 E. Bigeon
* mailto:emmanuel@bigeon.fr * mailto:emmanuel@bigeon.fr
* *
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/or redistribute the software under the terms of the CeCILL * modify and/or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
* As a counterpart to the access to the source code and rights to copy, * As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only * modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the * with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited * economic rights, and the successive licensors have only limited
* liability. * liability.
* *
* In this respect, the user's attention is drawn to the risks associated * In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the * with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software, * software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also * that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced * therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore * professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their * encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or * requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the * data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security. * same conditions as regards security.
* *
* The fact that you are presently reading this means that you have had * The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* *
*/ */
package fr.bigeon.gclc.process; package net.bigeon.gclc.process;
import java.util.Arrays; /*-
* #%L
import fr.bigeon.gclc.command.ICommand; * process
import fr.bigeon.gclc.exception.CommandRunException; * %%
* Copyright (C) 2014 - 2018 Bigeon
/** * %%
* @author Emmanuel Bigeon * This software is governed by the CeCILL license under French law and
* * abiding by the rules of distribution of free software. You can use,
*/ * modify and/ or redistribute the software under the terms of the CeCILL
public class ForkCommandTask extends ForkTask { * license as circulated by CEA, CNRS and INRIA at the following URL
private final ICommand command; * "http://www.cecill.info".
private final String[] args; *
* As a counterpart to the access to the source code and rights to copy,
/** @param cmd the command * modify and redistribute granted by the license, users are provided only
* @param args the arguements * with a limited warranty and the software's author, the holder of the
* @param lines the number of print to store in the output */ * economic rights, and the successive licensors have only limited
public ForkCommandTask(final ICommand cmd, final String[] args, int lines) { * liability.
super(lines); *
command = cmd; * In this respect, the user's attention is drawn to the risks associated
this.args = Arrays.copyOf(args, args.length); * with loading, using, modifying and/or developing or reproducing the
} * software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
/* (non-Javadoc) * therefore means that it is reserved for developers and experienced
* @see fr.bigeon.gclc.process.Task#getName() */ * professionals having in-depth computer knowledge. Users are therefore
@Override * encouraged to load and test the software's suitability as regards their
public String getName() { * requirements in conditions enabling the security of their systems and/or
return command.getCommandName(); * data to be ensured and, more generally, to use and operate it in the
} * same conditions as regards security.
*
/* (non-Javadoc) * The fact that you are presently reading this means that you have had
* @see fr.bigeon.gclc.process.ForkTask#doRun() */ * knowledge of the CeCILL license and that you accept its terms.
@Override * #L%
protected void doRun() throws CommandRunException { */
command.execute(out, in, args); import java.util.Arrays;
}
import net.bigeon.gclc.command.ICommand;
} import net.bigeon.gclc.exception.CommandRunException;
/**
* @author Emmanuel Bigeon
*
*/
public class ForkCommandTask extends ForkTask {
private final ICommand command;
private final String[] args;
/** @param cmd the command
* @param args the arguements
* @param lines the number of print to store in the output */
public ForkCommandTask(final ICommand cmd, final String[] args, int lines) {
super(lines);
command = cmd;
this.args = Arrays.copyOf(args, args.length);
}
/* (non-Javadoc)
* @see net.bigeon.gclc.process.Task#getName() */
@Override
public String getName() {
return command.getCommandName();
}
/* (non-Javadoc)
* @see net.bigeon.gclc.process.ForkTask#doRun() */
@Override
protected void doRun() throws CommandRunException {
command.execute(out, in, args);
}
}

343
gclc-process/src/main/java/fr/bigeon/gclc/process/ForkTask.java → gclc-process/src/main/java/net/bigeon/gclc/process/ForkTask.java
View File

@ -1,155 +1,188 @@
/* /*
* process, Distribution repositories and basic setup for Emmanuel Bigeon projects * process, Distribution repositories and basic setup for Emmanuel Bigeon projects
* Copyright (C) 2014-2018 E. Bigeon * Copyright (C) 2014-2018 E. Bigeon
* mailto:emmanuel@bigeon.fr * mailto:emmanuel@bigeon.fr
* *
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/or redistribute the software under the terms of the CeCILL * modify and/or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
* As a counterpart to the access to the source code and rights to copy, * As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only * modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the * with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited * economic rights, and the successive licensors have only limited
* liability. * liability.
* *
* In this respect, the user's attention is drawn to the risks associated * In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the * with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software, * software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also * that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced * therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore * professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their * encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or * requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the * data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security. * same conditions as regards security.
* *
* The fact that you are presently reading this means that you have had * The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc-process:fr.bigeon.gclc.process.ForkTask.java * gclc-process:net.bigeon.gclc.process.ForkTask.java
* Created on: Nov 13, 2017 * Created on: Nov 13, 2017
*/ */
package fr.bigeon.gclc.process; package net.bigeon.gclc.process;
import java.util.HashSet; /*-
import java.util.Set; * #%L
* process
import fr.bigeon.gclc.exception.CommandRunException; * %%
import fr.bigeon.gclc.manager.ConsoleInput; * Copyright (C) 2014 - 2018 Bigeon
import fr.bigeon.gclc.manager.ConsoleOutput; * %%
import fr.bigeon.gclc.process.io.ConnectingConsoleInput; * This software is governed by the CeCILL license under French law and
import fr.bigeon.gclc.process.io.ConnectingConsoleOutput; * abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
/** * license as circulated by CEA, CNRS and INRIA at the following URL
* <p> * "http://www.cecill.info".
* TODO *
* * As a counterpart to the access to the source code and rights to copy,
* @author Emmanuel Bigeon */ * modify and redistribute granted by the license, users are provided only
public abstract class ForkTask implements Task { * with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
private final Set<InterruptionListener> listeners = new HashSet<>(); * liability.
private boolean running = false; *
* In this respect, the user's attention is drawn to the risks associated
protected final ConnectingConsoleInput in = new ConnectingConsoleInput(); * with loading, using, modifying and/or developing or reproducing the
protected final ConnectingConsoleOutput out; * software by the user in light of its specific status of free software,
private CommandRunException exception; * that may mean that it is complicated to manipulate, and that also
private final Object runLock = new Object(); * therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
/** @param lines the number of print to store in the output */ * encouraged to load and test the software's suitability as regards their
public ForkTask(int lines) { * requirements in conditions enabling the security of their systems and/or
out = new ConnectingConsoleOutput(ConnectingConsoleOutput.PERSIST, lines); * data to be ensured and, more generally, to use and operate it in the
} * same conditions as regards security.
*
/* (non-Javadoc) * The fact that you are presently reading this means that you have had
* @see fr.bigeon.gclc.process.Task#addInterruptionListener(fr.bigeon.gclc. * knowledge of the CeCILL license and that you accept its terms.
* process.InterruptionListener) */ * #L%
@Override */
public final void addInterruptionListener(final InterruptionListener listener) { import java.util.HashSet;
listeners.add(listener); import java.util.Set;
}
import net.bigeon.gclc.exception.CommandRunException;
/* (non-Javadoc) import net.bigeon.gclc.manager.ConsoleInput;
* @see fr.bigeon.gclc.process.Task#isRunning() */ import net.bigeon.gclc.manager.ConsoleOutput;
@Override import net.bigeon.gclc.process.io.ConnectingConsoleInput;
public final boolean isRunning() { import net.bigeon.gclc.process.io.ConnectingConsoleOutput;
synchronized (runLock) {
return running; /**
} * <p>
} * TODO
*
/** @param out the console output * @author Emmanuel Bigeon */
* @param in the console input public abstract class ForkTask implements Task {
* @param timeout the maximal wait (0 for ever) */
public final void join(final ConsoleOutput out, final ConsoleInput in, long timeout) { private final Set<InterruptionListener> listeners = new HashSet<>();
synchronized (runLock) { private boolean running = false;
this.out.connect(out);
this.in.connect(in); protected final ConnectingConsoleInput in = new ConnectingConsoleInput();
try { protected final ConnectingConsoleOutput out;
if (running) { private CommandRunException exception;
runLock.wait(timeout); private final Object runLock = new Object();
}
} catch (final InterruptedException e) { /** @param lines the number of print to store in the output */
// TODO log. public ForkTask(int lines) {
Thread.currentThread().interrupt(); out = new ConnectingConsoleOutput(ConnectingConsoleOutput.PERSIST, lines);
} }
this.out.disconnect();
this.in.disconnect(); /* (non-Javadoc)
} * @see net.bigeon.gclc.process.Task#addInterruptionListener(fr.bigeon.gclc.
} * process.InterruptionListener) */
@Override
/* (non-Javadoc) public final void addInterruptionListener(final InterruptionListener listener) {
* @see listeners.add(listener);
* fr.bigeon.gclc.process.Task#rmInterruptionListener(fr.bigeon.gclc.process }
* .InterruptionListener) */
@Override /* (non-Javadoc)
public final void rmInterruptionListener(final InterruptionListener listener) { * @see net.bigeon.gclc.process.Task#isRunning() */
listeners.remove(listener); @Override
} public final boolean isRunning() {
synchronized (runLock) {
/* (non-Javadoc) return running;
* @see java.lang.Runnable#run() */ }
@Override }
public final void run() {
synchronized (runLock) { /** @param out the console output
running = true; * @param in the console input
} * @param timeout the maximal wait (0 for ever) */
try { public final void join(final ConsoleOutput out, final ConsoleInput in, long timeout) {
doRun(); synchronized (runLock) {
} catch (final CommandRunException e) { this.out.connect(out);
exception = e; this.in.connect(in);
} finally { try {
setRunning(false); if (running) {
} runLock.wait(timeout);
for (final InterruptionListener interruptionListener : listeners) { }
interruptionListener.interrupted(); } catch (final InterruptedException e) {
} // TODO log.
} Thread.currentThread().interrupt();
}
/** Actually run the fork. */ this.out.disconnect();
protected abstract void doRun() throws CommandRunException; this.in.disconnect();
}
/** Get the excepion that caused a failure. }
*
* @return the exception */ /* (non-Javadoc)
public final CommandRunException getException() { * @see
return exception; * net.bigeon.gclc.process.Task#rmInterruptionListener(net.bigeon.gclc.process
} * .InterruptionListener) */
@Override
/* (non-Javadoc) public final void rmInterruptionListener(final InterruptionListener listener) {
* @see fr.bigeon.gclc.process.Task#setRunning(boolean) */ listeners.remove(listener);
@Override }
public final void setRunning(final boolean running) {
synchronized (runLock) { /* (non-Javadoc)
this.running = running; * @see java.lang.Runnable#run() */
runLock.notifyAll(); @Override
} public final void run() {
} synchronized (runLock) {
running = true;
protected final Object getRunningLock() { }
return runLock; try {
} doRun();
} } catch (final CommandRunException e) {
exception = e;
} finally {
setRunning(false);
}
for (final InterruptionListener interruptionListener : listeners) {
interruptionListener.interrupted();
}
}
/** Actually run the fork. */
protected abstract void doRun() throws CommandRunException;
/** Get the excepion that caused a failure.
*
* @return the exception */
public final CommandRunException getException() {
return exception;
}
/* (non-Javadoc)
* @see net.bigeon.gclc.process.Task#setRunning(boolean) */
@Override
public final void setRunning(final boolean running) {
synchronized (runLock) {
this.running = running;
runLock.notifyAll();
}
}
protected final Object getRunningLock() {
return runLock;
}
}

121
gclc-process/src/main/java/fr/bigeon/gclc/process/InterruptionListener.java → gclc-process/src/main/java/net/bigeon/gclc/process/InterruptionListener.java
View File

@ -1,44 +1,77 @@
/* /*
* process, Distribution repositories and basic setup for Emmanuel Bigeon projects * process, Distribution repositories and basic setup for Emmanuel Bigeon projects
* Copyright (C) 2014-2018 E. Bigeon * Copyright (C) 2014-2018 E. Bigeon
* mailto:emmanuel@bigeon.fr * mailto:emmanuel@bigeon.fr
* *
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/or redistribute the software under the terms of the CeCILL * modify and/or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
* As a counterpart to the access to the source code and rights to copy, * As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only * modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the * with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited * economic rights, and the successive licensors have only limited
* liability. * liability.
* *
* In this respect, the user's attention is drawn to the risks associated * In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the * with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software, * software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also * that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced * therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore * professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their * encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or * requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the * data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security. * same conditions as regards security.
* *
* The fact that you are presently reading this means that you have had * The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc:fr.bigeon.gclc.proc.InterruptionListener.java * gclc:fr.bigeon.gclc.proc.InterruptionListener.java
* Created on: May 10, 2017 * Created on: May 10, 2017
*/ */
package fr.bigeon.gclc.process; package net.bigeon.gclc.process;
/** A listener for interruption /*-
* * #%L
* @author Emmanuel Bigeon */ * process
public interface InterruptionListener { * %%
/** Notification of an interuption of a listened object */ * Copyright (C) 2014 - 2018 Bigeon
void interrupted(); * %%
} * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
/** A listener for interruption
*
* @author Emmanuel Bigeon */
public interface InterruptionListener {
/** Notification of an interuption of a listened object */
void interrupted();
}

161
gclc-process/src/main/java/fr/bigeon/gclc/process/ProcessAttachement.java → gclc-process/src/main/java/net/bigeon/gclc/process/ProcessAttachement.java
View File

@ -1,64 +1,97 @@
/* /*
* process, Distribution repositories and basic setup for Emmanuel Bigeon projects * process, Distribution repositories and basic setup for Emmanuel Bigeon projects
* Copyright (C) 2014-2018 E. Bigeon * Copyright (C) 2014-2018 E. Bigeon
* mailto:emmanuel@bigeon.fr * mailto:emmanuel@bigeon.fr
* *
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/or redistribute the software under the terms of the CeCILL * modify and/or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
* As a counterpart to the access to the source code and rights to copy, * As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only * modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the * with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited * economic rights, and the successive licensors have only limited
* liability. * liability.
* *
* In this respect, the user's attention is drawn to the risks associated * In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the * with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software, * software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also * that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced * therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore * professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their * encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or * requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the * data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security. * same conditions as regards security.
* *
* The fact that you are presently reading this means that you have had * The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* *
*/ */
package fr.bigeon.gclc.process; package net.bigeon.gclc.process;
import fr.bigeon.gclc.ApplicationAttachement; /*-
import fr.bigeon.gclc.command.ICommandProvider; * #%L
import fr.bigeon.gclc.exception.InvalidCommandName; * process
* %%
/** * Copyright (C) 2014 - 2018 Bigeon
* @author Emmanuel Bigeon * %%
* * This software is governed by the CeCILL license under French law and
*/ * abiding by the rules of distribution of free software. You can use,
public class ProcessAttachement implements ApplicationAttachement { * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
private final TaskPool pool; * "http://www.cecill.info".
*
/** @param pool the task pool to manage */ * As a counterpart to the access to the source code and rights to copy,
public ProcessAttachement(TaskPool pool) { * modify and redistribute granted by the license, users are provided only
super(); * with a limited warranty and the software's author, the holder of the
this.pool = pool; * economic rights, and the successive licensors have only limited
} * liability.
*
/* (non-Javadoc) * In this respect, the user's attention is drawn to the risks associated
* @see fr.bigeon.gclc.ApplicationAttachement#attach(fr.bigeon.gclc.ConsoleApplication) * with loading, using, modifying and/or developing or reproducing the
*/ * software by the user in light of its specific status of free software,
@Override * that may mean that it is complicated to manipulate, and that also
public void attach(ICommandProvider application) throws InvalidCommandName { * therefore means that it is reserved for developers and experienced
application.add(new ProcessKill("kill", pool)); * professionals having in-depth computer knowledge. Users are therefore
application.add(new ProcessList("list", pool)); * encouraged to load and test the software's suitability as regards their
} * requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
} * same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import net.bigeon.gclc.ApplicationAttachement;
import net.bigeon.gclc.command.ICommandProvider;
import net.bigeon.gclc.exception.InvalidCommandName;
/**
* @author Emmanuel Bigeon
*
*/
public class ProcessAttachement implements ApplicationAttachement {
private final TaskPool pool;
/** @param pool the task pool to manage */
public ProcessAttachement(TaskPool pool) {
super();
this.pool = pool;
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.ApplicationAttachement#attach(fr.bigeon.gclc.ConsoleApplication)
*/
@Override
public void attach(ICommandProvider application) throws InvalidCommandName {
application.add(new ProcessKill("kill", pool));
application.add(new ProcessList("list", pool));
}
}

207
gclc-process/src/main/java/fr/bigeon/gclc/process/ProcessClear.java → gclc-process/src/main/java/net/bigeon/gclc/process/ProcessClear.java
View File

@ -1,87 +1,120 @@
/* /*
* process, Distribution repositories and basic setup for Emmanuel Bigeon projects * process, Distribution repositories and basic setup for Emmanuel Bigeon projects
* Copyright (C) 2014-2018 E. Bigeon * Copyright (C) 2014-2018 E. Bigeon
* mailto:emmanuel@bigeon.fr * mailto:emmanuel@bigeon.fr
* *
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/or redistribute the software under the terms of the CeCILL * modify and/or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
* As a counterpart to the access to the source code and rights to copy, * As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only * modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the * with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited * economic rights, and the successive licensors have only limited
* liability. * liability.
* *
* In this respect, the user's attention is drawn to the risks associated * In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the * with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software, * software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also * that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced * therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore * professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their * encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or * requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the * data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security. * same conditions as regards security.
* *
* The fact that you are presently reading this means that you have had * The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc:fr.bigeon.gclc.proc.ProcessList.java * gclc:fr.bigeon.gclc.proc.ProcessList.java
* Created on: May 10, 2017 * Created on: May 10, 2017
*/ */
package fr.bigeon.gclc.process; package net.bigeon.gclc.process;
import fr.bigeon.gclc.command.Command; /*-
import fr.bigeon.gclc.exception.CommandRunException; * #%L
import fr.bigeon.gclc.manager.ConsoleInput; * process
import fr.bigeon.gclc.manager.ConsoleOutput; * %%
* Copyright (C) 2014 - 2018 Bigeon
/** A command that will flag a task to stop * %%
* * This software is governed by the CeCILL license under French law and
* @author Emmanuel Bigeon */ * abiding by the rules of distribution of free software. You can use,
public final class ProcessClear extends Command { * modify and/ or redistribute the software under the terms of the CeCILL
/** The taskpool */ * license as circulated by CEA, CNRS and INRIA at the following URL
private final TaskPool pool; * "http://www.cecill.info".
*
/** @param name the command name * As a counterpart to the access to the source code and rights to copy,
* @param pool the pool */ * modify and redistribute granted by the license, users are provided only
public ProcessClear(final String name, final TaskPool pool) { * with a limited warranty and the software's author, the holder of the
super(name); * economic rights, and the successive licensors have only limited
this.pool = pool; * liability.
} *
* In this respect, the user's attention is drawn to the risks associated
/* (non-Javadoc) * with loading, using, modifying and/or developing or reproducing the
* @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.manager. * software by the user in light of its specific status of free software,
* ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput, * that may mean that it is complicated to manipulate, and that also
* java.lang.String[]) */ * therefore means that it is reserved for developers and experienced
@Override * professionals having in-depth computer knowledge. Users are therefore
public void execute(final ConsoleOutput out, final ConsoleInput in, * encouraged to load and test the software's suitability as regards their
final String... args) throws CommandRunException { * requirements in conditions enabling the security of their systems and/or
for (final String id : pool.getPIDs()) { * data to be ensured and, more generally, to use and operate it in the
if (!pool.get(id).isRunning()) { * same conditions as regards security.
pool.remove(id); *
} * The fact that you are presently reading this means that you have had
} * knowledge of the CeCILL license and that you accept its terms.
return; * #L%
} */
import net.bigeon.gclc.command.Command;
/* (non-Javadoc) import net.bigeon.gclc.exception.CommandRunException;
* @see fr.bigeon.gclc.command.ICommand#tip() */ import net.bigeon.gclc.manager.ConsoleInput;
@SuppressWarnings("nls") import net.bigeon.gclc.manager.ConsoleOutput;
@Override
public String tip() { /** A command that will flag a task to stop
return "Request a process to stop (softly)"; *
} * @author Emmanuel Bigeon */
public final class ProcessClear extends Command {
/* (non-Javadoc) /** The taskpool */
* @see fr.bigeon.gclc.command.Command#usageDetail() */ private final TaskPool pool;
@Override
protected String usageDetail() { /** @param name the command name
return null; * @param pool the pool */
} public ProcessClear(final String name, final TaskPool pool) {
super(name);
} this.pool = pool;
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.manager.
* ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
* java.lang.String[]) */
@Override
public void execute(final ConsoleOutput out, final ConsoleInput in,
final String... args) throws CommandRunException {
for (final String id : pool.getPIDs()) {
if (!pool.get(id).isRunning()) {
pool.remove(id);
}
}
return;
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#tip() */
@SuppressWarnings("nls")
@Override
public String tip() {
return "Request a process to stop (softly)";
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#usageDetail() */
@Override
protected String usageDetail() {
return null;
}
}

197
gclc-process/src/main/java/fr/bigeon/gclc/process/ProcessKill.java → gclc-process/src/main/java/net/bigeon/gclc/process/ProcessKill.java
View File

@ -1,82 +1,115 @@
/* /*
* process, Distribution repositories and basic setup for Emmanuel Bigeon projects * process, Distribution repositories and basic setup for Emmanuel Bigeon projects
* Copyright (C) 2014-2018 E. Bigeon * Copyright (C) 2014-2018 E. Bigeon
* mailto:emmanuel@bigeon.fr * mailto:emmanuel@bigeon.fr
* *
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/or redistribute the software under the terms of the CeCILL * modify and/or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
* As a counterpart to the access to the source code and rights to copy, * As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only * modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the * with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited * economic rights, and the successive licensors have only limited
* liability. * liability.
* *
* In this respect, the user's attention is drawn to the risks associated * In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the * with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software, * software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also * that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced * therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore * professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their * encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or * requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the * data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security. * same conditions as regards security.
* *
* The fact that you are presently reading this means that you have had * The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc:fr.bigeon.gclc.proc.ProcessList.java * gclc:fr.bigeon.gclc.proc.ProcessList.java
* Created on: May 10, 2017 * Created on: May 10, 2017
*/ */
package fr.bigeon.gclc.process; package net.bigeon.gclc.process;
import fr.bigeon.gclc.command.Command; /*-
import fr.bigeon.gclc.exception.CommandRunException; * #%L
import fr.bigeon.gclc.manager.ConsoleInput; * process
import fr.bigeon.gclc.manager.ConsoleOutput; * %%
* Copyright (C) 2014 - 2018 Bigeon
/** A command that will flag a task to stop * %%
* * This software is governed by the CeCILL license under French law and
* @author Emmanuel Bigeon */ * abiding by the rules of distribution of free software. You can use,
public final class ProcessKill extends Command { * modify and/ or redistribute the software under the terms of the CeCILL
/** The taskpool */ * license as circulated by CEA, CNRS and INRIA at the following URL
private final TaskPool pool; * "http://www.cecill.info".
*
/** @param name the command name * As a counterpart to the access to the source code and rights to copy,
* @param pool the pool */ * modify and redistribute granted by the license, users are provided only
public ProcessKill(final String name, final TaskPool pool) { * with a limited warranty and the software's author, the holder of the
super(name); * economic rights, and the successive licensors have only limited
this.pool = pool; * liability.
} *
* In this respect, the user's attention is drawn to the risks associated
/* (non-Javadoc) * with loading, using, modifying and/or developing or reproducing the
* @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.manager. * software by the user in light of its specific status of free software,
* ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput, * that may mean that it is complicated to manipulate, and that also
* java.lang.String[]) */ * therefore means that it is reserved for developers and experienced
@Override * professionals having in-depth computer knowledge. Users are therefore
public void execute(final ConsoleOutput out, final ConsoleInput in, * encouraged to load and test the software's suitability as regards their
final String... args) throws CommandRunException { * requirements in conditions enabling the security of their systems and/or
pool.get(args[0]).setRunning(false); * data to be ensured and, more generally, to use and operate it in the
} * same conditions as regards security.
*
/* (non-Javadoc) * The fact that you are presently reading this means that you have had
* @see fr.bigeon.gclc.command.ICommand#tip() */ * knowledge of the CeCILL license and that you accept its terms.
@SuppressWarnings("nls") * #L%
@Override */
public String tip() { import net.bigeon.gclc.command.Command;
return "Request a process to stop (softly)"; import net.bigeon.gclc.exception.CommandRunException;
} import net.bigeon.gclc.manager.ConsoleInput;
import net.bigeon.gclc.manager.ConsoleOutput;
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#usageDetail() */ /** A command that will flag a task to stop
@Override *
protected String usageDetail() { * @author Emmanuel Bigeon */
return null; public final class ProcessKill extends Command {
} /** The taskpool */
private final TaskPool pool;
}
/** @param name the command name
* @param pool the pool */
public ProcessKill(final String name, final TaskPool pool) {
super(name);
this.pool = pool;
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.manager.
* ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
* java.lang.String[]) */
@Override
public void execute(final ConsoleOutput out, final ConsoleInput in,
final String... args) throws CommandRunException {
pool.get(args[0]).setRunning(false);
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#tip() */
@SuppressWarnings("nls")
@Override
public String tip() {
return "Request a process to stop (softly)";
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#usageDetail() */
@Override
protected String usageDetail() {
return null;
}
}

233
gclc-process/src/main/java/fr/bigeon/gclc/process/ProcessList.java → gclc-process/src/main/java/net/bigeon/gclc/process/ProcessList.java
View File

@ -1,100 +1,133 @@
/* /*
* process, Distribution repositories and basic setup for Emmanuel Bigeon projects * process, Distribution repositories and basic setup for Emmanuel Bigeon projects
* Copyright (C) 2014-2018 E. Bigeon * Copyright (C) 2014-2018 E. Bigeon
* mailto:emmanuel@bigeon.fr * mailto:emmanuel@bigeon.fr
* *
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/or redistribute the software under the terms of the CeCILL * modify and/or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
* As a counterpart to the access to the source code and rights to copy, * As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only * modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the * with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited * economic rights, and the successive licensors have only limited
* liability. * liability.
* *
* In this respect, the user's attention is drawn to the risks associated * In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the * with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software, * software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also * that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced * therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore * professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their * encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or * requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the * data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security. * same conditions as regards security.
* *
* The fact that you are presently reading this means that you have had * The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc:fr.bigeon.gclc.proc.ProcessList.java * gclc:fr.bigeon.gclc.proc.ProcessList.java
* Created on: May 10, 2017 * Created on: May 10, 2017
*/ */
package fr.bigeon.gclc.process; package net.bigeon.gclc.process;
import java.io.IOException; /*-
import java.text.MessageFormat; * #%L
import java.util.ArrayList; * process
import java.util.Collections; * %%
* Copyright (C) 2014 - 2018 Bigeon
import fr.bigeon.gclc.command.Command; * %%
import fr.bigeon.gclc.exception.CommandRunException; * This software is governed by the CeCILL license under French law and
import fr.bigeon.gclc.exception.CommandRunExceptionType; * abiding by the rules of distribution of free software. You can use,
import fr.bigeon.gclc.manager.ConsoleInput; * modify and/ or redistribute the software under the terms of the CeCILL
import fr.bigeon.gclc.manager.ConsoleOutput; * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
/** A command to list current processes *
* * As a counterpart to the access to the source code and rights to copy,
* @author Emmanuel Bigeon */ * modify and redistribute granted by the license, users are provided only
public final class ProcessList extends Command { * with a limited warranty and the software's author, the holder of the
/** The process pool */ * economic rights, and the successive licensors have only limited
private final TaskPool pool; * liability.
*
/** @param name the command name * In this respect, the user's attention is drawn to the risks associated
* @param pool the pool */ * with loading, using, modifying and/or developing or reproducing the
public ProcessList(final String name, final TaskPool pool) { * software by the user in light of its specific status of free software,
super(name); * that may mean that it is complicated to manipulate, and that also
this.pool = pool; * therefore means that it is reserved for developers and experienced
} * professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
/* (non-Javadoc) * requirements in conditions enabling the security of their systems and/or
* @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.manager. * data to be ensured and, more generally, to use and operate it in the
* ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput, * same conditions as regards security.
* java.lang.String[]) */ *
@Override * The fact that you are presently reading this means that you have had
public void execute(final ConsoleOutput out, final ConsoleInput in, * knowledge of the CeCILL license and that you accept its terms.
final String... args) throws CommandRunException { * #L%
final ArrayList<String> pids = new ArrayList<>(pool.getPIDs()); */
Collections.sort(pids); import java.io.IOException;
for (final String string : pids) { import java.text.MessageFormat;
try { import java.util.ArrayList;
out.println(MessageFormat.format("{0}\t{1}", string, //$NON-NLS-1$ import java.util.Collections;
pool.get(string).getName()));
} catch (final IOException e) { import net.bigeon.gclc.command.Command;
throw new CommandRunException( import net.bigeon.gclc.exception.CommandRunException;
CommandRunExceptionType.INTERACTION, import net.bigeon.gclc.exception.CommandRunExceptionType;
"Unable to communicate with user", e, this); //$NON-NLS-1$ import net.bigeon.gclc.manager.ConsoleInput;
} import net.bigeon.gclc.manager.ConsoleOutput;
}
/** A command to list current processes
} *
* @author Emmanuel Bigeon */
/* (non-Javadoc) public final class ProcessList extends Command {
* @see fr.bigeon.gclc.command.ICommand#tip() */ /** The process pool */
@SuppressWarnings("nls") private final TaskPool pool;
@Override
public String tip() { /** @param name the command name
return "List all processes"; * @param pool the pool */
} public ProcessList(final String name, final TaskPool pool) {
super(name);
/* (non-Javadoc) this.pool = pool;
* @see fr.bigeon.gclc.command.Command#usageDetail() */ }
@Override
protected String usageDetail() { /* (non-Javadoc)
return null; * @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.manager.
} * ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
* java.lang.String[]) */
} @Override
public void execute(final ConsoleOutput out, final ConsoleInput in,
final String... args) throws CommandRunException {
final ArrayList<String> pids = new ArrayList<>(pool.getPIDs());
Collections.sort(pids);
for (final String string : pids) {
try {
out.println(MessageFormat.format("{0}\t{1}", string, //$NON-NLS-1$
pool.get(string).getName()));
} catch (final IOException e) {
throw new CommandRunException(
CommandRunExceptionType.INTERACTION,
"Unable to communicate with user", e); //$NON-NLS-1$
}
}
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#tip() */
@SuppressWarnings("nls")
@Override
public String tip() {
return "List all processes";
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#usageDetail() */
@Override
protected String usageDetail() {
return null;
}
}

163
gclc-process/src/main/java/fr/bigeon/gclc/process/ScreenAttachement.java → gclc-process/src/main/java/net/bigeon/gclc/process/ScreenAttachement.java
View File

@ -1,65 +1,98 @@
/* /*
* process, Distribution repositories and basic setup for Emmanuel Bigeon projects * process, Distribution repositories and basic setup for Emmanuel Bigeon projects
* Copyright (C) 2014-2018 E. Bigeon * Copyright (C) 2014-2018 E. Bigeon
* mailto:emmanuel@bigeon.fr * mailto:emmanuel@bigeon.fr
* *
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/or redistribute the software under the terms of the CeCILL * modify and/or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
* As a counterpart to the access to the source code and rights to copy, * As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only * modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the * with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited * economic rights, and the successive licensors have only limited
* liability. * liability.
* *
* In this respect, the user's attention is drawn to the risks associated * In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the * with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software, * software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also * that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced * therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore * professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their * encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or * requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the * data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security. * same conditions as regards security.
* *
* The fact that you are presently reading this means that you have had * The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* *
*/ */
package fr.bigeon.gclc.process; package net.bigeon.gclc.process;
import fr.bigeon.gclc.ApplicationAttachement; /*-
import fr.bigeon.gclc.command.ICommandProvider; * #%L
import fr.bigeon.gclc.exception.InvalidCommandName; * process
* %%
/** @author Emmanuel Bigeon */ * Copyright (C) 2014 - 2018 Bigeon
public class ScreenAttachement implements ApplicationAttachement { * %%
* This software is governed by the CeCILL license under French law and
private final TaskPool pool; * abiding by the rules of distribution of free software. You can use,
private final int lines; * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
/** @param pool the task pool to manage */ * "http://www.cecill.info".
public ScreenAttachement(TaskPool pool, int lines) { *
super(); * As a counterpart to the access to the source code and rights to copy,
this.pool = pool; * modify and redistribute granted by the license, users are provided only
this.lines = lines; * with a limited warranty and the software's author, the holder of the
} * economic rights, and the successive licensors have only limited
* liability.
/* (non-Javadoc) *
* @see fr.bigeon.gclc.ApplicationAttachement#attach(fr.bigeon.gclc. * In this respect, the user's attention is drawn to the risks associated
* ConsoleApplication) */ * with loading, using, modifying and/or developing or reproducing the
@Override * software by the user in light of its specific status of free software,
public void attach(ICommandProvider application) throws InvalidCommandName { * that may mean that it is complicated to manipulate, and that also
application.add(new ProcessKill("terminate", pool)); * therefore means that it is reserved for developers and experienced
application.add(new ProcessList("list", pool)); * professionals having in-depth computer knowledge. Users are therefore
application.add(new ProcessClear("clear", pool)); * encouraged to load and test the software's suitability as regards their
application.add(new CommandForeground("fg", pool)); * requirements in conditions enabling the security of their systems and/or
application.add(new CommandFork("fork", application, pool, lines)); * data to be ensured and, more generally, to use and operate it in the
} * same conditions as regards security.
} *
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import net.bigeon.gclc.ApplicationAttachement;
import net.bigeon.gclc.command.ICommandProvider;
import net.bigeon.gclc.exception.InvalidCommandName;
/** @author Emmanuel Bigeon */
public class ScreenAttachement implements ApplicationAttachement {
private final TaskPool pool;
private final int lines;
/** @param pool the task pool to manage */
public ScreenAttachement(TaskPool pool, int lines) {
super();
this.pool = pool;
this.lines = lines;
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.ApplicationAttachement#attach(fr.bigeon.gclc.
* ConsoleApplication) */
@Override
public void attach(ICommandProvider application) throws InvalidCommandName {
application.add(new ProcessKill("terminate", pool));
application.add(new ProcessList("list", pool));
application.add(new ProcessClear("clear", pool));
application.add(new CommandForeground("fg", pool));
application.add(new CommandFork("fork", application, pool, lines));
}
}

189
gclc-process/src/main/java/fr/bigeon/gclc/process/Task.java → gclc-process/src/main/java/net/bigeon/gclc/process/Task.java
View File

@ -1,78 +1,111 @@
/* /*
* process, Distribution repositories and basic setup for Emmanuel Bigeon projects * process, Distribution repositories and basic setup for Emmanuel Bigeon projects
* Copyright (C) 2014-2018 E. Bigeon * Copyright (C) 2014-2018 E. Bigeon
* mailto:emmanuel@bigeon.fr * mailto:emmanuel@bigeon.fr
* *
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/or redistribute the software under the terms of the CeCILL * modify and/or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
* As a counterpart to the access to the source code and rights to copy, * As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only * modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the * with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited * economic rights, and the successive licensors have only limited
* liability. * liability.
* *
* In this respect, the user's attention is drawn to the risks associated * In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the * with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software, * software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also * that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced * therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore * professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their * encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or * requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the * data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security. * same conditions as regards security.
* *
* The fact that you are presently reading this means that you have had * The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc:fr.bigeon.gclc.proc.ThreadCommand.java * gclc:fr.bigeon.gclc.proc.ThreadCommand.java
* Created on: May 10, 2017 * Created on: May 10, 2017
*/ */
package fr.bigeon.gclc.process; package net.bigeon.gclc.process;
/** Tasks are named runnable that can be interrupted. /*-
* <p> * #%L
* Good practice for those objects include an absence of interaction with the * process
* user (otherwise the user may not know from which running command comes * %%
* information and requests) and unicity of the object to have a coherent * Copyright (C) 2014 - 2018 Bigeon
* control through the {@link #setRunning(boolean)} method. * %%
* <p> * This software is governed by the CeCILL license under French law and
* Typical cases where such command can be useful is for an application that * abiding by the rules of distribution of free software. You can use,
* does long computations. * modify and/ or redistribute the software under the terms of the CeCILL
* * license as circulated by CEA, CNRS and INRIA at the following URL
* @author Emmanuel Bigeon */ * "http://www.cecill.info".
public interface Task extends Runnable { *
/** Add a listener for this command end of execution * As a counterpart to the access to the source code and rights to copy,
* * modify and redistribute granted by the license, users are provided only
* @param listener the listener */ * with a limited warranty and the software's author, the holder of the
void addInterruptionListener(InterruptionListener listener); * economic rights, and the successive licensors have only limited
* liability.
/** Get the task name. *
* * In this respect, the user's attention is drawn to the risks associated
* @return the task name */ * with loading, using, modifying and/or developing or reproducing the
String getName(); * software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
/** Test the running status of the task. * therefore means that it is reserved for developers and experienced
* * professionals having in-depth computer knowledge. Users are therefore
* @return if the command is supposed to be running */ * encouraged to load and test the software's suitability as regards their
boolean isRunning(); * requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
/** Remove a listener of this command end of execution * same conditions as regards security.
* *
* @param listener the listener */ * The fact that you are presently reading this means that you have had
void rmInterruptionListener(InterruptionListener listener); * knowledge of the CeCILL license and that you accept its terms.
* #L%
/** Set the running state. */
* <p> /** Tasks are named runnable that can be interrupted.
* This method should be only called by external objects with the false * <p>
* argument. Calling this method with true has unspecified behavior and * Good practice for those objects include an absence of interaction with the
* could do nothing as well as restart the command for example. * user (otherwise the user may not know from which running command comes
* * information and requests) and unicity of the object to have a coherent
* @param running the running state */ * control through the {@link #setRunning(boolean)} method.
void setRunning(boolean running); * <p>
} * Typical cases where such command can be useful is for an application that
* does long computations.
*
* @author Emmanuel Bigeon */
public interface Task extends Runnable {
/** Add a listener for this command end of execution
*
* @param listener the listener */
void addInterruptionListener(InterruptionListener listener);
/** Get the task name.
*
* @return the task name */
String getName();
/** Test the running status of the task.
*
* @return if the command is supposed to be running */
boolean isRunning();
/** Remove a listener of this command end of execution
*
* @param listener the listener */
void rmInterruptionListener(InterruptionListener listener);
/** Set the running state.
* <p>
* This method should be only called by external objects with the false
* argument. Calling this method with true has unspecified behavior and
* could do nothing as well as restart the command for example.
*
* @param running the running state */
void setRunning(boolean running);
}

331
gclc-process/src/main/java/fr/bigeon/gclc/process/TaskPool.java → gclc-process/src/main/java/net/bigeon/gclc/process/TaskPool.java
View File

@ -1,149 +1,182 @@
/* /*
* process, Distribution repositories and basic setup for Emmanuel Bigeon projects * process, Distribution repositories and basic setup for Emmanuel Bigeon projects
* Copyright (C) 2014-2018 E. Bigeon * Copyright (C) 2014-2018 E. Bigeon
* mailto:emmanuel@bigeon.fr * mailto:emmanuel@bigeon.fr
* *
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/or redistribute the software under the terms of the CeCILL * modify and/or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
* As a counterpart to the access to the source code and rights to copy, * As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only * modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the * with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited * economic rights, and the successive licensors have only limited
* liability. * liability.
* *
* In this respect, the user's attention is drawn to the risks associated * In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the * with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software, * software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also * that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced * therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore * professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their * encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or * requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the * data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security. * same conditions as regards security.
* *
* The fact that you are presently reading this means that you have had * The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc:fr.bigeon.gclc.proc.TaskPool.java * gclc:fr.bigeon.gclc.proc.TaskPool.java
* Created on: May 10, 2017 * Created on: May 10, 2017
*/ */
package fr.bigeon.gclc.process; package net.bigeon.gclc.process;
import java.util.Collection; /*-
import java.util.HashMap; * #%L
import java.util.HashSet; * process
import java.util.Map; * %%
* Copyright (C) 2014 - 2018 Bigeon
/** A process pool. * %%
* * This software is governed by the CeCILL license under French law and
* @author Emmanuel Bigeon */ * abiding by the rules of distribution of free software. You can use,
public final class TaskPool { * modify and/ or redistribute the software under the terms of the CeCILL
/** The running processes. */ * license as circulated by CEA, CNRS and INRIA at the following URL
private final Map<String, Task> running = new HashMap<>(); * "http://www.cecill.info".
/** The count for process id. */ *
private int count = 0; * As a counterpart to the access to the source code and rights to copy,
/** The lock for pid attribution synchronization. */ * modify and redistribute granted by the license, users are provided only
private final Object lock = new Object(); * with a limited warranty and the software's author, the holder of the
private final boolean autoClear; * economic rights, and the successive licensors have only limited
* liability.
/** Default constructor. */ *
public TaskPool() { * In this respect, the user's attention is drawn to the risks associated
this(true); * with loading, using, modifying and/or developing or reproducing the
} * software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
/** Default constructor. */ * therefore means that it is reserved for developers and experienced
public TaskPool(boolean autoClear) { * professionals having in-depth computer knowledge. Users are therefore
this.autoClear = autoClear; * encouraged to load and test the software's suitability as regards their
} * requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
/** Remove a task from the pool * same conditions as regards security.
* *
* @param pid the task id */ * The fact that you are presently reading this means that you have had
public void remove(String pid) { * knowledge of the CeCILL license and that you accept its terms.
synchronized (lock) { * #L%
running.remove(pid); */
count = Math.min(count, Integer.parseInt(pid)); import java.util.Collection;
} import java.util.HashMap;
} import java.util.HashSet;
import java.util.Map;
/** Add a process in the pool.
* /** A process pool.
* @param cmd the process *
* @return the pid */ * @author Emmanuel Bigeon */
public String add(final Task cmd) { public final class TaskPool {
if (cmd == null) { /** The running processes. */
throw new IllegalArgumentException("Task cannot be null"); //$NON-NLS-1$ private final Map<String, Task> running = new HashMap<>();
} /** The count for process id. */
final String pid; private int count = 0;
synchronized (lock) { /** The lock for pid attribution synchronization. */
pid = getPID(); private final Object lock = new Object();
running.put(pid, cmd); private final boolean autoClear;
}
if (autoClear) { /** Default constructor. */
cmd.addInterruptionListener(new InterruptionListener() { public TaskPool() {
@SuppressWarnings("synthetic-access") this(true);
@Override }
public void interrupted() {
synchronized (lock) { /** Default constructor. */
remove(pid); public TaskPool(boolean autoClear) {
} this.autoClear = autoClear;
cmd.rmInterruptionListener(this); }
}
}); /** Remove a task from the pool
} *
return pid; * @param pid the task id */
} public void remove(String pid) {
synchronized (lock) {
/** Get a process by it associated identifier. running.remove(pid);
* count = Math.min(count, Integer.parseInt(pid));
* @param pid the task id }
* @return the task, if any, associated to this id */ }
public Task get(final String pid) {
synchronized (lock) { /** Add a process in the pool.
return running.get(pid); *
} * @param cmd the process
} * @return the pid */
public String add(final Task cmd) {
/** Get the next process id. if (cmd == null) {
* throw new IllegalArgumentException("Task cannot be null"); //$NON-NLS-1$
* @return the process id */ }
private String getPID() { final String pid;
synchronized (lock) { synchronized (lock) {
String pid; pid = getPID();
do { running.put(pid, cmd);
pid = Integer.toString(count++); }
} while (running.containsKey(pid)); if (autoClear) {
return pid; cmd.addInterruptionListener(new InterruptionListener() {
} @SuppressWarnings("synthetic-access")
} @Override
public void interrupted() {
/** Get the running processes' identifiers. synchronized (lock) {
* remove(pid);
* @return the pids */ }
public Collection<String> getPIDs() { cmd.rmInterruptionListener(this);
return new HashSet<>(running.keySet()); }
} });
}
/** @return if the clearing of ended task is automatic */ return pid;
public boolean isAutoClearing() { }
return autoClear;
} /** Get a process by it associated identifier.
*
/** Request all task to stop running. * @param pid the task id
* <p> * @return the task, if any, associated to this id */
* This call does not guaranty end of execution, it is up to the task public Task get(final String pid) {
* implementation to actually take into account the termination request. */ synchronized (lock) {
public void shutdown() { return running.get(pid);
synchronized (lock) { }
for (final Task task : running.values()) { }
task.setRunning(false);
} /** Get the next process id.
} *
} * @return the process id */
} private String getPID() {
synchronized (lock) {
String pid;
do {
pid = Integer.toString(count++);
} while (running.containsKey(pid));
return pid;
}
}
/** Get the running processes' identifiers.
*
* @return the pids */
public Collection<String> getPIDs() {
return new HashSet<>(running.keySet());
}
/** @return if the clearing of ended task is automatic */
public boolean isAutoClearing() {
return autoClear;
}
/** Request all task to stop running.
* <p>
* This call does not guaranty end of execution, it is up to the task
* implementation to actually take into account the termination request. */
public void shutdown() {
synchronized (lock) {
for (final Task task : running.values()) {
task.setRunning(false);
}
}
}
}

197
gclc-process/src/main/java/fr/bigeon/gclc/process/TaskSpawner.java → gclc-process/src/main/java/net/bigeon/gclc/process/TaskSpawner.java
View File

@ -1,82 +1,115 @@
/* /*
* process, Distribution repositories and basic setup for Emmanuel Bigeon projects * process, Distribution repositories and basic setup for Emmanuel Bigeon projects
* Copyright (C) 2014-2018 E. Bigeon * Copyright (C) 2014-2018 E. Bigeon
* mailto:emmanuel@bigeon.fr * mailto:emmanuel@bigeon.fr
* *
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/or redistribute the software under the terms of the CeCILL * modify and/or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
* As a counterpart to the access to the source code and rights to copy, * As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only * modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the * with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited * economic rights, and the successive licensors have only limited
* liability. * liability.
* *
* In this respect, the user's attention is drawn to the risks associated * In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the * with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software, * software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also * that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced * therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore * professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their * encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or * requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the * data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security. * same conditions as regards security.
* *
* The fact that you are presently reading this means that you have had * The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* gclc:fr.bigeon.gclc.proc.ProcessList.java * gclc:fr.bigeon.gclc.proc.ProcessList.java
* Created on: May 10, 2017 * Created on: May 10, 2017
*/ */
package fr.bigeon.gclc.process; package net.bigeon.gclc.process;
import java.util.concurrent.ExecutorService; /*-
* #%L
import fr.bigeon.gclc.command.Command; * process
import fr.bigeon.gclc.exception.CommandRunException; * %%
import fr.bigeon.gclc.manager.ConsoleInput; * Copyright (C) 2014 - 2018 Bigeon
import fr.bigeon.gclc.manager.ConsoleOutput; * %%
* This software is governed by the CeCILL license under French law and
/** An abstract command to generate a task and return the control to the user * abiding by the rules of distribution of free software. You can use,
* * modify and/ or redistribute the software under the terms of the CeCILL
* @author Emmanuel Bigeon */ * license as circulated by CEA, CNRS and INRIA at the following URL
public abstract class TaskSpawner extends Command { * "http://www.cecill.info".
/** The process pool */ *
private final TaskPool pool; * As a counterpart to the access to the source code and rights to copy,
private final ExecutorService threadPool; * modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
/** @param name the command name * economic rights, and the successive licensors have only limited
* @param pool the pool */ * liability.
public TaskSpawner(final String name, final TaskPool pool, *
ExecutorService threadPool) { * In this respect, the user's attention is drawn to the risks associated
super(name); * with loading, using, modifying and/or developing or reproducing the
this.pool = pool; * software by the user in light of its specific status of free software,
this.threadPool = threadPool; * that may mean that it is complicated to manipulate, and that also
} * therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
/** @param in the input * encouraged to load and test the software's suitability as regards their
* @param out the output * requirements in conditions enabling the security of their systems and/or
* @param args the arguments * data to be ensured and, more generally, to use and operate it in the
* @return the process to start and add to the pool * same conditions as regards security.
* @throws CommandRunException if the task creation failed */ *
protected abstract Task createTask(ConsoleOutput out, ConsoleInput in, * The fact that you are presently reading this means that you have had
String... args) throws CommandRunException; * knowledge of the CeCILL license and that you accept its terms.
* #L%
/* (non-Javadoc) */
* @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.manager. import java.util.concurrent.ExecutorService;
* ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
* java.lang.String[]) */ import net.bigeon.gclc.command.Command;
@Override import net.bigeon.gclc.exception.CommandRunException;
public final void execute(final ConsoleOutput out, final ConsoleInput in, import net.bigeon.gclc.manager.ConsoleInput;
final String... args) throws CommandRunException { import net.bigeon.gclc.manager.ConsoleOutput;
final Task task = createTask(out, in, args);
final Thread th = new Thread(task); /** An abstract command to generate a task and return the control to the user
pool.add(task); *
threadPool.execute(th); * @author Emmanuel Bigeon */
} public abstract class TaskSpawner extends Command {
} /** The process pool */
private final TaskPool pool;
private final ExecutorService threadPool;
/** @param name the command name
* @param pool the pool */
public TaskSpawner(final String name, final TaskPool pool,
ExecutorService threadPool) {
super(name);
this.pool = pool;
this.threadPool = threadPool;
}
/** @param in the input
* @param out the output
* @param args the arguments
* @return the process to start and add to the pool
* @throws CommandRunException if the task creation failed */
protected abstract Task createTask(ConsoleOutput out, ConsoleInput in,
String... args) throws CommandRunException;
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.manager.
* ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
* java.lang.String[]) */
@Override
public final void execute(final ConsoleOutput out, final ConsoleInput in,
final String... args) throws CommandRunException {
final Task task = createTask(out, in, args);
final Thread th = new Thread(task);
pool.add(task);
threadPool.execute(th);
}
}

455
gclc-process/src/main/java/fr/bigeon/gclc/process/io/ConnectingConsoleInput.java → gclc-process/src/main/java/net/bigeon/gclc/process/io/ConnectingConsoleInput.java
View File

@ -1,211 +1,244 @@
/* /*
* process, Distribution repositories and basic setup for Emmanuel Bigeon projects * process, Distribution repositories and basic setup for Emmanuel Bigeon projects
* Copyright (C) 2014-2018 E. Bigeon * Copyright (C) 2014-2018 E. Bigeon
* mailto:emmanuel@bigeon.fr * mailto:emmanuel@bigeon.fr
* *
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/or redistribute the software under the terms of the CeCILL * modify and/or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
* As a counterpart to the access to the source code and rights to copy, * As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only * modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the * with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited * economic rights, and the successive licensors have only limited
* liability. * liability.
* *
* In this respect, the user's attention is drawn to the risks associated * In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the * with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software, * software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also * that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced * therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore * professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their * encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or * requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the * data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security. * same conditions as regards security.
* *
* The fact that you are presently reading this means that you have had * The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* *
*/ */
package fr.bigeon.gclc.process.io; package net.bigeon.gclc.process.io;
import java.io.IOException; /*-
import java.util.logging.Level; * #%L
import java.util.logging.Logger; * process
* %%
import fr.bigeon.gclc.manager.ConsoleInput; * Copyright (C) 2014 - 2018 Bigeon
import fr.bigeon.gclc.tools.StringProvider; * %%
* This software is governed by the CeCILL license under French law and
/** @author Emmanuel Bigeon */ * abiding by the rules of distribution of free software. You can use,
public final class ConnectingConsoleInput implements ConsoleInput { * modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
private static final Logger LOGGER = Logger * "http://www.cecill.info".
.getLogger(ConnectingConsoleInput.class.getName()); *
private boolean close = false; * As a counterpart to the access to the source code and rights to copy,
private StringProvider prompt; * modify and redistribute granted by the license, users are provided only
private boolean prompting; * with a limited warranty and the software's author, the holder of the
private final Object promptLock = new Object(); * economic rights, and the successive licensors have only limited
private final Object connectionLock = new Object(); * liability.
private ConsoleInput connected; *
private boolean disconnection; * In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
/* (non-Javadoc) * software by the user in light of its specific status of free software,
* @see fr.bigeon.gclc.manager.ConsoleInput#close() */ * that may mean that it is complicated to manipulate, and that also
@Override * therefore means that it is reserved for developers and experienced
public void close() throws IOException { * professionals having in-depth computer knowledge. Users are therefore
close = true; * encouraged to load and test the software's suitability as regards their
} * requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
/* (non-Javadoc) * same conditions as regards security.
* @see fr.bigeon.gclc.manager.ConsoleInput#getPrompt() */ *
@Override * The fact that you are presently reading this means that you have had
public StringProvider getPrompt() { * knowledge of the CeCILL license and that you accept its terms.
return prompt; * #L%
} */
import java.io.IOException;
/* (non-Javadoc) import java.util.logging.Level;
* @see fr.bigeon.gclc.manager.ConsoleInput#interruptPrompt() */ import java.util.logging.Logger;
@Override
public void interruptPrompt() { import net.bigeon.gclc.manager.ConsoleInput;
synchronized (promptLock) { import net.bigeon.gclc.tools.StringProvider;
prompting = false;
if (connected != null) { /** @author Emmanuel Bigeon */
connected.interruptPrompt(); public final class ConnectingConsoleInput implements ConsoleInput {
}
promptLock.notifyAll(); private static final Logger LOGGER = Logger
} .getLogger(ConnectingConsoleInput.class.getName());
} private boolean close = false;
private StringProvider prompt;
/* (non-Javadoc) private boolean prompting;
* @see fr.bigeon.gclc.manager.ConsoleInput#isClosed() */ private final Object promptLock = new Object();
@Override private final Object connectionLock = new Object();
public boolean isClosed() { private ConsoleInput connected;
return close; private boolean disconnection;
}
/* (non-Javadoc)
/* (non-Javadoc) * @see fr.bigeon.gclc.manager.ConsoleInput#close() */
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt() */ @Override
@Override public void close() throws IOException {
public String prompt() throws IOException { close = true;
return prompt(prompt.apply()); }
}
/* (non-Javadoc)
/* (non-Javadoc) * @see fr.bigeon.gclc.manager.ConsoleInput#getPrompt() */
* @see fr.bigeon.gclc.manager.ConsoleInput#setPrompt(fr.bigeon.gclc.tools. @Override
* StringProvider) */ public StringProvider getPrompt() {
@Override return prompt;
public void setPrompt(StringProvider string) { }
prompt = string;
} /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#interruptPrompt() */
/* (non-Javadoc) @Override
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt(long) */ public void interruptPrompt() {
@Override synchronized (promptLock) {
public String prompt(long timeout) throws IOException { prompting = false;
return prompt(prompt.apply(), timeout); if (connected != null) {
} connected.interruptPrompt();
}
/* (non-Javadoc) promptLock.notifyAll();
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String) */ }
@Override }
public String prompt(String message) throws IOException {
synchronized (promptLock) { /* (non-Javadoc)
prompting = true; * @see fr.bigeon.gclc.manager.ConsoleInput#isClosed() */
} @Override
while (prompting) { public boolean isClosed() {
synchronized (promptLock) { return close;
if (connected == null) { }
try {
promptLock.wait(); /* (non-Javadoc)
} catch (final InterruptedException e) { * @see fr.bigeon.gclc.manager.ConsoleInput#prompt() */
LOGGER.log(Level.WARNING, "Inerruption of console thread", e); @Override
Thread.currentThread().interrupt(); public String prompt() throws IOException {
} return prompt(prompt.apply());
} else { }
final String res = connected.prompt(message);
synchronized (connectionLock) { /* (non-Javadoc)
if (disconnection) { * @see fr.bigeon.gclc.manager.ConsoleInput#setPrompt(fr.bigeon.gclc.tools.
disconnection = false; * StringProvider) */
} else if (prompting) { @Override
return res; public void setPrompt(StringProvider string) {
} prompt = string;
} }
}
} /* (non-Javadoc)
} * @see fr.bigeon.gclc.manager.ConsoleInput#prompt(long) */
return null; @Override
} public String prompt(long timeout) throws IOException {
return prompt(prompt.apply(), timeout);
/* (non-Javadoc) }
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String, long) */
@Override /* (non-Javadoc)
public String prompt(String message, long timeout) throws IOException { * @see fr.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String) */
if (timeout <= 0) { @Override
return prompt(message); public String prompt(String message) throws IOException {
} synchronized (promptLock) {
final long end = System.currentTimeMillis() + timeout; prompting = true;
synchronized (promptLock) { }
prompting = true; while (prompting) {
} synchronized (promptLock) {
while (prompting) { if (connected == null) {
synchronized (promptLock) { try {
if (connected == null) { promptLock.wait();
try { } catch (final InterruptedException e) {
promptLock.wait(); LOGGER.log(Level.WARNING, "Inerruption of console thread", e);
} catch (final InterruptedException e) { Thread.currentThread().interrupt();
LOGGER.log(Level.WARNING, "Inerruption of console thread", e); }
Thread.currentThread().interrupt(); } else {
} final String res = connected.prompt(message);
} else { synchronized (connectionLock) {
final String res = connected.prompt(message, if (disconnection) {
end - System.currentTimeMillis()); disconnection = false;
synchronized (connectionLock) { } else if (prompting) {
if (disconnection) { return res;
disconnection = false; }
} else if (prompting) { }
return res; }
} }
} }
} return null;
} }
}
return null; /* (non-Javadoc)
} * @see fr.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String, long) */
@Override
/* (non-Javadoc) public String prompt(String message, long timeout) throws IOException {
* @see fr.bigeon.gclc.manager.ConsoleInput#setPrompt(java.lang.String) */ if (timeout <= 0) {
@Override return prompt(message);
public void setPrompt(final String prompt) { }
this.prompt = new StringProvider() { final long end = System.currentTimeMillis() + timeout;
@Override synchronized (promptLock) {
public String apply() { prompting = true;
return prompt; }
} while (prompting) {
}; synchronized (promptLock) {
} if (connected == null) {
try {
public void connect(ConsoleInput input) { promptLock.wait();
disconnect(); } catch (final InterruptedException e) {
synchronized (promptLock) { LOGGER.log(Level.WARNING, "Inerruption of console thread", e);
connected = input; Thread.currentThread().interrupt();
promptLock.notifyAll(); }
} } else {
} final String res = connected.prompt(message,
end - System.currentTimeMillis());
public void disconnect() { synchronized (connectionLock) {
synchronized (connectionLock) { if (disconnection) {
if (connected != null) { disconnection = false;
disconnection = true; } else if (prompting) {
synchronized (promptLock) { return res;
connected.interruptPrompt(); }
} }
connected = null; }
} }
} }
} return null;
} }
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#setPrompt(java.lang.String) */
@Override
public void setPrompt(final String prompt) {
this.prompt = new StringProvider() {
@Override
public String apply() {
return prompt;
}
};
}
public void connect(ConsoleInput input) {
disconnect();
synchronized (promptLock) {
connected = input;
promptLock.notifyAll();
}
}
public void disconnect() {
synchronized (connectionLock) {
if (connected != null) {
disconnection = true;
synchronized (promptLock) {
connected.interruptPrompt();
}
connected = null;
}
}
}
}

325
gclc-process/src/main/java/fr/bigeon/gclc/process/io/ConnectingConsoleOutput.java → gclc-process/src/main/java/net/bigeon/gclc/process/io/ConnectingConsoleOutput.java
View File

@ -1,146 +1,179 @@
/* /*
* process, Distribution repositories and basic setup for Emmanuel Bigeon projects * process, Distribution repositories and basic setup for Emmanuel Bigeon projects
* Copyright (C) 2014-2018 E. Bigeon * Copyright (C) 2014-2018 E. Bigeon
* mailto:emmanuel@bigeon.fr * mailto:emmanuel@bigeon.fr
* *
* This software is governed by the CeCILL license under French law and * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use, * abiding by the rules of distribution of free software. You can use,
* modify and/or redistribute the software under the terms of the CeCILL * modify and/or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info". * "http://www.cecill.info".
* *
* As a counterpart to the access to the source code and rights to copy, * As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only * modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the * with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited * economic rights, and the successive licensors have only limited
* liability. * liability.
* *
* In this respect, the user's attention is drawn to the risks associated * In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the * with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software, * software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also * that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced * therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore * professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their * encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or * requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the * data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security. * same conditions as regards security.
* *
* The fact that you are presently reading this means that you have had * The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms. * knowledge of the CeCILL license and that you accept its terms.
*/ */
/** /**
* *
*/ */
package fr.bigeon.gclc.process.io; package net.bigeon.gclc.process.io;
import java.io.IOException; /*-
import java.util.ArrayDeque; * #%L
import java.util.Deque; * process
import java.util.logging.Level; * %%
import java.util.logging.Logger; * Copyright (C) 2014 - 2018 Bigeon
* %%
import fr.bigeon.gclc.manager.ConsoleOutput; * This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
/** @author Emmanuel Bigeon */ * modify and/ or redistribute the software under the terms of the CeCILL
public class ConnectingConsoleOutput implements ConsoleOutput { * license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
private static final Logger LOGGER = Logger *
.getLogger(ConnectingConsoleOutput.class.getName()); * As a counterpart to the access to the source code and rights to copy,
/** If the undelivered message should be stored. */ * modify and redistribute granted by the license, users are provided only
public static final int QUEUE = 1; * with a limited warranty and the software's author, the holder of the
/** If the messages should be stored in all cases. */ * economic rights, and the successive licensors have only limited
public static final int PERSIST = 1 << 1; * liability.
private ConsoleOutput output; *
private boolean close = false; * In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
private final boolean persistent; * software by the user in light of its specific status of free software,
private final boolean queued; * that may mean that it is complicated to manipulate, and that also
private final Deque<String> messages; * therefore means that it is reserved for developers and experienced
private final int lines; * professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
/** @param style the type of redirected output * requirements in conditions enabling the security of their systems and/or
* @param lines the number of lines to store */ * data to be ensured and, more generally, to use and operate it in the
public ConnectingConsoleOutput(int style, int lines) { * same conditions as regards security.
super(); *
this.lines = lines; * The fact that you are presently reading this means that you have had
queued = (style & QUEUE) != 0; * knowledge of the CeCILL license and that you accept its terms.
persistent = (style & PERSIST) != 0; * #L%
if (lines > 0) { */
messages = new ArrayDeque<>(lines); import java.io.IOException;
} else { import java.util.ArrayDeque;
messages = new ArrayDeque<>(); import java.util.Deque;
} import java.util.logging.Level;
} import java.util.logging.Logger;
private synchronized void addMessage(String text) { import net.bigeon.gclc.manager.ConsoleOutput;
if (persistent || queued && output == null) {
if (messages.size() == lines) { /** @author Emmanuel Bigeon */
messages.poll(); public class ConnectingConsoleOutput implements ConsoleOutput {
}
messages.offer(text); private static final Logger LOGGER = Logger
} .getLogger(ConnectingConsoleOutput.class.getName());
if (output != null) { /** If the undelivered message should be stored. */
try { public static final int QUEUE = 1;
output.print(text); /** If the messages should be stored in all cases. */
} catch (final IOException e) { public static final int PERSIST = 1 << 1;
LOGGER.severe("nable to print to connecting console"); private ConsoleOutput output;
LOGGER.log(Level.FINE, "Console error", e); private boolean close = false;
}
} private final boolean persistent;
} private final boolean queued;
private final Deque<String> messages;
/* (non-Javadoc) private final int lines;
* @see java.lang.AutoCloseable#close() */
@Override /** @param style the type of redirected output
public void close() { * @param lines the number of lines to store */
close = true; public ConnectingConsoleOutput(int style, int lines) {
} super();
this.lines = lines;
/* (non-Javadoc) queued = (style & QUEUE) != 0;
* @see fr.bigeon.gclc.manager.ConsoleOutput#isClosed() */ persistent = (style & PERSIST) != 0;
@Override if (lines > 0) {
public boolean isClosed() { messages = new ArrayDeque<>(lines);
return close; } else {
} messages = new ArrayDeque<>();
}
/* (non-Javadoc) }
* @see fr.bigeon.gclc.manager.ConsoleOutput#print(java.lang.String) */
@Override private synchronized void addMessage(String text) {
public void print(String text) { if (persistent || queued && output == null) {
addMessage(text); if (messages.size() == lines) {
} messages.poll();
}
/* (non-Javadoc) messages.offer(text);
* @see fr.bigeon.gclc.manager.ConsoleOutput#println() */ }
@Override if (output != null) {
public void println() { try {
addMessage(System.lineSeparator()); output.print(text);
} } catch (final IOException e) {
LOGGER.severe("nable to print to connecting console");
/* (non-Javadoc) LOGGER.log(Level.FINE, "Console error", e);
* @see fr.bigeon.gclc.manager.ConsoleOutput#println(java.lang.String) */ }
@Override }
public void println(String message) { }
addMessage(message + System.lineSeparator());
} /* (non-Javadoc)
* @see java.lang.AutoCloseable#close() */
public synchronized void connect(ConsoleOutput output) { @Override
this.output = output; public void close() {
for (final String string : messages) { close = true;
try { }
output.print(string);
} catch (final IOException e) { /* (non-Javadoc)
LOGGER.severe("nable to print to connecting console"); * @see fr.bigeon.gclc.manager.ConsoleOutput#isClosed() */
LOGGER.log(Level.FINE, "Console error", e); @Override
} public boolean isClosed() {
} return close;
if (!persistent) { }
messages.clear();
} /* (non-Javadoc)
} * @see fr.bigeon.gclc.manager.ConsoleOutput#print(java.lang.String) */
@Override
public synchronized void disconnect() { public void print(String text) {
output = null; addMessage(text);
} }
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleOutput#println() */
@Override
public void println() {
addMessage(System.lineSeparator());
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleOutput#println(java.lang.String) */
@Override
public void println(String message) {
addMessage(message + System.lineSeparator());
}
public synchronized void connect(ConsoleOutput output) {
this.output = output;
for (final String string : messages) {
try {
output.print(string);
} catch (final IOException e) {
LOGGER.severe("nable to print to connecting console");
LOGGER.log(Level.FINE, "Console error", e);
}
}
if (!persistent) {
messages.clear();
}
}
public synchronized void disconnect() {
output = null;
}
}