Mailing-List: contact issues-help@karaf.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@karaf.apache.org
Date: Mon, 12 Jun 2017 16:18:00 +0000 (UTC)
From: "Denis Jouvin (JIRA)" <jira@apache.org>
To: issues@karaf.apache.org
Message-ID: <JIRA.13079170.1497261868000.2383.1497284280181@Atlassian.JIRA>
In-Reply-To: <JIRA.13079170.1497261868000@Atlassian.JIRA>
References: <JIRA.13079170.1497261868000@Atlassian.JIRA> <JIRA.13079170.1497261868321@jira-lw-us.apache.org>
Subject: [jira] [Commented] (KARAF-5202) Groovy and groovysh integration
 into Karaf console
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: quoted-printable
archived-at: Mon, 12 Jun 2017 16:18:05 -0000


    [ https://issues.apache.org/jira/browse/KARAF-5202?page=3Dcom.atlassian=
.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=3D1604=
6735#comment-16046735 ]=20

Denis Jouvin commented on KARAF-5202:
-------------------------------------

Here is the help from the Groovy side, including help on the 3 OSGi and Kar=
af related Groovy commands introduced in my prototype implementation ({{:os=
gi-service}}, {{:blueprint}} and {{:karaf}}).

The 2 first commands (prefixed with {{get}} and in camel-case), are also av=
ailable as Groovy closures (accessible from the current Groovysh session bi=
nding).

{noformat}
groovy:000> :help

Available commands:
  :help          (:h ) Display this help message
  ?              (:? ) Alias to: :help
  :exit          (:x ) Exit the shell
  :quit          (:q ) Alias to: :exit
  import         (:i ) Import a class into the namespace
  :display       (:d ) Display the current buffer
  :clear         (:c ) Clear the buffer and reset the prompt counter
  :show          (:S ) Show variables, classes or imports
  :inspect       (:n ) Inspect a variable or the last result with the GUI o=
bject browser
  :purge         (:p ) Purge variables, classes, imports or preferences
  :edit          (:e ) Edit the current buffer
  :load          (:l ) Load a file or URL into the buffer
  .              (:. ) Alias to: :load
  :save          (:s ) Save the current buffer to a file
  :record        (:r ) Record the current session to a file
  :history       (:H ) Display, manage and recall edit-line history
  :alias         (:a ) Create an alias
  :set           (:=3D ) Set (or list) preferences
  :register      (:rc) Register a new command with the shell
  :doc           (:D ) Open a browser window displaying the doc for the arg=
ument
  :osgi-service  (:os) Resolve an OSGi service and assign it to a variable
  :blueprint     (:bp) Resolve a blueprint container and assign it to a var=
iable
  :karaf         (:k ) Executes a Karaf command (from current Karaf session=
)

For help on a specific command type:
    :help command

groovy:000> :help :karaf

usage: :karaf [<arg1> [<arg2> [...]]]

Executes a Karaf command from the current Karaf session.Arguments are passe=
d through without specific
 (un)escaping or (un)quoting that may happen atGroovy or Karaf side. A tric=
k is to escape double-quoted
 arguments in single-quotes and vice versa.

groovy:000> :help :osgi-service

usage: :osgi-service <variableName> <serviceInterface> [<ldapFilter>]

Resolve the best matching OSGi service with the given interface, (i.e. with=
 the highest ranking and,
 if equal, lowest ID), possibly using the given LDAP filter if any, and bin=
d it a local variable

groovy:000> :help :blueprint

usage: :blueprint <variableName> <bundleSymbolicName> [<bundleVersion>]

Resolves the blueprint container OSGi service for the given bundle  symboli=
c name (and version
 if specified), and binds it to a shell variable.
{noformat}


> Groovy and groovysh integration into Karaf console
> --------------------------------------------------
>
>                 Key: KARAF-5202
>                 URL: https://issues.apache.org/jira/browse/KARAF-5202
>             Project: Karaf
>          Issue Type: New Feature
>          Components: karaf-shell
>            Reporter: Denis Jouvin
>            Assignee: Jean-Baptiste Onofr=C3=A9
>            Priority: Minor
>              Labels: Groovy, Groovysh, Karaf, ShellCommands
>
> The idea is to integrate Groovy into Karaf as an alternative scripting an=
d/or interactive shell language. Since Groovysh also uses JLine, integratio=
n is quite easy (pass the current Jline console/session instance to Groovys=
h at construction time). There are some class loading issues though since G=
roovy uses sometimes the TCCL even when we instruct it to use a given class=
 loader (I opened a Groovy JIRA issue about that).
> The Groovysh shell then would allow to get OSGi service reference or Blue=
print/Spring context references, or execute Karaf commands. Groovysh has a =
very nice command completion feature that enable to discover any objet (inc=
luding OSGi service instance) API at runtime, which makes it very easy to p=
lay with in a dynamic environment like Karaf. In addition, its native closu=
res and set operations, and very concise syntaxe, facilitates its use as a =
shell replacement.
> This open nice possibilites like exploratory programming on a live runnin=
g Karaf instance, scripting, tests or analysis, etc.
> Another common use case is to modify a not yet parameterized value in a B=
lueprint or Spring context at runtime (you can browse or access the Bluepri=
nt context components, and reinstaciate them or inject properties).


--
This message was sent by Atlassian JIRA
(v6.4.14#64029)