Compare commits

...

62 Commits

Author SHA1 Message Date
d01b1608f3 [maven-release-plugin] prepare release gclc-2.0.10 2018-10-26 10:11:27 -04:00
674333a42c Added comment and test
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-26 10:09:33 -04:00
af0c8e91f8 Order pom elements
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-26 09:31:01 -04:00
461dec8894 Update poms
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-26 09:15:43 -04:00
f590542b3f Add jenkins file
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-26 09:07:08 -04:00
c21517a53d license fix
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-26 09:06:49 -04:00
7e3b727024 Add echo command
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-26 09:06:28 -04:00
bd5b67c312 Move runnable to external class definition
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-26 09:05:40 -04:00
216cd41dc8 format and commands
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-16 19:07:33 -04:00
1df33afdbe Name convention
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-15 12:22:47 -04:00
8d51733590 Made shell invisible in tests. added shell style access
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-15 12:19:23 -04:00
d49a2474e0 Format
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-15 12:19:09 -04:00
d7ecd75678 Clean up
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-15 12:01:10 -04:00
31ad72567a Javadoc
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-15 11:42:40 -04:00
99134c1831 Update config
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-15 11:42:32 -04:00
dc988a07ac Clean up.
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-15 10:57:47 -04:00
4d31bbacbf Removed unecessary throw declarations
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-15 10:57:22 -04:00
2145473706 Added test for command
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-15 10:19:39 -04:00
3f8cee20e1 move protected to private
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-15 09:48:39 -04:00
977c9a8ec8 Method factoring
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-15 09:48:10 -04:00
889433d800 [maven-release-plugin] prepare for next development iteration 2018-10-15 09:36:03 -04:00
89847738e5 [maven-release-plugin] prepare release gclc-socket-1.1.11 2018-10-15 09:35:58 -04:00
cd76d438c1 Update config
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-15 09:34:59 -04:00
fa46939c54 Added doc. Clean up code
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-15 09:34:51 -04:00
fe4851053a Update configurations
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-15 09:14:06 -04:00
6a7d0b11a0 Removed thread sleeping lock
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-15 09:10:31 -04:00
93589c750e Reformatting
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-14 23:07:41 -04:00
c23af20b17 Update version of configuration
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-14 19:05:49 -04:00
c7625c8006 Update dependencies, organize imports
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-14 18:58:17 -04:00
ad65165169 [maven-release-plugin] prepare for next development iteration 2018-10-14 18:28:48 -04:00
0814ab5740 [maven-release-plugin] prepare release gclc-2.0.9 2018-10-14 18:28:43 -04:00
ba26a70daa Minor javadoc
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-14 18:24:54 -04:00
4301f2a15e Fix test and wait
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-14 18:15:49 -04:00
2a05366e31 REmoved unnecessary boolean variable
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-14 11:04:13 -04:00
bd44b5bf85 Added empty else for readability
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-14 11:02:14 -04:00
4e804325e6 Removed initialisation to default
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-14 11:02:05 -04:00
ae5dc1aeba Move help command to package of defined commands
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-14 10:55:55 -04:00
d5a7d4a16f Avoid contains and get calls on same key in map
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-14 10:04:08 -04:00
de593c00a1 Update config, remove site descriptor, to use inherited one 2018-10-14 09:29:42 -04:00
50ac6eec06 Moved out increments
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-14 09:28:04 -04:00
74c66dcbdd Moved listeners from list to set 2018-10-14 09:26:55 -04:00
7c94dea7b5 Avoid multiple creation of empty array 2018-10-14 09:26:27 -04:00
a580133945 Removed method with constant return 2018-10-14 09:26:07 -04:00
38fe457f47 Formating in logs 2018-10-11 12:50:19 -04:00
159805701c Fixed run lockings
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-11 12:43:17 -04:00
f7876dc964 Remove unused final modifiers 2018-10-11 12:38:09 -04:00
c4db9f43fb Clean up and format 2018-10-11 12:29:49 -04:00
67abd91f72 Use concurrent hash map, where possible
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-11 12:13:21 -04:00
7934ab7435 Removed unnecessary exception 2018-10-11 12:09:42 -04:00
761d640f0b Synchronization organisation 2018-10-11 12:09:24 -04:00
98d22782c1 Collections initial size 2018-10-11 12:08:59 -04:00
f8da1c0119 Move from list to linked set for order conservation and use efficiency 2018-10-11 11:33:15 -04:00
438727e7b9 Fix stream for efficient garbage collection 2018-10-11 11:32:49 -04:00
a2a87eb0d7 Added site definition 2018-10-11 11:32:32 -04:00
7ba8b38624 Added synchronize block 2018-10-11 11:32:23 -04:00
6bcf2b0c91 [maven-release-plugin] prepare for next development iteration 2018-10-11 11:11:23 -04:00
3a568d3723 [maven-release-plugin] prepare release gclc-2.0.8 2018-10-11 11:10:37 -04:00
7e81105785 Remove unecessary imports and site resources, update configurations 2018-10-11 11:04:05 -04:00
bb7c01a7f2 [maven-release-plugin] prepare for next development iteration 2018-10-08 15:05:15 -04:00
d3064f18b6 [maven-release-plugin] prepare release process-0.0.3 2018-10-08 15:05:11 -04:00
7a7bf0b019 Update versions, configuration, license, refactor package
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-08 15:04:22 -04:00
a69c4a777f [maven-release-plugin] prepare for next development iteration 2018-10-08 15:03:52 -04:00
128 changed files with 5970 additions and 4517 deletions

65
Jenkinsfile vendored Normal file
View File

@@ -0,0 +1,65 @@
pipeline {
agent any
stages {
stage('Site GCLC') {
when {
tag "gclc-*"
}
steps {
dir('gclc') {
sh 'mvn site:site'
sh 'mkdir -p /home/maven-sites/net/bigeon/gclc'
sh 'cp -r target/site /home/maven-sites/net/bigeon/gclc/gclc'
}
}
}
stage('Site GCLC-Socket') {
when {
tag "socket-*"
}
steps {
dir('gclc-socket') {
sh 'mvn site:site'
sh 'mkdir -p /home/maven-sites/net/bigeon/gclc'
sh 'cp -r target/site /home/maven-sites/net/bigeon/gclc/gclc-socket'
}
}
}
stage('Site GCLC-Swt') {
when {
tag "swt-*"
}
steps {
dir('gclc-swt') {
sh 'mvn site:site'
sh 'mkdir -p /home/maven-sites/net/bigeon/gclc'
sh 'cp -r target/site /home/maven-sites/net/bigeon/gclc/gclc-swt'
}
}
}
stage('Site GCLC-Processes') {
when {
tag "process-*"
}
steps {
dir('gclc-process') {
sh 'mvn site:site'
sh 'mkdir -p /home/maven-sites/net/bigeon/gclc'
sh 'cp -r target/site /home/maven-sites/net/bigeon/gclc/gclc-process'
}
}
}
stage('Site GCLC-System') {
when {
tag "system-*"
}
steps {
dir('gclc.system') {
sh 'mvn site:site'
sh 'mkdir -p /home/maven-sites/net/bigeon/gclc'
sh 'cp -r target/site /home/maven-sites/net/bigeon/gclc/gclc-system'
}
}
}
}
}

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.

View File

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

View File

@@ -1,139 +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.
*/ */
/** /**
* 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 java.util.logging.Level;
import java.util.logging.Logger;
/**
* import net.bigeon.gclc.command.CommandParameters;
*/ import net.bigeon.gclc.command.ParametrizedCommand;
private void addParameters() { import net.bigeon.gclc.exception.CommandRunException;
try { import net.bigeon.gclc.exception.CommandRunExceptionType;
addStringParameter("pid", false); import net.bigeon.gclc.exception.InvalidParameterException;
addStringParameter("delai", false); import net.bigeon.gclc.manager.ConsoleInput;
} catch (final InvalidParameterException e) { import net.bigeon.gclc.manager.ConsoleOutput;
// TODO Auto-generated catch block
e.printStackTrace(); /** A command that is launched inside an internal terminal.
} * <p>
} * Several things are to be considered before adding this command to an
* application:
/* (non-Javadoc) * <ul>
* @see fr.bigeon.gclc.command.ParametrizedCommand#doExecute(fr.bigeon.gclc. * <li>The commands will be able to run in parallel.
* manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput, * <li>The managing of the commands will be handled through piped systems and
* fr.bigeon.gclc.command.CommandParameters) */ * buffered in so switching to a forked command will actually print again all
@Override * the command history to the output console.
protected void doExecute(final ConsoleOutput out, final ConsoleInput in, * </ul>
final CommandParameters parameters) throws CommandRunException { *
String string = parameters.get("pid"); * @author Emmanuel Bigeon */
final List<String> additionals = parameters.getAdditionals(); public class CommandForeground extends ParametrizedCommand {
if (string == null && !additionals.isEmpty()) {
string = additionals.get(0); /** Number of milliseconds in a second. */
} private static final int MILLIS_IN_A_SEC = 1000;
if (string == null) { /** The class logger. */
throw new CommandRunException(CommandRunExceptionType.USAGE, private static final Logger LOGGER = Logger
"Missing process id", this); .getLogger(CommandForeground.class.getName());
}
// Join the command. /** The task pool to fetch task from. */
final Task cmd = pool.get(string); private final TaskPool pool;
if (!(cmd instanceof ForkTask)) {
throw new CommandRunException("No such forked process", this); /** Add the fork command.
} *
long delai = 0; * @param name the command name
final String delaiOpt = parameters.get("delai"); * @param pool The pool to get joinable tasks from */
if (delaiOpt != null) { public CommandForeground(final String name, final TaskPool pool) {
delai = Long.parseLong(delaiOpt) * 1000; super(name, false);
} this.pool = pool;
if (delai < 0) { addParameters();
throw new CommandRunException("Join delai cannot be negative", this); }
}
((ForkTask) cmd).join(out, in, delai); /** Add the parameters of the command. */
} private void addParameters() {
try {
/* (non-Javadoc) addStringParameter("pid", false);
* @see fr.bigeon.gclc.command.ICommand#tip() */ addStringParameter("delai", false);
@Override } catch (final InvalidParameterException e) {
public String tip() { // Cannot be reached unless GCLC base framework has an error
return "Join the execution of a command, for a given amount of time"; LOGGER.log(Level.SEVERE, "unexpected parameter error!", e);
} }
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#usageDetail() */ /* (non-Javadoc)
@Override * @see fr.bigeon.gclc.command.ParametrizedCommand#doExecute(fr.bigeon.gclc.
protected String usageDetail() { * manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
return ""; * 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#usagePattern() */ String string = parameters.get("pid");
@Override final List<String> additionals = parameters.getAdditionals();
protected String usagePattern() { if (string == null && !additionals.isEmpty()) {
return super.usagePattern() + " [(-pid) <id>] ([-delai <delai>])"; string = additionals.get(0);
} }
} if (string == null) {
throw new CommandRunException(CommandRunExceptionType.USAGE,
"Missing process id");
}
// Join the command.
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) * MILLIS_IN_A_SEC;
}
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>])";
}
}

View File

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

View File

@@ -1,73 +1,103 @@
/* /*
* 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.ForkTask#doRun() */
@Override
protected void doRun() throws CommandRunException {
command.execute(out, in, args);
}
/* (non-Javadoc)
* @see net.bigeon.gclc.process.Task#getName() */
@Override
public String getName() {
return command.getCommandName();
}
}

View File

@@ -1,155 +1,195 @@
/* /*
* 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; /** A task that is made to run into a thread.
} *
} * @author Emmanuel Bigeon */
public abstract class ForkTask implements Task {
/** @param out the console output
* @param in the console input /** THe listeners. */
* @param timeout the maximal wait (0 for ever) */ private final Set<InterruptionListener> listeners = new HashSet<>();
public final void join(final ConsoleOutput out, final ConsoleInput in, long timeout) { /** The running state. */
synchronized (runLock) { private boolean running = false;
this.out.connect(out); /** The connecting input for this task */
this.in.connect(in); protected final ConnectingConsoleInput in = new ConnectingConsoleInput();
try { /** The connecting output for this task */
if (running) { protected final ConnectingConsoleOutput out;
runLock.wait(timeout); /** The exception of the run. */
} private CommandRunException exception;
} catch (final InterruptedException e) { /** The synchronization lock. */
// TODO log. private final Object runLock = new Object();
Thread.currentThread().interrupt();
} /** Create the task.
this.out.disconnect(); *
this.in.disconnect(); * @param lines the number of print to store in the output */
} public ForkTask(final int lines) {
} out = new ConnectingConsoleOutput(ConnectingConsoleOutput.PERSIST, lines);
}
/* (non-Javadoc)
* @see /* (non-Javadoc)
* fr.bigeon.gclc.process.Task#rmInterruptionListener(fr.bigeon.gclc.process * @see net.bigeon.gclc.process.Task#addInterruptionListener(fr.bigeon.gclc.
* .InterruptionListener) */ * process.InterruptionListener) */
@Override @Override
public final void rmInterruptionListener(final InterruptionListener listener) { public final void addInterruptionListener(final InterruptionListener listener) {
listeners.remove(listener); listeners.add(listener);
} }
/* (non-Javadoc) /** Actually run the fork. */
* @see java.lang.Runnable#run() */ protected abstract void doRun() throws CommandRunException;
@Override
public final void run() { /** Get the excepion that caused a failure.
synchronized (runLock) { *
running = true; * @return the exception */
} public final CommandRunException getException() {
try { return exception;
doRun(); }
} catch (final CommandRunException e) {
exception = e; protected final Object getRunningLock() {
} finally { return runLock;
setRunning(false); }
}
for (final InterruptionListener interruptionListener : listeners) { /* (non-Javadoc)
interruptionListener.interrupted(); * @see net.bigeon.gclc.process.Task#isRunning() */
} @Override
} public final boolean isRunning() {
synchronized (runLock) {
/** Actually run the fork. */ return running;
protected abstract void doRun() throws CommandRunException; }
}
/** Get the excepion that caused a failure.
* /** Join the task.
* @return the exception */ *
public final CommandRunException getException() { * @param out the console output
return exception; * @param in the console input
} * @param timeout the maximal time to join for (0 for ever) */
public final void join(final ConsoleOutput out, final ConsoleInput in,
/* (non-Javadoc) final long timeout) {
* @see fr.bigeon.gclc.process.Task#setRunning(boolean) */ synchronized (runLock) {
@Override this.out.connect(out);
public final void setRunning(final boolean running) { this.in.connect(in);
synchronized (runLock) { try {
this.running = running; if (running) {
runLock.notifyAll(); runLock.wait(timeout);
} }
} } catch (final InterruptedException e) {
Thread.currentThread().interrupt();
protected final Object getRunningLock() { }
return runLock; this.out.disconnect();
} this.in.disconnect();
} }
}
/* (non-Javadoc)
* @see
* net.bigeon.gclc.process.Task#rmInterruptionListener(net.bigeon.gclc.process
* .InterruptionListener) */
@Override
public final void rmInterruptionListener(final InterruptionListener listener) {
listeners.remove(listener);
}
/* (non-Javadoc)
* @see java.lang.Runnable#run() */
@Override
public final void run() {
synchronized (runLock) {
running = true;
}
try {
doRun();
} catch (final CommandRunException e) {
exception = e;
} finally {
setRunning(false);
}
for (final InterruptionListener interruptionListener : listeners) {
interruptionListener.interrupted();
}
}
/* (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();
}
}
}

View File

@@ -0,0 +1,78 @@
/*
* process, Distribution repositories and basic setup for Emmanuel Bigeon projects
* Copyright (C) 2014-2018 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.
*/
/**
* gclc:fr.bigeon.gclc.proc.InterruptionListener.java
* Created on: May 10, 2017
*/
package net.bigeon.gclc.process;
/*-
* #%L
* process
* %%
* Copyright (C) 2014 - 2018 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
* 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 */
@FunctionalInterface
public interface InterruptionListener {
/** Notification of an interuption of a listened object */
void interrupted();
}

View File

@@ -0,0 +1,94 @@
/*
* process, Distribution repositories and basic setup for Emmanuel Bigeon projects
* Copyright (C) 2014-2018 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.
*/
/**
*
*/
package net.bigeon.gclc.process;
/*-
* #%L
* process
* %%
* Copyright (C) 2014 - 2018 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
* 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%
*/
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));
}
}

View File

@@ -1,87 +1,116 @@
/* /*
* 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.manager.ConsoleInput;
* @see fr.bigeon.gclc.command.ICommand#tip() */ import net.bigeon.gclc.manager.ConsoleOutput;
@SuppressWarnings("nls")
@Override /** A command that will flag a task to stop
public String tip() { *
return "Request a process to stop (softly)"; * @author Emmanuel Bigeon */
} public final class ProcessClear extends Command {
/** The taskpool */
/* (non-Javadoc) private final TaskPool pool;
* @see fr.bigeon.gclc.command.Command#usageDetail() */
@Override /** @param name the command name
protected String usageDetail() { * @param pool the pool */
return null; 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) {
for (final String id : pool.getPIDs()) {
if (!pool.get(id).isRunning()) {
pool.remove(id);
}
}
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#tip() */
@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;
}
}

View File

@@ -1,82 +1,112 @@
/* /*
* 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.manager.ConsoleInput;
} import net.bigeon.gclc.manager.ConsoleOutput;
/* (non-Javadoc) /** A command that will flag a task to stop
* @see fr.bigeon.gclc.command.Command#usageDetail() */ *
@Override * @author Emmanuel Bigeon */
protected String usageDetail() { public final class ProcessKill extends Command {
return null; /** 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) {
pool.get(args[0]).setRunning(false);
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#tip() */
@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;
}
}

View File

@@ -1,100 +1,130 @@
/* /*
* 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() */
@Override
public String tip() {
return "List all processes";
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#usageDetail() */
@Override
protected String usageDetail() {
return null;
}
}

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));
}
}

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);
}

View File

@@ -1,149 +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.
*/ */
/** /**
* 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(final boolean autoClear) {
} this.autoClear = autoClear;
cmd.rmInterruptionListener(this); }
}
}); /** Add a process in the pool.
} *
return pid; * @param cmd the process
} * @return the pid */
public String add(final Task cmd) {
/** Get a process by it associated identifier. if (cmd == null) {
* throw new IllegalArgumentException("Task cannot be null"); //$NON-NLS-1$
* @param pid the task id }
* @return the task, if any, associated to this id */ final String pid;
public Task get(final String pid) { synchronized (lock) {
synchronized (lock) { pid = getPID();
return running.get(pid); running.put(pid, cmd);
} }
} if (autoClear) {
cmd.addInterruptionListener(new InterruptionListener() {
/** Get the next process id. @Override
* public void interrupted() {
* @return the process id */ remove(pid);
private String getPID() { cmd.rmInterruptionListener(this);
synchronized (lock) { }
String pid; });
do { }
pid = Integer.toString(count++); return pid;
} while (running.containsKey(pid)); }
return pid;
} /** Get a process by it associated identifier.
} *
* @param pid the task id
/** Get the running processes' identifiers. * @return the task, if any, associated to this id */
* public Task get(final String pid) {
* @return the pids */ synchronized (lock) {
public Collection<String> getPIDs() { return running.get(pid);
return new HashSet<>(running.keySet()); }
} }
/** @return if the clearing of ended task is automatic */ /** Get the next process id.
public boolean isAutoClearing() { *
return autoClear; * @return the process id */
} private String getPID() {
synchronized (lock) {
/** Request all task to stop running. String pid;
* <p> do {
* This call does not guaranty end of execution, it is up to the task pid = Integer.toString(count++);
* implementation to actually take into account the termination request. */ } while (running.containsKey(pid));
public void shutdown() { return pid;
synchronized (lock) { }
for (final Task task : running.values()) { }
task.setRunning(false);
} /** 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;
}
/** Remove a task from the pool
*
* @param pid the task id */
public void remove(final String pid) {
synchronized (lock) {
running.remove(pid);
count = Math.min(count, Integer.parseInt(pid));
}
}
/** 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);
}
}
}
}

View File

@@ -1,82 +1,113 @@
/* /*
* 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,
final 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);
pool.add(task);
threadPool.execute(task);
}
}

View File

@@ -1,211 +1,270 @@
/* /*
* 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.ConstantString;
prompting = false; import net.bigeon.gclc.tools.StringProvider;
if (connected != null) {
connected.interruptPrompt(); /** A console input that can be connected to and diconnected from.
} *
promptLock.notifyAll(); * @author Emmanuel Bigeon */
} public final class ConnectingConsoleInput implements ConsoleInput {
}
/** The empty string provider. */
/* (non-Javadoc) private static final ConstantString EMPTY_STRING = new ConstantString("");
* @see fr.bigeon.gclc.manager.ConsoleInput#isClosed() */ /** The logger. */
@Override private static final Logger LOGGER = Logger
public boolean isClosed() { .getLogger(ConnectingConsoleInput.class.getName());
return close;
} /** If the input is closed. */
private boolean close = false;
/* (non-Javadoc) /** The prompt string. */
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt() */ private StringProvider prompt = EMPTY_STRING;
@Override /** If the input is currently in prompting state. */
public String prompt() throws IOException { private boolean prompting = false;
return prompt(prompt.apply()); /** The synchronization lock for the rompting status. */
} private final Object promptLock = new Object();
/** The synchronization lock for the connection status. */
/* (non-Javadoc) private final Object connectionLock = new Object();
* @see fr.bigeon.gclc.manager.ConsoleInput#setPrompt(fr.bigeon.gclc.tools. /** The connected console input. */
* StringProvider) */ private ConsoleInput connected = null;
@Override /** The connection state. */
public void setPrompt(StringProvider string) { private boolean disconnection = false;
prompt = string;
} /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#close() */
/* (non-Javadoc) @Override
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt(long) */ public void close() {
@Override close = true;
public String prompt(long timeout) throws IOException { }
return prompt(prompt.apply(), timeout);
} /** Connect an input.
*
/* (non-Javadoc) * @param input the input to connect */
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String) */ public void connect(final ConsoleInput input) {
@Override disconnect();
public String prompt(String message) throws IOException { synchronized (promptLock) {
synchronized (promptLock) { connected = input;
prompting = true; promptLock.notifyAll();
} }
while (prompting) { }
synchronized (promptLock) {
if (connected == null) { /** Disconnect the current input. */
try { public void disconnect() {
promptLock.wait(); synchronized (connectionLock) {
} catch (final InterruptedException e) { if (connected != null) {
LOGGER.log(Level.WARNING, "Inerruption of console thread", e); disconnection = true;
Thread.currentThread().interrupt(); synchronized (promptLock) {
} connected.interruptPrompt();
} else { }
final String res = connected.prompt(message); connected = null;
synchronized (connectionLock) { }
if (disconnection) { }
disconnection = false; }
} else if (prompting) {
return res; /* (non-Javadoc)
} * @see fr.bigeon.gclc.manager.ConsoleInput#getPrompt() */
} @Override
} public StringProvider getPrompt() {
} return prompt;
} }
return null;
} /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#interruptPrompt() */
/* (non-Javadoc) @Override
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String, long) */ public void interruptPrompt() {
@Override synchronized (promptLock) {
public String prompt(String message, long timeout) throws IOException { prompting = false;
if (timeout <= 0) { if (connected != null) {
return prompt(message); connected.interruptPrompt();
} }
final long end = System.currentTimeMillis() + timeout; promptLock.notifyAll();
synchronized (promptLock) { }
prompting = true; }
}
while (prompting) { /* (non-Javadoc)
synchronized (promptLock) { * @see fr.bigeon.gclc.manager.ConsoleInput#isClosed() */
if (connected == null) { @Override
try { public boolean isClosed() {
promptLock.wait(); return close;
} catch (final InterruptedException e) { }
LOGGER.log(Level.WARNING, "Inerruption of console thread", e);
Thread.currentThread().interrupt(); /* (non-Javadoc)
} * @see fr.bigeon.gclc.manager.ConsoleInput#prompt() */
} else { @Override
final String res = connected.prompt(message, public String prompt() throws IOException {
end - System.currentTimeMillis()); return prompt(prompt.apply());
synchronized (connectionLock) { }
if (disconnection) {
disconnection = false; /* (non-Javadoc)
} else if (prompting) { * @see fr.bigeon.gclc.manager.ConsoleInput#prompt(long) */
return res; @Override
} public String prompt(final long timeout) throws IOException {
} return prompt(prompt.apply(), timeout);
} }
}
} /* (non-Javadoc)
return null; * @see fr.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String) */
} @Override
public String prompt(final String message) throws IOException {
/* (non-Javadoc) synchronized (promptLock) {
* @see fr.bigeon.gclc.manager.ConsoleInput#setPrompt(java.lang.String) */ prompting = true;
@Override }
public void setPrompt(final String prompt) { while (true) {
this.prompt = new StringProvider() { synchronized (promptLock) {
@Override if (!prompting) {
public String apply() { return null;
return prompt; }
} if (connected == null) {
}; try {
} promptLock.wait();
} catch (final InterruptedException e) {
public void connect(ConsoleInput input) { LOGGER.log(Level.WARNING, "Inerruption of console thread", e);
disconnect(); Thread.currentThread().interrupt();
synchronized (promptLock) { }
connected = input; } else {
promptLock.notifyAll(); final String res = connected.prompt(message);
} synchronized (connectionLock) {
} if (disconnection) {
disconnection = false;
public void disconnect() { } else if (prompting) {
synchronized (connectionLock) { return res;
if (connected != null) { } else {
disconnection = true; // prompt interrupted, lose the result.
synchronized (promptLock) { }
connected.interruptPrompt(); }
} }
connected = null; }
} }
} }
}
} /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String, long) */
@Override
public String prompt(final String message, final long timeout) throws IOException {
if (timeout <= 0) {
return prompt(message);
}
final long end = System.currentTimeMillis() + timeout;
synchronized (promptLock) {
prompting = true;
}
while (true) {
synchronized (promptLock) {
if (!prompting) {
return null;
}
if (connected == null) {
try {
promptLock.wait();
} catch (final InterruptedException e) {
LOGGER.log(Level.WARNING, "Inerruption of console thread", e);
Thread.currentThread().interrupt();
}
} else {
final String res = connected.prompt(message,
end - System.currentTimeMillis());
synchronized (connectionLock) {
if (disconnection) {
disconnection = false;
} else if (prompting) {
return res;
} else {
// prompt interrupted, lose the result.
}
}
}
}
}
}
/* (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;
}
};
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#setPrompt(fr.bigeon.gclc.tools.
* StringProvider) */
@Override
public void setPrompt(final StringProvider string) {
prompt = string;
}
}

View File

@@ -1,146 +1,197 @@
/* /*
* 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) { /** A console output that can be connected and disconnected from.
messages.poll(); *
} * @author Emmanuel Bigeon */
messages.offer(text); public class ConnectingConsoleOutput implements ConsoleOutput {
}
if (output != null) { /** The logger. */
try { private static final Logger LOGGER = Logger
output.print(text); .getLogger(ConnectingConsoleOutput.class.getName());
} catch (final IOException e) { /** The flag indicating that the un-delivered message should be stored. */
LOGGER.severe("nable to print to connecting console"); public static final int QUEUE = 1;
LOGGER.log(Level.FINE, "Console error", e); /** The flag indicating that the messages should be stored in all cases. */
} public static final int PERSIST = 1 << 1;
} /** The connected output console */
} private ConsoleOutput output;
/** If the console is closed */
/* (non-Javadoc) private boolean close = false;
* @see java.lang.AutoCloseable#close() */
@Override /** If the messages should be stored. */
public void close() { private final boolean persistent;
close = true; /** If the message should be stored until delivery. */
} private final boolean queued;
/** The messages. */
/* (non-Javadoc) private final Deque<String> messages;
* @see fr.bigeon.gclc.manager.ConsoleOutput#isClosed() */ /** The number of stored messages. */
@Override private final int lines;
public boolean isClosed() {
return close; /** Create the console output.
} *
* @param style the type of redirected output
/* (non-Javadoc) * @param lines the number of lines to store */
* @see fr.bigeon.gclc.manager.ConsoleOutput#print(java.lang.String) */ public ConnectingConsoleOutput(final int style, final int lines) {
@Override super();
public void print(String text) { this.lines = lines;
addMessage(text); queued = (style & QUEUE) != 0;
} persistent = (style & PERSIST) != 0;
if (lines > 0) {
/* (non-Javadoc) messages = new ArrayDeque<>(lines);
* @see fr.bigeon.gclc.manager.ConsoleOutput#println() */ } else {
@Override messages = new ArrayDeque<>();
public void println() { }
addMessage(System.lineSeparator()); }
}
/** Add a message.
/* (non-Javadoc) *
* @see fr.bigeon.gclc.manager.ConsoleOutput#println(java.lang.String) */ * @param text the message */
@Override private synchronized void addMessage(final String text) {
public void println(String message) { if (persistent || queued && output == null) {
addMessage(message + System.lineSeparator()); if (messages.size() == lines) {
} messages.poll();
}
public synchronized void connect(ConsoleOutput output) { messages.offer(text);
this.output = output; }
for (final String string : messages) { if (output != null) {
try { try {
output.print(string); output.print(text);
} catch (final IOException e) { } catch (final IOException e) {
LOGGER.severe("nable to print to connecting console"); LOGGER.severe("nable to print to connecting console");
LOGGER.log(Level.FINE, "Console error", e); LOGGER.log(Level.FINE, "Console error", e);
} }
} }
if (!persistent) { }
messages.clear();
} /* (non-Javadoc)
} * @see java.lang.AutoCloseable#close() */
@Override
public synchronized void disconnect() { public void close() {
output = null; close = true;
} }
}
/** Connect an output.
*
* @param output the output */
public synchronized void connect(final 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();
}
}
/** Disconnect the currently connected output. */
public synchronized void disconnect() {
output = null;
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleOutput#isClosed() */
@Override
public boolean isClosed() {
return close;
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleOutput#print(java.lang.String) */
@Override
public void print(final String text) {
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(final String message) {
addMessage(message + System.lineSeparator());
}
}

View File

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

View File

@@ -1,64 +1,48 @@
/* /** This package defines elements for processes inside a console application.
* process, Distribution repositories and basic setup for Emmanuel Bigeon projects * <p>
* Copyright (C) 2014-2018 E. Bigeon * Processes are tasks that are run in background of the application. One may
* mailto:emmanuel@bigeon.fr * want to temporarily connect to such a task (through
* * {@link net.bigeon.gclc.process.CommandForeground}), or verify it's actual
* This software is governed by the CeCILL license under French law and * running status (through {@link net.bigeon.gclc.process.ProcessList}. One may
* abiding by the rules of distribution of free software. You can use, * also want to start such a process (through
* modify and/or redistribute the software under the terms of the CeCILL * {@link net.bigeon.gclc.process.ForkCommandTask}) or close it (through
* license as circulated by CEA, CNRS and INRIA at the following URL * {@link net.bigeon.gclc.process.ProcessKill}).
* "http://www.cecill.info". * <p>
* * The task list can be managed by several commands to list or clear it.
* 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 * @author Emmanuel Bigeon */
* with a limited warranty and the software's author, the holder of the package net.bigeon.gclc.process;
* economic rights, and the successive licensors have only limited
* liability. /*-
* * #%L
* In this respect, the user's attention is drawn to the risks associated * process
* with loading, using, modifying and/or developing or reproducing the * %%
* software by the user in light of its specific status of free software, * Copyright (C) 2014 - 2018 Bigeon
* that may mean that it is complicated to manipulate, and that also * %%
* therefore means that it is reserved for developers and experienced * This software is governed by the CeCILL license under French law and
* professionals having in-depth computer knowledge. Users are therefore * abiding by the rules of distribution of free software. You can use,
* encouraged to load and test the software's suitability as regards their * modify and/ or redistribute the software under the terms of the CeCILL
* requirements in conditions enabling the security of their systems and/or * license as circulated by CEA, CNRS and INRIA at the following URL
* data to be ensured and, more generally, to use and operate it in the * "http://www.cecill.info".
* same conditions as regards security. *
* * As a counterpart to the access to the source code and rights to copy,
* The fact that you are presently reading this means that you have had * modify and redistribute granted by the license, users are provided only
* knowledge of the CeCILL license and that you accept its terms. * 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
package fr.bigeon.gclc.process; * with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
import fr.bigeon.gclc.ApplicationAttachement; * that may mean that it is complicated to manipulate, and that also
import fr.bigeon.gclc.command.ICommandProvider; * therefore means that it is reserved for developers and experienced
import fr.bigeon.gclc.exception.InvalidCommandName; * 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
* @author Emmanuel Bigeon * data to be ensured and, more generally, to use and operate it in the
* * same conditions as regards security.
*/ *
public class ProcessAttachement implements ApplicationAttachement { * The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
private final TaskPool pool; * #L%
*/
/** @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));
}
}

View File

@@ -34,11 +34,10 @@
--> -->
<project name="GCLC"> <project name="GCLC">
<bannerLeft> <bannerRight>
<name>GCLC</name> <src>https://bigeon.net/images/logo_48.png</src>
<src>banner_dev_60.png</src> <href>https://bigeon.net/</href>
<href>http://bigeon.net/</href> </bannerRight>
</bannerLeft>
<body> <body>
<menu ref="reports"/> <menu ref="reports"/>
</body> </body>

View File

@@ -1,101 +1,99 @@
<!-- GCLC Socket, Socket implementation of GCLC --> <!-- GCLC Socket, Socket implementation of GCLC -->
<!-- Copyright (C) 2014-2017 E. Bigeon --> <!-- Copyright (C) 2014-2017 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. -->
<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/maven-v4_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/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion> <modelVersion>4.0.0</modelVersion>
<artifactId>gclc-socket</artifactId> <artifactId>socket</artifactId>
<version>1.1.11-SNAPSHOT</version> <version>1.1.12-SNAPSHOT</version>
<packaging>jar</packaging> <packaging>jar</packaging>
<url>http://www.bigeon.net</url> <url>https://bigeon.net/projects/gclc.html</url>
<properties> <properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.scm.id>git.code.bigeon.net</project.scm.id> <project.scm.id>git.code.bigeon.net</project.scm.id>
<license.licenseName>cecill_2.1</license.licenseName> <license.licenseName>cecill_2.1</license.licenseName>
<copyright.email>emmanuel@bigeon.fr</copyright.email> </properties>
</properties> <dependencies>
<dependencies> <dependency>
<dependency> <groupId>net.bigeon</groupId>
<groupId>net.bigeon</groupId> <artifactId>gclc</artifactId>
<artifactId>gclc</artifactId> <version>2.0.9</version>
<version>2.0.7</version> </dependency>
</dependency> <dependency>
<dependency> <groupId>net.bigeon</groupId>
<groupId>net.bigeon</groupId> <artifactId>smu</artifactId>
<artifactId>smu</artifactId> <version>1.0.5</version>
<version>1.0.0</version> </dependency>
</dependency> </dependencies>
</dependencies> <parent>
<parent> <groupId>net.bigeon.config</groupId>
<groupId>net.bigeon.config</groupId> <artifactId>ebigeon-config</artifactId>
<artifactId>ebigeon-config</artifactId> <version>1.8.21</version>
<version>1.8.4</version> </parent>
</parent> <licenses>
<licenses> <license>
<license> <distribution>manual</distribution>
<distribution>manual</distribution> <name>CeCILL 2.1</name>
<name>CeCILL 2.1</name> <url>https://cecill.info/licences/Licence_CeCILL_V2.1-en.html</url>
<url>https://cecill.info/licences/Licence_CeCILL_V2.1-en.html</url> </license>
</license> </licenses>
</licenses> <reporting>
<reporting> <plugins>
<plugins> <plugin>
<plugin> <groupId>com.github.sevntu-checkstyle</groupId>
<groupId>org.apache.maven.plugins</groupId> <artifactId>dsm-maven-plugin</artifactId>
<artifactId>maven-javadoc-plugin</artifactId> <version>2.2.0</version>
<version>2.10.3</version> </plugin>
</plugin> </plugins>
<plugin> </reporting>
<groupId>com.github.sevntu-checkstyle</groupId> <developers>
<artifactId>dsm-maven-plugin</artifactId> <developer>
<version>2.2.0</version> <email>emmanuel@bigeon.fr</email>
</plugin> <name>Emmanuel Bigeon</name>
</plugins> <url>bigeon.net</url>
</reporting> <roles>
<developers> <role>PM</role>
<developer> </roles>
<email>emmanuel@bigeon.fr</email> </developer>
<name>Emmanuel Bigeon</name> </developers>
<url>bigeon.net</url> <name>GCLC Socket</name>
<roles> <description>Socket implementation of GCLC</description>
<role>PM</role> <scm>
</roles> <developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection>
</developer> <tag>HEAD</tag>
</developers> </scm>
<name>GCLC Socket</name> <groupId>net.bigeon.gclc</groupId>
<description>Socket implementation of GCLC</description> <inceptionYear>2016</inceptionYear>
<scm> <organization>
<developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection> <name>Bigeon</name>
<tag>HEAD</tag> <url>https://bigeon.net/</url>
</scm> </organization>
<groupId>net.bigeon.gclc</groupId> </project>
<inceptionYear>2016</inceptionYear>
</project>

View File

@@ -11,17 +11,17 @@ package net.bigeon.gclc.socket;
* Copyright (C) 2016 - 2018 Bigeon * Copyright (C) 2016 - 2018 Bigeon
* %% * %%
* 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,
@@ -29,10 +29,10 @@ package net.bigeon.gclc.socket;
* 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.
* #L% * #L%

View File

@@ -11,17 +11,17 @@ package net.bigeon.gclc.socket;
* Copyright (C) 2016 - 2018 Bigeon * Copyright (C) 2016 - 2018 Bigeon
* %% * %%
* 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,
@@ -29,10 +29,10 @@ package net.bigeon.gclc.socket;
* 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.
* #L% * #L%
@@ -50,23 +50,24 @@ import java.util.logging.Logger;
public final class DConnexionManager<T> implements ConnexionManager<T> { public final class DConnexionManager<T> implements ConnexionManager<T> {
/** Class logger. */ /** Class logger. */
private static final Logger LOGGER = Logger private static final Logger LOGGER = Logger
.getLogger(DConnexionManager.class.getName()); .getLogger(DConnexionManager.class.getName());
/** The connected objects. */ /** The connected objects. */
private final Map<String, T> connecteds = new HashMap<>(); private final Map<String, T> connecteds = new HashMap<>();
/** The locks for the connexions. */ /** The locks for the connexions. */
private final Map<String, Object> locks = new HashMap<>(); private final Map<String, Object> locks = new HashMap<>();
/** The counter for the disconnexion locks. */ /** The counter for the disconnexion locks. */
private final Map<String, Integer> counters = new HashMap<>(); private final Map<String, Integer> counters = new HashMap<>();
/** The lock for modification of {@link #counters}. */ /** The lock for modification of {@link #counters}. */
private final Object counterLock = new Object(); private final Object counterLock = new Object();
/** The count of connexions. */ /** The count of connexions. */
private int count = 0; private int count;
/** Default.constructor. */ /** Default.constructor. */
public DConnexionManager() { public DConnexionManager() {
// //
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see * @see
* net.bigeon.gclc.socket.ConnexionManager#addConnexion(java.lang.Object) */ * net.bigeon.gclc.socket.ConnexionManager#addConnexion(java.lang.Object) */
@@ -80,29 +81,28 @@ public final class DConnexionManager<T> implements ConnexionManager<T> {
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see * @see net.bigeon.gclc.socket.ConnexionManager#disconnect(java.lang.String) */
* net.bigeon.gclc.socket.ConnexionManager#disconnect(java.lang.String) */
@Override @Override
public T disconnect(final String id) { public T disconnect(final String id) {
if (connecteds.containsKey(id)) { if (!connecteds.containsKey(id)) {
final T disc = connecteds.remove(id); return null;
final Object lock = locks.get(id); }
synchronized (lock) { final T disc = connecteds.remove(id);
lock.notifyAll(); final Object lock = locks.get(id);
} synchronized (lock) {
synchronized (counterLock) { lock.notifyAll();
while (counters.get(id).intValue() > 0) { }
try { synchronized (counterLock) {
counterLock.wait(); while (counters.get(id).intValue() > 0) {
} catch (final InterruptedException e) { try {
LOGGER.log(Level.FINE, "Interruption of thread", e); //$NON-NLS-1$ counterLock.wait();
Thread.currentThread().interrupt(); } catch (final InterruptedException e) {
} LOGGER.log(Level.FINE, "Interruption of thread", e); //$NON-NLS-1$
Thread.currentThread().interrupt();
} }
} }
return disc;
} }
return null; return disc;
} }
/* (non-Javadoc) /* (non-Javadoc)
@@ -120,8 +120,7 @@ public final class DConnexionManager<T> implements ConnexionManager<T> {
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see * @see net.bigeon.gclc.socket.ConnexionManager#isConnected(java.lang.String) */
* net.bigeon.gclc.socket.ConnexionManager#isConnected(java.lang.String) */
@Override @Override
public boolean isConnected(final String id) { public boolean isConnected(final String id) {
return connecteds.containsKey(id); return connecteds.containsKey(id);
@@ -154,8 +153,8 @@ public final class DConnexionManager<T> implements ConnexionManager<T> {
@Override @Override
public void releaseDisconnexionLock(final String id) { public void releaseDisconnexionLock(final String id) {
synchronized (counterLock) { synchronized (counterLock) {
counters.put(id, Integer counters.put(id,
.valueOf(Math.max(counters.get(id).intValue() - 1, 0))); Integer.valueOf(Math.max(counters.get(id).intValue() - 1, 0)));
counterLock.notifyAll(); counterLock.notifyAll();
} }
} }

View File

@@ -11,17 +11,17 @@ package net.bigeon.gclc.socket;
* Copyright (C) 2016 - 2018 Bigeon * Copyright (C) 2016 - 2018 Bigeon
* %% * %%
* 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,
@@ -29,10 +29,10 @@ package net.bigeon.gclc.socket;
* 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.
* #L% * #L%
@@ -54,35 +54,38 @@ import net.bigeon.gclc.utils.ReadingRunnable;
/** A console input where the stream can be plugged. /** A console input where the stream can be plugged.
* <p> * <p>
* This pluggable console input accepts an input and output to be connected to * This pluggable console input accepts an input and output to be connected to
* it. The connexion cannot be concurrent, which mean that any connected stream * it. The connection cannot be concurrent, which mean that any connected stream
* must be disconnected before a new call to * must be disconnected before a new call to
* {@link #connect(InputStream, PrintStream)} is done. * {@link #connect(InputStream, PrintStream)} is done.
* <p>
* On connection, if the prompt is in wait, this console input will provide the
* prompting message.
* *
* @author Emmanuel Bigeon */ * @author Emmanuel Bigeon */
public final class PluggableConsoleInput implements ConsoleInput { public final class PluggableConsoleInput implements ConsoleInput {
/** The ten constant. */ /** The ten constant. */
private static final int TENTH = 10; private static final int TENTH = 10;
/** Class logger. */ /** Class logger. */
private static final Logger LOGGER = Logger private static final Logger LOGGER = Logger
.getLogger(PluggableConsoleInput.class.getName()); .getLogger(PluggableConsoleInput.class.getName());
/** The default time out. */ /** The default time out. */
private static final long TIMEOUT = 100; private static final long TIMEOUT = 100;
/** The prompting. */ /** The prompting. */
private boolean prompting = false; private boolean prompting = false;
/** If the element is closed. */ /** If the element is closed. */
private boolean closed = false; private boolean closed = false;
/** The default prompt. */ /** The default prompt. */
private StringProvider prompt = new ConstantString("> "); //$NON-NLS-1$ private StringProvider prompt = new ConstantString("> "); //$NON-NLS-1$
/** If the input is plugged or buffering. */ /** If the input is plugged or buffering. */
private boolean connected = false; private boolean connected = false;
/** The current connexion (if any). */ /** The current connexion (if any). */
private ReadingRunnable connexion; private ReadingRunnable connexion;
/** The interrupted status for prompts. */ /** The interrupted status for prompts. */
private boolean interrupted = false; private boolean interrupted = false;
/** The last hint hint. */ /** The last hint hint. */
private String hint; private String hint;
/** The output for hints. */ /** The output for hints. */
private PrintStream output; private PrintStream output;
// Locks // Locks
/** The lock for connexion and disconnexion of actual streams. */ /** The lock for connexion and disconnexion of actual streams. */
@@ -100,28 +103,26 @@ public final class PluggableConsoleInput implements ConsoleInput {
closed = true; closed = true;
} }
/** Connect the given input stream to the input and output to the hints /** Connect the given input stream to the input and output to the hints writing.
* writing.
* *
* @param stream the input stream * @param stream the input stream
* @param out the output for hints. * @param out the output for hints.
* @throws IOException if the input is already connected. */ * @throws IOException if the input is already connected. */
public void connect(final InputStream stream, public void connect(final InputStream stream, final PrintStream out)
final PrintStream out) throws IOException { throws IOException {
synchronized (connexionLock) { synchronized (connexionLock) {
if (connected) { if (connected) {
throw new IOException( // Cannot be connected to several sources
"Input already connected to an input stream"); //$NON-NLS-1$ throw new IOException("Input already connected to an input stream"); //$NON-NLS-1$
} }
output = out; output = out;
if (prompting) { if (prompting) {
// print the hint, to indicate we are waiting for a user input.
out.print(hint); out.print(hint);
out.flush(); out.flush();
} }
final InputStreamReader streamReader = new InputStreamReader(stream,
final InputStreamReader streamReader = new InputStreamReader( StandardCharsets.UTF_8);
stream, StandardCharsets.UTF_8);
final BufferedReader reader = new BufferedReader(streamReader); final BufferedReader reader = new BufferedReader(streamReader);
connexion = new ReadingRunnable(reader); connexion = new ReadingRunnable(reader);
final Thread th = new Thread(connexion, "GCLC Socket - Read input"); //$NON-NLS-1$ final Thread th = new Thread(connexion, "GCLC Socket - Read input"); //$NON-NLS-1$
@@ -191,19 +192,11 @@ public final class PluggableConsoleInput implements ConsoleInput {
if (closed) { if (closed) {
throw new IOException(); throw new IOException();
} }
prompting = true; preparePrompt(message);
hint = message;
synchronized (connexionLock) {
hint = message;
if (connected) {
output.print(message);
output.flush();
}
}
String res = null; String res = null;
while (res == null && !interrupted) { while (res == null && !interrupted) {
try { try {
// Wait for a message or a connection with message
res = waitMessageOrConnexion(TIMEOUT, TIMEOUT / TENTH); res = waitMessageOrConnexion(TIMEOUT, TIMEOUT / TENTH);
} catch (final InterruptedException e) { } catch (final InterruptedException e) {
LOGGER.log(Level.FINE, "Interruption of thread", e); //$NON-NLS-1$ LOGGER.log(Level.FINE, "Interruption of thread", e); //$NON-NLS-1$
@@ -217,31 +210,36 @@ public final class PluggableConsoleInput implements ConsoleInput {
return res; return res;
} }
/* (non-Javadoc) /** Prepare the new prompt.
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String, *
* long) */ * @param message the message to indicate request of prompt. */
@Override private void preparePrompt(final String message) {
public String prompt(final String message,
final long timeout) throws IOException {
if (closed) {
throw new IOException();
}
prompting = true; prompting = true;
// hold the message
synchronized (connexionLock) { synchronized (connexionLock) {
hint = message; hint = message;
if (connected) { if (connected) {
// print the message
output.print(message); output.print(message);
output.flush(); output.flush();
} }
} }
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String, long) */
@Override
public String prompt(final String message, final long timeout) throws IOException {
if (closed) {
throw new IOException();
}
preparePrompt(message);
String res = null; String res = null;
final long tic = System.currentTimeMillis(); final long tic = System.currentTimeMillis();
long time = System.currentTimeMillis() - tic; long time = System.currentTimeMillis() - tic;
while (res == null && !interrupted && time < timeout) { while (res == null && !interrupted && time < timeout) {
try { try {
res = waitMessageOrConnexion(timeout - time, res = waitMessageOrConnexion(timeout - time, (timeout - time) / TENTH);
(timeout - time) / TENTH);
} catch (final InterruptedException e) { } catch (final InterruptedException e) {
LOGGER.log(Level.FINE, "Interruption of thread", e); //$NON-NLS-1$ LOGGER.log(Level.FINE, "Interruption of thread", e); //$NON-NLS-1$
Thread.currentThread().interrupt(); Thread.currentThread().interrupt();
@@ -255,26 +253,30 @@ public final class PluggableConsoleInput implements ConsoleInput {
return res; return res;
} }
/* (non-Javadoc)
* @see net.bigeon.gclc.manager.ConsoleInput#setPrompt(java.lang.String) */
@Override
public void setPrompt(final String prompt) {
setPrompt(new ConstantString(prompt));
}
/* (non-Javadoc)
* @see net.bigeon.gclc.manager.ConsoleInput#setPrompt(net.bigeon.gclc.tools.
* StringProvider) */
@Override @Override
public void setPrompt(final StringProvider prompt) { public void setPrompt(final StringProvider prompt) {
this.prompt = prompt; this.prompt = prompt;
} }
@Override
public void setPrompt(String prompt) {
setPrompt(new ConstantString(prompt));
}
/** Wait for a hint or connexion. /** Wait for a hint or connection.
* *
* @param messageTimeout the timeout on the current connexion hint waiting * @param messageTimeout the timeout on the current connection hint waiting
* @param connexionTimeout the timeout on the new connexion wait * @param connexionTimeout the timeout on the new connection wait
* @return the hint, or null if not connected or timed out. * @return the hint, or null if not connected or timed out.
* @throws IOException if the reading failed. * @throws IOException if the reading failed.
* @throws InterruptedException if the wait was interrupted */ * @throws InterruptedException if the wait was interrupted */
private String waitMessageOrConnexion(final long messageTimeout, private String waitMessageOrConnexion(final long messageTimeout,
final long connexionTimeout) throws IOException, final long connexionTimeout) throws IOException, InterruptedException {
InterruptedException {
synchronized (connexionLock) { synchronized (connexionLock) {
if (connected) { if (connected) {
return connexion.getNextMessage(messageTimeout); return connexion.getNextMessage(messageTimeout);

View File

@@ -11,17 +11,17 @@ package net.bigeon.gclc.socket;
* Copyright (C) 2016 - 2018 Bigeon * Copyright (C) 2016 - 2018 Bigeon
* %% * %%
* 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,
@@ -29,10 +29,10 @@ package net.bigeon.gclc.socket;
* 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.
* #L% * #L%
@@ -50,16 +50,17 @@ import net.bigeon.gclc.manager.ConsoleOutput;
public final class PluggableConsoleOutput implements ConsoleOutput { public final class PluggableConsoleOutput implements ConsoleOutput {
/** The actual output. */ /** The actual output. */
private PrintStream out; private PrintStream out;
/** The buffered messages. */ /** The buffered messages. */
private final Deque<String> messages = new ArrayDeque<>(); private final Deque<String> messages = new ArrayDeque<>();
/** If this output is closed. */ /** If this output is closed. */
private boolean closed = false; private boolean closed = false;
/** Default constructor. */ /** Default constructor. */
public PluggableConsoleOutput() { public PluggableConsoleOutput() {
// //
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see java.lang.AutoCloseable#close() */ * @see java.lang.AutoCloseable#close() */
@Override @Override

View File

@@ -11,17 +11,17 @@ package net.bigeon.gclc.socket;
* Copyright (C) 2016 - 2018 Bigeon * Copyright (C) 2016 - 2018 Bigeon
* %% * %%
* 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,
@@ -29,10 +29,10 @@ package net.bigeon.gclc.socket;
* 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.
* #L% * #L%
@@ -57,16 +57,16 @@ public final class RemoteDisconnectCommand<T> extends Command {
private final ConnexionManager<T> manager; private final ConnexionManager<T> manager;
/** If all connexion should be disconnected when no argument have been /** If all connexion should be disconnected when no argument have been
* specified. */ * specified. */
private final boolean all; private final boolean all;
/** Create the disconnection command. /** Create the disconnection command.
* *
* @param name the command name * @param name the command name
* @param manager the manager * @param manager the manager
* @param all if all elements should be disconnected when no argument is * @param all if all elements should be disconnected when no argument is
* provided */ * provided */
public RemoteDisconnectCommand(final String name, public RemoteDisconnectCommand(final String name, final ConnexionManager<T> manager,
final ConnexionManager<T> manager, final boolean all) { final boolean all) {
super(name); super(name);
this.manager = manager; this.manager = manager;
this.all = all; this.all = all;
@@ -74,11 +74,10 @@ public final class RemoteDisconnectCommand<T> extends Command {
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.manager. * @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.manager.
* ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput, * ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput, java.lang.String[]) */
* java.lang.String[]) */
@Override @Override
public void execute(final ConsoleOutput out, final ConsoleInput in, public void execute(final ConsoleOutput out, final ConsoleInput in,
final String... args) throws CommandRunException { final String... args) throws CommandRunException {
if (args.length == 0 && all) { if (args.length == 0 && all) {
final Collection<String> coll = manager.getConnected(); final Collection<String> coll = manager.getConnected();
for (final String string : coll) { for (final String string : coll) {
@@ -89,8 +88,8 @@ public final class RemoteDisconnectCommand<T> extends Command {
if (manager.isConnected(string)) { if (manager.isConnected(string)) {
manager.disconnect(string); manager.disconnect(string);
} else { } else {
print(out, MessageFormat print(out,
.format("[WARNING] {0} is not connected", string)); //$NON-NLS-1$ MessageFormat.format("[WARNING] {0} is not connected", string)); //$NON-NLS-1$
} }
} }
} }
@@ -99,16 +98,14 @@ public final class RemoteDisconnectCommand<T> extends Command {
* *
* @param out the output * @param out the output
* @param string the message * @param string the message
* @throws CommandRunException if the output exists but cannot be printed * @throws CommandRunException if the output exists but cannot be printed to */
* to */ private static void print(final ConsoleOutput out, final String string)
private void print(final ConsoleOutput out, throws CommandRunException {
final String string) throws CommandRunException {
if (out != null) { if (out != null) {
try { try {
out.println(string); out.println(string);
} catch (final IOException e) { } catch (final IOException e) {
throw new CommandRunException( throw new CommandRunException(CommandRunExceptionType.INTERACTION,
CommandRunExceptionType.INTERACTION,
"Unable to print to existing output", e); //$NON-NLS-1$ "Unable to print to existing output", e); //$NON-NLS-1$
} }
} }
@@ -123,12 +120,11 @@ public final class RemoteDisconnectCommand<T> extends Command {
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#usageDetail() */ * @see fr.bigeon.gclc.command.Command#usageDetail() */
@SuppressWarnings("nls")
@Override @Override
protected String usageDetail() { protected String usageDetail() {
return MessageFormat.format( return MessageFormat.format(
" If arguments are provided the corresponding connexions are closed, " + " If arguments are provided the corresponding connexions are closed, "
"otherwise{0}{1} are.", + "otherwise{0}{1} are.",
System.lineSeparator(), all ? "all connexions" : "none"); System.lineSeparator(), all ? "all connexions" : "none");
} }
} }

View File

@@ -7,17 +7,17 @@ package net.bigeon.gclc.socket;
* Copyright (C) 2016 - 2018 Bigeon * Copyright (C) 2016 - 2018 Bigeon
* %% * %%
* 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,
@@ -25,10 +25,10 @@ package net.bigeon.gclc.socket;
* 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.
* #L% * #L%
@@ -64,31 +64,30 @@ import net.bigeon.gclc.ConsoleApplication;
public final class SocketConsoleApplicationShell implements Runnable { public final class SocketConsoleApplicationShell implements Runnable {
/** The class logger. */ /** The class logger. */
private static final Logger LOGGER = Logger private static final Logger LOGGER = Logger
.getLogger(SocketConsoleApplicationShell.class.getName()); .getLogger(SocketConsoleApplicationShell.class.getName());
/** The listening port. */ /** The listening port. */
private final int port; private final int port;
/** The running status. */ /** The running status. */
private boolean running; private boolean running;
/** The socket console interface. */ /** The socket console interface. */
private SocketConsoleInterface sci; private SocketConsoleInterface sci;
/** The remote disconnection command. */ /** The remote disconnection command. */
private ConnexionManager<Socket> rdc; private ConnexionManager<Socket> rdc;
/** The application. */ /** The application. */
private ConsoleApplication app; private ConsoleApplication app;
/** The server socket. */ /** The server socket. */
private ServerSocket serverSocket; private ServerSocket serverSocket;
/** THe server address. */ /** THe server address. */
private final InetAddress addr; private final InetAddress addr;
/** Create a socket application shell which will listen on the given port /** Create a socket application shell which will listen on the given port and
* and network interface. * network interface.
* *
* @param port the part * @param port the part
* @param addr the inet address */ * @param addr the inet address */
public SocketConsoleApplicationShell(final int port, public SocketConsoleApplicationShell(final int port, final InetAddress addr) {
final InetAddress addr) {
super(); super();
this.port = port; this.port = port;
this.addr = addr; this.addr = addr;
@@ -110,9 +109,9 @@ public final class SocketConsoleApplicationShell implements Runnable {
} }
/** If the port provided was 0, this allows to get the actual port. /** If the port provided was 0, this allows to get the actual port.
*
* @return the local port * @return the local port
* @see java.net.ServerSocket#getLocalPort() * @see java.net.ServerSocket#getLocalPort() */
*/
public int getLocalPort() { public int getLocalPort() {
return serverSocket.getLocalPort(); return serverSocket.getLocalPort();
} }
@@ -122,16 +121,14 @@ public final class SocketConsoleApplicationShell implements Runnable {
@Override @Override
public void run() { public void run() {
// Create the server // Create the server
try (ServerSocket actualServerSocket = new ServerSocket(port, 1, try (ServerSocket actualServerSocket = new ServerSocket(port, 1, addr)) {
addr)) {
serverSocket = actualServerSocket; serverSocket = actualServerSocket;
running = true; running = true;
// Create the streams // Create the streams
runSokectServer(); runSokectServer();
} catch (final IOException e) { } catch (final IOException e) {
LOGGER.severe("Communication error between client and server"); //$NON-NLS-1$ LOGGER.severe("Communication error between client and server"); //$NON-NLS-1$
LOGGER.log(Level.FINE, LOGGER.log(Level.FINE, "Communication error between client and server", e); //$NON-NLS-1$
"Communication error between client and server", e); //$NON-NLS-1$
} }
} }
@@ -141,7 +138,7 @@ public final class SocketConsoleApplicationShell implements Runnable {
private void runSokectServer() throws IOException { private void runSokectServer() throws IOException {
while (running && app.isRunning()) { while (running && app.isRunning()) {
LOGGER.info("Waiting client"); //$NON-NLS-1$ LOGGER.info("Waiting client"); //$NON-NLS-1$
try (Socket clientSocket = serverSocket.accept();) { try (Socket clientSocket = serverSocket.accept()) {
sci.connect(clientSocket); sci.connect(clientSocket);

View File

@@ -11,17 +11,17 @@ package net.bigeon.gclc.socket;
* Copyright (C) 2016 - 2018 Bigeon * Copyright (C) 2016 - 2018 Bigeon
* %% * %%
* 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,
@@ -29,10 +29,10 @@ package net.bigeon.gclc.socket;
* 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.
* #L% * #L%
@@ -48,7 +48,7 @@ import java.nio.charset.StandardCharsets;
public final class SocketConsoleInterface { public final class SocketConsoleInterface {
/** The application's input. */ /** The application's input. */
private final PluggableConsoleInput input; private final PluggableConsoleInput input;
/** The application's output. */ /** The application's output. */
private final PluggableConsoleOutput output; private final PluggableConsoleOutput output;
@@ -57,7 +57,7 @@ public final class SocketConsoleInterface {
* @param input the input * @param input the input
* @param output the output */ * @param output the output */
public SocketConsoleInterface(final PluggableConsoleInput input, public SocketConsoleInterface(final PluggableConsoleInput input,
final PluggableConsoleOutput output) { final PluggableConsoleOutput output) {
super(); super();
this.input = input; this.input = input;
this.output = output; this.output = output;
@@ -68,12 +68,10 @@ public final class SocketConsoleInterface {
* @param socket the socket * @param socket the socket
* @throws IOException if the connection failed */ * @throws IOException if the connection failed */
public void connect(final Socket socket) throws IOException { public void connect(final Socket socket) throws IOException {
final PrintStream printStream = new PrintStream( final PrintStream printStream = new PrintStream(socket.getOutputStream(), true,
socket.getOutputStream(), true,
StandardCharsets.UTF_8.name()); StandardCharsets.UTF_8.name());
output.connect(printStream); output.connect(printStream);
input.connect(socket.getInputStream(), input.connect(socket.getInputStream(), printStream);
printStream);
} }
/** Disconnect the input and output of the application from the socket's. */ /** Disconnect the input and output of the application from the socket's. */

View File

@@ -11,17 +11,17 @@ package net.bigeon.gclc.socket;
* Copyright (C) 2016 - 2018 Bigeon * Copyright (C) 2016 - 2018 Bigeon
* %% * %%
* 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,
@@ -29,10 +29,10 @@ package net.bigeon.gclc.socket;
* 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.
* #L% * #L%

View File

@@ -0,0 +1,44 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
#%L
Generic Command Ligne console
%%
Copyright (C) 2014 - 2018 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
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%
-->
<project name="GCLC">
<bannerRight>
<src>https://bigeon.net/images/logo_48.png</src>
<href>https://bigeon.net/</href>
</bannerRight>
<body>
<menu ref="reports"/>
</body>
</project>

View File

@@ -7,17 +7,17 @@ package net.bigeon.gclc.socket;
* Copyright (C) 2016 - 2018 Bigeon * Copyright (C) 2016 - 2018 Bigeon
* %% * %%
* 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,
@@ -25,10 +25,10 @@ package net.bigeon.gclc.socket;
* 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.
* #L% * #L%
@@ -39,14 +39,12 @@ import java.util.Collection;
import net.bigeon.gclc.ConsoleApplication; import net.bigeon.gclc.ConsoleApplication;
import net.bigeon.gclc.command.Command; import net.bigeon.gclc.command.Command;
import net.bigeon.gclc.command.HelpExecutor;
import net.bigeon.gclc.command.base.ExitCommand; import net.bigeon.gclc.command.base.ExitCommand;
import net.bigeon.gclc.command.base.HelpExecutor;
import net.bigeon.gclc.exception.CommandRunException; import net.bigeon.gclc.exception.CommandRunException;
import net.bigeon.gclc.exception.InvalidCommandName; import net.bigeon.gclc.exception.InvalidCommandName;
import net.bigeon.gclc.manager.ConsoleInput; import net.bigeon.gclc.manager.ConsoleInput;
import net.bigeon.gclc.manager.ConsoleOutput; import net.bigeon.gclc.manager.ConsoleOutput;
import net.bigeon.gclc.socket.ConnexionManager;
import net.bigeon.gclc.socket.RemoteDisconnectCommand;
/** A test-purpose application /** A test-purpose application
* *
@@ -57,20 +55,17 @@ public class ConsoleTestApplication {
public static final String EXIT = "exit"; //$NON-NLS-1$ public static final String EXIT = "exit"; //$NON-NLS-1$
/** Create the test application. /** Create the test application.
* *
* @param output the output * @param output the output
* @param input the input * @param input the input
* @param manager the manager * @param manager the manager
* @return create the application */ * @return create the application */
@SuppressWarnings("nls") @SuppressWarnings("nls")
public static ConsoleApplication create(final ConsoleOutput output, public static ConsoleApplication create(final ConsoleOutput output,
final ConsoleInput input, final ConsoleInput input, final ConnexionManager<Socket> manager) {
final ConnexionManager<Socket> manager) {
try { try {
final ConsoleApplication application = new ConsoleApplication( final ConsoleApplication application = new ConsoleApplication(output, input,
output, input, "Welcome to the test application. Type help or test.", "See you");
"Welcome to the test application. Type help or test.",
"See you");
application.add(new ExitCommand(EXIT, application) { application.add(new ExitCommand(EXIT, application) {
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.command.ExitCommand#beforeExit() */ * @see fr.bigeon.gclc.command.ExitCommand#beforeExit() */
@@ -82,8 +77,7 @@ public class ConsoleTestApplication {
} }
} }
}); });
application application.add(new HelpExecutor("help", application.root));
.add(new HelpExecutor("help", application.root));
application.add(new Command("test") { application.add(new Command("test") {
/* (non-Javadoc) /* (non-Javadoc)
@@ -91,9 +85,8 @@ public class ConsoleTestApplication {
* manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput, * manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
* java.lang.String[]) */ * java.lang.String[]) */
@Override @Override
public void execute(final ConsoleOutput out, public void execute(final ConsoleOutput out, final ConsoleInput in,
final ConsoleInput in, final String... args) throws CommandRunException {
final String... args) throws CommandRunException {
try { try {
output.println("Test command ran fine"); output.println("Test command ran fine");
} catch (final IOException e) { } catch (final IOException e) {
@@ -107,8 +100,7 @@ public class ConsoleTestApplication {
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#usageDetail() * @see fr.bigeon.gclc.command.Command#usageDetail() */
*/
@Override @Override
protected String usageDetail() { protected String usageDetail() {
// TODO Auto-generated method stub // TODO Auto-generated method stub
@@ -123,11 +115,13 @@ public class ConsoleTestApplication {
* manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput, * manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
* java.lang.String[]) */ * java.lang.String[]) */
@Override @Override
public void execute(final ConsoleOutput out, public void execute(final ConsoleOutput out, final ConsoleInput in,
final ConsoleInput in, final String... args) throws CommandRunException {
final String... args) throws CommandRunException {
try { try {
Thread.sleep(2000); Object obj = new Object();
synchronized (obj) {
obj.wait(2000);
}
output.println("Test command ran fine"); output.println("Test command ran fine");
} catch (IOException | InterruptedException e) { } catch (IOException | InterruptedException e) {
throw new CommandRunException("manager closed", e); throw new CommandRunException("manager closed", e);
@@ -140,8 +134,7 @@ public class ConsoleTestApplication {
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#usageDetail() * @see fr.bigeon.gclc.command.Command#usageDetail() */
*/
@Override @Override
protected String usageDetail() { protected String usageDetail() {
// TODO Auto-generated method stub // TODO Auto-generated method stub
@@ -149,8 +142,7 @@ public class ConsoleTestApplication {
throw new RuntimeException("Not implemented yet"); throw new RuntimeException("Not implemented yet");
} }
}); });
application.add( application.add(new RemoteDisconnectCommand<>("out", manager, true));
new RemoteDisconnectCommand<>("out", manager, true));
return application; return application;
} catch (final InvalidCommandName e) { } catch (final InvalidCommandName e) {
e.printStackTrace(); e.printStackTrace();

View File

@@ -11,17 +11,17 @@ package net.bigeon.gclc.socket;
* Copyright (C) 2016 - 2018 Bigeon * Copyright (C) 2016 - 2018 Bigeon
* %% * %%
* 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,
@@ -29,16 +29,17 @@ package net.bigeon.gclc.socket;
* 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.
* #L% * #L%
*/ */
import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse; import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertTrue; import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail; import static org.junit.Assert.fail;
@@ -46,11 +47,10 @@ import java.io.IOException;
import java.io.PipedInputStream; import java.io.PipedInputStream;
import java.io.PipedOutputStream; import java.io.PipedOutputStream;
import java.io.PrintStream; import java.io.PrintStream;
import java.util.concurrent.atomic.AtomicReference;
import org.junit.Test; import org.junit.Test;
import net.bigeon.gclc.socket.PluggableConsoleInput;
/** /**
* <p> * <p>
* TODO * TODO
@@ -90,7 +90,10 @@ public class PluggableConsoleInputTest {
} }
try { try {
Thread.sleep(100); Object obj = new Object();
synchronized (obj) {
obj.wait(100);
}
} catch (final InterruptedException e) { } catch (final InterruptedException e) {
// TODO Auto-generated catch block // TODO Auto-generated catch block
e.printStackTrace(); e.printStackTrace();
@@ -112,7 +115,10 @@ public class PluggableConsoleInputTest {
@Override @Override
public void run() { public void run() {
try { try {
Thread.sleep(200); Object obj = new Object();
synchronized (obj) {
obj.wait(200);
}
} catch (final InterruptedException e) { } catch (final InterruptedException e) {
// TODO Auto-generated catch block // TODO Auto-generated catch block
e.printStackTrace(); e.printStackTrace();
@@ -135,11 +141,11 @@ public class PluggableConsoleInputTest {
input.disconnect(); input.disconnect();
try (final PipedInputStream pis = new PipedInputStream(); try (final PipedInputStream pis = new PipedInputStream();
final PipedOutputStream pos = new PipedOutputStream(); final PipedOutputStream pos = new PipedOutputStream();
final PipedInputStream inner = new PipedInputStream(pos); final PipedInputStream inner = new PipedInputStream(pos);
final PipedOutputStream innerPos = new PipedOutputStream(pis); final PipedOutputStream innerPos = new PipedOutputStream(pis);
final PrintStream testIn = new PrintStream(innerPos, true, "UTF8"); final PrintStream testIn = new PrintStream(innerPos, true, "UTF8");
final PrintStream out = new PrintStream(pos)) { final PrintStream out = new PrintStream(pos)) {
input.connect(pis, out); input.connect(pis, out);
try { try {
input.connect(pis, out); input.connect(pis, out);
@@ -162,32 +168,40 @@ public class PluggableConsoleInputTest {
}); });
th.start(); th.start();
while (!input.isPrompting()) { Object obj = new Object();
Thread.sleep(10); synchronized (obj) {
while (!input.isPrompting()) {
obj.wait(10);
}
} }
input.connect(pis, out); input.connect(pis, out);
testIn.println("tac"); testIn.println("tac");
final AtomicReference<IOException> ref = new AtomicReference<>();
final Thread th2 = new Thread(new Runnable() { final Thread th2 = new Thread(new Runnable() {
@Override @Override
public void run() { public void run() {
try { try {
input.prompt("Test", 5000); input.prompt("Test", 5000);
fail("Prompt should io"); // fail("Prompt should io");
} catch (final IOException e) { } catch (final IOException e) {
// ok // ok
ref.set(e);
} }
} }
}); });
th2.start(); th2.start();
while (!input.isPrompting()) { synchronized (obj) {
Thread.sleep(10); while (!input.isPrompting()) {
obj.wait(10);
}
} }
input.close(); input.close();
th2.join();
assertNotNull("Prompt should io", ref.get());
} }
} }

View File

@@ -11,17 +11,17 @@ package net.bigeon.gclc.socket;
* Copyright (C) 2016 - 2018 Bigeon * Copyright (C) 2016 - 2018 Bigeon
* %% * %%
* 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,
@@ -29,10 +29,10 @@ package net.bigeon.gclc.socket;
* 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.
* #L% * #L%
@@ -46,8 +46,6 @@ import java.io.IOException;
import org.junit.Test; import org.junit.Test;
import net.bigeon.gclc.exception.CommandRunException; import net.bigeon.gclc.exception.CommandRunException;
import net.bigeon.gclc.socket.DConnexionManager;
import net.bigeon.gclc.socket.RemoteDisconnectCommand;
import net.bigeon.gclc.utils.PipedConsoleOutput; import net.bigeon.gclc.utils.PipedConsoleOutput;
/** /**
@@ -65,10 +63,10 @@ public class RemoteDisconnectCommandTest {
@Test @Test
public final void testExecute() throws CommandRunException, IOException { public final void testExecute() throws CommandRunException, IOException {
final DConnexionManager<String> manager = new DConnexionManager<>(); final DConnexionManager<String> manager = new DConnexionManager<>();
final RemoteDisconnectCommand<String> cmd = new RemoteDisconnectCommand<>( final RemoteDisconnectCommand<String> cmd = new RemoteDisconnectCommand<>("quit",
"quit", manager, true); manager, true);
final RemoteDisconnectCommand<String> cmd2 = new RemoteDisconnectCommand<>( final RemoteDisconnectCommand<String> cmd2 = new RemoteDisconnectCommand<>("quit",
"quit", manager, false); manager, false);
manager.addConnexion("test"); manager.addConnexion("test");
cmd2.execute(null, null); cmd2.execute(null, null);

View File

@@ -11,17 +11,17 @@ package net.bigeon.gclc.socket;
* Copyright (C) 2016 - 2018 Bigeon * Copyright (C) 2016 - 2018 Bigeon
* %% * %%
* 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,
@@ -29,10 +29,10 @@ package net.bigeon.gclc.socket;
* 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.
* #L% * #L%
@@ -48,12 +48,10 @@ import java.util.logging.Logger;
import org.junit.Test; import org.junit.Test;
import net.bigeon.gclc.socket.SocketConsoleApplicationShell;
/** Test class for {@link SocketConsoleApplicationShell} /** Test class for {@link SocketConsoleApplicationShell}
* *
* @author Emmanuel Bigeon */ * @author Emmanuel Bigeon */
@SuppressWarnings({"static-method", "javadoc", "nls"}) @SuppressWarnings({ "static-method", "javadoc", "nls" })
public class SocketConsoleApplicationTest { public class SocketConsoleApplicationTest {
private static final Logger LOGGER = Logger private static final Logger LOGGER = Logger
@@ -62,12 +60,12 @@ public class SocketConsoleApplicationTest {
/** @param in the input /** @param in the input
* @return the string * @return the string
* @throws IOException if the input reading failed */ * @throws IOException if the input reading failed */
private String consumeToPrompt(final String server, private String consumeToPrompt(final String server, final BufferedReader in)
final BufferedReader in) throws IOException { throws IOException {
String fromServer = server; String fromServer = server;
LOGGER.fine("Server: \n" + fromServer); LOGGER.fine("Server: \n" + fromServer);
while (fromServer != null && !fromServer.equals("Bye.") && while (fromServer != null && !fromServer.equals("Bye.")
!fromServer.equals("> ")) { && !fromServer.equals("> ")) {
fromServer = in.readLine(); fromServer = in.readLine();
LOGGER.fine("Server: \n" + fromServer); LOGGER.fine("Server: \n" + fromServer);
} }
@@ -78,19 +76,17 @@ public class SocketConsoleApplicationTest {
public void testIntegration() throws IOException, InterruptedException { public void testIntegration() throws IOException, InterruptedException {
Thread server; Thread server;
server = TestServer.getServer(); server = TestServer.getServer();
Thread.sleep(1000);
final String hostName = "127.0.0.1"; final String hostName = "127.0.0.1";
final int portNumber = 3300; final int portNumber = 3300;
try (Socket kkSocket = new Socket(hostName, portNumber); try (Socket kkSocket = new Socket(hostName, portNumber);
PrintWriter out = new PrintWriter(kkSocket.getOutputStream(), PrintWriter out = new PrintWriter(kkSocket.getOutputStream(), true);
true); BufferedReader in = new BufferedReader(
BufferedReader in = new BufferedReader( new InputStreamReader(kkSocket.getInputStream()));) {
new InputStreamReader(kkSocket.getInputStream()));) {
String fromServer; String fromServer;
int i = -1; int i = -1;
final String[] cmds = {"help", "toto", "test", "out"}; final String[] cmds = { "help", "toto", "test", "out" };
while ((fromServer = in.readLine()) != null) { while ((fromServer = in.readLine()) != null) {
i++; i++;
fromServer = consumeToPrompt(fromServer, in); fromServer = consumeToPrompt(fromServer, in);
@@ -108,15 +104,13 @@ public class SocketConsoleApplicationTest {
} }
try (Socket kkSocket = new Socket(hostName, portNumber); try (Socket kkSocket = new Socket(hostName, portNumber);
PrintWriter out = new PrintWriter(kkSocket.getOutputStream(), PrintWriter out = new PrintWriter(kkSocket.getOutputStream(), true);
true); BufferedReader in = new BufferedReader(
BufferedReader in = new BufferedReader( new InputStreamReader(kkSocket.getInputStream()));) {
new InputStreamReader(kkSocket.getInputStream()));) {
String fromServer; String fromServer;
int i = 0; int i = 0;
final String[] cmds = {"help", "toto", "test", final String[] cmds = { "help", "toto", "test", ConsoleTestApplication.EXIT };
ConsoleTestApplication.EXIT};
while ((fromServer = in.readLine()) != null) { while ((fromServer = in.readLine()) != null) {
fromServer = consumeToPrompt(fromServer, in); fromServer = consumeToPrompt(fromServer, in);
if (fromServer == null || fromServer.equals("Bye.")) { if (fromServer == null || fromServer.equals("Bye.")) {
@@ -131,26 +125,20 @@ public class SocketConsoleApplicationTest {
} }
i++; i++;
} }
assertEquals("Application exit command should close connection", 4, assertEquals("Application exit command should close connection", 4, i);
i);
} }
Thread.sleep(100);
TestServer.closeServer(); TestServer.closeServer();
server.join(); server.join();
server = TestServer.getServer(); server = TestServer.getServer();
Thread.sleep(1000);
try (Socket kkSocket = new Socket(hostName, portNumber); try (Socket kkSocket = new Socket(hostName, portNumber);
PrintWriter out = new PrintWriter(kkSocket.getOutputStream(), PrintWriter out = new PrintWriter(kkSocket.getOutputStream(), true);
true); BufferedReader in = new BufferedReader(
BufferedReader in = new BufferedReader( new InputStreamReader(kkSocket.getInputStream()));) {
new InputStreamReader(kkSocket.getInputStream()));) {
String fromServer; String fromServer;
int i = 0; int i = 0;
final String[] cmds = {"help", "toto", "test", final String[] cmds = { "help", "toto", "test", ConsoleTestApplication.EXIT };
ConsoleTestApplication.EXIT};
while ((fromServer = in.readLine()) != null) { while ((fromServer = in.readLine()) != null) {
fromServer = consumeToPrompt(fromServer, in); fromServer = consumeToPrompt(fromServer, in);
if (fromServer == null || fromServer.equals("Bye.")) { if (fromServer == null || fromServer.equals("Bye.")) {
@@ -164,8 +152,7 @@ public class SocketConsoleApplicationTest {
} }
i++; i++;
} }
assertEquals("Application exit command should close connection", 4, assertEquals("Application exit command should close connection", 4, i);
i);
} }
TestServer.closeServer(); TestServer.closeServer();
server.join(); server.join();

View File

@@ -7,17 +7,17 @@ package net.bigeon.gclc.socket;
* Copyright (C) 2016 - 2018 Bigeon * Copyright (C) 2016 - 2018 Bigeon
* %% * %%
* 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,
@@ -25,10 +25,10 @@ package net.bigeon.gclc.socket;
* 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.
* #L% * #L%
@@ -44,9 +44,8 @@ import java.util.Collection;
import net.bigeon.smu.StringEncoder; import net.bigeon.smu.StringEncoder;
/** TODO Describe TestConsoleClient.java /** TODO Describe TestConsoleClient.java
* @author Emmanuel Bigeon *
* * @author Emmanuel Bigeon */
*/
@SuppressWarnings("nls") @SuppressWarnings("nls")
public class TestConsoleClient { public class TestConsoleClient {
@SuppressWarnings("javadoc") @SuppressWarnings("javadoc")
@@ -56,8 +55,7 @@ public class TestConsoleClient {
} }
@SuppressWarnings("javadoc") @SuppressWarnings("javadoc")
private static final StringEncoder ENCODER = new StringEncoder("%", private static final StringEncoder ENCODER = new StringEncoder("%", TO_ENCODE);
TO_ENCODE);
@SuppressWarnings("javadoc") @SuppressWarnings("javadoc")
public static void main(String[] args) { public static void main(String[] args) {
@@ -65,10 +63,9 @@ public class TestConsoleClient {
final int portNumber = 3300; final int portNumber = 3300;
try (Socket kkSocket = new Socket(hostName, portNumber); try (Socket kkSocket = new Socket(hostName, portNumber);
PrintWriter out = new PrintWriter(kkSocket.getOutputStream(), PrintWriter out = new PrintWriter(kkSocket.getOutputStream(), true);
true); BufferedReader in = new BufferedReader(
BufferedReader in = new BufferedReader(new InputStreamReader( new InputStreamReader(kkSocket.getInputStream()));) {
kkSocket.getInputStream()));) {
String fromServer; String fromServer;
while ((fromServer = in.readLine()) != null) { while ((fromServer = in.readLine()) != null) {

View File

@@ -7,17 +7,17 @@ package net.bigeon.gclc.socket;
* Copyright (C) 2016 - 2018 Bigeon * Copyright (C) 2016 - 2018 Bigeon
* %% * %%
* 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,
@@ -25,10 +25,10 @@ package net.bigeon.gclc.socket;
* 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.
* #L% * #L%
@@ -39,24 +39,18 @@ import java.net.Socket;
import java.net.UnknownHostException; import java.net.UnknownHostException;
import net.bigeon.gclc.ConsoleApplication; import net.bigeon.gclc.ConsoleApplication;
import net.bigeon.gclc.socket.ConnexionManager;
import net.bigeon.gclc.socket.DConnexionManager;
import net.bigeon.gclc.socket.PluggableConsoleInput;
import net.bigeon.gclc.socket.PluggableConsoleOutput;
import net.bigeon.gclc.socket.SocketConsoleApplicationShell;
import net.bigeon.gclc.socket.SocketConsoleInterface;
/** A test server /** A test server
* *
* @author Emmanuel Bigeon */ * @author Emmanuel Bigeon */
@SuppressWarnings({"javadoc", "nls"}) @SuppressWarnings({ "javadoc", "nls" })
public class TestServer { public class TestServer {
private static SocketConsoleApplicationShell SHELL; private static SocketConsoleApplicationShell SHELL;
private static ConnexionManager<Socket> manager; private static ConnexionManager<Socket> manager;
private static Thread server; private static Thread server;
private static PluggableConsoleInput input; private static PluggableConsoleInput input;
private static PluggableConsoleOutput output; private static PluggableConsoleOutput output;
public static synchronized void closeServer() { public static synchronized void closeServer() {
@@ -83,8 +77,8 @@ public class TestServer {
manager = new DConnexionManager<>(); manager = new DConnexionManager<>();
SHELL = new SocketConsoleApplicationShell(3300, SHELL = new SocketConsoleApplicationShell(3300,
InetAddress.getByName("127.0.0.1")); InetAddress.getByName("127.0.0.1"));
final ConsoleApplication app = ConsoleTestApplication final ConsoleApplication app = ConsoleTestApplication.create(output, input,
.create(output, input, manager); manager);
SHELL.setInterface(new SocketConsoleInterface(input, output)); SHELL.setInterface(new SocketConsoleInterface(input, output));
SHELL.setConnexionManager(manager); SHELL.setConnexionManager(manager);
SHELL.setApplication(app); SHELL.setApplication(app);
@@ -96,6 +90,16 @@ public class TestServer {
} }
}); });
th.start(); th.start();
try {
Object waiting = new Object();
synchronized (waiting) {
while (!input.isPrompting()) {
waiting.wait(50);
}
}
} catch (InterruptedException e) {
Thread.currentThread().interrupt();
}
} }
return SHELL; return SHELL;
} }

View File

@@ -1,69 +1,24 @@
<project xmlns="http://maven.apache.org/POM/4.0.0"
<!-- GCLC swt, provide a swt window for console applications --> xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
<!-- Copyright (C) 2015-2017 E. Bigeon --> xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<!-- mailto:emmanuel@bigeon.fr --> <modelVersion>4.0.0</modelVersion>
<!-- --> <parent>
<!-- This software is governed by the CeCILL license under French law and --> <groupId>net.bigeon.config</groupId>
<!-- abiding by the rules of distribution of free software. You can use, --> <artifactId>swt-config</artifactId>
<!-- modify and/or redistribute the software under the terms of the CeCILL --> <version>1.8.11</version>
<!-- license as circulated by CEA, CNRS and INRIA at the following URL --> </parent>
<!-- "http://www.cecill.info". --> <groupId>net.bigeon.gclc</groupId>
<!-- --> <artifactId>swt</artifactId>
<!-- As a counterpart to the access to the source code and rights to copy, --> <version>1.1.6-SNAPSHOT</version>
<!-- modify and redistribute granted by the license, users are provided only --> <packaging>jar</packaging>
<!-- with a limited warranty and the software's author, the holder of the --> <name>GCLC swt</name>
<!-- economic rights, and the successive licensors have only limited --> <description>A swt window for console applications</description>
<!-- liability. --> <inceptionYear>2015</inceptionYear>
<!-- --> <url>https://bigeon.net/projects/gclc.html</url>
<!-- In this respect, the user's attention is drawn to the risks associated --> <organization>
<!-- with loading, using, modifying and/or developing or reproducing the --> <name>Bigeon</name>
<!-- software by the user in light of its specific status of free software, --> <url>https://bigeon.net/</url>
<!-- that may mean that it is complicated to manipulate, and that also --> </organization>
<!-- 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/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>net.bigeon.gclc</groupId>
<artifactId>gclc-swt</artifactId>
<version>1.1.6-SNAPSHOT</version>
<packaging>jar</packaging>
<inceptionYear>2015</inceptionYear>
<name>GCLC swt</name>
<description>A swt window for console applications</description>
<parent>
<groupId>net.bigeon.config</groupId>
<artifactId>swt-config</artifactId>
<version>1.8.5</version>
</parent>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<copyright.email>emmanuel@bigeon.fr</copyright.email>
<license.licenseName>cecill_2.1</license.licenseName>
</properties>
<dependencies>
<dependency>
<groupId>net.bigeon</groupId>
<artifactId>gclc</artifactId>
<version>2.0.7</version>
</dependency>
<dependency>
<groupId>net.bigeon</groupId>
<artifactId>collections</artifactId>
<version>1.1.1</version>
</dependency>
</dependencies>
<licenses> <licenses>
<license> <license>
<distribution>manual</distribution> <distribution>manual</distribution>
@@ -71,20 +26,6 @@
<url>https://cecill.info/licences/Licence_CeCILL_V2.1-en.html</url> <url>https://cecill.info/licences/Licence_CeCILL_V2.1-en.html</url>
</license> </license>
</licenses> </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> <developers>
<developer> <developer>
<email>emmanuel@bigeon.fr</email> <email>emmanuel@bigeon.fr</email>
@@ -95,9 +36,36 @@
</roles> </roles>
</developer> </developer>
</developers> </developers>
<scm>
<developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection>
<tag>HEAD</tag>
</scm>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<copyright.email>emmanuel@bigeon.fr</copyright.email>
<license.licenseName>cecill_2.1</license.licenseName>
</properties>
<scm> <dependencies>
<developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection> <dependency>
<tag>HEAD</tag> <groupId>net.bigeon</groupId>
</scm> <artifactId>gclc</artifactId>
<version>2.0.9</version>
</dependency>
<dependency>
<groupId>net.bigeon</groupId>
<artifactId>collections</artifactId>
<version>1.1.4</version>
</dependency>
</dependencies>
<reporting>
<plugins>
<plugin>
<groupId>com.github.sevntu-checkstyle</groupId>
<artifactId>dsm-maven-plugin</artifactId>
<version>2.2.0</version>
</plugin>
</plugins>
</reporting>
</project> </project>

View File

@@ -42,17 +42,17 @@ package net.bigeon.gclc.swt;
* Copyright (C) 2015 - 2018 Bigeon * Copyright (C) 2015 - 2018 Bigeon
* %% * %%
* 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,
@@ -60,10 +60,10 @@ package net.bigeon.gclc.swt;
* 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.
* #L% * #L%
@@ -77,11 +77,12 @@ package net.bigeon.gclc.swt;
* @author Emmanuel Bigeon */ * @author Emmanuel Bigeon */
public interface ConsoleDelayIO { public interface ConsoleDelayIO {
/** Get the input text. /** Get the input text.
*
* @return the non validated input */ * @return the non validated input */
String getInput(); String getInput();
/** Set the input text. /** Set the input text.
* *
* @param input the input to set */ * @param input the input to set */
void setInput(String input); void setInput(String input);

View File

@@ -42,17 +42,17 @@ package net.bigeon.gclc.swt;
* Copyright (C) 2015 - 2018 Bigeon * Copyright (C) 2015 - 2018 Bigeon
* %% * %%
* 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,
@@ -60,10 +60,10 @@ package net.bigeon.gclc.swt;
* 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.
* #L% * #L%
@@ -81,13 +81,13 @@ import net.bigeon.collections.Ribbon;
public final class HistoryTextKeyListener extends KeyAdapter { public final class HistoryTextKeyListener extends KeyAdapter {
/** The size of commands history. */ /** The size of commands history. */
private static final int DEFAULT_HISTORY_SIZE = 10; private static final int DEFAULT_HISTORY_SIZE = 10;
/** The empty string constant. */ /** The empty string constant. */
private static final String EMPTY = ""; //$NON-NLS-1$ private static final String EMPTY = ""; //$NON-NLS-1$
/** The history ribbon. */ /** The history ribbon. */
private final Ribbon<String> commands; private final Ribbon<String> commands;
/** The current index in history search. */ /** The current index in history search. */
private int currentIndex = 0; private int currentIndex = 0;
/** The console to notify of command validation. */ /** The console to notify of command validation. */
private final ConsoleDelayIO console; private final ConsoleDelayIO console;
@@ -123,8 +123,7 @@ public final class HistoryTextKeyListener extends KeyAdapter {
} }
// Upper arrow retrieves previous commands // Upper arrow retrieves previous commands
if (keyCode == SWT.ARROW_UP && if (keyCode == SWT.ARROW_UP && currentIndex < commands.size() - 1) {
currentIndex < commands.size() - 1) {
currentIndex++; currentIndex++;
final String cmd = commands.get(commands.size() - currentIndex - 1); final String cmd = commands.get(commands.size() - currentIndex - 1);
console.setInput(cmd); console.setInput(cmd);
@@ -132,12 +131,14 @@ public final class HistoryTextKeyListener extends KeyAdapter {
// Lower arrow retrieves next commands // Lower arrow retrieves next commands
if (keyCode == SWT.ARROW_DOWN) { if (keyCode == SWT.ARROW_DOWN) {
if (currentIndex == 0) { if (currentIndex <= 0) {
if (currentIndex == 0) {
console.setInput(EMPTY);
}
currentIndex = -1;
} else {
currentIndex--; currentIndex--;
console.setInput(EMPTY); final String cmd = commands.get(commands.size() - currentIndex - 1);
} else if (currentIndex > 0) {
final String cmd = commands
.get(commands.size() - (--currentIndex) - 1);
console.setInput(cmd); console.setInput(cmd);
} }
} }

View File

@@ -42,17 +42,17 @@ package net.bigeon.gclc.swt;
* Copyright (C) 2015 - 2018 Bigeon * Copyright (C) 2015 - 2018 Bigeon
* %% * %%
* 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,
@@ -60,10 +60,10 @@ package net.bigeon.gclc.swt;
* 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.
* #L% * #L%
@@ -92,29 +92,32 @@ import net.bigeon.gclc.tools.StringProvider;
* @author Emmanuel Bigeon */ * @author Emmanuel Bigeon */
public final class SWTConsole extends Composite public final class SWTConsole extends Composite
implements ConsoleDelayIO, ConsoleInput, ConsoleOutput { implements ConsoleDelayIO, ConsoleInput, ConsoleOutput {
private static final int TWO = 2;
private static final String ERROR_SYNCHRO_PROMPT = "Error in synchronization of prompting";
/** The number of columns of the layout. */ /** The number of columns of the layout. */
private static final int LAYOUT_NB_COLUMNS = 2; private static final int LAYOUT_NB_COLUMNS = 2;
/** The cmd prefix in the output console. */ /** The cmd prefix in the output console. */
private static final String CMD_PREFIX = "[CMD] "; //$NON-NLS-1$ private static final String CMD_PREFIX = "[CMD] "; //$NON-NLS-1$
/** The class logger. */ /** The class logger. */
private static final Logger LOGGER = Logger private static final Logger LOGGER = Logger
.getLogger(SWTConsole.class.getName()); .getLogger(SWTConsole.class.getName());
/** The empty string constant. */ /** The empty string constant. */
private static final String EMPTY = ""; //$NON-NLS-1$ private static final String EMPTY = ""; //$NON-NLS-1$
/** The console output text field. */ /** The console output text field. */
private final Text consoleOutput; private final Text consoleOutput;
/** The console input text field. */ /** The console input text field. */
private final Text consoleInput; private final Text consoleInput;
/** The prompt label. */ /** The prompt label. */
private final Label lblPromptlabel; private final Label lblPromptlabel;
/** The prompt text. */ /** The prompt text. */
private StringProvider prompt = new ConstantString("> "); //$NON-NLS-1$ private StringProvider prompt = new ConstantString("> "); //$NON-NLS-1$
/** The command entered by the user. */ /** The command entered by the user. */
private String command = null; private String command = null;
/** If the prompt should be active. */ /** If the prompt should be active. */
private boolean prompting = false; private boolean prompting = false;
/** The object for thread synchronization with the prompt. */ /** The object for thread synchronization with the prompt. */
private final Object promptLock = new Object(); private final Object promptLock = new Object();
/** Create the composite. /** Create the composite.
* *
@@ -140,6 +143,8 @@ public final class SWTConsole extends Composite
} }
/* (non-Javadoc)
* @see org.eclipse.swt.widgets.Composite#checkSubclass() */
@Override @Override
protected void checkSubclass() { protected void checkSubclass() {
// Disable the check that prevents subclassing of SWT components // Disable the check that prevents subclassing of SWT components
@@ -250,29 +255,14 @@ public final class SWTConsole extends Composite
@Override @Override
public String prompt() throws IOException { public String prompt() throws IOException {
synchronized (promptLock) { synchronized (promptLock) {
if (isDisposed()) { initPrompt(prompt.apply());
throw new IOException(); promptLock.notifyAll();
}
try { try {
Display.getDefault().syncExec(new Runnable() {
@Override
public void run() {
if (!consoleInput.isDisposed()) {
consoleInput.setEnabled(true);
lblPromptlabel.setText(prompt.apply());
// relayout
SWTConsole.this.layout();
consoleInput.setFocus();
}
}
});
prompting = true;
promptLock.notifyAll();
while (prompting) { while (prompting) {
promptLock.wait(); promptLock.wait();
} }
} catch (final InterruptedException e) { } catch (final InterruptedException e) {
LOGGER.log(Level.WARNING, "Error in synchronization of prompting", e); //$NON-NLS-1$ LOGGER.log(Level.WARNING, ERROR_SYNCHRO_PROMPT, e);
command = null; command = null;
Thread.currentThread().interrupt(); Thread.currentThread().interrupt();
} }
@@ -283,45 +273,46 @@ public final class SWTConsole extends Composite
return command; return command;
} }
/** Initialize the prompting.
*
* @param message the prompt message
* @throws IOException if the console is disposed */
private void initPrompt(final String message) throws IOException {
if (isDisposed()) {
throw new IOException();
}
Display.getDefault().syncExec(new Runnable() {
@SuppressWarnings("synthetic-access")
@Override
public void run() {
if (!consoleOutput.isDisposed()) {
lblPromptlabel.setText(message);
// relayout
SWTConsole.this.layout();
consoleInput.setEnabled(true);
consoleInput.setFocus();
}
}
});
prompting = true;
command = null;
}
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt(long) */ * @see fr.bigeon.gclc.manager.ConsoleInput#prompt(long) */
@Override @Override
public String prompt(final long timeout) throws IOException { public String prompt(final long timeout) throws IOException {
synchronized (promptLock) { synchronized (promptLock) {
if (isDisposed()) { initPrompt(prompt.apply());
throw new IOException(); promptLock.notifyAll();
}
try { try {
Display.getDefault().syncExec(new Runnable() { waitPromptResolution(timeout);
@Override
public void run() {
if (!consoleInput.isDisposed()) {
consoleInput.setEnabled(true);
lblPromptlabel.setText(prompt.apply());
// relayout
SWTConsole.this.layout();
consoleInput.setFocus();
}
}
});
prompting = true;
command = null;
promptLock.notifyAll();
final long start = System.currentTimeMillis();
long cur = start;
while (prompting && start + timeout>cur) {
promptLock.wait((cur-start-timeout)/2);
cur = System.currentTimeMillis();
}
} catch (final InterruptedException e) { } catch (final InterruptedException e) {
LOGGER.log(Level.WARNING, "Error in synchronization of prompting", e); //$NON-NLS-1$ LOGGER.log(Level.WARNING, ERROR_SYNCHRO_PROMPT, e);
command = null; command = null;
Thread.currentThread().interrupt(); Thread.currentThread().interrupt();
} }
} }
if (isDisposed()) {
throw new IOException("Input closed"); //$NON-NLS-1$
}
return command; return command;
} }
@@ -330,44 +321,21 @@ public final class SWTConsole extends Composite
@Override @Override
public String prompt(final String message) throws IOException { public String prompt(final String message) throws IOException {
synchronized (promptLock) { synchronized (promptLock) {
if (isDisposed()) { initPrompt(message);
throw new IOException(); promptLock.notifyAll();
}
try { try {
Display.getDefault().syncExec(new Runnable() { while (prompting) {
@SuppressWarnings("synthetic-access") promptLock.wait();
@Override }
public void run() {
if (!consoleOutput.isDisposed()) {
lblPromptlabel.setText(message);
// relayout
SWTConsole.this.layout();
consoleInput.setEnabled(true);
consoleInput.setFocus();
}
}
});
prompting = true;
promptLock.wait();
if (isDisposed()) { if (isDisposed()) {
throw new IOException(); throw new IOException();
} }
} catch (final InterruptedException e) { } catch (final InterruptedException e) {
LOGGER.log(Level.WARNING, "Error in synchronization of prompting", e); //$NON-NLS-1$ LOGGER.log(Level.WARNING, ERROR_SYNCHRO_PROMPT, e);
command = null; command = null;
Thread.currentThread().interrupt(); Thread.currentThread().interrupt();
} finally { } finally {
Display.getDefault().syncExec(new Runnable() { resetPrompt();
@SuppressWarnings("synthetic-access")
@Override
public void run() {
if (!consoleOutput.isDisposed()) {
lblPromptlabel.setText(prompt.apply());
// relayout
SWTConsole.this.layout();
}
}
});
} }
} }
return command; return command;
@@ -377,9 +345,53 @@ public final class SWTConsole extends Composite
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String, long) */ * @see fr.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String, long) */
@Override @Override
public String prompt(final String message, final long timeout) throws IOException { public String prompt(final String message, final long timeout) throws IOException {
// TODO Auto-generated method stub synchronized (promptLock) {
// return null; initPrompt(message);
throw new RuntimeException("Not implemented yet"); promptLock.notifyAll();
try {
waitPromptResolution(timeout);
} catch (final InterruptedException e) {
LOGGER.log(Level.WARNING, ERROR_SYNCHRO_PROMPT, e);
command = null;
Thread.currentThread().interrupt();
} finally {
resetPrompt();
}
}
return command;
}
/** Wait the prompt resolution by user.
*
* @param timeout the timeout for the wait
* @throws InterruptedException if the thread is interrupted
* @throws IOException if the console is disposed. */
private void waitPromptResolution(final long timeout)
throws InterruptedException, IOException {
final long start = System.currentTimeMillis();
long cur = start;
while (prompting && start + timeout > cur) {
promptLock.wait((cur - start - timeout) / TWO);
cur = System.currentTimeMillis();
}
if (isDisposed()) {
throw new IOException();
}
}
/** Reset the prompt message. */
private void resetPrompt() {
Display.getDefault().syncExec(new Runnable() {
@SuppressWarnings("synthetic-access")
@Override
public void run() {
if (!consoleOutput.isDisposed()) {
lblPromptlabel.setText(prompt.apply());
// relayout
SWTConsole.this.layout();
}
}
});
} }
/* (non-Javadoc) /* (non-Javadoc)
@@ -397,6 +409,13 @@ public final class SWTConsole extends Composite
consoleInput.setSelection(input.length()); consoleInput.setSelection(input.length());
} }
/* (non-Javadoc)
* @see net.bigeon.gclc.manager.ConsoleInput#setPrompt(java.lang.String) */
@Override
public void setPrompt(final String prompt) {
setPrompt(new ConstantString(prompt));
}
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.ConsoleManager#setPrompt(java.lang.String) */ * @see fr.bigeon.gclc.ConsoleManager#setPrompt(java.lang.String) */
@Override @Override
@@ -415,26 +434,15 @@ public final class SWTConsole extends Composite
}); });
} }
@Override /** Set the input text.
public void setPrompt(String prompt) { *
setPrompt(new ConstantString(prompt)); * @param string the text */
}
/** @param string the text */
public void setText(final String string) { public void setText(final String string) {
consoleInput.setText(string); consoleInput.setText(string);
} }
/** /* (non-Javadoc)
* * @see net.bigeon.gclc.swt.ConsoleDelayIO#validateInput() */
*/
public void validateCommand() {
validateInput();
}
/**
*
*/
@Override @Override
public void validateInput() { public void validateInput() {
Display.getDefault().syncExec(new Runnable() { Display.getDefault().syncExec(new Runnable() {
@@ -450,6 +458,7 @@ public final class SWTConsole extends Composite
promptLock.wait(); promptLock.wait();
} catch (final InterruptedException e) { } catch (final InterruptedException e) {
LOGGER.log(Level.SEVERE, "Interruption while waiting prompt", e); //$NON-NLS-1$ LOGGER.log(Level.SEVERE, "Interruption while waiting prompt", e); //$NON-NLS-1$
Thread.currentThread().interrupt();
} }
} }
Display.getDefault().syncExec(new Runnable() { Display.getDefault().syncExec(new Runnable() {

View File

@@ -42,17 +42,17 @@ package net.bigeon.gclc.swt;
* Copyright (C) 2015 - 2018 Bigeon * Copyright (C) 2015 - 2018 Bigeon
* %% * %%
* 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,
@@ -60,10 +60,10 @@ package net.bigeon.gclc.swt;
* 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.
* #L% * #L%
@@ -85,8 +85,8 @@ public final class SWTConsoleShell extends Shell {
/** Create the shell. /** Create the shell.
* *
* @param display the display */ * @param display the display */
public SWTConsoleShell(final Display display) { public SWTConsoleShell(final Display display, final int style) {
super(display, SWT.SHELL_TRIM); super(display, style);
setLayout(new FillLayout(SWT.HORIZONTAL)); setLayout(new FillLayout(SWT.HORIZONTAL));
createContents(); createContents();
@@ -98,7 +98,7 @@ public final class SWTConsoleShell extends Shell {
} }
/** Create contents of the shell. */ /** Create contents of the shell. */
protected void createContents() { private void createContents() {
console = new SWTConsole(this, SWT.NONE); console = new SWTConsole(this, SWT.NONE);
setText("Console Application"); //$NON-NLS-1$ setText("Console Application"); //$NON-NLS-1$
} }

View File

@@ -42,17 +42,17 @@ package net.bigeon.gclc.swt;
* Copyright (C) 2015 - 2018 Bigeon * Copyright (C) 2015 - 2018 Bigeon
* %% * %%
* 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,
@@ -60,10 +60,10 @@ package net.bigeon.gclc.swt;
* 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.
* #L% * #L%
@@ -92,8 +92,7 @@ public final class SWTConsoleView extends Composite implements ConsoleDelayIO {
/** The local implementation of the forwarding runnable /** The local implementation of the forwarding runnable
* *
* @author Emmanuel Bigeon */ * @author Emmanuel Bigeon */
private final class ToSWTConsoleForwardRunnable private final class ToSWTConsoleForwardRunnable extends AOutputForwardRunnable {
extends AOutputForwardRunnable {
/** The running status */ /** The running status */
private boolean running = true; private boolean running = true;
@@ -104,7 +103,7 @@ public final class SWTConsoleView extends Composite implements ConsoleDelayIO {
@Override @Override
protected void forwardLine(final String m) { protected void forwardLine(final String m) {
appendConsoleOutput(m); appendConsoleOutput(System.lineSeparator() + m);
} }
@Override @Override
@@ -119,14 +118,14 @@ public final class SWTConsoleView extends Composite implements ConsoleDelayIO {
} }
/** The class logger */ /** The class logger */
private static final Logger LOGGER = Logger private static final Logger LOGGER = Logger
.getLogger(SWTConsoleView.class.getName()); .getLogger(SWTConsoleView.class.getName());
/** The console output text field */ /** The console output text field */
private final Text consoleOutput; private final Text consoleOutput;
/** The console input text field */ /** The console input text field */
private final Text consoleInput; private final Text consoleInput;
/** The input. */ /** The input. */
private PipedConsoleInput input; private PipedConsoleInput input;
/** The forwarding runnable */ /** The forwarding runnable */
private ToSWTConsoleForwardRunnable forward; private ToSWTConsoleForwardRunnable forward;
@@ -139,25 +138,23 @@ public final class SWTConsoleView extends Composite implements ConsoleDelayIO {
setLayout(new GridLayout(1, false)); setLayout(new GridLayout(1, false));
consoleOutput = new Text(this, SWT.BORDER | SWT.READ_ONLY | SWT.WRAP | consoleOutput = new Text(this,
SWT.V_SCROLL | SWT.MULTI); SWT.BORDER | SWT.READ_ONLY | SWT.WRAP | SWT.V_SCROLL | SWT.MULTI);
consoleOutput.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true, consoleOutput.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true, 1, 1));
1, 1));
consoleOutput.setRedraw(true); consoleOutput.setRedraw(true);
consoleInput = new Text(this, SWT.BORDER); consoleInput = new Text(this, SWT.BORDER);
consoleInput.setLayoutData( consoleInput.setLayoutData(new GridData(SWT.FILL, SWT.CENTER, true, false, 1, 1));
new GridData(SWT.FILL, SWT.CENTER, true, false, 1, 1));
consoleInput.addKeyListener(new HistoryTextKeyListener(this)); consoleInput.addKeyListener(new HistoryTextKeyListener(this));
} }
/** @param next the next message */ /** @param next the next message */
protected void appendConsoleOutput(final String next) { public void appendConsoleOutput(final String next) {
Display.getDefault().syncExec(new Runnable() { Display.getDefault().syncExec(new Runnable() {
@SuppressWarnings("synthetic-access") @SuppressWarnings("synthetic-access")
@Override @Override
public void run() { public void run() {
consoleOutput.append(System.lineSeparator() + next); consoleOutput.append(next);
} }
}); });
} }
@@ -190,11 +187,11 @@ public final class SWTConsoleView extends Composite implements ConsoleDelayIO {
} }
/** Set the input and output. /** Set the input and output.
* *
* @param manager the output to set * @param manager the output to set
* @param input the input */ * @param input the input */
public void setManager(final PipedConsoleOutput manager, public void setManager(final PipedConsoleOutput manager,
final PipedConsoleInput input) { final PipedConsoleInput input) {
this.input = input; this.input = input;
if (forward != null) { if (forward != null) {
forward.setRunning(false); forward.setRunning(false);

View File

@@ -10,17 +10,17 @@ package net.bigeon.gclc.swt;
* Copyright (C) 2015 - 2018 Bigeon * Copyright (C) 2015 - 2018 Bigeon
* %% * %%
* 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,
@@ -28,10 +28,10 @@ package net.bigeon.gclc.swt;
* 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.
* #L% * #L%

View File

@@ -0,0 +1,44 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
#%L
Generic Command Ligne console
%%
Copyright (C) 2014 - 2018 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
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%
-->
<project name="GCLC">
<bannerRight>
<src>https://bigeon.net/images/logo_48.png</src>
<href>https://bigeon.net/</href>
</bannerRight>
<body>
<menu ref="reports"/>
</body>
</project>

View File

@@ -42,17 +42,17 @@ package net.bigeon.gclc.swt;
* Copyright (C) 2015 - 2018 Bigeon * Copyright (C) 2015 - 2018 Bigeon
* %% * %%
* 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,
@@ -60,10 +60,10 @@ package net.bigeon.gclc.swt;
* 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.
* #L% * #L%
@@ -73,10 +73,8 @@ import static org.junit.Assert.assertEquals;
import org.eclipse.swt.SWT; import org.eclipse.swt.SWT;
import org.junit.Test; import org.junit.Test;
import net.bigeon.gclc.swt.ConsoleDelayIO; /**
import net.bigeon.gclc.swt.HistoryTextKeyListener; * <p>
/** <p>
* TODO * TODO
* *
* @author Emmanuel Bigeon */ * @author Emmanuel Bigeon */
@@ -90,8 +88,8 @@ public class HistoryTextKeyListenerTest {
private String input = ""; private String input = "";
@Override @Override
public void validateInput() { public String getInput() {
input = ""; return input;
} }
@Override @Override
@@ -100,8 +98,8 @@ public class HistoryTextKeyListenerTest {
} }
@Override @Override
public String getInput() { public void validateInput() {
return input; input = "";
} }
}; };
HistoryTextKeyListener listener = new HistoryTextKeyListener(io); HistoryTextKeyListener listener = new HistoryTextKeyListener(io);

View File

@@ -42,17 +42,17 @@ package net.bigeon.gclc.swt;
* Copyright (C) 2015 - 2018 Bigeon * Copyright (C) 2015 - 2018 Bigeon
* %% * %%
* 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,
@@ -60,10 +60,10 @@ package net.bigeon.gclc.swt;
* 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.
* #L% * #L%
@@ -75,6 +75,7 @@ import static org.junit.Assert.fail;
import java.io.IOException; import java.io.IOException;
import org.eclipse.swt.SWT;
import org.eclipse.swt.widgets.Display; import org.eclipse.swt.widgets.Display;
import org.junit.Test; import org.junit.Test;
@@ -85,27 +86,25 @@ import net.bigeon.gclc.exception.CommandRunException;
import net.bigeon.gclc.exception.InvalidCommandName; import net.bigeon.gclc.exception.InvalidCommandName;
import net.bigeon.gclc.manager.ConsoleInput; import net.bigeon.gclc.manager.ConsoleInput;
import net.bigeon.gclc.manager.ConsoleOutput; import net.bigeon.gclc.manager.ConsoleOutput;
import net.bigeon.gclc.swt.SWTConsole;
import net.bigeon.gclc.swt.SWTConsoleShell;
/** /**
* <p> * <p>
* TODO * TODO
* *
* @author Emmanuel Bigeon */ * @author Emmanuel Bigeon */
@SuppressWarnings({"javadoc", "static-method", "nls", "deprecation"}) @SuppressWarnings({ "javadoc", "static-method", "nls", "deprecation" })
public class SWTConsoleShellTest { public class SWTConsoleShellTest {
protected static final long TWO_SECONDS = 2000; protected static final long TWO_SECONDS = 2000;
private static final Display DISPLAY = Display.getDefault(); private static final Display DISPLAY = Display.getDefault();
@Test @Test
public void test() { public void testGeneric() {
final SWTConsoleShell shell = new SWTConsoleShell(DISPLAY); final SWTConsoleShell shell = new SWTConsoleShell(DISPLAY, SWT.SHELL_TRIM);
final SWTConsole swtConsole = shell.getManager(); final SWTConsole swtConsole = shell.getManager();
try { try {
final ConsoleApplication appl = new ConsoleApplication(swtConsole, final ConsoleApplication appl = new ConsoleApplication(swtConsole, swtConsole,
swtConsole, "Hello", "See you"); "Hello", "See you");
appl.add(new ExitCommand("exit", appl)); appl.add(new ExitCommand("exit", appl));
appl.add(new Command("long") { appl.add(new Command("long") {
@@ -114,9 +113,8 @@ public class SWTConsoleShellTest {
* manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput, * manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
* java.lang.String[]) */ * java.lang.String[]) */
@Override @Override
public void execute(final ConsoleOutput out, public void execute(final ConsoleOutput out, final ConsoleInput in,
final ConsoleInput in, final String... args) throws CommandRunException {
final String... args) throws CommandRunException {
try { try {
Thread.sleep(TWO_SECONDS); Thread.sleep(TWO_SECONDS);
} catch (final InterruptedException e) { } catch (final InterruptedException e) {
@@ -139,8 +137,9 @@ public class SWTConsoleShellTest {
throw new RuntimeException("Not implemented yet"); throw new RuntimeException("Not implemented yet");
} }
}); });
// shell.pack(); // shell.pack();
shell.open(); shell.open();
shell.setVisible(false);
final Thread applThread = new Thread(new Runnable() { final Thread applThread = new Thread(new Runnable() {
@Override @Override
@@ -162,7 +161,7 @@ public class SWTConsoleShellTest {
@Override @Override
public void run() { public void run() {
swtConsole.setText("test"); //$NON-NLS-1$ swtConsole.setText("test"); //$NON-NLS-1$
swtConsole.validateCommand(); swtConsole.validateInput();
} }
}); });
try { try {
@@ -186,7 +185,7 @@ public class SWTConsoleShellTest {
DISPLAY.sleep(); DISPLAY.sleep();
} }
} }
// DISPLAY.dispose(); // DISPLAY.dispose();
assertTrue(swtConsole.isClosed()); assertTrue(swtConsole.isClosed());
Thread.sleep(TWO_SECONDS); Thread.sleep(TWO_SECONDS);
assertFalse(appl.isRunning()); assertFalse(appl.isRunning());
@@ -201,13 +200,13 @@ public class SWTConsoleShellTest {
@Test @Test
public void testConsoleClose() { public void testConsoleClose() {
final SWTConsoleShell shell = new SWTConsoleShell(DISPLAY); final SWTConsoleShell shell = new SWTConsoleShell(DISPLAY, SWT.SHELL_TRIM);
final SWTConsole swtConsole = shell.getManager(); final SWTConsole swtConsole = shell.getManager();
swtConsole.close(); swtConsole.close();
swtConsole.setPrompt(":"); swtConsole.setPrompt(":");
try { try {
final ConsoleApplication appl = new ConsoleApplication(swtConsole, final ConsoleApplication appl = new ConsoleApplication(swtConsole, swtConsole,
swtConsole, "Hello", "See you"); "Hello", "See you");
appl.add(new ExitCommand("exit", appl)); appl.add(new ExitCommand("exit", appl));
appl.add(new Command("long") { appl.add(new Command("long") {
/* (non-Javadoc) /* (non-Javadoc)
@@ -215,9 +214,8 @@ public class SWTConsoleShellTest {
* manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput, * manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
* java.lang.String[]) */ * java.lang.String[]) */
@Override @Override
public void execute(final ConsoleOutput out, public void execute(final ConsoleOutput out, final ConsoleInput in,
final ConsoleInput in, final String... args) throws CommandRunException {
final String... args) throws CommandRunException {
try { try {
Thread.sleep(TWO_SECONDS); Thread.sleep(TWO_SECONDS);
} catch (final InterruptedException e) { } catch (final InterruptedException e) {
@@ -246,9 +244,8 @@ public class SWTConsoleShellTest {
* manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput, * manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
* java.lang.String[]) */ * java.lang.String[]) */
@Override @Override
public void execute(final ConsoleOutput out, public void execute(final ConsoleOutput out, final ConsoleInput in,
final ConsoleInput in, final String... args) throws CommandRunException {
final String... args) throws CommandRunException {
try { try {
swtConsole.prompt("Test"); swtConsole.prompt("Test");
} catch (final IOException e) { } catch (final IOException e) {
@@ -270,8 +267,9 @@ public class SWTConsoleShellTest {
throw new RuntimeException("Not implemented yet"); throw new RuntimeException("Not implemented yet");
} }
}); });
// shell.pack(); // shell.pack();
shell.open(); shell.open();
shell.setVisible(false);
final Thread applThread = new Thread(new Runnable() { final Thread applThread = new Thread(new Runnable() {
@Override @Override
@@ -293,7 +291,7 @@ public class SWTConsoleShellTest {
@Override @Override
public void run() { public void run() {
swtConsole.setText("test"); //$NON-NLS-1$ swtConsole.setText("test"); //$NON-NLS-1$
swtConsole.validateCommand(); swtConsole.validateInput();
} }
}); });
Display.getDefault().syncExec(new Runnable() { Display.getDefault().syncExec(new Runnable() {
@@ -302,28 +300,28 @@ public class SWTConsoleShellTest {
swtConsole.setText("ok"); //$NON-NLS-1$ swtConsole.setText("ok"); //$NON-NLS-1$
} }
}); });
swtConsole.validateCommand(); swtConsole.validateInput();
Display.getDefault().syncExec(new Runnable() { Display.getDefault().syncExec(new Runnable() {
@Override @Override
public void run() { public void run() {
swtConsole.setText("long"); //$NON-NLS-1$ swtConsole.setText("long"); //$NON-NLS-1$
} }
}); });
swtConsole.validateCommand(); swtConsole.validateInput();
Display.getDefault().syncExec(new Runnable() { Display.getDefault().syncExec(new Runnable() {
@Override @Override
public void run() { public void run() {
swtConsole.setText("test"); //$NON-NLS-1$ swtConsole.setText("test"); //$NON-NLS-1$
} }
}); });
swtConsole.validateCommand(); swtConsole.validateInput();
Display.getDefault().syncExec(new Runnable() { Display.getDefault().syncExec(new Runnable() {
@Override @Override
public void run() { public void run() {
swtConsole.setText("test"); //$NON-NLS-1$ swtConsole.setText("test"); //$NON-NLS-1$
} }
}); });
swtConsole.validateCommand(); swtConsole.validateInput();
try { try {
Thread.sleep(TWO_SECONDS); Thread.sleep(TWO_SECONDS);
} catch (final InterruptedException e) { } catch (final InterruptedException e) {
@@ -353,7 +351,7 @@ public class SWTConsoleShellTest {
} catch (final IOException e) { } catch (final IOException e) {
assertNotNull(e); assertNotNull(e);
} }
// DISPLAY.dispose(); // DISPLAY.dispose();
assertTrue(swtConsole.isClosed()); assertTrue(swtConsole.isClosed());
Thread.sleep(TWO_SECONDS); Thread.sleep(TWO_SECONDS);
assertFalse(appl.isRunning()); assertFalse(appl.isRunning());

View File

@@ -42,17 +42,17 @@ package net.bigeon.gclc.swt;
* Copyright (C) 2015 - 2018 Bigeon * Copyright (C) 2015 - 2018 Bigeon
* %% * %%
* 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,
@@ -60,10 +60,10 @@ package net.bigeon.gclc.swt;
* 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.
* #L% * #L%
@@ -84,45 +84,45 @@ import net.bigeon.gclc.exception.CommandRunException;
import net.bigeon.gclc.exception.InvalidCommandName; import net.bigeon.gclc.exception.InvalidCommandName;
import net.bigeon.gclc.manager.ConsoleInput; import net.bigeon.gclc.manager.ConsoleInput;
import net.bigeon.gclc.manager.ConsoleOutput; import net.bigeon.gclc.manager.ConsoleOutput;
import net.bigeon.gclc.swt.SWTConsoleView;
import net.bigeon.gclc.utils.PipedConsoleInput; import net.bigeon.gclc.utils.PipedConsoleInput;
import net.bigeon.gclc.utils.PipedConsoleOutput; import net.bigeon.gclc.utils.PipedConsoleOutput;
/** <p> /**
* <p>
* TODO * TODO
* *
* @author Emmanuel Bigeon */ * @author Emmanuel Bigeon */
@SuppressWarnings({"javadoc", "static-method", "nls", "deprecation"}) @SuppressWarnings({ "javadoc", "static-method", "nls", "deprecation" })
public class SWTConsoleViewTest { public class SWTConsoleViewTest {
protected static final long TWO_SECONDS = 2000; protected static final long TWO_SECONDS = 2000;
private static final Display DISPLAY = Display.getDefault(); private static final Display DISPLAY = Display.getDefault();
@Test @Test
public void test() { public void testGeneric() {
final Shell shell = new Shell(DISPLAY); final Shell shell = new Shell(DISPLAY);
final SWTConsoleView swtConsole = new SWTConsoleView(shell, SWT.NONE); final SWTConsoleView swtConsole = new SWTConsoleView(shell, SWT.NONE);
try (PipedConsoleOutput manager = new PipedConsoleOutput(); try (PipedConsoleOutput manager = new PipedConsoleOutput();
PipedConsoleInput input = new PipedConsoleInput(System.out)) { PipedConsoleInput input = new PipedConsoleInput(System.out)) {
swtConsole.setManager(manager, input); swtConsole.setManager(manager, input);
} catch (final IOException e2) { } catch (final IOException e2) {
assertNull(e2); assertNull(e2);
} }
try (PipedConsoleOutput manager = new PipedConsoleOutput(); try (PipedConsoleOutput manager = new PipedConsoleOutput();
PipedConsoleInput input = new PipedConsoleInput(System.out)) { PipedConsoleInput input = new PipedConsoleInput(System.out)) {
swtConsole.setManager(manager, input); swtConsole.setManager(manager, input);
final ConsoleApplication appl = new ConsoleApplication(manager, final ConsoleApplication appl = new ConsoleApplication(manager, input,
input,
"Hello", "See you"); "Hello", "See you");
appl.add(new ExitCommand("exit", appl)); appl.add(new ExitCommand("exit", appl));
appl.add(new Command("long") { appl.add(new Command("long") {
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput, java.lang.String[]) * @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.manager.
*/ * ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
* java.lang.String[]) */
@Override @Override
public void execute(final ConsoleOutput out, final ConsoleInput in, public void execute(final ConsoleOutput out, final ConsoleInput in,
final String... args) throws CommandRunException { final String... args) throws CommandRunException {
try { try {
Thread.sleep(TWO_SECONDS); Thread.sleep(TWO_SECONDS);
} catch (final InterruptedException e) { } catch (final InterruptedException e) {
@@ -145,8 +145,9 @@ public class SWTConsoleViewTest {
throw new RuntimeException("Not implemented yet"); throw new RuntimeException("Not implemented yet");
} }
}); });
// shell.pack(); // shell.pack();
shell.open(); shell.open();
shell.setVisible(false);
final Thread applThread = new Thread(new Runnable() { final Thread applThread = new Thread(new Runnable() {
@Override @Override

View File

@@ -1,75 +1,69 @@
<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/maven-v4_0_0.xsd"> <project xmlns="http://maven.apache.org/POM/4.0.0"
<modelVersion>4.0.0</modelVersion> xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
<groupId>net.bigeon.gclc</groupId> xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<artifactId>system</artifactId> <modelVersion>4.0.0</modelVersion>
<version>0.0.1</version> <parent>
<packaging>jar</packaging> <groupId>net.bigeon.config</groupId>
<url>http://www.bigeon.net</url> <artifactId>ebigeon-config</artifactId>
<properties> <version>1.8.21</version>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> </parent>
<copyright.email>emmanuel@bigeon.fr</copyright.email> <groupId>net.bigeon.gclc</groupId>
<license.licenseName>cecill_2.1</license.licenseName> <artifactId>system</artifactId>
</properties> <version>0.0.2-SNAPSHOT</version>
<build> <packaging>jar</packaging>
<plugins> <name>GCLC system command</name>
</plugins> <description>Provide an exec command to execute system commands</description>
</build> <url>https://bigeon.net/projects/gclc.html</url>
<dependencies> <inceptionYear>2016</inceptionYear>
<dependency> <organization>
<groupId>junit</groupId> <name>Bigeon</name>
<artifactId>junit</artifactId> <url>https://bigeon.net</url>
<version>4.11</version> </organization>
<scope>test</scope> <licenses>
</dependency> <license>
<dependency> <distribution>manual</distribution>
<groupId>net.bigeon</groupId> <name>CeCILL 2.1</name>
<artifactId>gclc</artifactId> <url>https://cecill.info/licences/Licence_CeCILL_V2.1-en.html</url>
<version>2.0.7</version> </license>
</dependency> </licenses>
</dependencies> <developers>
<name>GCLC system command</name> <developer>
<description>Provide an exec command to execute system commands</description> <email>emmanuel@bigeon.fr</email>
<inceptionYear>2016</inceptionYear> <name>Emmanuel Bigeon</name>
<url>bigeon.net</url>
<licenses> <roles>
<license> <role>PM</role>
<distribution>manual</distribution> </roles>
<name>CeCILL 2.1</name> </developer>
<url>https://cecill.info/licences/Licence_CeCILL_V2.1-en.html</url> </developers>
</license> <scm>
</licenses> <developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection>
<reporting> <tag>HEAD</tag>
<plugins> </scm>
<plugin> <properties>
<groupId>org.apache.maven.plugins</groupId> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<artifactId>maven-javadoc-plugin</artifactId> <copyright.email>emmanuel@bigeon.fr</copyright.email>
<version>2.10.3</version> <license.licenseName>cecill_2.1</license.licenseName>
</plugin> </properties>
<plugin>
<groupId>com.github.sevntu-checkstyle</groupId> <dependencies>
<artifactId>dsm-maven-plugin</artifactId> <dependency>
<version>2.2.0</version> <groupId>net.bigeon</groupId>
</plugin> <artifactId>gclc</artifactId>
</plugins> <version>2.0.9</version>
</reporting> </dependency>
<developers> </dependencies>
<developer>
<email>emmanuel@bigeon.fr</email> <reporting>
<name>Emmanuel Bigeon</name> <plugins>
<url>bigeon.net</url> <plugin>
<roles> <groupId>com.github.sevntu-checkstyle</groupId>
<role>PM</role> <artifactId>dsm-maven-plugin</artifactId>
</roles> <version>2.2.0</version>
</developer> </plugin>
</developers> </plugins>
</reporting><build>
<scm> <plugins>
<developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection> </plugins>
<tag>system-0.0.1</tag> </build>
</scm> </project>
<parent>
<groupId>net.bigeon.config</groupId>
<artifactId>ebigeon-config</artifactId>
<version>1.8.4</version>
</parent>
</project>

View File

@@ -11,17 +11,17 @@ package net.bigeon.gclc.system;
* Copyright (C) 2016 - 2018 Bigeon * Copyright (C) 2016 - 2018 Bigeon
* %% * %%
* 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,
@@ -29,10 +29,10 @@ package net.bigeon.gclc.system;
* 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.
* #L% * #L%
@@ -42,8 +42,6 @@ import java.io.IOException;
import java.io.InputStream; import java.io.InputStream;
import java.io.OutputStream; import java.io.OutputStream;
import java.io.OutputStreamWriter; import java.io.OutputStreamWriter;
import java.util.logging.Level;
import java.util.logging.Logger;
import net.bigeon.gclc.command.Command; import net.bigeon.gclc.command.Command;
import net.bigeon.gclc.exception.CommandRunException; import net.bigeon.gclc.exception.CommandRunException;
@@ -51,103 +49,65 @@ import net.bigeon.gclc.exception.CommandRunExceptionType;
import net.bigeon.gclc.manager.ConsoleInput; import net.bigeon.gclc.manager.ConsoleInput;
import net.bigeon.gclc.manager.ConsoleOutput; import net.bigeon.gclc.manager.ConsoleOutput;
/** A command that will execute a system command. /** A command that will execute system commands.
* <p>
* Note that this class may induce security issues in the code as it can execute
* arbitrary system commands. It is recommended that it be used only in private
* applications or application used by aware parties.
* *
* @author Emmanuel Bigeon */ * @author Emmanuel Bigeon */
public class ExecSystemCommand extends Command { public class ExecSystemCommand extends Command {
/** Error message for the manager closed. */
private static final String MANAGER_WAS_CLOSED = "manager was closed";
/** The command default name */ /** The command default name */
private static final String COMMAND_DEFAULT_NAME = "exec"; //$NON-NLS-1$ private static final String COMMAND_DEFAULT_NAME = "exec"; //$NON-NLS-1$
/** The end of line separator */ /** The end of line separator */
private static final String EOL = System.lineSeparator(); private static final String EOL = System.lineSeparator();
/** The class logger */
private static final Logger LOGGER = Logger
.getLogger(ExecSystemCommand.class.getName());
/***/ /** Create the command with the name 'exec'. */
public ExecSystemCommand() { public ExecSystemCommand() {
super(COMMAND_DEFAULT_NAME); super(COMMAND_DEFAULT_NAME);
} }
/** @param name the name of the command (the input from the manager that /** Create the command with a custom name.
* should trigger this command) */ *
* @param name the name of the command (the input from the manager that should
* trigger this command) */
public ExecSystemCommand(final String name) { public ExecSystemCommand(final String name) {
super(name); super(name);
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.manager. * @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.manager.
* ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput, * ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput, java.lang.String[]) */
* java.lang.String[]) */
@Override @Override
public void execute(final ConsoleOutput out, final ConsoleInput in, public void execute(final ConsoleOutput out, final ConsoleInput in,
final String... args) throws CommandRunException { final String... args) throws CommandRunException {
Process proc; Process proc;
try { try {
proc = Runtime.getRuntime().exec(args); proc = Runtime.getRuntime().exec(args);
} catch (final IOException e2) { } catch (final IOException e2) {
LOGGER.log(Level.SEVERE, "Unable to run process", e2); //$NON-NLS-1$ throw new CommandRunException("Unable to run process", e2);
return;
} }
// Stream forwarding to the application's console
final InputStream is = proc // This is started in a parallel thread.
.getInputStream(); final InputStream is = proc.getInputStream();
final Thread th = new Thread(new Runnable() { final Thread th = new Thread(new ForwardingRunnable(out, is));
@SuppressWarnings("synthetic-access")
@Override
public void run() {
try {
readToEnd(out, is);
is.close();
} catch (final CommandRunException e) {
LOGGER.log(Level.WARNING,
"Manager was closed in the meantime...", e); //$NON-NLS-1$
} catch (final IOException e) {
LOGGER.log(Level.WARNING, "Input stream was closed...", e); //$NON-NLS-1$
}
}
});
th.start(); th.start();
in.setPrompt(""); //$NON-NLS-1$ in.setPrompt(""); //$NON-NLS-1$
// Forward console input to the process.
final OutputStream os = proc.getOutputStream(); final OutputStream os = proc.getOutputStream();
try (BufferedWriter writer = new BufferedWriter( try (BufferedWriter writer = new BufferedWriter(new OutputStreamWriter(os))) {
new OutputStreamWriter(os))) {
while (th.isAlive()) { while (th.isAlive()) {
String user; final String user = in.prompt();
try { if (!user.isEmpty()) {
user = in.prompt(); writer.write(user + EOL);
} catch (final IOException e) {
throw new CommandRunException(
CommandRunExceptionType.INTERACTION,
"manager was closed", e); //$NON-NLS-1$
} }
writer.write(user + EOL);
} }
} catch (final IOException e1) { } catch (final IOException e1) {
throw new CommandRunException(CommandRunExceptionType.INTERACTION, throw new CommandRunException(CommandRunExceptionType.INTERACTION,
"manager was closed", e1); //$NON-NLS-1$ MANAGER_WAS_CLOSED, e1); // $NON-NLS-1$
}
}
/** @param is the input stream
* @throws CommandRunException if the manager was closed while writing the
* stream */
protected void readToEnd(final ConsoleOutput out,
final InputStream is) throws CommandRunException {
int c;
try {
while ((c = is.read()) != -1) {
try {
out.print(Character.valueOf((char) c).toString());
} catch (final IOException e) {
throw new CommandRunException(
CommandRunExceptionType.INTERACTION,
"manager was closed", e); //$NON-NLS-1$
}
}
} catch (final IOException e) {
LOGGER.log(Level.INFO, "input stream reading failed", e); //$NON-NLS-1$
} }
} }
@@ -163,12 +123,11 @@ public class ExecSystemCommand extends Command {
@Override @Override
protected String usageDetail() { protected String usageDetail() {
return " The system command is a system dependend command like sh on linux or" + //$NON-NLS-1$ return " The system command is a system dependend command like sh on linux or" + //$NON-NLS-1$
System.lineSeparator() + "powershell on windows." + //$NON-NLS-1$ System.lineSeparator() + "powershell on windows." + //$NON-NLS-1$
System.lineSeparator() + System.lineSeparator() + System.lineSeparator() + System.lineSeparator()
" As an example if you give \"cat /etc/hostname\" as argument, on a linux" + //$NON-NLS-1$ + " As an example if you give \"cat /etc/hostname\" as argument, on a linux" //$NON-NLS-1$
System.lineSeparator() + + System.lineSeparator() + "system, you would get the computer name." + //$NON-NLS-1$
"system, you would get the computer name." + //$NON-NLS-1$ System.lineSeparator();
System.lineSeparator();
} }
/* (non-Javadoc) /* (non-Javadoc)

View File

@@ -0,0 +1,117 @@
package net.bigeon.gclc.system;
/*-
* #%L
* GCLC system command
* %%
* Copyright (C) 2016 - 2018 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
* 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%
*/
import java.io.IOException;
import java.io.InputStream;
import java.util.logging.Level;
import java.util.logging.Logger;
import net.bigeon.gclc.exception.CommandRunException;
import net.bigeon.gclc.exception.CommandRunExceptionType;
import net.bigeon.gclc.manager.ConsoleOutput;
/** A class forwarding the content of a stream into a console output.
*
* @author Emmanuel Bigeon */
public final class ForwardingRunnable implements Runnable {
/** Error message for the manager closed. */
private static final String MANAGER_WAS_CLOSED = "manager was closed";
/** The class logger */
private static final Logger LOGGER = Logger
.getLogger(ForwardingRunnable.class.getName());
/** The console output. */
private final ConsoleOutput out;
/** The input stream. */
private final InputStream is;
/** Create the runnable.
*
* @param out the output console
* @param is the input stream */
public ForwardingRunnable(final ConsoleOutput out, final InputStream is) {
this.out = out;
this.is = is;
}
/* (non-Javadoc)
* @see java.lang.Runnable#run() */
@Override
public void run() {
try {
readToEnd(out, is);
is.close();
} catch (final CommandRunException e) {
LOGGER.log(Level.WARNING,
"Manager was closed in the meantime...", e); //$NON-NLS-1$
} catch (final IOException e) {
LOGGER.log(Level.WARNING, "Input stream was closed...", e); //$NON-NLS-1$
}
}
/** Read the input until its end.
*
* @param is the input stream
* @throws CommandRunException if the manager was closed while writing the
* stream */
private void readToEnd(final ConsoleOutput out, final InputStream is)
throws CommandRunException {
int c;
try {
while ((c = is.read()) >= 0) {
// Print the chaeacter in the output
printCharacter(out, (char) c);
}
} catch (final IOException e) {
LOGGER.log(Level.INFO, "input stream reading failed", e); //$NON-NLS-1$
}
}
/** Print a character on the console.
*
* @param out the console
* @param c the character
* @throws CommandRunException if the console failed to print the character. */
private static void printCharacter(final ConsoleOutput out, final char c)
throws CommandRunException {
try {
out.print(Character.toString(c));
} catch (final IOException e) {
throw new CommandRunException(CommandRunExceptionType.INTERACTION,
MANAGER_WAS_CLOSED, e); // $NON-NLS-1$
}
}
}

View File

@@ -0,0 +1,42 @@
/** This package contains classes for command execution on the system.
* <p>
* The class {@link net.bigeon.gclc.system.ExecSystemCommand} is, in the current
* version (0.0.1), a source of vulnerability and should probably be used only
* in private projects where the user is aware of the dangers.
*
* @author Emmanuel Bigeon */
package net.bigeon.gclc.system;
/*-
* #%L
* GCLC system command
* %%
* Copyright (C) 2016 - 2018 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
* 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%
*/

View File

@@ -0,0 +1,44 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
#%L
Generic Command Ligne console
%%
Copyright (C) 2014 - 2018 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
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%
-->
<project name="GCLC">
<bannerRight>
<src>https://bigeon.net/images/logo_48.png</src>
<href>https://bigeon.net/</href>
</bannerRight>
<body>
<menu ref="reports"/>
</body>
</project>

View File

@@ -0,0 +1,75 @@
package net.bigeon.gclc.system;
/*-
* #%L
* GCLC system command
* %%
* Copyright (C) 2016 - 2018 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
* 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%
*/
import static org.junit.Assert.*;
import org.junit.Test;
import net.bigeon.gclc.exception.CommandRunException;
import net.bigeon.gclc.manager.ConsoleInput;
import net.bigeon.gclc.manager.ConsoleOutput;
import net.bigeon.gclc.utils.EmptyInput;
import net.bigeon.gclc.utils.SinkOutput;
public class ExecSystemCommandTest {
@Test
public void testExecSystemCommand() {
ExecSystemCommand cmd = new ExecSystemCommand("test");
assertEquals("Name should be preserved", "test", cmd.getCommandName());
assertNotNull("tip should be defined", cmd.tip());
assertNotNull("usage should be defined", cmd.usagePattern());
assertNotNull("usage should be defined", cmd.usageDetail());
}
@Test
public void testExecute() throws CommandRunException {
ConsoleOutput out = SinkOutput.INSTANCE;
ConsoleInput in = EmptyInput.INSTANCE;
ExecSystemCommand cmd = new ExecSystemCommand();
if (System.getProperty("os.name").contains("indows")) {
cmd.execute(out, in, "cmd", "/C", "dir");
try {
cmd.execute(out, in, "inexistent");
fail("Able to execute inexistent command in system");
} catch (CommandRunException e) {
// ok
}
}
}
}

View File

@@ -1,10 +1,44 @@
<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/maven-v4_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/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion> <modelVersion>4.0.0</modelVersion>
<parent>
<groupId>net.bigeon.config</groupId>
<artifactId>ebigeon-config</artifactId>
<version>1.8.21</version>
</parent>
<groupId>net.bigeon</groupId>
<artifactId>gclc</artifactId> <artifactId>gclc</artifactId>
<version>2.0.8-SNAPSHOT</version> <version>2.0.10</version>
<packaging>jar</packaging> <packaging>jar</packaging>
<url>http://bigeon.net</url> <name>Generic Command Ligne console</name>
<description>A generic framework for console applications, with customized command input and output streams.</description>
<url>https://bigeon.net/projects/gclc.html</url>
<inceptionYear>2014</inceptionYear>
<organization>
<name>Bigeon</name>
<url>https://bigeon.net/</url>
</organization>
<licenses>
<license>
<distribution>manual</distribution>
<name>CeCILL 2.1</name>
<url>https://cecill.info/licences/Licence_CeCILL_V2.1-en.html</url>
</license>
</licenses>
<developers>
<developer>
<email>emmanuel@bigeon.fr</email>
<name>Emmanuel Bigeon</name>
<url>bigeon.net</url>
<roles>
<role>PM</role>
</roles>
</developer>
</developers>
<scm>
<developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection>
<tag>gclc-2.0.10</tag>
</scm>
<properties> <properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.scm.id>git.code.bigeon.net</project.scm.id> <project.scm.id>git.code.bigeon.net</project.scm.id>
@@ -19,11 +53,20 @@
<scope>test</scope> <scope>test</scope>
</dependency> </dependency>
</dependencies> </dependencies>
<parent> <reporting>
<groupId>net.bigeon.config</groupId> <plugins>
<artifactId>ebigeon-config</artifactId> <plugin>
<version>1.8.3</version> <groupId>com.github.sevntu-checkstyle</groupId>
</parent> <artifactId>dsm-maven-plugin</artifactId>
<version>2.2.0</version>
</plugin>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>jdepend-maven-plugin</artifactId>
<version>2.0</version>
</plugin>
</plugins>
</reporting>
<build> <build>
<plugins> <plugins>
<plugin> <plugin>
@@ -38,43 +81,4 @@
</plugin> </plugin>
</plugins> </plugins>
</build> </build>
<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>
<inceptionYear>2014</inceptionYear>
<name>Generic Command Ligne console</name>
<description>A generic framework for console applications, with customized command input and output streams.</description>
<scm>
<developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection>
<tag>HEAD</tag>
</scm>
<groupId>net.bigeon</groupId>
</project> </project>

View File

@@ -11,17 +11,17 @@ package net.bigeon.gclc;
* Copyright (C) 2014 - 2018 Bigeon * Copyright (C) 2014 - 2018 Bigeon
* %% * %%
* 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,
@@ -29,10 +29,10 @@ package net.bigeon.gclc;
* 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.
* #L% * #L%
@@ -51,7 +51,7 @@ public interface ApplicationAttachement {
* application. The attached command should be specific to the attachement * application. The attached command should be specific to the attachement
* (typically, the generic help command or the script command should not be * (typically, the generic help command or the script command should not be
* added through this mechanism). * added through this mechanism).
* *
* @param application the application * @param application the application
* @throws InvalidCommandName if a command name is invalid for the * @throws InvalidCommandName if a command name is invalid for the
* application. */ * application. */

View File

@@ -11,17 +11,17 @@ package net.bigeon.gclc;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 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,
@@ -29,10 +29,10 @@ package net.bigeon.gclc;
* 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.
* #L% * #L%

View File

@@ -43,17 +43,17 @@ package net.bigeon.gclc;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 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,
@@ -61,19 +61,20 @@ package net.bigeon.gclc;
* 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.
* #L% * #L%
*/ */
import java.io.IOException; import java.io.IOException;
import java.io.InterruptedIOException; import java.io.InterruptedIOException;
import java.util.ArrayList;
import java.util.Arrays; import java.util.Arrays;
import java.util.LinkedHashSet;
import java.util.List; import java.util.List;
import java.util.Set;
import java.util.logging.Level; import java.util.logging.Level;
import java.util.logging.Logger; import java.util.logging.Logger;
@@ -88,9 +89,8 @@ import net.bigeon.gclc.i18n.Messages;
import net.bigeon.gclc.manager.ConsoleInput; import net.bigeon.gclc.manager.ConsoleInput;
import net.bigeon.gclc.manager.ConsoleOutput; import net.bigeon.gclc.manager.ConsoleOutput;
/** /** A {@link ConsoleApplication} is an application that require the user to
* A {@link ConsoleApplication} is an application that require the user to input * input commands.
* commands.
* <p> * <p>
* A typical use case is the following: * A typical use case is the following:
* *
@@ -111,22 +111,22 @@ import net.bigeon.gclc.manager.ConsoleOutput;
public final class ConsoleApplication implements ICommandProvider { public final class ConsoleApplication implements ICommandProvider {
/** The class logger. */ /** The class logger. */
private static final Logger LOGGER = Logger private static final Logger LOGGER = Logger
.getLogger(ConsoleApplication.class.getName()); .getLogger(ConsoleApplication.class.getName());
/** The welcome message. */ /** The welcome message. */
public final String header; public final String header;
/** The good bye message. */ /** The good bye message. */
public final String footer; public final String footer;
/** The standard output for the application. */ /** The standard output for the application. */
private final ConsoleOutput out; private final ConsoleOutput out;
/** The standard input for the application. */ /** The standard input for the application. */
private final ConsoleInput in; private final ConsoleInput in;
/** The container of commands. */ /** The container of commands. */
public final SubedCommand root; public final SubedCommand root;
/** The state of this application. */ /** The state of this application. */
private boolean running; private boolean running;
/** The listeners. */ /** The listeners. */
private final List<CommandRequestListener> listeners = new ArrayList<>(); private final Set<CommandRequestListener> listeners = new LinkedHashSet<>();
/** Create a console application. /** Create a console application.
* *
@@ -135,8 +135,7 @@ public final class ConsoleApplication implements ICommandProvider {
* @param welcome the welcoming message * @param welcome the welcoming message
* @param goodbye the goodbye message */ * @param goodbye the goodbye message */
public ConsoleApplication(final ConsoleOutput out, final ConsoleInput in, public ConsoleApplication(final ConsoleOutput out, final ConsoleInput in,
final String welcome, final String welcome, final String goodbye) {
final String goodbye) {
header = welcome; header = welcome;
footer = goodbye; footer = goodbye;
this.in = in; this.in = in;
@@ -161,8 +160,7 @@ public final class ConsoleApplication implements ICommandProvider {
* java.lang.String[]) */ * java.lang.String[]) */
@Override @Override
public void executeSub(final ConsoleOutput output, final ConsoleInput input, public void executeSub(final ConsoleOutput output, final ConsoleInput input,
final String command, final String command, final String... args) throws CommandRunException {
final String... args) throws CommandRunException {
root.executeSub(output, input, command, args); root.executeSub(output, input, command, args);
} }
@@ -182,8 +180,8 @@ public final class ConsoleApplication implements ICommandProvider {
/** Interpret a command line. /** Interpret a command line.
* <p> * <p>
* This method will split the command in its part and execute the command * This method will split the command in its part and execute the command with
* with {@link #executeSub(ConsoleOutput, ConsoleInput, String, String...)}. * {@link #executeSub(ConsoleOutput, ConsoleInput, String, String...)}.
* *
* @param cmd the command * @param cmd the command
* @throws IOException if the command could not be parsed */ * @throws IOException if the command could not be parsed */
@@ -191,19 +189,18 @@ public final class ConsoleApplication implements ICommandProvider {
List<String> args; List<String> args;
try { try {
args = GCLCConstants.splitCommand(cmd); args = GCLCConstants.splitCommand(cmd);
} catch (final CommandParsingException e1) { } catch (final CommandParsingException e) {
out.println("Command line cannot be parsed"); //$NON-NLS-1$ out.println("Command line cannot be parsed"); //$NON-NLS-1$
LOGGER.log(Level.FINE, "Invalid user command " + cmd, e1); //$NON-NLS-1$ LOGGER.log(Level.FINE, "Invalid user command " + cmd, e); //$NON-NLS-1$
return; return;
} }
if (!args.isEmpty()) { if (!args.isEmpty()) {
try { try {
executeSub(out, in, args.get(0), Arrays.copyOfRange( executeSub(out, in, args.get(0),
args.toArray(new String[0]), 1, args.size())); Arrays.copyOfRange(args.toArray(new String[0]), 1, args.size()));
} catch (final CommandRunException e) { } catch (final CommandRunException e) {
LOGGER.log(Level.FINE, "Command failed: " + cmd, e); //$NON-NLS-1$ LOGGER.log(Level.FINE, "Command failed: " + cmd, e); //$NON-NLS-1$
out.println(Messages out.println(Messages.getString("ConsoleApplication.cmd.failed", cmd)); //$NON-NLS-1$
.getString("ConsoleApplication.cmd.failed", cmd)); //$NON-NLS-1$
out.println(e.getLocalizedMessage()); out.println(e.getLocalizedMessage());
if (e.getType() == CommandRunExceptionType.USAGE) { if (e.getType() == CommandRunExceptionType.USAGE) {
get(args.get(0)).help(out); get(args.get(0)).help(out);
@@ -228,8 +225,8 @@ public final class ConsoleApplication implements ICommandProvider {
/** The running loop content. /** The running loop content.
* <p> * <p>
* This consisting in getting the command, executing it and exiting * This consisting in getting the command, executing it and exiting (restarting
* (restarting the loop). */ * the loop). */
private void runLoop() { private void runLoop() {
try { try {
final String cmd = in.prompt(); final String cmd = in.prompt();
@@ -241,8 +238,7 @@ public final class ConsoleApplication implements ICommandProvider {
} }
interpretCommand(cmd); interpretCommand(cmd);
} catch (final InterruptedIOException e) { } catch (final InterruptedIOException e) {
LOGGER.info( LOGGER.info("Prompt interrupted. It is likely the application is closing."); //$NON-NLS-1$
"Prompt interrupted. It is likely the application is closing."); //$NON-NLS-1$
LOGGER.log(Level.FINER, "Interruption of the prompt.", //$NON-NLS-1$ LOGGER.log(Level.FINER, "Interruption of the prompt.", //$NON-NLS-1$
e); e);
} catch (final IOException e) { } catch (final IOException e) {
@@ -250,8 +246,7 @@ public final class ConsoleApplication implements ICommandProvider {
running = false; running = false;
LOGGER.warning( LOGGER.warning(
"The console manager was closed. Closing the application as no one can reach it."); //$NON-NLS-1$ "The console manager was closed. Closing the application as no one can reach it."); //$NON-NLS-1$
LOGGER.log(Level.FINE, LOGGER.log(Level.FINE, "An exception caused the closing of the application", //$NON-NLS-1$
"An exception caused the closing of the application", //$NON-NLS-1$
e); e);
} }
} }
@@ -268,8 +263,7 @@ public final class ConsoleApplication implements ICommandProvider {
running = false; running = false;
LOGGER.warning( LOGGER.warning(
"The console manager was closed. Closing the application as no one can reach it."); //$NON-NLS-1$ "The console manager was closed. Closing the application as no one can reach it."); //$NON-NLS-1$
LOGGER.log(Level.FINE, LOGGER.log(Level.FINE, "An exception caused the closing of the application", //$NON-NLS-1$
"An exception caused the closing of the application", //$NON-NLS-1$
e); e);
return; return;
} }

View File

@@ -45,17 +45,17 @@ package net.bigeon.gclc;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 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,
@@ -63,10 +63,10 @@ package net.bigeon.gclc;
* 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.
* #L% * #L%
@@ -85,7 +85,7 @@ import net.bigeon.gclc.exception.CommandParsingException;
public final class GCLCConstants { public final class GCLCConstants {
/** The escaping character. */ /** The escaping character. */
private static final char ESCAPING_CHAR = getSystemEscapingChar(); private static final char ESCAPING_CHAR = '\\';
/** Hide utility class constructor. */ /** Hide utility class constructor. */
private GCLCConstants() { private GCLCConstants() {
@@ -99,22 +99,15 @@ public final class GCLCConstants {
* @param index the index of the current position * @param index the index of the current position
* @return the argument * @return the argument
* @throws CommandParsingException if the end of string does not mark end of * @throws CommandParsingException if the end of string does not mark end of
* command and is not followed by a space */ * command and is not followed by a space */
private static String endOfString(final String cmd, final int startIndex, private static String endOfString(final String cmd, final int startIndex,
final int index) throws CommandParsingException { final int index) throws CommandParsingException {
if (index < cmd.length() && cmd.charAt(index) != ' ') { if (index < cmd.length() && cmd.charAt(index) != ' ') {
throw new CommandParsingException("Misplaced quote"); //$NON-NLS-1$ throw new CommandParsingException("Misplaced quote"); //$NON-NLS-1$
} }
return cmd.substring(startIndex + 1, index - 1); return cmd.substring(startIndex + 1, index - 1);
} }
/** Get the excaping character.
*
* @return the escaping character */
private static char getSystemEscapingChar() {
return '\\';
}
/** Remove escaping characters from the string. /** Remove escaping characters from the string.
* *
* @param arg the string to remove excaping character from * @param arg the string to remove excaping character from
@@ -137,7 +130,8 @@ public final class GCLCConstants {
* @param cmd the command to split in its parts * @param cmd the command to split in its parts
* @return the list of argument preceded by the command name * @return the list of argument preceded by the command name
* @throws CommandParsingException if the parsing of the command failed */ * @throws CommandParsingException if the parsing of the command failed */
public static List<String> splitCommand(final String cmd) throws CommandParsingException { public static List<String> splitCommand(final String cmd)
throws CommandParsingException {
final List<String> args = new ArrayList<>(); final List<String> args = new ArrayList<>();
// parse the string to separate arguments // parse the string to separate arguments
int index = 0; int index = 0;
@@ -164,6 +158,8 @@ public final class GCLCConstants {
startIndex = index; startIndex = index;
} }
inString = startIndex == index - 1; inString = startIndex == index - 1;
} else {
// No special processing
} }
} }
if (startIndex < cmd.length()) { if (startIndex < cmd.length()) {

View File

@@ -11,17 +11,17 @@ package net.bigeon.gclc.command;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 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,
@@ -29,10 +29,10 @@ package net.bigeon.gclc.command;
* 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.
* #L% * #L%
@@ -68,7 +68,7 @@ public abstract class Command implements ICommand {
/** The linux end of line character. */ /** The linux end of line character. */
private static final String EOL_LINUX = "\n"; //$NON-NLS-1$ private static final String EOL_LINUX = "\n"; //$NON-NLS-1$
/** The name of the command. */ /** The name of the command. */
protected final String name; protected final String name;
/** Create the command. /** Create the command.
* *
@@ -80,8 +80,8 @@ public abstract class Command implements ICommand {
/** Get the brief part of the command help. /** Get the brief part of the command help.
* <p> * <p>
* This method may be overriden by implementations to improve the help * This method may be overriden by implementations to improve the help content.
* content. The default behavior is to print the tip. * The default behavior is to print the tip.
* *
* @return a brief description of the command * @return a brief description of the command
* @see Command#help(ConsoleOutput, String...) */ * @see Command#help(ConsoleOutput, String...) */
@@ -112,8 +112,8 @@ public abstract class Command implements ICommand {
* *
* @see net.bigeon.gclc.command.ICommand#help(ConsoleOutput, String...) */ * @see net.bigeon.gclc.command.ICommand#help(ConsoleOutput, String...) */
@Override @Override
public final void help(final ConsoleOutput manager, public final void help(final ConsoleOutput manager, final String... args)
final String... args) throws IOException { throws IOException {
manager.println(getCommandName()); manager.println(getCommandName());
manager.println(brief()); manager.println(brief());
manager.println(); manager.println();
@@ -123,8 +123,8 @@ public abstract class Command implements ICommand {
final String details = usageDetail(); final String details = usageDetail();
if (details != null && !details.isEmpty()) { if (details != null && !details.isEmpty()) {
manager.print(details); manager.print(details);
if (!(details.endsWith(EOL_LINUX) || if (!(details.endsWith(EOL_LINUX)
details.endsWith(System.lineSeparator()))) { || details.endsWith(System.lineSeparator()))) {
manager.println(); manager.println();
} }
} }

View File

@@ -11,17 +11,17 @@ package net.bigeon.gclc.command;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 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,
@@ -29,10 +29,10 @@ package net.bigeon.gclc.command;
* 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.
* #L% * #L%
@@ -43,6 +43,7 @@ import java.util.HashMap;
import java.util.List; import java.util.List;
import java.util.Map; import java.util.Map;
import java.util.Set; import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import net.bigeon.gclc.exception.CommandParsingException; import net.bigeon.gclc.exception.CommandParsingException;
@@ -53,15 +54,15 @@ import net.bigeon.gclc.exception.CommandParsingException;
* @author Emmanuel BIGEON */ * @author Emmanuel BIGEON */
public final class CommandParameters { public final class CommandParameters {
/** Number of element for a string argument. */ /** Number of element for a string argument. */
private static final int STRINGARG_NUMBER_OF_ELEMENTS = 2; private static final int STRINGARG_NUMBER_OF_ELEMENTS = 2;
/** Boolean arguments. */ /** Boolean arguments. */
private final Map<String, Boolean> booleanArguments = new HashMap<>(); private final Map<String, Boolean> booleanArguments;
/** String arguments. */ /** String arguments. */
private final Map<String, String> stringArguments = new HashMap<>(); private final Map<String, String> stringArguments;
/** Arguments restriction on the named ones. */ /** Arguments restriction on the named ones. */
private final boolean strict; private final boolean strict;
/** additional (unnamed) parameters. */ /** additional (unnamed) parameters. */
private final List<String> additional = new ArrayList<>(); private final List<String> additional = new ArrayList<>();
/** Create a command parameter object. /** Create a command parameter object.
* *
@@ -69,10 +70,13 @@ public final class CommandParameters {
* @param strings the string parameters * @param strings the string parameters
* @param strict if the argument are restricted to the declared ones */ * @param strict if the argument are restricted to the declared ones */
public CommandParameters(final Set<String> bools, final Set<String> strings, public CommandParameters(final Set<String> bools, final Set<String> strings,
final boolean strict) { final boolean strict) {
booleanArguments = new ConcurrentHashMap<>(bools.size());
for (final String string : bools) { for (final String string : bools) {
booleanArguments.put(string, Boolean.FALSE); booleanArguments.put(string, Boolean.FALSE);
} }
// Cannot use concurrent because of the null values.
stringArguments = new HashMap<>(strings.size());
for (final String string : strings) { for (final String string : strings) {
stringArguments.put(string, null); stringArguments.put(string, null);
} }
@@ -98,9 +102,9 @@ public final class CommandParameters {
* *
* @param key the key * @param key the key
* @return if the key was specified */ * @return if the key was specified */
public boolean getBool(final String key) { public boolean isActive(final String key) {
return booleanArguments.containsKey(key) && Boolean val = booleanArguments.get(key);
booleanArguments.get(key).booleanValue(); return val != null && val.booleanValue();
} }
/** Get the boolean arguments. /** Get the boolean arguments.
@@ -122,14 +126,13 @@ public final class CommandParameters {
* @param key the key * @param key the key
* @return if the key is present in string arguments or boolean ones. */ * @return if the key is present in string arguments or boolean ones. */
public boolean hasArgument(final String key) { public boolean hasArgument(final String key) {
return stringArguments.containsKey(key) || return stringArguments.containsKey(key) || booleanArguments.containsKey(key);
booleanArguments.containsKey(key);
} }
/** Attempt to parse an argument. /** Attempt to parse an argument.
* <p> * <p>
* This method return 0 if the parsing was incorrect, or the number of * This method return 0 if the parsing was incorrect, or the number of parsed
* parsed elements. * elements.
* *
* @param arg the argument * @param arg the argument
* @param next the next element * @param next the next element
@@ -170,8 +173,7 @@ public final class CommandParameters {
} }
final int p = parseArg(args[i], next); final int p = parseArg(args[i], next);
if (p == 0) { if (p == 0) {
throw new CommandParsingException( throw new CommandParsingException("Invalid parameter " + args[i]); //$NON-NLS-1$
"Invalid parameter " + args[i]); //$NON-NLS-1$
} }
i += p; i += p;
} }

View File

@@ -9,17 +9,17 @@ package net.bigeon.gclc.command;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 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,
@@ -27,16 +27,16 @@ package net.bigeon.gclc.command;
* 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.
* #L% * #L%
*/ */
import java.util.ArrayList; import java.util.LinkedHashSet;
import java.util.List; import java.util.Set;
import net.bigeon.gclc.exception.CommandRunException; import net.bigeon.gclc.exception.CommandRunException;
import net.bigeon.gclc.exception.InvalidCommandName; import net.bigeon.gclc.exception.InvalidCommandName;
@@ -49,27 +49,20 @@ import net.bigeon.gclc.manager.ConsoleOutput;
* @author Emmanuel BIGEON */ * @author Emmanuel BIGEON */
public class CommandProvider implements ICommandProvider { public class CommandProvider implements ICommandProvider {
/** The minus character. */ /** The minus character. */
private static final String MINUS = "-"; //$NON-NLS-1$ private static final String MINUS = "-"; //$NON-NLS-1$
/** The space character. */ /** The space character. */
private static final String SPACE = " "; //$NON-NLS-1$ private static final String SPACE = " "; //$NON-NLS-1$
/** The commands map. */
protected final List<ICommand> commands; /** The commands set.
* <p>
* The insertion order is conserved through the use of a
* {@link LinkedHashSet}. */
protected final Set<ICommand> commands;
/** Create a command provider. */ /** Create a command provider. */
public CommandProvider() { public CommandProvider() {
super(); super();
commands = new ArrayList<>(); commands = new LinkedHashSet<>();
}
/** Test the command name validity.
*
* @param name the command name
* @throws InvalidCommandName if the name is invalid */
private static void testCommandName(final String name) throws InvalidCommandName {
if (name == null || name.isEmpty() || name.startsWith(MINUS)
|| name.contains(SPACE)) {
throw new InvalidCommandName();
}
} }
/* (non-Javadoc) /* (non-Javadoc)
@@ -118,4 +111,15 @@ public class CommandProvider implements ICommandProvider {
} }
return null; return null;
} }
/** Test the command name validity.
*
* @param name the command name
* @throws InvalidCommandName if the name is invalid */
private static void testCommandName(final String name) throws InvalidCommandName {
if (name == null || name.isEmpty() || name.startsWith(MINUS)
|| name.contains(SPACE)) {
throw new InvalidCommandName();
}
}
} }

View File

@@ -45,17 +45,17 @@ package net.bigeon.gclc.command;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 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,
@@ -63,10 +63,10 @@ package net.bigeon.gclc.command;
* 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.
* #L% * #L%
@@ -90,11 +90,11 @@ public interface ICommand {
* @param in the input * @param in the input
* @param args the arguments * @param args the arguments
* @throws CommandRunException if the command failed */ * @throws CommandRunException if the command failed */
void execute(ConsoleOutput out, ConsoleInput in, void execute(ConsoleOutput out, ConsoleInput in, String... args)
String... args) throws CommandRunException; throws CommandRunException;
/** Get teh command name. /** Get teh command name.
* *
* @return the command's name */ * @return the command's name */
String getCommandName(); String getCommandName();

View File

@@ -43,17 +43,17 @@ package net.bigeon.gclc.command;
* Copyright (C) 2014 - 2018 Bigeon * Copyright (C) 2014 - 2018 Bigeon
* %% * %%
* 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,
@@ -61,10 +61,10 @@ package net.bigeon.gclc.command;
* 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.
* #L% * #L%
@@ -81,8 +81,8 @@ import net.bigeon.gclc.manager.ConsoleOutput;
* @author Emmanuel BIGEON */ * @author Emmanuel BIGEON */
public interface ICommandProvider { public interface ICommandProvider {
/** Adds a command to this provider, if no command was associated with the /** Adds a command to this provider, if no command was associated with the given
* given key. * key.
* *
* @param value the command to execute * @param value the command to execute
* @return if the command was added * @return if the command was added
@@ -91,25 +91,25 @@ public interface ICommandProvider {
/** Execute the command with the given name. /** Execute the command with the given name.
* <p> * <p>
* If no command with this name is found, an error command is usually * If no command with this name is found, an error command is usually executed.
* executed. If there are several commands with the same name, the behavior * If there are several commands with the same name, the behavior is
* is unspecified. Depending on the implementation, it may run an error * unspecified. Depending on the implementation, it may run an error command or
* command or prompt the user for a choice. * prompt the user for a choice.
* *
* @param out the output * @param out the output
* @param in the input * @param in the input
* @param command the name of the command the user wishes to execute * @param command the name of the command the user wishes to execute
* @param args the arguments for the command * @param args the arguments for the command
* @throws CommandRunException if the command failed to run */ * @throws CommandRunException if the command failed to run */
void executeSub(ConsoleOutput out, ConsoleInput in, String command, void executeSub(ConsoleOutput out, ConsoleInput in, String command, String... args)
String... args) throws CommandRunException; throws CommandRunException;
/** Get the command with the given name. /** Get the command with the given name.
* <p> * <p>
* If no command with this name is found, an error command is usually * If no command with this name is found, an error command is usually returned.
* returned. If there are several commands with the same name, the behavior * If there are several commands with the same name, the behavior is
* is unspecified. Depending on the implementation, it may return an error * unspecified. Depending on the implementation, it may return an error command
* command or the first command with this name found. * or the first command with this name found.
* *
* @param command the name of the command the user wishes to execute * @param command the name of the command the user wishes to execute
* @return the command to execute */ * @return the command to execute */

View File

@@ -45,17 +45,17 @@ package net.bigeon.gclc.command;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 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,
@@ -63,10 +63,10 @@ package net.bigeon.gclc.command;
* 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.
* #L% * #L%
@@ -89,9 +89,8 @@ public abstract class ParametrizedCommand extends Command {
/** Create a parametrized command. /** Create a parametrized command.
* <p> * <p>
* Implementation are supposed to call the * Implementation are supposed to call the {@link #addBooleanParameter(String)}
* {@link #addBooleanParameter(String)} and * and {@link #addStringParameter(String, boolean)} method to set the
* {@link #addStringParameter(String, boolean)} method to set the
* parameters. * parameters.
* *
* @param name the name */ * @param name the name */
@@ -101,9 +100,8 @@ public abstract class ParametrizedCommand extends Command {
/** Create a parametrized command. /** Create a parametrized command.
* <p> * <p>
* Implementation are supposed to call the * Implementation are supposed to call the {@link #addBooleanParameter(String)}
* {@link #addBooleanParameter(String)} and * and {@link #addStringParameter(String, boolean)} method to set the
* {@link #addStringParameter(String, boolean)} method to set the
* parameters. * parameters.
* *
* @param name the name * @param name the name
@@ -116,9 +114,10 @@ public abstract class ParametrizedCommand extends Command {
/** Add a boolean parameter to defined parmaters. /** Add a boolean parameter to defined parmaters.
* *
* @param flag the boolean flag * @param flag the boolean flag
* @throws InvalidParameterException if the parameter is already defined as * @throws InvalidParameterException if the parameter is already defined as a
* a string parameter */ * string parameter */
protected final void addBooleanParameter(final String flag) throws InvalidParameterException { protected final void addBooleanParameter(final String flag)
throws InvalidParameterException {
data.addBooleanParameter(flag); data.addBooleanParameter(flag);
} }
@@ -126,28 +125,27 @@ public abstract class ParametrizedCommand extends Command {
* *
* @param flag the parameter flag * @param flag the parameter flag
* @param needed if the parameter's absence should cause an exception * @param needed if the parameter's absence should cause an exception
* @throws InvalidParameterException if the parameter is already defined as * @throws InvalidParameterException if the parameter is already defined as a
* a boolean parameter */ * boolean parameter */
protected final void addStringParameter(final String flag, protected final void addStringParameter(final String flag, final boolean needed)
final boolean needed) throws InvalidParameterException { throws InvalidParameterException {
data.addStringParameter(flag, needed); data.addStringParameter(flag, needed);
} }
/** Actually performs the execution after parsing the parameters. /** Actually performs the execution after parsing the parameters.
* *
* @param out the output * @param out the output
* @param in the input * @param in the input
* @param parameters the command parameters * @param parameters the command parameters
* @throws CommandRunException if the command failed */ * @throws CommandRunException if the command failed */
protected abstract void doExecute(ConsoleOutput out, ConsoleInput in, protected abstract void doExecute(ConsoleOutput out, ConsoleInput in,
CommandParameters parameters) throws CommandRunException; CommandParameters parameters) throws CommandRunException;
/* (non-Javadoc) /* (non-Javadoc)
* @see net.bigeon.gclc.command.Command#execute(java.lang.String[]) */ * @see net.bigeon.gclc.command.Command#execute(java.lang.String[]) */
@Override @Override
public final void execute(final ConsoleOutput output, public final void execute(final ConsoleOutput output, final ConsoleInput input,
final ConsoleInput input, final String... args) throws CommandRunException {
final String... args) throws CommandRunException {
try { try {
doExecute(output, input, data.getParameters(input, args)); doExecute(output, input, data.getParameters(input, args));
} catch (final IOException e) { } catch (final IOException e) {

View File

@@ -45,17 +45,17 @@ package net.bigeon.gclc.command;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 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,
@@ -63,10 +63,10 @@ package net.bigeon.gclc.command;
* 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.
* #L% * #L%
@@ -75,18 +75,17 @@ import java.io.IOException;
import java.text.MessageFormat; import java.text.MessageFormat;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.Collections; import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet; import java.util.HashSet;
import java.util.List; import java.util.List;
import java.util.Map; import java.util.Map;
import java.util.Map.Entry; import java.util.Map.Entry;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import net.bigeon.gclc.exception.CommandParsingException; import net.bigeon.gclc.exception.CommandParsingException;
import net.bigeon.gclc.exception.InvalidParameterException; import net.bigeon.gclc.exception.InvalidParameterException;
import net.bigeon.gclc.manager.ConsoleInput; import net.bigeon.gclc.manager.ConsoleInput;
import net.bigeon.gclc.manager.EmptyInput; import net.bigeon.gclc.utils.EmptyInput;
import java.util.Set;
/** An object to handle standardized command parameters. /** An object to handle standardized command parameters.
* *
@@ -94,11 +93,12 @@ import java.util.Set;
public final class ParametrizedCommandData { public final class ParametrizedCommandData {
/** The boolean parameters mandatory status. */ /** The boolean parameters mandatory status. */
private final Set<String> boolParams = new HashSet<>(); private final Set<String> boolParams = new HashSet<>();
/** The string parameters mandatory status. */ /** The string parameters mandatory status. */
private final Map<String, Boolean> stringParams = new HashMap<>(); private final Map<String, Boolean> stringParams = new ConcurrentHashMap<>();
/** The parameters mandatory status. */ /** The parameters mandatory status. */
private final Map<String, Boolean> params = new HashMap<>(); private final Map<String, Boolean> params = new ConcurrentHashMap<>();
/** The restriction of provided parameters on execution to declared paramters in /** The restriction of provided parameters on execution to declared paramters in
* the status maps. */ * the status maps. */
private final boolean strict; private final boolean strict;
@@ -109,7 +109,7 @@ public final class ParametrizedCommandData {
} }
/** The data for a parametrized command. /** The data for a parametrized command.
* *
* @param strict if the command was refusing unrecognized parameters */ * @param strict if the command was refusing unrecognized parameters */
public ParametrizedCommandData(final boolean strict) { public ParametrizedCommandData(final boolean strict) {
this.strict = strict; this.strict = strict;
@@ -120,8 +120,7 @@ public final class ParametrizedCommandData {
* @param flag the boolean flag * @param flag the boolean flag
* @throws InvalidParameterException if the parameter is already defined as a * @throws InvalidParameterException if the parameter is already defined as a
* string parameter */ * string parameter */
public final void addBooleanParameter(final String flag) public void addBooleanParameter(final String flag) throws InvalidParameterException {
throws InvalidParameterException {
if (params.containsKey(flag) && stringParams.containsKey(flag)) { if (params.containsKey(flag) && stringParams.containsKey(flag)) {
throw new InvalidParameterException("Parameter is already defined as string"); //$NON-NLS-1$ throw new InvalidParameterException("Parameter is already defined as string"); //$NON-NLS-1$
} }
@@ -135,7 +134,7 @@ public final class ParametrizedCommandData {
* @param needed if the parameter's absence should cause an exception * @param needed if the parameter's absence should cause an exception
* @throws InvalidParameterException if the parameter is already defined as a * @throws InvalidParameterException if the parameter is already defined as a
* boolean parameter */ * boolean parameter */
public final void addStringParameter(final String flag, final boolean needed) public void addStringParameter(final String flag, final boolean needed)
throws InvalidParameterException { throws InvalidParameterException {
if (params.containsKey(flag)) { if (params.containsKey(flag)) {
checkParam(flag, needed); checkParam(flag, needed);
@@ -152,9 +151,9 @@ public final class ParametrizedCommandData {
* @throws InvalidParameterException if the new definition is invalid */ * @throws InvalidParameterException if the new definition is invalid */
private void checkParam(final String param, final boolean needed) private void checkParam(final String param, final boolean needed)
throws InvalidParameterException { throws InvalidParameterException {
if (stringParams.containsKey(param)) { Boolean val = stringParams.get(param);
final Boolean need = Boolean if (val != null) {
.valueOf(needed || stringParams.get(param).booleanValue()); final Boolean need = Boolean.valueOf(needed || val.booleanValue());
stringParams.put(param, need); stringParams.put(param, need);
params.put(param, need); params.put(param, need);
return; return;
@@ -162,14 +161,28 @@ public final class ParametrizedCommandData {
throw new InvalidParameterException("Parameter is already defined as boolean"); //$NON-NLS-1$ throw new InvalidParameterException("Parameter is already defined as boolean"); //$NON-NLS-1$
} }
/** Retrieve the boolean parameters (aka flags).
*
* @return the set of boolean parameters */
public Set<String> getBooleanParameters() {
return Collections.unmodifiableSet(boolParams);
}
/** Retrieve the parameter names.
*
* @return the stringParams */
public Set<String> getParameters() {
return params.keySet();
}
/** Get the parameters from an input. /** Get the parameters from an input.
* *
* @param input the input * @param input the input
* @param args the command arguments * @param args the command arguments
* @return the command object * @return the command object
* @throws IOException if the command could not be filled. */ * @throws IOException if the command could not be filled. */
public final CommandParameters getParameters(final ConsoleInput input, public CommandParameters getParameters(final ConsoleInput input, final String... args)
final String... args) throws IOException { throws IOException {
final CommandParameters parameters = new CommandParameters(boolParams, final CommandParameters parameters = new CommandParameters(boolParams,
stringParams.keySet(), strict); stringParams.keySet(), strict);
try { try {
@@ -192,6 +205,29 @@ public final class ParametrizedCommandData {
return parameters; return parameters;
} }
/** Get the string parameters names.
*
* @return the stringParams */
public Set<String> getStringParameters() {
return stringParams.keySet();
}
/** Test if a parameter is needed.
*
* @param param the parameter name
* @return if the parameter is needed */
public boolean isNeeded(final String param) {
Boolean val = params.get(param);
return val != null && val.booleanValue();
}
/** If the command refuse unrecognized parameters.
*
* @return the strict */
public boolean isStrict() {
return strict;
}
/** Fill the undefined parameters. /** Fill the undefined parameters.
* <p> * <p>
* This method prompts the user to fill the needed parameters. * This method prompts the user to fill the needed parameters.
@@ -200,7 +236,7 @@ public final class ParametrizedCommandData {
* @param parameters the parameter list to complete * @param parameters the parameter list to complete
* @param toProvide the parameters to ask for * @param toProvide the parameters to ask for
* @throws IOException if the manager was closed */ * @throws IOException if the manager was closed */
private final static void fillParameters(final ConsoleInput input, private static void fillParameters(final ConsoleInput input,
final List<String> toProvide, final CommandParameters parameters) final List<String> toProvide, final CommandParameters parameters)
throws IOException { throws IOException {
for (final String string : toProvide) { for (final String string : toProvide) {
@@ -214,40 +250,4 @@ public final class ParametrizedCommandData {
parameters.set(string, value); parameters.set(string, value);
} }
} }
/** Retrieve the boolean parameters (aka flags).
*
* @return the set of boolean parameters */
public final Set<String> getBooleanParameters() {
return Collections.unmodifiableSet(boolParams);
}
/** Retrieve the parameter names.
*
* @return the stringParams */
public final Set<String> getParameters() {
return params.keySet();
}
/** Get the string parameters names.
*
* @return the stringParams */
public final Set<String> getStringParameters() {
return stringParams.keySet();
}
/** Test if a parameter is needed.
*
* @param param the parameter name
* @return if the parameter is needed */
public final boolean isNeeded(final String param) {
return params.containsKey(param) && params.get(param).booleanValue();
}
/** If the command refuse unrecognized parameters.
*
* @return the strict */
public final boolean isStrict() {
return strict;
}
} }

View File

@@ -43,17 +43,17 @@ package net.bigeon.gclc.command;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 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,
@@ -61,10 +61,10 @@ package net.bigeon.gclc.command;
* 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.
* #L% * #L%
@@ -86,16 +86,15 @@ import net.bigeon.gclc.manager.ConsoleOutput;
public final class SubedCommand extends CommandProvider implements ICommand { public final class SubedCommand extends CommandProvider implements ICommand {
/** The tab character. */ /** The tab character. */
private static final String TAB = "\t"; //$NON-NLS-1$ private static final String TAB = "\t"; //$NON-NLS-1$
/** The command to execute when this command is called with no sub /** The command to execute when this command is called with no sub arguments.
* arguments.
* <p> * <p>
* This may be null, in which case the command should have arguments. */ * This may be null, in which case the command should have arguments. */
private final ICommand noArgCommand; private final ICommand noArgCommand;
/** A tip on this command. */ /** A tip on this command. */
private final String tip; private final String tip;
/** The name of the command. */ /** The name of the command. */
private final String name; private final String name;
/** Create the command that defines sub commands. /** Create the command that defines sub commands.
* *
@@ -111,7 +110,7 @@ public final class SubedCommand extends CommandProvider implements ICommand {
* *
* @param name the name of the command * @param name the name of the command
* @param noArgCommand the command to execute when no extra parameter are * @param noArgCommand the command to execute when no extra parameter are
* provided */ * provided */
public SubedCommand(final String name, final ICommand noArgCommand) { public SubedCommand(final String name, final ICommand noArgCommand) {
super(); super();
this.name = name; this.name = name;
@@ -125,7 +124,7 @@ public final class SubedCommand extends CommandProvider implements ICommand {
* @param noArgCommand the command to execute * @param noArgCommand the command to execute
* @param tip the help tip associated */ * @param tip the help tip associated */
public SubedCommand(final String name, final ICommand noArgCommand, public SubedCommand(final String name, final ICommand noArgCommand,
final String tip) { final String tip) {
super(); super();
this.name = name; this.name = name;
this.noArgCommand = noArgCommand; this.noArgCommand = noArgCommand;
@@ -147,7 +146,7 @@ public final class SubedCommand extends CommandProvider implements ICommand {
* @see fr.bigeon.acide.Command#execute(java.lang.String[]) */ * @see fr.bigeon.acide.Command#execute(java.lang.String[]) */
@Override @Override
public void execute(final ConsoleOutput output, final ConsoleInput input, public void execute(final ConsoleOutput output, final ConsoleInput input,
final String... args) throws CommandRunException { final String... args) throws CommandRunException {
if (args.length == 0 || args[0].startsWith("-")) { //$NON-NLS-1$ if (args.length == 0 || args[0].startsWith("-")) { //$NON-NLS-1$
if (noArgCommand != null) { if (noArgCommand != null) {
noArgCommand.execute(output, input, args); noArgCommand.execute(output, input, args);
@@ -176,15 +175,15 @@ public final class SubedCommand extends CommandProvider implements ICommand {
/* (non-Javadoc) /* (non-Javadoc)
* @see net.bigeon.gclc.command.Command#help() */ * @see net.bigeon.gclc.command.Command#help() */
@Override @Override
public void help(final ConsoleOutput manager, public void help(final ConsoleOutput manager, final String... args)
final String... args) throws IOException { throws IOException {
if (args.length != 0 && !args[0].startsWith("-")) { //$NON-NLS-1$ if (args.length != 0 && !args[0].startsWith("-")) { //$NON-NLS-1$
// Specific // Specific
final ICommand c = get(args[0]); final ICommand c = get(args[0]);
if (c != null) { if (c != null) {
c.help(manager, Arrays.copyOfRange(args, 1, args.length)); c.help(manager, Arrays.copyOfRange(args, 1, args.length));
} else { } else {
manager.println("No command "+Arrays.toString(args)); manager.println("No command " + Arrays.toString(args));
} }
} else { } else {
// Generic // Generic
@@ -196,7 +195,7 @@ public final class SubedCommand extends CommandProvider implements ICommand {
manager.println(TAB + cmd.getCommandName()); manager.println(TAB + cmd.getCommandName());
} else { } else {
manager.println(TAB + cmd.getCommandName() + ": " + //$NON-NLS-1$ manager.println(TAB + cmd.getCommandName() + ": " + //$NON-NLS-1$
cmd.tip()); cmd.tip());
} }
} }
} }

View File

@@ -0,0 +1,100 @@
/*
* ralph.runner, Runs RALPH (belongs to IREQ) in sequence for several days
* Copyright (C) 2016-2018 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.
*/
/**
*
*/
package net.bigeon.gclc.command.base;
import java.io.IOException;
import java.text.MessageFormat;
import java.util.Arrays;
import net.bigeon.gclc.command.Command;
import net.bigeon.gclc.exception.CommandRunException;
import net.bigeon.gclc.manager.ConsoleInput;
import net.bigeon.gclc.manager.ConsoleOutput;
/** A command printing test to the console.
* <p>
* This command mimics the effect of the echo command in linux system. The
* difference is this command accepts java like formatting.
*
* <pre>
* echo.execute(out, in, "My Formatted {0}, with {1}", "message", "short arguments");
* </pre>
*
* @author Emmanuel Bigeon */
public class EchoCommand extends Command {
/** Create the command.
*
* @param name the command name */
public EchoCommand(final String name) {
super(name);
}
/* (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 {
try {
if (args.length == 1) {
out.print(args[0]);
}
if (args.length > 1) {
out.print(MessageFormat.format(args[0],
(Object[]) Arrays.copyOfRange(args, 1, args.length)));
}
out.println();
} catch (final IOException e) {
throw new CommandRunException("Printing failed", e);
}
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#tip() */
@Override
public String tip() {
return "Print the message";
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#usageDetail() */
@Override
protected String usageDetail() {
return "A formatted message can be used";
}
}

View File

@@ -45,17 +45,17 @@ package net.bigeon.gclc.command.base;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 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,
@@ -63,10 +63,10 @@ package net.bigeon.gclc.command.base;
* 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.
* #L% * #L%
@@ -84,13 +84,13 @@ import net.bigeon.gclc.prompt.CLIPrompterMessages;
* @author Emmanuel BIGEON */ * @author Emmanuel BIGEON */
public class ExitCommand implements ICommand { public class ExitCommand implements ICommand {
/** The exit command manual message key. */ /** The exit command manual message key. */
private static final String EXIT_MAN = "exit.man"; //$NON-NLS-1$ private static final String EXIT_MAN = "exit.man"; //$NON-NLS-1$
/** The tip of the exit command. */ /** The tip of the exit command. */
private static final String EXIT = "exit.tip"; //$NON-NLS-1$ private static final String EXIT = "exit.tip"; //$NON-NLS-1$
/** The application that will be exited when this command runs. */ /** The application that will be exited when this command runs. */
private final ConsoleApplication app; private final ConsoleApplication app;
/** The exit command name. */ /** The exit command name. */
private final String name; private final String name;
/** Create the exiting command. /** Create the exiting command.
* *
@@ -109,8 +109,8 @@ public class ExitCommand implements ICommand {
} }
@Override @Override
public final void execute(final ConsoleOutput output, public final void execute(final ConsoleOutput output, final ConsoleInput input,
final ConsoleInput input, final String... args) { final String... args) {
beforeExit(); beforeExit();
app.exit(); app.exit();
} }
@@ -123,11 +123,11 @@ public class ExitCommand implements ICommand {
} }
@Override @Override
public final void help(final ConsoleOutput manager, public final void help(final ConsoleOutput manager, final String... args)
final String... args) throws IOException { throws IOException {
manager.println( manager.println(CLIPrompterMessages.getString(EXIT_MAN, (Object[]) args));
CLIPrompterMessages.getString(EXIT_MAN, (Object[]) args));
} }
@Override @Override
public final String tip() { public final String tip() {
return CLIPrompterMessages.getString(EXIT); return CLIPrompterMessages.getString(EXIT);

View File

@@ -36,7 +36,7 @@
* gclc:net.bigeon.gclc.command.HelpExecutor.java * gclc:net.bigeon.gclc.command.HelpExecutor.java
* Created on: Sep 6, 2014 * Created on: Sep 6, 2014
*/ */
package net.bigeon.gclc.command; package net.bigeon.gclc.command.base;
/*- /*-
* #%L * #%L
@@ -45,17 +45,17 @@ package net.bigeon.gclc.command;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 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,
@@ -63,16 +63,19 @@ package net.bigeon.gclc.command;
* 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.
* #L% * #L%
*/ */
import java.io.IOException; import java.io.IOException;
import net.bigeon.gclc.command.Command;
import net.bigeon.gclc.command.ICommand;
import net.bigeon.gclc.command.SubedCommand;
import net.bigeon.gclc.exception.CommandRunException; import net.bigeon.gclc.exception.CommandRunException;
import net.bigeon.gclc.exception.CommandRunExceptionType; import net.bigeon.gclc.exception.CommandRunExceptionType;
import net.bigeon.gclc.manager.ConsoleInput; import net.bigeon.gclc.manager.ConsoleInput;
@@ -93,8 +96,7 @@ public final class HelpExecutor extends Command {
* *
* @param cmdName the command name * @param cmdName the command name
* @param cmd the command to execute the help of */ * @param cmd the command to execute the help of */
public HelpExecutor(final String cmdName, public HelpExecutor(final String cmdName, final ICommand cmd) {
final ICommand cmd) {
super(cmdName); super(cmdName);
this.cmd = cmd; this.cmd = cmd;
} }
@@ -114,7 +116,7 @@ public final class HelpExecutor extends Command {
* String[]) */ * String[]) */
@Override @Override
public void execute(final ConsoleOutput out, final ConsoleInput in, public void execute(final ConsoleOutput out, final ConsoleInput in,
final String... args) throws CommandRunException { final String... args) throws CommandRunException {
try { try {
cmd.help(out, args); cmd.help(out, args);
} catch (final IOException e) { } catch (final IOException e) {
@@ -131,8 +133,7 @@ public final class HelpExecutor extends Command {
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see net.bigeon.gclc.command.Command#usageDetail() * @see net.bigeon.gclc.command.Command#usageDetail() */
*/
@Override @Override
protected String usageDetail() { protected String usageDetail() {
return null; return null;

View File

@@ -45,17 +45,17 @@ package net.bigeon.gclc.command.base;
* Copyright (C) 2014 - 2018 Bigeon * Copyright (C) 2014 - 2018 Bigeon
* %% * %%
* 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,
@@ -63,10 +63,10 @@ package net.bigeon.gclc.command.base;
* 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.
* #L% * #L%
@@ -98,7 +98,7 @@ public final class MockCommand implements ICommand {
* String[]) */ * String[]) */
@Override @Override
public void execute(final ConsoleOutput out, final ConsoleInput in, public void execute(final ConsoleOutput out, final ConsoleInput in,
final String... args) { final String... args) {
// //
} }
@@ -113,8 +113,7 @@ public final class MockCommand implements ICommand {
* @see net.bigeon.gclc.command.ICommand#help(net.bigeon.gclc.manager. * @see net.bigeon.gclc.command.ICommand#help(net.bigeon.gclc.manager.
* ConsoleManager, java.lang.String[]) */ * ConsoleManager, java.lang.String[]) */
@Override @Override
public void help(final ConsoleOutput manager, public void help(final ConsoleOutput manager, final String... args) {
final String... args) {
// //
} }

View File

@@ -45,17 +45,17 @@ package net.bigeon.gclc.command.base;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 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,
@@ -63,19 +63,20 @@ package net.bigeon.gclc.command.base;
* 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.
* #L% * #L%
*/ */
import java.io.BufferedReader; import java.io.BufferedReader;
import java.io.FileInputStream;
import java.io.IOException; import java.io.IOException;
import java.io.InputStreamReader; import java.io.InputStreamReader;
import java.nio.charset.Charset; import java.nio.charset.Charset;
import java.nio.file.Files;
import java.nio.file.Paths;
import java.text.MessageFormat; import java.text.MessageFormat;
import java.util.Arrays; import java.util.Arrays;
import java.util.List; import java.util.List;
@@ -98,13 +99,16 @@ import net.bigeon.gclc.manager.ConsoleOutput;
public final class ScriptExecution extends Command { public final class ScriptExecution extends Command {
/** The tab character. */ /** The tab character. */
private static final String TAB = "\t"; //$NON-NLS-1$ private static final String TAB = "\t"; //$NON-NLS-1$
/** the space character. */ /** the space character. */
private static final String SPACE = " "; //$NON-NLS-1$ private static final String SPACE = " "; //$NON-NLS-1$
/** The application. */ /** The application. */
private final ConsoleApplication application; private final ConsoleApplication application;
/** The commenting prefix. */ /** The commenting prefix. */
private final String commentPrefix; private final String commentPrefix;
/** The charset for files. */ /** The charset for files. */
private final Charset charset; private final Charset charset;
@@ -115,40 +119,27 @@ public final class ScriptExecution extends Command {
* @param commentPrefix the comment prefix in the script files * @param commentPrefix the comment prefix in the script files
* @param charset the charset to use for files */ * @param charset the charset to use for files */
public ScriptExecution(final String name, final ConsoleApplication application, public ScriptExecution(final String name, final ConsoleApplication application,
final String commentPrefix, final Charset charset) { final String commentPrefix, final Charset charset) {
super(name); super(name);
this.application = application; this.application = application;
this.commentPrefix = commentPrefix; this.commentPrefix = commentPrefix;
this.charset = charset; this.charset = charset;
} }
/** Check the arguments.
*
* @param args the arguments
* @throws CommandRunException if the arguments were not the ones
* expected */
private static void checkArgs(final String[] args) throws CommandRunException {
if (args.length == 0) {
throw new CommandRunException(CommandRunExceptionType.USAGE,
"Expecting a file"); //$NON-NLS-1$
}
}
/* (non-Javadoc) /* (non-Javadoc)
* @see net.bigeon.gclc.command.ICommand#execute(java.lang.String[]) */ * @see net.bigeon.gclc.command.ICommand#execute(java.lang.String[]) */
@Override @Override
public void execute(final ConsoleOutput out, final ConsoleInput in, public void execute(final ConsoleOutput out, final ConsoleInput in,
final String... args) throws CommandRunException { final String... args) throws CommandRunException {
checkArgs(args); checkArgs(args);
final String scriptFile = args[0]; final String scriptFile = args[0];
final String[] params = Arrays.copyOfRange(args, 1, args.length); final String[] params = Arrays.copyOfRange(args, 1, args.length);
String cmd; String cmd;
int lineNo = -1; int lineNo = -1;
try (InputStreamReader fReader = new InputStreamReader( try (InputStreamReader fReader = new InputStreamReader(
new FileInputStream(scriptFile), charset); Files.newInputStream(Paths.get(scriptFile)), charset);
BufferedReader reader = new BufferedReader(fReader)) { BufferedReader reader = new BufferedReader(fReader)) {
String[] emptyArray = new String[0];
while ((cmd = reader.readLine()) != null) { while ((cmd = reader.readLine()) != null) {
lineNo++; lineNo++;
final String cmdLine = readCommandLine(cmd, params); final String cmdLine = readCommandLine(cmd, params);
@@ -157,12 +148,12 @@ public final class ScriptExecution extends Command {
} }
final List<String> ps = GCLCConstants.splitCommand(cmdLine); final List<String> ps = GCLCConstants.splitCommand(cmdLine);
final String command = ps.remove(0); final String command = ps.remove(0);
application.executeSub(out, in, command, application.executeSub(out, in, command, ps.toArray(emptyArray));
ps.toArray(new String[0]));
} }
} catch (final CommandParsingException e) { } catch (final CommandParsingException e) {
throw new CommandRunException(MessageFormat.format( throw new CommandRunException(
"Invalid command in script ({0})", e.getLocalizedMessage()), //$NON-NLS-1$ MessageFormat.format("Invalid command in script ({0})", //$NON-NLS-1$
e.getLocalizedMessage()),
e); e);
} catch (final IOException e) { } catch (final IOException e) {
throw new CommandRunException("Unable to read script", //$NON-NLS-1$ throw new CommandRunException("Unable to read script", //$NON-NLS-1$
@@ -172,29 +163,14 @@ public final class ScriptExecution extends Command {
} }
} }
/** This method will create the correct exception. The exception source must
* be this command.
*
* @param e the exception
* @param lineNo the line nu;ber
* @return the exception to actually throw */
private static CommandRunException manageRunException(final CommandRunException e,
final int lineNo) {
return new CommandRunException(CommandRunExceptionType.EXECUTION,
MessageFormat.format(
"The script could not complete due to command failure at line {0} ({1})", //$NON-NLS-1$
Integer.valueOf(lineNo), e.getLocalizedMessage()),
e);
}
/** Read a line of the script. /** Read a line of the script.
* *
* @param cmd the line * @param cmd the line
* @param params the formatting parameters * @param params the formatting parameters
* @return the command if it is indeed one, null otherwise * @return the command if it is indeed one, null otherwise
* @throws CommandRunException if the line stqrted with a space character */ * @throws CommandRunException if the line stqrted with a space character */
private String readCommandLine(final String cmd, private String readCommandLine(final String cmd, final Object[] params)
final Object[] params) throws CommandRunException { throws CommandRunException {
if (cmd.startsWith(SPACE) || cmd.startsWith(TAB)) { if (cmd.startsWith(SPACE) || cmd.startsWith(TAB)) {
throw new CommandRunException( throw new CommandRunException(
"Invalid line in script (line starts with space character)"); "Invalid line in script (line starts with space character)");
@@ -225,8 +201,7 @@ public final class ScriptExecution extends Command {
builder.append( builder.append(
" The script file must contain one line commands. The lines must never"); //$NON-NLS-1$ " The script file must contain one line commands. The lines must never"); //$NON-NLS-1$
builder.append(System.lineSeparator()); builder.append(System.lineSeparator());
builder.append( builder.append("start with whitespace characters. The lines starting with"); //$NON-NLS-1$
"start with whitespace characters. The lines starting with"); //$NON-NLS-1$
builder.append(System.lineSeparator()); builder.append(System.lineSeparator());
builder.append('"'); builder.append('"');
builder.append(commentPrefix); builder.append(commentPrefix);
@@ -243,4 +218,30 @@ public final class ScriptExecution extends Command {
return super.usagePattern() + " <scriptfile>"; //$NON-NLS-1$ return super.usagePattern() + " <scriptfile>"; //$NON-NLS-1$
} }
/** Check the arguments.
*
* @param args the arguments
* @throws CommandRunException if the arguments were not the ones expected */
private static void checkArgs(final String[] args) throws CommandRunException {
if (args.length == 0) {
throw new CommandRunException(CommandRunExceptionType.USAGE,
"Expecting a file"); //$NON-NLS-1$
}
}
/** This method will create the correct exception. The exception source must be
* this command.
*
* @param e the exception
* @param lineNo the line nu;ber
* @return the exception to actually throw */
private static CommandRunException manageRunException(final CommandRunException e,
final int lineNo) {
return new CommandRunException(CommandRunExceptionType.EXECUTION,
MessageFormat.format(
"The script could not complete due to command failure at line {0} ({1})", //$NON-NLS-1$
Integer.valueOf(lineNo), e.getLocalizedMessage()),
e);
}
} }

View File

@@ -1,7 +1,4 @@
/** /** @author Emmanuel Bigeon */
* @author Emmanuel Bigeon
*
*/
package net.bigeon.gclc.command.base; package net.bigeon.gclc.command.base;
/*- /*-
@@ -11,17 +8,17 @@ package net.bigeon.gclc.command.base;
* Copyright (C) 2014 - 2018 Bigeon * Copyright (C) 2014 - 2018 Bigeon
* %% * %%
* 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,
@@ -29,10 +26,10 @@ package net.bigeon.gclc.command.base;
* 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.
* #L% * #L%

View File

@@ -4,9 +4,9 @@
* There are some implementations, such as the * There are some implementations, such as the
* {@link net.bigeon.gclc.command.ParametrizedCommand} for commands with a * {@link net.bigeon.gclc.command.ParametrizedCommand} for commands with a
* predefined set of flags and option taking a string as value, the * predefined set of flags and option taking a string as value, the
* {@link net.bigeon.gclc.command.SubedCommand} for a command that is declined in * {@link net.bigeon.gclc.command.SubedCommand} for a command that is declined
* a set of sub commands, the {@link net.bigeon.gclc.command.HelpExecutor} for * in a set of sub commands, the {@link net.bigeon.gclc.command.base.HelpExecutor}
* help display of other commands and the * for help display of other commands and the
* *
* @author Emmanuel BIGEON */ * @author Emmanuel BIGEON */
package net.bigeon.gclc.command; package net.bigeon.gclc.command;
@@ -18,17 +18,17 @@ package net.bigeon.gclc.command;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 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,
@@ -36,10 +36,10 @@ package net.bigeon.gclc.command;
* 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.
* #L% * #L%

View File

@@ -45,17 +45,17 @@ package net.bigeon.gclc.exception;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 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,
@@ -63,10 +63,10 @@ package net.bigeon.gclc.exception;
* 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.
* #L% * #L%
@@ -80,16 +80,16 @@ public class CommandParsingException extends Exception {
private static final long serialVersionUID = 1L; private static final long serialVersionUID = 1L;
/** Create the exception with a message. /** Create the exception with a message.
* *
* @param message the message */ * @param message the message */
public CommandParsingException(final String message) { public CommandParsingException(final String message) {
super(message); super(message);
} }
/** Create the exception with a message and a cause. /** Create the exception with a message and a cause.
* *
* @param message the message * @param message the message
* @param cause the cause */ * @param cause the cause */
public CommandParsingException(final String message, final Throwable cause) { public CommandParsingException(final String message, final Throwable cause) {
super(message, cause); super(message, cause);
} }

View File

@@ -45,17 +45,17 @@ package net.bigeon.gclc.exception;
* Copyright (C) 2014 - 2018 Bigeon * Copyright (C) 2014 - 2018 Bigeon
* %% * %%
* 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,
@@ -63,10 +63,10 @@ package net.bigeon.gclc.exception;
* 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.
* #L% * #L%
@@ -87,8 +87,7 @@ public final class CommandRunException extends Exception {
* *
* @param type the type of exception * @param type the type of exception
* @param message the message */ * @param message the message */
public CommandRunException(final CommandRunExceptionType type, public CommandRunException(final CommandRunExceptionType type, final String message) {
final String message) {
super(message); super(message);
this.type = type; this.type = type;
} }
@@ -98,8 +97,8 @@ public final class CommandRunException extends Exception {
* @param type the type of exception * @param type the type of exception
* @param message a message * @param message a message
* @param cause the cause */ * @param cause the cause */
public CommandRunException(final CommandRunExceptionType type, public CommandRunException(final CommandRunExceptionType type, final String message,
final String message, final Throwable cause) { final Throwable cause) {
super(message, cause); super(message, cause);
this.type = type; this.type = type;
} }
@@ -128,7 +127,7 @@ public final class CommandRunException extends Exception {
public String getLocalizedMessage() { public String getLocalizedMessage() {
if (getCause() != null) { if (getCause() != null) {
return super.getLocalizedMessage() + ": " + //$NON-NLS-1$ return super.getLocalizedMessage() + ": " + //$NON-NLS-1$
getCause().getLocalizedMessage(); getCause().getLocalizedMessage();
} }
return super.getLocalizedMessage(); return super.getLocalizedMessage();
} }

View File

@@ -45,17 +45,17 @@ package net.bigeon.gclc.exception;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 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,
@@ -63,10 +63,10 @@ package net.bigeon.gclc.exception;
* 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.
* #L% * #L%

View File

@@ -45,17 +45,17 @@ package net.bigeon.gclc.exception;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 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,
@@ -63,10 +63,10 @@ package net.bigeon.gclc.exception;
* 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.
* #L% * #L%

View File

@@ -45,17 +45,17 @@ package net.bigeon.gclc.exception;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 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,
@@ -63,10 +63,10 @@ package net.bigeon.gclc.exception;
* 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.
* #L% * #L%

View File

@@ -10,17 +10,17 @@ package net.bigeon.gclc.exception;
* Copyright (C) 2014 - 2018 Bigeon * Copyright (C) 2014 - 2018 Bigeon
* %% * %%
* 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,
@@ -28,10 +28,10 @@ package net.bigeon.gclc.exception;
* 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.
* #L% * #L%

View File

@@ -45,17 +45,17 @@ package net.bigeon.gclc.i18n;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 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,
@@ -63,10 +63,10 @@ package net.bigeon.gclc.i18n;
* 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.
* #L% * #L%
@@ -89,8 +89,7 @@ public final class Messages {
.getBundle(BUNDLE_NAME); .getBundle(BUNDLE_NAME);
/** The class logger. */ /** The class logger. */
private static final Logger LOGGER = Logger private static final Logger LOGGER = Logger.getLogger(Messages.class.getName());
.getLogger(Messages.class.getName());
/** Utility class. */ /** Utility class. */
private Messages() { private Messages() {

View File

@@ -10,17 +10,17 @@ package net.bigeon.gclc.i18n;
* Copyright (C) 2014 - 2018 Bigeon * Copyright (C) 2014 - 2018 Bigeon
* %% * %%
* 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,
@@ -28,10 +28,10 @@ package net.bigeon.gclc.i18n;
* 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.
* #L% * #L%

View File

@@ -45,17 +45,17 @@ package net.bigeon.gclc.manager;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 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,
@@ -63,10 +63,10 @@ package net.bigeon.gclc.manager;
* 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.
* #L% * #L%
@@ -146,7 +146,7 @@ public interface ConsoleInput extends AutoCloseable {
void setPrompt(String prompt); void setPrompt(String prompt);
/** Set the prompting string. /** Set the prompting string.
* *
* @param string the prompt string */ * @param string the prompt string */
void setPrompt(StringProvider string); void setPrompt(StringProvider string);
} }

View File

@@ -45,17 +45,17 @@ package net.bigeon.gclc.manager;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 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,
@@ -63,10 +63,10 @@ package net.bigeon.gclc.manager;
* 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.
* #L% * #L%
@@ -86,14 +86,12 @@ public interface ConsoleOutput extends AutoCloseable {
/** Print a string. /** Print a string.
* *
* @param text the message to print (without line break at the end). * @param text the message to print (without line break at the end).
* @throws IOException if the manager is closed or could not read the * @throws IOException if the manager is closed or could not read the prompt */
* prompt */
void print(String text) throws IOException; void print(String text) throws IOException;
/** Prints an end of line. /** Prints an end of line.
* *
* @throws IOException if the manager is closed or could not read the * @throws IOException if the manager is closed or could not read the prompt */
* prompt */
void println() throws IOException; void println() throws IOException;
/** Print a string followed by an end of line. /** Print a string followed by an end of line.
@@ -102,8 +100,7 @@ public interface ConsoleOutput extends AutoCloseable {
* {@link #println()}. * {@link #println()}.
* *
* @param message the message to print * @param message the message to print
* @throws IOException if the manager is closed or could not read the * @throws IOException if the manager is closed or could not read the prompt */
* prompt */
void println(String message) throws IOException; void println(String message) throws IOException;
} }

View File

@@ -10,17 +10,17 @@ package net.bigeon.gclc.manager;
* Copyright (C) 2014 - 2018 Bigeon * Copyright (C) 2014 - 2018 Bigeon
* %% * %%
* 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,
@@ -28,10 +28,10 @@ package net.bigeon.gclc.manager;
* 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.
* #L% * #L%

View File

@@ -10,17 +10,17 @@ package net.bigeon.gclc;
* Copyright (C) 2014 - 2018 Bigeon * Copyright (C) 2014 - 2018 Bigeon
* %% * %%
* 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,
@@ -28,10 +28,10 @@ package net.bigeon.gclc;
* 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.
* #L% * #L%

View File

@@ -43,17 +43,17 @@ package net.bigeon.gclc.prompt;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 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,
@@ -61,15 +61,16 @@ package net.bigeon.gclc.prompt;
* 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.
* #L% * #L%
*/ */
import java.io.IOException; import java.io.IOException;
import java.text.MessageFormat;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.List; import java.util.List;
import java.util.Map; import java.util.Map;
@@ -86,25 +87,25 @@ import net.bigeon.gclc.manager.ConsoleOutput;
public final class CLIPrompter { public final class CLIPrompter {
/** The zero integer. */ /** The zero integer. */
private static final Integer ZERO = Integer.valueOf(0); private static final Integer ZERO = Integer.valueOf(0);
/** message key for format error in prompting a choice. */ /** message key for format error in prompting a choice. */
private static final String PROMPTCHOICE_FORMATERR = "promptchoice.formaterr"; //$NON-NLS-1$ private static final String PROMPTCHOICE_FORMATERR = "promptchoice.formaterr"; //$NON-NLS-1$
/** message key for out of bound error in prompting a choice. */ /** message key for out of bound error in prompting a choice. */
private static final String PROMPTCHOICE_OUTOFBOUNDS = "promptchoice.outofbounds"; //$NON-NLS-1$ private static final String PROMPTCHOICE_OUTOFBOUNDS = "promptchoice.outofbounds"; //$NON-NLS-1$
/** message key for first form of no in prompting a choice. */ /** message key for first form of no in prompting a choice. */
private static final String PROMPTBOOL_CHOICES_NO1 = "promptbool.choices.no1"; //$NON-NLS-1$ private static final String PROMPTBOOL_CHOICES_NO1 = "promptbool.choices.no1"; //$NON-NLS-1$
/** message key for first form of yes in prompting a choice. */ /** message key for first form of yes in prompting a choice. */
private static final String PROMPTBOOL_CHOICES_YES1 = "promptbool.choices.yes1"; //$NON-NLS-1$ private static final String PROMPTBOOL_CHOICES_YES1 = "promptbool.choices.yes1"; //$NON-NLS-1$
/** Message key for boolean choosing. */ /** Message key for boolean choosing. */
private static final String BOOL_CHOICES = "promptbool.choices"; //$NON-NLS-1$ private static final String BOOL_CHOICES = "promptbool.choices"; //$NON-NLS-1$
/** Message key for the list end of prompt symbol. */ /** Message key for the list end of prompt symbol. */
private static final String LIST_DISP_KEY = "promptlist.exit.dispkey"; //$NON-NLS-1$ private static final String LIST_DISP_KEY = "promptlist.exit.dispkey"; //$NON-NLS-1$
/** Message key for the line prompt. */ /** Message key for the line prompt. */
private static final String PROMPT = "prompt.lineprompt"; //$NON-NLS-1$ private static final String PROMPT = "prompt.lineprompt"; //$NON-NLS-1$
/** Message key for the separation of choices selection. */ /** Message key for the separation of choices selection. */
private static final String LIST_CHOICE_SEP = "promptlist.multi.sepkey"; //$NON-NLS-1$ private static final String LIST_CHOICE_SEP = "promptlist.multi.sepkey"; //$NON-NLS-1$
/** The class logger. */ /** The class logger. */
private static final Logger LOGGER = Logger private static final Logger LOGGER = Logger
.getLogger(CLIPrompter.class.getName()); .getLogger(CLIPrompter.class.getName());
/** Utility class. */ /** Utility class. */
@@ -118,9 +119,8 @@ public final class CLIPrompter {
* @param chs the list of integers * @param chs the list of integers
* @param index the max index of choice * @param index the max index of choice
* @return if the parsing was done correctly */ * @return if the parsing was done correctly */
private static boolean addUserChoice(final String val, private static boolean addUserChoice(final String val, final List<Integer> chs,
final List<Integer> chs, final int index) {
final int index) {
if (val.isEmpty()) { if (val.isEmpty()) {
return true; return true;
} }
@@ -138,18 +138,18 @@ public final class CLIPrompter {
* @param output the manager * @param output the manager
* @param choices the choices * @param choices the choices
* @param cancel the cancel option if it exists * @param cancel the cancel option if it exists
* @return the number of choices plus one (or the number of choices if there * @return the index of last choice
* is a cancel)
* @throws IOException if the manager was closed */ * @throws IOException if the manager was closed */
private static <U> Integer listChoices(final ConsoleOutput output, private static <U> Integer listChoices(final ConsoleOutput output,
final List<U> choices, final List<U> choices, final String cancel) throws IOException {
final String cancel) throws IOException {
int index = 0; int index = 0;
for (final U u : choices) { for (final U u : choices) {
output.println(index++ + ") " + u); //$NON-NLS-1$ output.println(index + ") " + u); //$NON-NLS-1$
index++;
} }
if (cancel != null) { if (cancel != null) {
output.println(index++ + ") " + cancel); //$NON-NLS-1$ output.println(index + ") " + cancel); //$NON-NLS-1$
index++;
} }
return Integer.valueOf(index - 1); return Integer.valueOf(index - 1);
} }
@@ -162,36 +162,28 @@ public final class CLIPrompter {
* @return the choice * @return the choice
* @throws IOException if the manager was closed */ * @throws IOException if the manager was closed */
public static boolean promptBoolean(final ConsoleOutput manager, public static boolean promptBoolean(final ConsoleOutput manager,
final ConsoleInput input, final ConsoleInput input, final String message) throws IOException {
final String message) throws IOException { String booleanChoices = message + CLIPrompterMessages.getString(BOOL_CHOICES);
String result = input String result = input.prompt(booleanChoices);
.prompt(message + CLIPrompterMessages.getString(BOOL_CHOICES));
boolean first = true; boolean first = true;
final String choices = CLIPrompterMessages String booleanYesChoice = CLIPrompterMessages.getString(PROMPTBOOL_CHOICES_YES1);
.getString(PROMPTBOOL_CHOICES_YES1) + ", " + //$NON-NLS-1$ String booleanNoChoice = CLIPrompterMessages.getString(PROMPTBOOL_CHOICES_NO1);
CLIPrompterMessages final String choices = MessageFormat.format("{0}, {1}", booleanYesChoice,
.getString(PROMPTBOOL_CHOICES_NO1); booleanNoChoice);
while (!(result.equalsIgnoreCase( String yes2 = CLIPrompterMessages.getString("promptbool.choices.yes2");
CLIPrompterMessages.getString(PROMPTBOOL_CHOICES_YES1)) || String no2 = CLIPrompterMessages.getString("promptbool.choices.no2");
CLIPrompterMessages.getString(PROMPTBOOL_CHOICES_NO1) while (!(result.equalsIgnoreCase(booleanYesChoice)
.equalsIgnoreCase(result) || || booleanNoChoice.equalsIgnoreCase(result)
CLIPrompterMessages.getString("promptbool.choices.no2") //$NON-NLS-1$ || no2.equalsIgnoreCase(result) || yes2.equalsIgnoreCase(result))) {
.equalsIgnoreCase(result) ||
CLIPrompterMessages.getString("promptbool.choices.yes2") //$NON-NLS-1$
.equalsIgnoreCase(result))) {
if (!first) { if (!first) {
manager.println(CLIPrompterMessages manager.println(CLIPrompterMessages
.getString("promptbool.choices.invalid", choices)); //$NON-NLS-1$ .getString("promptbool.choices.invalid", choices)); //$NON-NLS-1$
result = input.prompt( result = input.prompt(booleanChoices);
message + CLIPrompterMessages.getString(BOOL_CHOICES));
} }
first = false; first = false;
} }
return result.equalsIgnoreCase( return result.equalsIgnoreCase(booleanYesChoice) || result.equalsIgnoreCase(yes2); // $NON-NLS-1$
CLIPrompterMessages.getString(PROMPTBOOL_CHOICES_YES1)) ||
result.equalsIgnoreCase(CLIPrompterMessages
.getString("promptbool.choices.yes2")); //$NON-NLS-1$
} }
/** Prompt for a choice. /** Prompt for a choice.
@@ -206,13 +198,9 @@ public final class CLIPrompter {
* @return the choice * @return the choice
* @throws IOException if the manager was closed */ * @throws IOException if the manager was closed */
public static <U> U promptChoice(final ConsoleOutput manager, public static <U> U promptChoice(final ConsoleOutput manager,
final ConsoleInput input, final ConsoleInput input, final List<String> keys, final List<U> choices,
final List<String> keys, final String message, final String cancel) throws IOException {
final List<U> choices, final Integer index = promptChoice(manager, input, keys, message, cancel);
final String message,
final String cancel) throws IOException {
final Integer index = promptChoice(manager, input, keys, message,
cancel);
if (index == null) { if (index == null) {
return null; return null;
} }
@@ -232,13 +220,9 @@ public final class CLIPrompter {
* @return the chosen object * @return the chosen object
* @throws IOException if the manager was closed */ * @throws IOException if the manager was closed */
public static <U, T> T promptChoice(final ConsoleOutput manager, public static <U, T> T promptChoice(final ConsoleOutput manager,
final ConsoleInput input, final ConsoleInput input, final List<U> choices, final Map<U, T> choicesMap,
final List<U> choices, final String message, final String cancel) throws IOException {
final Map<U, T> choicesMap, final Integer res = promptChoice(manager, input, choices, message, cancel);
final String message,
final String cancel) throws IOException {
final Integer res = promptChoice(manager, input, choices, message,
cancel);
if (res == null) { if (res == null) {
return null; return null;
} }
@@ -256,10 +240,8 @@ public final class CLIPrompter {
* @return the index of the choice * @return the index of the choice
* @throws IOException if the manager was closed */ * @throws IOException if the manager was closed */
public static <U> Integer promptChoice(final ConsoleOutput manager, public static <U> Integer promptChoice(final ConsoleOutput manager,
final ConsoleInput input, final ConsoleInput input, final List<U> choices, final String message,
final List<U> choices, final String cancel) throws IOException {
final String message,
final String cancel) throws IOException {
manager.println(message); manager.println(message);
final Integer index = listChoices(manager, choices, cancel); final Integer index = listChoices(manager, choices, cancel);
String result; String result;
@@ -271,13 +253,12 @@ public final class CLIPrompter {
if (r >= 0 && r <= index.intValue()) { if (r >= 0 && r <= index.intValue()) {
break; break;
} }
manager.println(CLIPrompterMessages manager.println(CLIPrompterMessages.getString(PROMPTCHOICE_OUTOFBOUNDS,
.getString(PROMPTCHOICE_OUTOFBOUNDS, ZERO, index)); ZERO, index));
} catch (final NumberFormatException e) { } catch (final NumberFormatException e) {
LOGGER.log(Level.FINER, LOGGER.log(Level.FINER, "Unrecognized number. Prompting user again.", e); //$NON-NLS-1$
"Unrecognized number. Prompting user again.", e); //$NON-NLS-1$ manager.println(CLIPrompterMessages.getString(PROMPTCHOICE_FORMATERR,
manager.println(CLIPrompterMessages ZERO, index));
.getString(PROMPTCHOICE_FORMATERR, ZERO, index));
} }
listChoices(manager, choices, cancel); listChoices(manager, choices, cancel);
} }
@@ -299,13 +280,10 @@ public final class CLIPrompter {
* @return the chosen object * @return the chosen object
* @throws IOException if the manager was closed */ * @throws IOException if the manager was closed */
public static <U, T> T promptChoice(final ConsoleOutput manager, public static <U, T> T promptChoice(final ConsoleOutput manager,
final ConsoleInput input, final ConsoleInput input, final Map<U, T> choicesMap, final String message,
final Map<U, T> choicesMap, final String cancel) throws IOException {
final String message, return promptChoice(manager, input, new ArrayList<>(choicesMap.keySet()),
final String cancel) throws IOException { choicesMap, message, cancel);
return promptChoice(manager, input,
new ArrayList<>(choicesMap.keySet()), choicesMap, message,
cancel);
} }
/** Prompt for an integer. /** Prompt for an integer.
@@ -314,8 +292,8 @@ public final class CLIPrompter {
* @param message the prompt message * @param message the prompt message
* @return the integer * @return the integer
* @throws IOException if the manager was closed */ * @throws IOException if the manager was closed */
public static int promptInteger(final ConsoleInput manager, public static int promptInteger(final ConsoleInput manager, final String message)
final String message) throws IOException { throws IOException {
boolean still = true; boolean still = true;
int r = 0; int r = 0;
while (still) { while (still) {
@@ -344,8 +322,7 @@ public final class CLIPrompter {
* @return the list of user inputs * @return the list of user inputs
* @throws IOException if the manager was closed */ * @throws IOException if the manager was closed */
public static List<String> promptList(final ConsoleOutput manager, public static List<String> promptList(final ConsoleOutput manager,
final ConsoleInput input, final ConsoleInput input, final String message) throws IOException {
final String message) throws IOException {
return promptList(manager, input, message, return promptList(manager, input, message,
CLIPrompterMessages.getString("promptlist.exit.defaultkey")); //$NON-NLS-1$ CLIPrompterMessages.getString("promptlist.exit.defaultkey")); //$NON-NLS-1$
} }
@@ -359,12 +336,10 @@ public final class CLIPrompter {
* @return the list of user inputs * @return the list of user inputs
* @throws IOException if the manager was closed */ * @throws IOException if the manager was closed */
public static List<String> promptList(final ConsoleOutput manager, public static List<String> promptList(final ConsoleOutput manager,
final ConsoleInput input, final ConsoleInput input, final String message, final String ender)
final String message, throws IOException {
final String ender) throws IOException {
final List<String> strings = new ArrayList<>(); final List<String> strings = new ArrayList<>();
manager.println( manager.println(message + CLIPrompterMessages.getString(LIST_DISP_KEY, ender));
message + CLIPrompterMessages.getString(LIST_DISP_KEY, ender));
String res = null; String res = null;
while (!ender.equals(res)) { while (!ender.equals(res)) {
res = input.prompt(CLIPrompterMessages.getString(PROMPT)); res = input.prompt(CLIPrompterMessages.getString(PROMPT));
@@ -383,10 +358,9 @@ public final class CLIPrompter {
* @return the text * @return the text
* @throws IOException if the manager was closed */ * @throws IOException if the manager was closed */
public static String promptLongText(final ConsoleOutput manager, public static String promptLongText(final ConsoleOutput manager,
final ConsoleInput input, final ConsoleInput input, final String message) throws IOException {
final String message) throws IOException { return promptLongText(manager, input, message,
return promptLongText(manager, input, message, CLIPrompterMessages CLIPrompterMessages.getString("promptlongtext.exit.defaultkey")); //$NON-NLS-1$
.getString("promptlongtext.exit.defaultkey")); //$NON-NLS-1$
} }
/** Prompt for a text with several lines. /** Prompt for a text with several lines.
@@ -398,11 +372,10 @@ public final class CLIPrompter {
* @return the text * @return the text
* @throws IOException if the manager was closed */ * @throws IOException if the manager was closed */
public static String promptLongText(final ConsoleOutput manager, public static String promptLongText(final ConsoleOutput manager,
final ConsoleInput input, final ConsoleInput input, final String message, final String ender)
final String message, throws IOException {
final String ender) throws IOException { manager.println(message
manager.println(message + CLIPrompterMessages + CLIPrompterMessages.getString("promptlongtext.exit.dispkey", ender)); //$NON-NLS-1$
.getString("promptlongtext.exit.dispkey", ender)); //$NON-NLS-1$
final StringBuilder res = new StringBuilder(); final StringBuilder res = new StringBuilder();
String line; String line;
do { do {
@@ -426,13 +399,10 @@ public final class CLIPrompter {
* @return the choice * @return the choice
* @throws IOException if the manager was closed */ * @throws IOException if the manager was closed */
public static <U> List<U> promptMultiChoice(final ConsoleOutput manager, public static <U> List<U> promptMultiChoice(final ConsoleOutput manager,
final ConsoleInput input, final ConsoleInput input, final List<String> keys, final List<U> choices,
final List<String> keys, final String message) throws IOException {
final List<U> choices, final List<Integer> indices = promptMultiChoice(manager, input, keys, message);
final String message) throws IOException { final List<U> userChoices = new ArrayList<>(indices.size());
final List<Integer> indices = promptMultiChoice(manager, input, keys,
message);
final List<U> userChoices = new ArrayList<>();
for (final Integer integer : indices) { for (final Integer integer : indices) {
userChoices.add(choices.get(integer.intValue())); userChoices.add(choices.get(integer.intValue()));
} }
@@ -451,13 +421,10 @@ public final class CLIPrompter {
* @return the chosen objects (or an empty list) * @return the chosen objects (or an empty list)
* @throws IOException if the manager was closed */ * @throws IOException if the manager was closed */
public static <U, T> List<T> promptMultiChoice(final ConsoleOutput manager, public static <U, T> List<T> promptMultiChoice(final ConsoleOutput manager,
final ConsoleInput input, final ConsoleInput input, final List<U> choices, final Map<U, T> choicesMap,
final List<U> choices, final String message) throws IOException {
final Map<U, T> choicesMap, final List<Integer> chs = promptMultiChoice(manager, input, choices, message);
final String message) throws IOException { final List<T> userChoices = new ArrayList<>(chs.size());
final List<Integer> chs = promptMultiChoice(manager, input, choices,
message);
final List<T> userChoices = new ArrayList<>();
for (final Integer integer : chs) { for (final Integer integer : chs) {
userChoices.add(choicesMap.get(choices.get(integer.intValue()))); userChoices.add(choicesMap.get(choices.get(integer.intValue())));
} }
@@ -474,9 +441,8 @@ public final class CLIPrompter {
* @return the indices of the choices * @return the indices of the choices
* @throws IOException if the manager was closed */ * @throws IOException if the manager was closed */
public static <U> List<Integer> promptMultiChoice(final ConsoleOutput manager, public static <U> List<Integer> promptMultiChoice(final ConsoleOutput manager,
final ConsoleInput input, final ConsoleInput input, final List<U> choices, final String message)
final List<U> choices, throws IOException {
final String message) throws IOException {
manager.println(message); manager.println(message);
final Integer index = listChoices(manager, choices, null); final Integer index = listChoices(manager, choices, null);
String result; String result;
@@ -492,11 +458,11 @@ public final class CLIPrompter {
try { try {
added = addUserChoice(val, chs, index.intValue()); added = addUserChoice(val, chs, index.intValue());
} catch (final NumberFormatException e) { } catch (final NumberFormatException e) {
LOGGER.log(Level.FINER, LOGGER.log(Level.FINER, "Unrecognized number. Prompting user again.", //$NON-NLS-1$
"Unrecognized number. Prompting user again.", e); //$NON-NLS-1$ e);
keepOn = true; keepOn = true;
manager.println(CLIPrompterMessages manager.println(CLIPrompterMessages.getString(PROMPTCHOICE_FORMATERR,
.getString(PROMPTCHOICE_FORMATERR, ZERO, index)); ZERO, index));
listChoices(manager, choices, null); listChoices(manager, choices, null);
break; break;
} }
@@ -522,11 +488,10 @@ public final class CLIPrompter {
* @return the chosen objects * @return the chosen objects
* @throws IOException if the manager was closed */ * @throws IOException if the manager was closed */
public static <U, T> List<T> promptMultiChoice(final ConsoleOutput manager, public static <U, T> List<T> promptMultiChoice(final ConsoleOutput manager,
final ConsoleInput input, final ConsoleInput input, final Map<U, T> choicesMap, final String message)
final Map<U, T> choicesMap, throws IOException {
final String message) throws IOException { return promptMultiChoice(manager, input, new ArrayList<>(choicesMap.keySet()),
return promptMultiChoice(manager, input, choicesMap, message);
new ArrayList<>(choicesMap.keySet()), choicesMap, message);
} }
/** Prompt the user for a non empty text. /** Prompt the user for a non empty text.
@@ -536,9 +501,8 @@ public final class CLIPrompter {
* @param reprompt the prompting message after empty input * @param reprompt the prompting message after empty input
* @return the non empty input * @return the non empty input
* @throws IOException if the manager was closed */ * @throws IOException if the manager was closed */
public static String promptNonEmpty(final ConsoleInput manager, public static String promptNonEmpty(final ConsoleInput manager, final String prompt,
final String prompt, final String reprompt) throws IOException {
final String reprompt) throws IOException {
String res = manager.prompt(prompt); String res = manager.prompt(prompt);
while (res.isEmpty()) { while (res.isEmpty()) {
res = manager.prompt(reprompt); res = manager.prompt(reprompt);

View File

@@ -45,17 +45,17 @@ package net.bigeon.gclc.prompt;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 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,
@@ -63,10 +63,10 @@ package net.bigeon.gclc.prompt;
* 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.
* #L% * #L%
@@ -82,12 +82,12 @@ import java.util.logging.Logger;
* @author Emmanuel BIGEON */ * @author Emmanuel BIGEON */
public final class CLIPrompterMessages { public final class CLIPrompterMessages {
/** The resource name. */ /** The resource name. */
private static final String BUNDLE_NAME = "net.bigeon.gclc.messages"; //$NON-NLS-1$ private static final String BUNDLE_NAME = "net.bigeon.gclc.messages"; //$NON-NLS-1$
/** The resource. */ /** The resource. */
private static final ResourceBundle RESOURCE_BUNDLE = ResourceBundle private static final ResourceBundle RESOURCE_BUNDLE = ResourceBundle
.getBundle(BUNDLE_NAME); .getBundle(BUNDLE_NAME);
/** The logger. */ /** The logger. */
private static final Logger LOGGER = Logger private static final Logger LOGGER = Logger
.getLogger(CLIPrompterMessages.class.getName()); .getLogger(CLIPrompterMessages.class.getName());
/** Utility class. */ /** Utility class. */

View File

@@ -17,17 +17,17 @@ package net.bigeon.gclc.prompt;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 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,
@@ -35,10 +35,10 @@ package net.bigeon.gclc.prompt;
* 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.
* #L% * #L%

View File

@@ -41,17 +41,17 @@ package net.bigeon.gclc.tools;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 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,
@@ -59,32 +59,32 @@ package net.bigeon.gclc.tools;
* 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.
* #L% * #L%
*/ */
/** A {@link StringProvider} that hold a constant string. /** A {@link StringProvider} that hold a constant string.
* *
* @author Emmanuel Bigeon */ * @author Emmanuel Bigeon */
public class ConstantString implements StringProvider { public class ConstantString implements StringProvider {
private final String string; private final String string;
/** Create a provider for a string.
*
* @param string the string */
public ConstantString(String string) {
this.string = string;
}
/* (non-Javadoc) /* (non-Javadoc)
* @see net.bigeon.gclc.tools.StringProvider#apply() */ * @see net.bigeon.gclc.tools.StringProvider#apply() */
@Override @Override
public String apply() { public String apply() {
return string; return string;
} }
/** Create a provider for a string.
*
* @param string the string */
public ConstantString(String string) {
this.string = string;
}
} }

View File

@@ -45,17 +45,17 @@ package net.bigeon.gclc.tools;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 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,
@@ -63,10 +63,10 @@ package net.bigeon.gclc.tools;
* 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.
* #L% * #L%
@@ -80,27 +80,27 @@ import java.util.List;
public final class PrintUtils { public final class PrintUtils {
/** The continuation dot string. */ /** The continuation dot string. */
private static final String CONT_DOT = "..."; //$NON-NLS-1$ private static final String CONT_DOT = "..."; //$NON-NLS-1$
/** The continuation dot string length. */ /** The continuation dot string length. */
private static final int CONT_DOT_LENGTH = CONT_DOT.length(); private static final int CONT_DOT_LENGTH = CONT_DOT.length();
/** The empty string constant. */ /** The empty string constant. */
private static final String EMPTY = ""; //$NON-NLS-1$ private static final String EMPTY = ""; //$NON-NLS-1$
/** Utility class. */ /** Utility class. */
private PrintUtils() { private PrintUtils() {
// Utility class // Utility class
} }
/** Print the text possibly cutting it if it goes over the authorized length /** Print the text possibly cutting it if it goes over the authorized length and
* and adding a mark of continuation. * adding a mark of continuation.
* *
* @param text the text to print * @param text the text to print
* @param nbCharacters the number of characters of the resulting text * @param nbCharacters the number of characters of the resulting text
* @param indicateTooLong if an indication shell be given that the text * @param indicateTooLong if an indication shell be given that the text didn't
* didn't fit * fit
* @return the text to print (will be of exactly nbCharacters). */ * @return the text to print (will be of exactly nbCharacters). */
public static String print(final String text, final int nbCharacters, public static String print(final String text, final int nbCharacters,
final boolean indicateTooLong) { final boolean indicateTooLong) {
StringBuilder res = new StringBuilder(text); StringBuilder res = new StringBuilder(text);
if (res.length() > nbCharacters) { if (res.length() > nbCharacters) {
// Cut // Cut
@@ -125,8 +125,7 @@ public final class PrintUtils {
* @param i the length of the wrap * @param i the length of the wrap
* @return the list of resulting strings */ * @return the list of resulting strings */
public static List<String> wrap(final String description, final int i) { public static List<String> wrap(final String description, final int i) {
final String[] originalLines = description final String[] originalLines = description.split(System.lineSeparator());
.split(System.lineSeparator());
final List<String> result = new ArrayList<>(); final List<String> result = new ArrayList<>();
for (final String string : originalLines) { for (final String string : originalLines) {
String toCut = string; String toCut = string;

View File

@@ -41,17 +41,17 @@ package net.bigeon.gclc.tools;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 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,
@@ -59,10 +59,10 @@ package net.bigeon.gclc.tools;
* 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.
* #L% * #L%
@@ -73,11 +73,11 @@ package net.bigeon.gclc.tools;
* Implementations of this interface will provide a string, this internal state * Implementations of this interface will provide a string, this internal state
* of the object may be so that successive calls to the apply method return * of the object may be so that successive calls to the apply method return
* different results. * different results.
* *
* @author Emmanuel */ * @author Emmanuel */
public interface StringProvider { public interface StringProvider {
/** Provide a string. /** Provide a string.
* *
* @return the string */ * @return the string */
String apply(); String apply();
} }

View File

@@ -10,17 +10,17 @@ package net.bigeon.gclc.tools;
* Copyright (C) 2014 - 2018 Bigeon * Copyright (C) 2014 - 2018 Bigeon
* %% * %%
* 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,
@@ -28,10 +28,10 @@ package net.bigeon.gclc.tools;
* 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.
* #L% * #L%

View File

@@ -45,17 +45,17 @@ package net.bigeon.gclc.utils;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 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,
@@ -63,10 +63,10 @@ package net.bigeon.gclc.utils;
* 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.
* #L% * #L%
@@ -83,14 +83,14 @@ import java.util.logging.Logger;
public abstract class AOutputForwardRunnable implements Runnable { public abstract class AOutputForwardRunnable implements Runnable {
/** The class logger. */ /** The class logger. */
private static final Logger LOGGER = Logger private static final Logger LOGGER = Logger
.getLogger(AOutputForwardRunnable.class.getName()); .getLogger(AOutputForwardRunnable.class.getName());
/** The default timeout (one tenth of second). */ /** The default timeout (one tenth of second). */
private static final long DEFAULT_TIMEOUT = 100; private static final long DEFAULT_TIMEOUT = 100;
/** The manager. */ /** The manager. */
private final PipedConsoleOutput manager; private final PipedConsoleOutput manager;
/** The timeout. */ /** The timeout. */
private final long timeout; private final long timeout;
/** Create a forwarding runnable. /** Create a forwarding runnable.
* *
@@ -103,19 +103,18 @@ public abstract class AOutputForwardRunnable implements Runnable {
/** Create a forward runnable with the given timeout. /** Create a forward runnable with the given timeout.
* <p> * <p>
* Short timeout will be very responsive to the application actual messages, * Short timeout will be very responsive to the application actual messages, but
* but may use computation time if the application is not verbose. Long * may use computation time if the application is not verbose. Long timeout will
* timeout will save computation time, but will read batches of messages at * save computation time, but will read batches of messages at once if the
* once if the application is verbose. The right length for the timeout is * application is verbose. The right length for the timeout is likely to depend
* likely to depend on the application and the use of it. * on the application and the use of it.
* <p> * <p>
* If you do not know what timeout length to use, please use the * If you do not know what timeout length to use, please use the
* {@link #AOutputForwardRunnable(PipedConsoleOutput)} constructor. * {@link #AOutputForwardRunnable(PipedConsoleOutput)} constructor.
* *
* @param manager the manager * @param manager the manager
* @param timeout the timeout between message requests. */ * @param timeout the timeout between message requests. */
public AOutputForwardRunnable(final PipedConsoleOutput manager, public AOutputForwardRunnable(final PipedConsoleOutput manager, final long timeout) {
final long timeout) {
super(); super();
this.manager = manager; this.manager = manager;
this.timeout = timeout; this.timeout = timeout;

View File

@@ -36,7 +36,9 @@
* gclc:net.bigeon.gclc.manager.EmptyInput.java * gclc:net.bigeon.gclc.manager.EmptyInput.java
* Created on: Nov 13, 2017 * Created on: Nov 13, 2017
*/ */
package net.bigeon.gclc.manager; package net.bigeon.gclc.utils;
import net.bigeon.gclc.manager.ConsoleInput;
/*- /*-
* #%L * #%L
@@ -45,17 +47,17 @@ package net.bigeon.gclc.manager;
* Copyright (C) 2014 - 2018 Bigeon * Copyright (C) 2014 - 2018 Bigeon
* %% * %%
* 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,
@@ -63,10 +65,10 @@ package net.bigeon.gclc.manager;
* 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.
* #L% * #L%
@@ -80,12 +82,15 @@ import net.bigeon.gclc.tools.StringProvider;
* @author Emmanuel Bigeon */ * @author Emmanuel Bigeon */
public final class EmptyInput implements ConsoleInput { public final class EmptyInput implements ConsoleInput {
private static final ConstantString CONSTANT_STRING = new ConstantString("");
/** The empty prompter. */ /** The empty prompter. */
public static final ConsoleInput INSTANCE = new EmptyInput(); public static final ConsoleInput INSTANCE = new EmptyInput();
/** The empty input. */ /** The empty input. */
private EmptyInput() { private EmptyInput() {
// //
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see net.bigeon.gclc.manager.ConsoleInput#close() */ * @see net.bigeon.gclc.manager.ConsoleInput#close() */
@Override @Override
@@ -97,7 +102,7 @@ public final class EmptyInput implements ConsoleInput {
* @see net.bigeon.gclc.manager.ConsoleInput#getPrompt() */ * @see net.bigeon.gclc.manager.ConsoleInput#getPrompt() */
@Override @Override
public StringProvider getPrompt() { public StringProvider getPrompt() {
return new ConstantString(""); //$NON-NLS-1$ return CONSTANT_STRING; //$NON-NLS-1$
} }
/* (non-Javadoc) /* (non-Javadoc)
@@ -136,11 +141,9 @@ public final class EmptyInput implements ConsoleInput {
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see net.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String, * @see net.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String, long) */
* long) */
@Override @Override
public String prompt(final String message, public String prompt(final String message, final long timeout) {
final long timeout) {
return ""; //$NON-NLS-1$ return ""; //$NON-NLS-1$
} }
@@ -153,6 +156,6 @@ public final class EmptyInput implements ConsoleInput {
@Override @Override
public void setPrompt(StringProvider string) { public void setPrompt(StringProvider string) {
// //
} }
} }

View File

@@ -45,17 +45,17 @@ package net.bigeon.gclc.utils;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 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,
@@ -63,10 +63,10 @@ package net.bigeon.gclc.utils;
* 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.
* #L% * #L%
@@ -87,17 +87,16 @@ import net.bigeon.gclc.tools.StringProvider;
* used to test application behavior. * used to test application behavior.
* *
* @author Emmanuel Bigeon */ * @author Emmanuel Bigeon */
public final class PipedConsoleInput public final class PipedConsoleInput implements ConsoleInput {
implements ConsoleInput {
/** THe inner manager. */ /** THe inner manager. */
private final StreamConsoleInput innerManager; private final StreamConsoleInput innerManager;
/** The stream to pipe commands into. */ /** The stream to pipe commands into. */
private final PipedOutputStream commandInput; private final PipedOutputStream commandInput;
/** The stream for the application to read commands from. */ /** The stream for the application to read commands from. */
private final PipedInputStream in; private final PipedInputStream in;
/** The writing thread. */ /** The writing thread. */
private final WritingRunnable writing; private final WritingRunnable writing;
/** Create a manager that will write and read through piped stream. /** Create a manager that will write and read through piped stream.
* *
@@ -106,11 +105,9 @@ public final class PipedConsoleInput
public PipedConsoleInput(final PrintStream outPrint) throws IOException { public PipedConsoleInput(final PrintStream outPrint) throws IOException {
commandInput = new PipedOutputStream(); commandInput = new PipedOutputStream();
in = new PipedInputStream(commandInput); in = new PipedInputStream(commandInput);
innerManager = new StreamConsoleInput(outPrint, in, innerManager = new StreamConsoleInput(outPrint, in, StandardCharsets.UTF_8);
StandardCharsets.UTF_8);
writing = new WritingRunnable(commandInput, StandardCharsets.UTF_8); writing = new WritingRunnable(commandInput, StandardCharsets.UTF_8);
final Thread th = new Thread(writing, final Thread th = new Thread(writing, "GCLC console piped input stream"); //$NON-NLS-1$
"GCLC console piped input stream"); //$NON-NLS-1$
th.start(); th.start();
} }
@@ -145,8 +142,7 @@ public final class PipedConsoleInput
* @see net.bigeon.gclc.manager.ConsoleInput#prompt() */ * @see net.bigeon.gclc.manager.ConsoleInput#prompt() */
@Override @Override
public String prompt() throws IOException { public String prompt() throws IOException {
return innerManager return innerManager.prompt(innerManager.getPrompt() + System.lineSeparator());
.prompt(innerManager.getPrompt() + System.lineSeparator());
} }
/* (non-Javadoc) /* (non-Javadoc)
@@ -164,8 +160,7 @@ public final class PipedConsoleInput
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see net.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String, * @see net.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String, long) */
* long) */
@Override @Override
public String prompt(final String message, final long timeout) throws IOException { public String prompt(final String message, final long timeout) throws IOException {
return innerManager.prompt(message + System.lineSeparator(), timeout); return innerManager.prompt(message + System.lineSeparator(), timeout);
@@ -177,10 +172,10 @@ public final class PipedConsoleInput
public void setPrompt(final String prompt) { public void setPrompt(final String prompt) {
innerManager.setPrompt(prompt); innerManager.setPrompt(prompt);
} }
@Override @Override
public void setPrompt(StringProvider string) { public void setPrompt(StringProvider string) {
innerManager.setPrompt(string); innerManager.setPrompt(string);
} }
/** Type a message in the input. /** Type a message in the input.

View File

@@ -45,17 +45,17 @@ package net.bigeon.gclc.utils;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 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,
@@ -63,10 +63,10 @@ package net.bigeon.gclc.utils;
* 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.
* #L% * #L%
@@ -87,21 +87,20 @@ import net.bigeon.gclc.manager.ConsoleOutput;
* used to test application behavior. * used to test application behavior.
* *
* @author Emmanuel Bigeon */ * @author Emmanuel Bigeon */
public final class PipedConsoleOutput public final class PipedConsoleOutput implements ConsoleOutput {
implements ConsoleOutput {
/** The encoding between streams. */ /** The encoding between streams. */
private static final String UTF_8 = "UTF-8"; //$NON-NLS-1$ private static final String UTF_8 = "UTF-8"; //$NON-NLS-1$
/** THe inner manager. */ /** THe inner manager. */
private final StreamConsoleOutput innerManager; private final StreamConsoleOutput innerManager;
/** The reader to get application return from. */ /** The reader to get application return from. */
private final BufferedReader commandBuffOutput; private final BufferedReader commandBuffOutput;
/** The stream to get application return from. */ /** The stream to get application return from. */
private final PipedInputStream commandOutput; private final PipedInputStream commandOutput;
/** The print writer for application to write return to. */ /** The print writer for application to write return to. */
private final PrintStream outPrint; private final PrintStream outPrint;
/** The reading thread. */ /** The reading thread. */
private final ReadingRunnable reading; private final ReadingRunnable reading;
/** Create a manager that will write and read through piped stream. /** Create a manager that will write and read through piped stream.
* *
@@ -140,14 +139,14 @@ public final class PipedConsoleOutput
/** Wait for a specific message to arrive. /** Wait for a specific message to arrive.
* <p> * <p>
* When this method returns, the message was appended to the data, it * When this method returns, the message was appended to the data, it <em>may or
* <em>may or may not</em> be the next line of data. * may not</em> be the next line of data.
* *
* @param message the message * @param message the message
* @return the thread to join to wait for message delivery * @throws InterruptedException if the wait on the message was interrupted
* @see net.bigeon.gclc.utils.ReadingRunnable#getWaitForDelivery(java.lang.String) */ * @see net.bigeon.gclc.utils.ReadingRunnable#waitForDelivery(String) */
public Thread getWaitForDelivery(final String message) { public void waitForDelivery(final String message) throws InterruptedException {
return reading.getWaitForDelivery(message); reading.waitForDelivery(message);
} }
/* (non-Javadoc) /* (non-Javadoc)

View File

@@ -45,17 +45,17 @@ package net.bigeon.gclc.utils;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 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,
@@ -63,10 +63,10 @@ package net.bigeon.gclc.utils;
* 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.
* #L% * #L%
@@ -76,8 +76,8 @@ import java.io.IOException;
import java.io.InterruptedIOException; import java.io.InterruptedIOException;
import java.util.ArrayDeque; import java.util.ArrayDeque;
import java.util.Deque; import java.util.Deque;
import java.util.HashMap;
import java.util.Map; import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
import java.util.logging.Level; import java.util.logging.Level;
import java.util.logging.Logger; import java.util.logging.Logger;
@@ -86,91 +86,31 @@ import java.util.logging.Logger;
* @author Emmanuel Bigeon */ * @author Emmanuel Bigeon */
public final class ReadingRunnable implements Runnable { public final class ReadingRunnable implements Runnable {
/** The runnable to wait for arrival of a message in the queue.
*
* @author Emmanuel Bigeon */
private final class ToWaitRunnable implements Runnable {
/** The Object. */
private final Object obj;
/** The locking object. */
private final Object start;
/** The message. */
private final String message;
/** The started status. */
private boolean started = false;
/** Create the waiting runnable.
*
* @param obj the object to lock on
* @param start the object to notify when ready to wait
* @param message the message to wait for */
public ToWaitRunnable(final Object obj, final Object start,
final String message) {
this.obj = obj;
this.start = start;
this.message = message;
}
/** Test if the waiting runnable is started.
*
* @return the started */
public boolean isStarted() {
synchronized (start) {
return started;
}
}
/* (non-Javadoc)
* @see java.lang.Runnable#run() */
@Override
public void run() {
synchronized (obj) {
synchronized (start) {
started = true;
start.notifyAll();
}
while (isRunning()) {
try {
obj.wait();
if (delivering.equals(message)) {
return;
}
} catch (final InterruptedException e) {
LOGGER.log(Level.SEVERE, THREAD_INTERRUPTION_EXCEPTION,
e);
Thread.currentThread().interrupt();
}
}
}
}
}
/** The thread intteruption logging message. */ /** The thread intteruption logging message. */
private static final String THREAD_INTERRUPTION_EXCEPTION = "Thread interruption exception."; //$NON-NLS-1$ private static final String THREAD_INTERRUPTION_EXCEPTION = "Thread interruption exception."; //$NON-NLS-1$
/** The closed pipe message. */ /** The closed pipe message. */
private static final String CLOSED_PIPE = "Closed pipe"; //$NON-NLS-1$ private static final String CLOSED_PIPE = "Closed pipe"; //$NON-NLS-1$
/** Wait timeout. */ /** Wait timeout. */
private static final long TIMEOUT = 1000; private static final long TIMEOUT = 1000;
/** Class logger. */ /** Class logger. */
private static final Logger LOGGER = Logger private static final Logger LOGGER = Logger
.getLogger(ReadingRunnable.class.getName()); .getLogger(ReadingRunnable.class.getName());
/** Read messages. */ /** Read messages. */
private final Deque<String> messages = new ArrayDeque<>(); private final Deque<String> messages = new ArrayDeque<>();
/** the reader. */
private final BufferedReader reader;
/** the state of this runnable. */
private boolean running = true;
/** Synchro object. */
private final Object lock = new Object();
/** The waiting status for a message. */
private boolean waiting;
/** The blocker for a given message. */
private final Map<String, Object> messageBlocker = new HashMap<>();
/** The lock. */
private final Object messageBlockerLock = new Object();
/** The message being delivered. */
private String delivering;
/** the reader. */
private final BufferedReader reader;
/** the state of this runnable. */
private boolean running = true;
/** Synchro object. */
private final Object lock = new Object();
/** The waiting status for a message. */
private boolean waiting;
/** The blocker for a given message. */
private final Map<String, Object> messageBlocker = new ConcurrentHashMap<>();
/** The lock. */
private final Object messageBlockerLock = new Object();
/** Create a reading runnable. /** Create a reading runnable.
* *
* @param reader the input to read from */ * @param reader the input to read from */
@@ -179,28 +119,17 @@ public final class ReadingRunnable implements Runnable {
this.reader = reader; this.reader = reader;
} }
/** Strip the string from head NULL characters. /** Do wait for a message.
* <p>
* This method should only be called inside a loop.
* *
* @param line the line to strip the null character from
* @return the resulting string */
private static String stripNull(final String line) {
String res = line;
while (res.length() > 0 && res.charAt(0) == 0) {
LOGGER.severe(
"NULL character heading the result of the read. This is a stream problem..."); //$NON-NLS-1$
res = res.substring(1);
}
return res;
}
/** do wait for a message.
* <p>This method should only be called inside a loop.
* @param timeout the timeout of the wait. * @param timeout the timeout of the wait.
* @throws IOException if the runnable was stopped and no essage was found. * @throws IOException if the runnable was stopped and no essage was found. */
*/
private void doWaitMessage(final long timeout) throws IOException { private void doWaitMessage(final long timeout) throws IOException {
try { try {
lock.wait(timeout); synchronized (lock) {
lock.wait(timeout);
}
} catch (final InterruptedException e) { } catch (final InterruptedException e) {
LOGGER.log(Level.SEVERE, THREAD_INTERRUPTION_EXCEPTION, e); LOGGER.log(Level.SEVERE, THREAD_INTERRUPTION_EXCEPTION, e);
Thread.currentThread().interrupt(); Thread.currentThread().interrupt();
@@ -221,7 +150,7 @@ public final class ReadingRunnable implements Runnable {
} }
waiting = true; waiting = true;
waitMessage(TIMEOUT); waitMessage(TIMEOUT);
LOGGER.finest("Polled: " + messages.peek()); //$NON-NLS-1$ LOGGER.log(Level.FINEST, "Polled: {0}", messages.peek()); //$NON-NLS-1$
waiting = false; waiting = false;
notifyMessage(messages.peek()); notifyMessage(messages.peek());
return messages.poll(); return messages.poll();
@@ -247,38 +176,20 @@ public final class ReadingRunnable implements Runnable {
return messages.poll(); return messages.poll();
} }
} }
/** Get a waiting thread for a specific message delivery. public void waitForDelivery(String message) throws InterruptedException {
* Object mLock;
* @param message the message
* @return the thread to join to wait for message delivery */
public Thread getWaitForDelivery(final String message) {
synchronized (messageBlockerLock) { synchronized (messageBlockerLock) {
if (!messageBlocker.containsKey(message)) { if (!messageBlocker.containsKey(message)) {
messageBlocker.put(message, new Object()); messageBlocker.put(message, new Object());
} }
final Object obj = messageBlocker.get(message); mLock = messageBlocker.get(message);
final Object start = new Object(); }
final ToWaitRunnable waitRunn = new ToWaitRunnable(obj, start, synchronized (mLock) {
message); mLock.wait();
final Thread th = new Thread(waitRunn);
synchronized (start) {
th.start();
while (!waitRunn.isStarted()) {
try {
start.wait(TIMEOUT);
} catch (final InterruptedException e) {
LOGGER.log(Level.SEVERE, THREAD_INTERRUPTION_EXCEPTION,
e);
Thread.currentThread().interrupt();
}
}
}
return th;
} }
} }
/** Test if some data is available. /** Test if some data is available.
* *
* @return if a message is waiting * @return if a message is waiting
@@ -292,8 +203,7 @@ public final class ReadingRunnable implements Runnable {
} }
} }
/** Interrupts the wait on the next message by providing an empty /** Interrupts the wait on the next message by providing an empty message. */
* message. */
public void interrupt() { public void interrupt() {
synchronized (lock) { synchronized (lock) {
if (waiting) { if (waiting) {
@@ -317,9 +227,8 @@ public final class ReadingRunnable implements Runnable {
* @param message the message */ * @param message the message */
private void notifyMessage(final String message) { private void notifyMessage(final String message) {
synchronized (messageBlockerLock) { synchronized (messageBlockerLock) {
delivering = message; final Object mLock = messageBlocker.get(message);
if (messageBlocker.containsKey(message)) { if (mLock!=null) {
final Object mLock = messageBlocker.get(message);
synchronized (mLock) { synchronized (mLock) {
mLock.notifyAll(); mLock.notifyAll();
} }
@@ -332,32 +241,41 @@ public final class ReadingRunnable implements Runnable {
* @see java.lang.Runnable#run() */ * @see java.lang.Runnable#run() */
@Override @Override
public void run() { public void run() {
while (running) { while (true) {
synchronized (lock) {
if (!running) {
break;
}
}
try { try {
String line = reader.readLine(); String line = reader.readLine();
if (line == null) { if (line == null) {
// Buffer end // Buffer end
running = false; setRunning(false);
return; return;
} }
LOGGER.finer("Read: " + line); //$NON-NLS-1$ LOGGER.log(Level.FINER, "Read: {0}", line); //$NON-NLS-1$
line = stripNull(line); line = stripNull(line);
synchronized (lock) { synchronized (lock) {
messages.add(line); messages.add(line);
lock.notifyAll(); lock.notifyAll();
} }
} catch (final InterruptedIOException e) { } catch (final InterruptedIOException e) {
if (running) { synchronized (lock) {
LOGGER.info("Reading interrupted"); //$NON-NLS-1$ if (running) {
LOGGER.info("Reading interrupted"); //$NON-NLS-1$
}
} }
LOGGER.log(Level.FINER, LOGGER.log(Level.FINER, "Read interruption was caused by an exception", //$NON-NLS-1$
"Read interruption was caused by an exception", e); //$NON-NLS-1$ e);
} catch (final IOException e) { } catch (final IOException e) {
LOGGER.log(Level.FINE, "The stream reading threw an exception", //$NON-NLS-1$ LOGGER.log(Level.FINE, "The stream reading threw an exception", //$NON-NLS-1$
e); e);
if (running) { synchronized (lock) {
LOGGER.severe("Unable to read from stream"); //$NON-NLS-1$ if (running) {
running = false; LOGGER.severe("Unable to read from stream"); //$NON-NLS-1$
setRunning(false);
}
} }
return; return;
} }
@@ -373,14 +291,28 @@ public final class ReadingRunnable implements Runnable {
} }
} }
/** Wait for the next message to be integratted. /** Wait for the next message to be integrated.
* *
* @param timeout the timeout to wait * @param timeout the timeout to wait
* @throws IOException if the next message was not delivered and the * @throws IOException if the next message was not delivered and the runnable
* runnable stopped. */ * stopped. */
private void waitMessage(final long timeout) throws IOException { private void waitMessage(final long timeout) throws IOException {
while (messages.isEmpty()) { while (messages.isEmpty()) {
doWaitMessage(timeout); doWaitMessage(timeout);
} }
} }
/** Strip the string from head NULL characters.
*
* @param line the line to strip the null character from
* @return the resulting string */
private static String stripNull(final String line) {
String res = line;
while (res.length() > 0 && res.charAt(0) == 0) {
LOGGER.severe(
"NULL character heading the result of the read. This is a stream problem..."); //$NON-NLS-1$
res = res.substring(1);
}
return res;
}
} }

View File

@@ -47,17 +47,17 @@ import net.bigeon.gclc.manager.ConsoleOutput;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 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,
@@ -65,10 +65,10 @@ import net.bigeon.gclc.manager.ConsoleOutput;
* 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.
* #L% * #L%
@@ -85,6 +85,7 @@ public final class SinkOutput implements ConsoleOutput {
private SinkOutput() { private SinkOutput() {
// //
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see net.bigeon.gclc.manager.ConsoleOutput#close() */ * @see net.bigeon.gclc.manager.ConsoleOutput#close() */
@Override @Override
@@ -114,8 +115,7 @@ public final class SinkOutput implements ConsoleOutput {
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see net.bigeon.gclc.manager.ConsoleOutput#println(java.lang.String) * @see net.bigeon.gclc.manager.ConsoleOutput#println(java.lang.String) */
*/
@Override @Override
public void println(final String message) { public void println(final String message) {
// //

View File

@@ -45,17 +45,17 @@ package net.bigeon.gclc.utils;
* Copyright (C) 2014 - 2018 bigeon.fr * Copyright (C) 2014 - 2018 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,
@@ -63,10 +63,10 @@ package net.bigeon.gclc.utils;
* 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.
* #L% * #L%
@@ -96,12 +96,12 @@ public final class StreamConsoleInput implements ConsoleInput {
private StringProvider prompt = DEFAULT_PROMPT; private StringProvider prompt = DEFAULT_PROMPT;
/** The print stream. */ /** The print stream. */
private final PrintStream out; private final PrintStream out;
/** The input stream. */ /** The input stream. */
private final BufferedReader in; private final BufferedReader in;
/** If the manager is closed. */ /** If the manager is closed. */
private boolean closed = false; private boolean closed;
/** The prompting thread. */ /** The prompting thread. */
private final Thread promptThread; private final Thread promptThread;
@@ -109,8 +109,8 @@ public final class StreamConsoleInput implements ConsoleInput {
/** The reading runnable. */ /** The reading runnable. */
private final ReadingRunnable reading; private final ReadingRunnable reading;
/** This default constructor relies on the system defined standart output /** This default constructor relies on the system defined standart output and
* and input stream. */ * input stream. */
public StreamConsoleInput() { public StreamConsoleInput() {
this(System.out, System.in, Charset.defaultCharset()); this(System.out, System.in, Charset.defaultCharset());
} }
@@ -121,7 +121,7 @@ public final class StreamConsoleInput implements ConsoleInput {
* @param in the input stream * @param in the input stream
* @param charset the charset for the input */ * @param charset the charset for the input */
public StreamConsoleInput(final PrintStream out, final InputStream in, public StreamConsoleInput(final PrintStream out, final InputStream in,
final Charset charset) { final Charset charset) {
super(); super();
this.out = out; this.out = out;
this.in = new BufferedReader(new InputStreamReader(in, charset)); this.in = new BufferedReader(new InputStreamReader(in, charset));
@@ -143,7 +143,7 @@ public final class StreamConsoleInput implements ConsoleInput {
/* (non-Javadoc) /* (non-Javadoc)
* @see net.bigeon.gclc.manager.ConsoleManager#close() */ * @see net.bigeon.gclc.manager.ConsoleManager#close() */
@Override @Override
public void close() throws IOException { public void close() {
closed = true; closed = true;
reading.setRunning(false); reading.setRunning(false);
promptThread.interrupt(); promptThread.interrupt();
@@ -200,8 +200,7 @@ public final class StreamConsoleInput implements ConsoleInput {
/* (non-Javadoc) /* (non-Javadoc)
* @see net.bigeon.gclc.ConsoleManager#prompt(java.lang.String) */ * @see net.bigeon.gclc.ConsoleManager#prompt(java.lang.String) */
@Override @Override
public String prompt(final String message, public String prompt(final String message, final long timeout) throws IOException {
final long timeout) throws IOException {
checkOpen(); checkOpen();
if (out != null) { if (out != null) {
out.print(message); out.print(message);
@@ -219,6 +218,6 @@ public final class StreamConsoleInput implements ConsoleInput {
@Override @Override
public void setPrompt(StringProvider string) { public void setPrompt(StringProvider string) {
this.prompt = string; prompt = string;
} }
} }

Some files were not shown because too many files have changed in this diff Show More