16.9. コンソールの使用

利用できるすべてのコマンドを表示する help コマンドの使用方法についてすでに説明しました。

ただし、help コマンドや、help コマンドのエイリアスである man コマンドを使用して、コマンドの詳細を取得することもできます。コマンドの --help オプションを使用して、別のフォームを使用してコマンドのヘルプを取得することもできます。

以下のコマンドのようになります。

karaf@root()> help feature:list
karaf@root()> man feature:list
karaf@root()> feature:list --help

以下で、すべて同じヘルプ出力を生成します。

DESCRIPTION
        feature:list

        Lists all existing features available from the defined repositories.

SYNTAX
        feature:list [options]

OPTIONS
        --help
                Display this help message
        -o, --ordered
                Display a list using alphabetical order
        -i, --installed
                Display a list of all installed features only
        --no-format
                Disable table rendered output

タブキーを入力すると、Karaf は補完しようとします。

エイリアスは、指定したコマンドに関連する別の名前です。

shell:alias コマンドは、新しいエイリアスを作成します。たとえば、実際の feature:list -i コマンドの list-installed-features エイリアスを作成するには、次の操作を実行できます。

karaf@root()> alias "list-features-installed = { feature:list -i }"
karaf@root()> list-features-installed
Name       | Version | Required | State   | Repository     | Description
------------------------------------------------------------------------------------------------------------------------------
feature    | 4.0.0   | x        | Started | standard-4.0.0 | Features Support
shell      | 4.0.0   | x        | Started | standard-4.0.0 | Karaf Shell
deployer   | 4.0.0   | x        | Started | standard-4.0.0 | Karaf Deployer
bundle     | 4.0.0   | x        | Started | standard-4.0.0 | Provide Bundle support
config     | 4.0.0   | x        | Started | standard-4.0.0 | Provide OSGi ConfigAdmin support
diagnostic | 4.0.0   | x        | Started | standard-4.0.0 | Provide Diagnostic support
instance   | 4.0.0   | x        | Started | standard-4.0.0 | Provide Instance support
jaas       | 4.0.0   | x        | Started | standard-4.0.0 | Provide JAAS support
log        | 4.0.0   | x        | Started | standard-4.0.0 | Provide Log support
package    | 4.0.0   | x        | Started | standard-4.0.0 | Package commands and mbeans
service    | 4.0.0   | x        | Started | standard-4.0.0 | Provide Service support
system     | 4.0.0   | x        | Started | standard-4.0.0 | Provide System support
kar        | 4.0.0   | x        | Started | standard-4.0.0 | Provide KAR (KARaf archive) support
ssh        | 4.0.0   | x        | Started | standard-4.0.0 | Provide a SSHd server on Karaf
management | 4.0.0   | x        | Started | standard-4.0.0 | Provide a JMX MBeanServer and a set of MBeans in

ログイン時に、Apache Karaf コンソールは、エイリアスを作成できる etc/shell.init.script ファイルを読み取ります。これは、Unix の bashrc またはプロファイルファイルと似ています。

ld = { log:display $args } ;
lde = { log:exception-display $args } ;
la = { bundle:list -t 0 $args } ;
ls = { service:list $args } ;
cl = { config:list "(service.pid=$args)" } ;
halt = { system:shutdown -h -f $args } ;
help = { *:help $args | more } ;
man = { help $args } ;
log:list = { log:get ALL } ;

デフォルトでは利用可能なエイリアスをここで確認できます。

etc/shell.init.script ファイルで独自のエイリアスを作成できます。

ほとんどの Unix 環境と同様に、Karaf コンソールはいくつかの主要なバインディングをサポートしています。

あるコマンドの出力を別の入力としてパイプできます。これは、| 文字を使用したパイプです。

karaf@root()> feature:list |grep -i war
pax-war                       | 4.1.4                            |          | Uninstalled | org.ops4j.pax.web-4.1.4  | Provide support of a full WebContainer
pax-war-tomcat                | 4.1.4                            |          | Uninstalled | org.ops4j.pax.web-4.1.4  |
war                           | 4.0.0                            |          | Uninstalled | standard-4.0.0           | Turn Karaf as a full WebContainer
blueprint-web                 | 4.0.0                            |          | Uninstalled | standard-4.0.0           | Provides an OSGI-aware Servlet ContextListener fo

Karaf コンソールでは、Unix 環境に似たコアコマンドを使用できます。

コマンドの完全修飾名を使用する必要はありませんが、コマンド名が一意であれば、直接使用できます。つまり、shell:head の代わりに head を使用できます。

ここでも、help コマンドまたは --help オプションを使用して、これらのコマンドの詳細とすべてのオプションを確認できます。

Apache Karaf コンソールは、Unix の bash または csh と同様に完全なスクリプト言語をサポートします。

each (shell:each) コマンドは、リストで処理を繰り返すことができます。

karaf@root()> list = [1 2 3]; each ($list) { echo $it }
1
2
3

karaf@root()> a = 0 ; while { %((a+=1) <= 3) } { echo $a }
1
2
3

(前述の例のように) リストを独自に作成することも、一部のコマンドでもリストを返すこともできます。

コンソールは、$list でアクセス可能な list という名前のセッション変数を作成したことに注意してください。

$it 変数は、現在のオブジェクトに対応する暗黙的な変数です (ここではリストの現在の反復処理された値)。

[] でリストを作成すると、Apache Karaf コンソールは Java ArrayList を作成します。つまり、ArrayList オブジェクトで利用可能なメソッド (例: get または size) を使用できます。

karaf@root()> list = ["Hello" world]; echo ($list get 0) ($list get 1)
Hello world

ここで、オブジェクトのメソッドを呼び出すことは、(object method argument) を直接使用することに注意してください。($list get 0) は $list.get(0) を意味します。$list は ArrayList です。

class 表記には、オブジェクトの詳細が表示されます。

karaf@root()> $list class
...
ProtectionDomain     ProtectionDomain  null
 null
 <no principals>
 java.security.Permissions@6521c24e (
 ("java.security.AllPermission" "<all permissions>" "<all actions>")
)


Signers              null
SimpleName           ArrayList
TypeParameters       [E]

指定のタイプに変数をキャストすることができます。

karaf@root()> ("hello world" toCharArray)
[h, e, l, l, o,  , w, o, r, l, d]

失敗すると、キャストの例外が表示されます。

karaf@root()> ("hello world" toCharArray)[0]
Error executing command: [C cannot be cast to [Ljava.lang.Object;

shell:source コマンドを使用して、スクリプトを呼び出しすることができます。

karaf@root> shell:source script.txt
True!

script.txt に含まれる場所:

foo = "foo"
if { $foo equals "foo" } {
  echo "True!"
}

if{ $foo equals "foo" } ...

karaf@root> shell:source script.txt
Error executing command: Cannot coerce echo "true!"() to any of []

エイリアスについては、etc/shell.init.script ファイルで init スクリプトを作成できます。エイリアスを使用してスクリプトに名前を付けることもできます。実際にはエイリアスは単なるスクリプトです。

詳細は、開発者ガイドのスクリプトセクションを参照してください。