第 2 章 管理ツールの使用

この章では、Service Registry の管理ツールの使用方法について説明します。

この章の内容は次のとおりです。

• 「管理ツールについて」

• 「管理ツールの起動」

• 「管理ツールの機能」

• 「管理ツールコマンドの使用」

管理ツールについて

Service Registry 管理ツールは、レジストリへの関連付けの追加やレジストリからのオブジェクトの削除といった一般的な管理作業を行うための、単純なコマンド行インタフェースを提供します。

このツールは次の 2 つのモードのいずれかで動作します。

• バッチモードでは、ツールのコマンド行で 1 つまたは複数のコマンドを指定します。

• 対話型モードでは、ツールの対話型シェル内でコマンドを入力します。

ls や rm などのいくつかのコマンドでは、ファイルやフォルダの操作に用いられる有名な UNIX® コマンドの名前と動作の両方を模倣しています。その他のコマンドについては、対応する UNIX コマンドはありません。

管理ツールの起動

管理ツールを起動するには、admin-tool.jar ファイルを実行します。

java java-options -jar ServiceRegistry-base/lib/admin-tool.jar [admin-tool-options]...

通常、java コマンドはディレクトリ /usr/jdk/entsys-j2se/bin にあります。

ServiceRegistry-base の場所は、Solaris OS では /opt/SUNWsrvc-registry、Linux および HP-UX システムでは /opt/sun/srvc-registry です。

ツールの起動時に表示される警告は無視しても安全です。

管理ツールを終了するには、quit コマンドを使用します。

バッチモード

管理ツールをバッチモードで実行するには、管理ツール起動時のコマンド行で -command オプションを指定します。

たとえば、次のコマンドでは ls コマンドが実行されます。

java -jar ServiceRegistry-base/lib/admin-tool.jar -command "ls *.html"

管理ツールは、コマンドとその応答を画面上にエコーし、コマンドの実行が完了すると処理を終了します。

シェルにとって特別な意味を持つ文字は、必ず正しくエスケープするようにしてください。

対話型モード

管理ツールを対話型モードで実行するには、コマンド行で -command 以外の任意のオプションを指定するか、オプションを指定せずに、管理ツールシェルを起動します。

java -jar ServiceRegistry-base/lib/admin-tool.jar

管理ツールは、次のプロンプトを表示し、ユーザーからの入力を待ちます。

admin>

管理ツールのコマンド行オプション

管理ツールは、「形式」にリストされ、「オプション」で説明されているコマンド行オプションを認識します。

形式

オプション

-alias

キーストア内のユーザーの証明書にアクセスする際に使用するエイリアス。ユーザー登録時に使用したエイリアスを指定します。管理ツールを使ってデータをレジストリに発行する場合、このオプションは必須です。

-command

対話型シェルからコマンドを取得しないで実行する管理ツールコマンドシーケンス。複数のコマンドを区切るには、セミコロン (;) を使用します。commands に quit コマンドを含める必要はありません。コマンド区切り文字でないセミコロンを使用する必要がある場合は、セミコロンの前に円記号を付けます。

\;

管理ツールを実行しているシェルが、円記号をもう 1 つの円記号でエスケープすることを要求する可能性があります。

\\;

コマンドに空白が含まれている場合、ツールがそのコマンドシーケンスを複数のコマンド行パラメータとしてではなく 1 つのパラメータとして処理できるように、そのシーケンス全体を一重引用符または二重引用符で囲みます。実行中のシェルでセミコロンもシェルコマンドの区切り文字として解釈される場合、複数の管理ツールコマンドのシーケンスは常に引用符で囲む必要があります。

-create

-root オプションで指定されたRegistryPackage オブジェクトとそのすべての親 RegistryPackage オブジェクトを、必要に応じて作成します。このオプションが有効になるのは、管理ツールの実行ユーザーがオブジェクト作成権限を持っている場合だけです。

-debug

デバッグ時に役立つ追加情報を出力します。

-help

これらのオプションの一覧を表示します。

-keypass

キーストア内のユーザーの証明書にアクセスする際に使用するパスワード。ユーザー登録時に使用したパスワードを指定します。管理ツールを使ってデータをレジストリに発行する場合、このオプションは必須です。

-localdir

ローカルファイルシステム内のベースディレクトリ。ローカルファイルシステム内のファイルに関係するコマンドの場合に指定します。

-locale

エラーメッセージや状態メッセージ用のリソースバンドルを選択する際に使用するロケール (en、fr など)。デフォルトは、Java 仮想マシン (JVM) によって決定されます。

-registry

接続先となる ebXML レジストリの URL。デフォルトは http://localhost:6480/soar/registry/soap です。

-root

リポジトリを RegistryPackage オブジェクトのツリーとして扱うコマンドにおいてベースとして使用される RegistryPackage のロケータ (/registry/userData など)。なお、こうしたツリー内の各オブジェクトには、ほかの RegistryObject オブジェクトや RegistryPackage オブジェクトが含まれます。デフォルトは、すべてのユーザーのデータ用に定義された RegistryPackage である、/registry/userData です。

-sqlselect

レジストリオブジェクトを選択するための SQL-statement を実行します。この文は select で始まる完全な SQL 文にするようにしてください。この SQL 文は、引用符で囲む必要がありますが、末尾にセミコロンを付ける必要はありません。このオプションを指定したあとで、引数なしの select コマンドを使用した場合、SQL-statement 以外の引数を持つ select コマンドを使用するまでその SQL-statement が実行されます。

-v | -verbose

状態メッセージの冗長出力を指定します。

-help オプションの出力には、このリリースでサポートされていないオプションが 2 つ表示されます。-class と -property です。

管理ツールを使用した、コンテンツのレジストリへの発行

管理ツールコマンドには、コンテンツをレジストリに発行できるものがあります。たとえば、 cp、import などです。また、 rm コマンドでは、レジストリからコンテンツを削除できます。これらのコマンドを使用できるようにするには、追加の手順を実行してください。

コンテンツをレジストリに発行できるようにする

1. 『Service Registry 3.1 ユーザーズガイド (2006Q4)』の「ユーザーアカウントの作成」の説明に従ってユーザー登録を行います。

   指定したユーザー名とパスワードに加えて、ダウンロードした PKCS12 証明書の格納場所を覚えておきます。

2. 管理ツールを起動します。

   java -jar ServiceRegistry-base/lib/admin-tool.jar

3. keystoreMover コマンドを実行して、PKCS12 証明書を JKS キーストアにエクスポートします。詳細については、「keystoreMover」を参照してください。

   通常は、コマンド例で示される 4 つのオプションのみ指定する必要があります。

4. 管理ツールを停止します。

   quit

5. 再度、管理ツールを起動します。今回は次のようにオプションを指定します。

   java -Djaxr-ebxml.security.storetype=JKS \ -Djaxr-ebxml.security.keystore=security/filename \ -Djaxr-ebxml.security.storepass=ebxmlrr \ -jar ServiceRegistry-base/lib/admin-tool.jar -alias alias -keypass password

   ここで、filename は証明書ファイルの名前で、通常は keystore.jks です。場所 security/filename は、ディレクトリ $HOME/soar/3.0/jaxr-ebxml からの相対パスです。alias と password の値は、ユーザーアカウントを作成したときに指定した値です。

   入力内容を保存するには、このコマンドを実行するスクリプトを作成します。

管理ツールの機能

ここでは、管理ツールの次の特徴について説明します。

• 「権限」

• 「例外の表示」

• 「レジストリオブジェクトの特定」

• 「ロケールの名前指定への影響」

• 「大文字と小文字の区別」

権限

管理ツール使用時に実行可能なアクションは、ツール起動時に指定されたキーエイリアスとパスワードに対応するユーザーに許可されているアクションだけです。自らが所有しないオブジェクトを変更するコマンドを実行できるのは、管理者のロールを持つユーザーのみです。詳細については、「管理者の作成」を参照してください。

例外の表示

管理ツールを使えば、コマンド失敗時に長いスタックトレースが表示されるのを回避できます。

コマンドが失敗した場合、管理ツールは、スタックトレースの 1 行目を出力したあと、次のメッセージを表示します。

An error occurred when executing the function.  Use the show exception 
command to view messages.

より詳しい情報が必要な場合には、続けて show exception コマンドを実行して、完全なスタックトレースを確認します。

show exception コマンドは常に、直前のコマンドに対するスタックトレースを表示します。

レジストリオブジェクトの特定

レジストリオブジェクトの特定方法としてもっともよく使用されるのは、名前による特定です。ただし、通常は registry ルートから RegistryPackage までのパスによって RegistryPackage オブジェクトを特定します。たとえば、/registry/userData は、userData RegistryPackage へのパスです。

一部の名前一致では、ワイルドカードがサポートされています。1 文字に一致させるには疑問符 (?) を使用します。0 個以上の文字に一致させるにはアスタリスク (*) を使用します。

cd や chown など、一部のコマンドでは、URN (Uniform Resource Name) によるオブジェクトの特定がサポートされています。ただし、その場合、先頭の urn: まで含めて指定する必要があります。たとえば、urn:uuid:2702f889-3ced-4d49-82d1-e4cd846cb9e4 は有効な URN です。

chown コマンドおよび cp コマンドでは別の方法もサポートされています。その方法では、先行する users コマンドで表示された一覧内の特定の User を、%number を使って参照します。

一部のコマンドでは、空白を含む名前を入力できます。その場合、名前全体を二重引用符で囲むか、名前に含まれる各空白の直前に円記号を付けます。

select コマンドでは、SQL のワイルドカードがサポートされています。複数の文字に一致させるにはパーセント記号 ( %) を、1 文字に一致させるにはアンダースコア (_) を、それぞれ使用します。

ロケールの名前指定への影響

RegistryObject (または RegistryPackage) は、異なるロケールに関連付けられた複数の名前を持つことができます。

ユーザーが指定したパスやオブジェクト名は、現在のロケールだけに基づいて評価されます。複数の名前を持つレジストリオブジェクトを名前で選択しようとした場合、ユーザーが入力した名前の一致対象となるのは、そのレジストリオブジェクトの名前の 1 つの選択肢 (現在のロケールにもっとも近いロケールを持つ選択肢) のみです。そのレジストリオブジェクトの複数の名前すべてが一致対象になるわけではありません。

たとえば、現在の RegistryPackage に、異なるロケールに関連付けられた 2 つの名前を持つ 1 つのメンバーオブジェクトがあるとします。具体的には、red が en (英語) ロケールに、rouge が fr (フランス語) ロケールに、それぞれ関連付けられています。現在のロケールが en である場合、コマンド ls rouge を実行してもそのメンバーオブジェクトは表示されませんが、ロケールが fr (またはそのバリアントの 1 つ) である場合には表示されます。

大文字と小文字の区別

管理ツールが認識するコマンド名やリテラルパラメータでは、大文字、小文字の区別はありません。たとえば、ls、Ls、LS はすべて同等です。

値が指定されたオプションは、そのオプションを使用するコードにそのまま渡されます。

管理ツールコマンドの使用

以下では、利用可能なコマンドについて説明します。

• 「add association」

• 「add user」

• 「cd」

• 「chown」

• 「cp」

• 「echo」

• 「help」

• 「import」

• 「keystoreMover」

• 「lcd」

• 「ls」

• 「pwd」

• 「quit」

• 「rm」

• 「select」

• 「set」

• 「show」

• 「users」

各コマンドの形式、オプション説明、およびオペランド説明は、次の文字体裁規約に従って記述されています。

• 斜体は、コマンド実行時に実際の値に置き換える、オプション引数またはオペランドを示します。

• オプションまたはオペランドの選択肢は、大括弧 ({ }) で囲まれます。ユーザーは、この括弧内のオプションまたはオペランドのいずれか 1 つを選択する必要があります。複数のオプションまたはオペランドは、縦棒 (|) で区切られます。

• 省略可能な 1 つ以上のオプションまたはオペランドは、角括弧 ([ ]) で囲まれます。

• 1つの オプションまたはオペランドに続く省略記号 (...) は、その引数またはオペランドを繰り返し指定できることを示します。

上記以外はすべて、コマンド実行時に含める必要のあるリテラルテキストです。

add association

Association オブジェクトをレジストリに追加します。

形式

説明

add association コマンドは、指定されたタイプの Association オブジェクトをレジストリに追加します。

次のタイプのいずれかを使用できます。

• AccessControlPolicyFor

• AffiliatedWith (Subconcept として EmployeeOf と MemberOf を持つ)

• Contains

• ContentManagementServiceFor

• EquivalentTo

• Extends

• ExternallyLinks

• HasFederationMember

• HasMember

• Implements

• InstanceOf

• InvocationControlFileFor (Subconcept として CatalogingControlFileFor と ValidationControlFileFor を持つ)

• OffersService

• OwnerOf

• RelatedTo

• Replaces

• ResponsibleFor

• SubmitterOf

• Supersedes

• Uses

オプション

-type

Association オブジェクトのタイプ。

オペランド

sourceURN

ソースオブジェクトの URN。

targetURN

ターゲットオブジェクトの URN。

例

次のコマンド (すべてを 1 行で入力) は、指定された URN を持つ 2 つのオブジェクト間に RelatedTo 関係を作成します。

admin> add association -type RelatedTo 
urn:uuid:ab80d8f7-3bea-4467-ad26-d04a40045446 
urn:uuid:7a54bbca-2131-4a49-8ecc-e7b4ac86c4fd

add user

特定のユーザーをレジストリに追加します。

形式

説明

add user コマンドは、User オブジェクトを追加します。User オブジェクトには通常、PostalAddress、TelephoneNumber、EmailAddress の各オブジェクトが少なくとも 1 つずつ含まれます。

ユーザーに関する情報を指定するには、それらの情報をコマンド行から直接入力するか、あるいは -load オプションを使ってそれらの情報を含む Java プロパティーファイルを指定します。情報オプションと -load オプションは、コマンド行に指定された順番で評価されます。たとえば、いくつかのプロパティーをコマンド行から指定し、その他のプロパティーをプロパティーファイルから読み込んだあとで、そのプロパティーファイルの情報を後続のコマンド行オプションで上書きする、といったことも可能です。

新規ユーザーごとにアドレス、電話番号、および電子メールアドレスを最大 3 つずつ指定できます。それ以上必要な場合も、あとで Web コンソールや JAXR を使って追加できます。

住所、電話番号、電子メールアドレスのいずれかを指定する際には、タイプの値を指定してください。たとえば、-emailType OfficeEmail のように指定します。

コマンド行では、すべてのユーザーで必要となる基本情報のいくつかに対して短形式オプション (-fn など) が使用できるようになっています。ただし、そうした情報をプロパティーファイルで指定する場合には、長形式を使用してください。たとえば、-email1.address、-emailAddress 、-email のいずれかを使用して、ユーザーの 1 つ目の電子メールアドレスをコマンド行から指定できます。ただし、1 つ目の電子メールアドレスをプロパティーファイルで指定する場合には、email1.address= を使用してください。ユーザーの 2 つ目の電子メールアドレスに対するオプションは 1 つしか用意されていないため、コマンド行では -email2.address を、プロパティーファイル内では email2.address= を、それぞれ使用してください。

-edit オプションを指定した場合、新しいユーザーの情報を編集できるように、管理ツールによってエディタが起動されます。詳細については、オプション説明を参照してください。

このコマンドは、ホームディレクトリのファイル $HOME/soar/3.0/jaxr-ebxml/security/keystore.jks に新しいユーザーの証明書キーストアを作成します。ツールを root として実行している場合、ホームディレクトリは / または /root です。

-load の読み込み対象または -edit の編集対象となるプロパティーファイルでは、その他のすべての Java プロパティーファイルと同じく、IS0-8859-1 文字セットを使用します。ISO-8859-1 に含まれない文字をプロパティーファイル内で表現する方法の詳細については、java.util.Properties.load(InputStream) のドキュメントを参照してください。

オプション

-edit

これを指定すると、新しいユーザーの情報を編集できるように、管理ツールによってエディタが起動されます。ツールによってエディタが起動されるのは、ほかのコマンド行パラメータが評価されたあとです。したがって、コマンド行またはプロパティーファイル内に指定された情報の評価結果に基づいて編集作業が開始されます。編集プログラムが正常に終了しないと、コマンドは続行されません。管理ツールは、set editor コマンド (「set」 を参照) で指定されたエディタを起動します。これはデフォルトでは vi エディタになっています。

---

注 –

このリリースでは、-edit は、emacsclient および NetBeans^TM コマンド bin/runide.sh --open と組み合わせて使用できますが、動作は保証されておらず、vi と組み合わせた場合に正常に動作するかどうかは、明らかになっていません。

---

-load

ユーザーのプロパティーが格納された Java プロパティーファイルを指定します。そのプロパティー名は、add user コマンドの長形式オプション (lastName、post1.type など) と同一です。

-fn | -firstName

ユーザーの名を指定します。

-ln | -lastName

ユーザーの姓 (名字) を指定します。姓は必須です。コマンド行、プロパティーファイル内のいずれかで指定してください。

-mn | -middleName

ユーザーのミドルネームを指定します。

-alias

キーストア内のユーザーの証明書にアクセスする際に使用するエイリアス。 このオプションは必須です。エイリアスの文字長は 3 文字以上でなければなりません。

-keypass

キーストア内のユーザーの証明書にアクセスする際に使用するパスワード。 このオプションは必須です。パスワードの文字長は 6 文字以上でなければなりません。

-postalType | -post1.type

1 つ目の PostalAddress のタイプ。このタイプは必須です。コマンド行、プロパティーファイル内のいずれかで指定してください。値は任意の文字列 (Office、Home など) です。

-city | -post1.city

1 つ目の PostalAddress の市。

-country | -post1.country

1 つ目の PostalAddress の国。

-postalCode | -postcode | - zip | -post1.postalcode

1 つ目の PostalAddress の郵便番号。

-stateOrProvince | -state | - province | -post1.stateOrProvince

1 つ目の PostalAddress の州または都道府県。

-street | -post1.street

1 つ目の PostalAddress の町名。

-streetNumber | -number | - -post1.streetNumber

1 つ目の PostalAddress の番地。

-post2.type

2 つ目の PostalAddress のタイプ。2 つ目の PostalAddress を指定する場合、必須であるタイプを、コマンド行、プロパティーファイル内のいずれかで指定してください。値は任意の文字列 (Office、Home など) です。

-post2.city

2 つ目の PostalAddress の市。

-post2.country

2 つ目の PostalAddress の国。

-post2.postalcode

2 つ目の PostalAddress の郵便番号。

-post2.stateOrProvince

2 つ目の PostalAddress の州または都道府県。

-post2.street

2 つ目の PostalAddress の町名。

-post2.streetNumber

2 つ目の PostalAddress の番地。

-post3.type

3 つ目の PostalAddress のタイプ。3 つ目の PostalAddress を指定する場合、必須であるタイプを、コマンド行、プロパティーファイル内のいずれかで指定してください。値は任意の文字列 (Office、Home など) です。

-post3.city

3 つ目の PostalAddress の市。

-post3.country

3 つ目の PostalAddress の国。

-post3.postalcode

3 つ目の PostalAddress の郵便番号。

-post3.stateOrProvince

3 つ目の PostalAddress の州または都道府県。

-post3.street

3 つ目の PostalAddress の町名。

-post3.streetNumber

3 つ目の PostalAddress の番地。

-phoneType | -telephone1.type

1 つ目の TelephoneNumber のタイプ。このタイプは必須です。コマンド行、プロパティーファイル内のいずれかで指定してください。値は任意の文字列ですが、次の既知のタイプのいずれかを指定できます。Beeper、FAX、HomePhone、MobilePhone、または OfficePhone。

-areaCode | -telephone1.areaCode

1 つ目の TelephoneNumber の市外局番。

-countryCode | -telephone1.countryCode

1 つ目の TelephoneNumber の国番号。

-extension | -telephone1.extension

1 つ目の TelephoneNumber の内線。

-number | -telephone1.number

1 つ目の TelephoneNumber の電話番号サフィックス。国番号や市外局番は含みません。この番号は必須です。コマンド行、プロパティーファイル内のいずれかで指定する必要があります。

-URL | -telephone1.URL

1 つ目の TelephoneNumber の URL (この番号に電子的に電話をかけることのできる URL)。

-telephone2.type

2 つ目の TelephoneNumber のタイプ。2 つ目の TelephoneNumber を指定する場合、必須であるタイプを、コマンド行、プロパティーファイル内のいずれかで指定してください。値は任意の文字列ですが、次の既知のタイプのいずれかを指定できます。Beeper、FAX、HomePhone、MobilePhone、または OfficePhone。

-telephone2.areaCode

2 つ目の TelephoneNumber の市外局番。

-telephone2.countryCode

2 つ目の TelephoneNumber の国番号。

-telephone2.extension

2 つ目の TelephoneNumber の内線。

-telephone2.number

2 つ目の TelephoneNumber の電話番号サフィックス。国番号や市外局番は含みません。2 つ目の TelephoneNumber を指定する場合、必須である番号を、コマンド行、プロパティーファイル内のいずれかで指定してください。

-telephone2.URL

2 つ目の TelephoneNumber の URL (この番号に電子的に電話をかけることのできる URL)。

-telephone3.type

3 つ目の TelephoneNumber のタイプ。3 つ目の TelephoneNumber を指定する場合、必須であるタイプを、コマンド行、プロパティーファイル内のいずれかで指定してください。値は任意の文字列ですが、次の既知のタイプのいずれかを指定できます。Beeper、FAX、HomePhone、MobilePhone、または OfficePhone。

-telephone3.areaCode

3 つ目の TelephoneNumber の市外局番。

-telephone3.countryCode

3 つ目の TelephoneNumber の国番号。

-telephone3.extension

3 つ目の TelephoneNumber の内線。

-telephone3.number

3 つ目の TelephoneNumber の電話番号サフィックス。国番号や市外局番は含みません。3 つ目の TelephoneNumber を指定する場合、必須である番号を、コマンド行、プロパティーファイル内のいずれかで指定してください。

-telephone3.URL

3 つ目の TelephoneNumber の URL (この番号に電子的に電話をかけることのできる URL)。

-emailType | -email1.type

1 つ目の EmailAddress のタイプ。このタイプは必須です。コマンド行、プロパティーファイル内のいずれかで指定してください。値は任意の文字列ですが、次の既知のタイプのいずれかを指定できます。HomeEmail または OfficeEmail。

-emailAddress | -email | - email1.address

1 つ目の電子メールアドレス。1 つ目の電子メールアドレスは必須です。

-email2.type

2 つ目の EmailAddress のタイプ。2 つ目の EmailAddress を指定する場合、必須であるタイプを、コマンド行、プロパティーファイル内のいずれかで指定してください。値は任意の文字列ですが、次の既知のタイプのいずれかを指定できます。HomeEmail または OfficeEmail。

-email2.address

2 つ目の電子メールアドレス。

-email3.type

3 つ目の EmailAddress のタイプ。3 つ目の EmailAddress を指定する場合、必須であるタイプを、コマンド行、プロパティーファイル内のいずれかで指定してください。値は任意の文字列ですが、次の既知のタイプのいずれかを指定できます。HomeEmail または OfficeEmail。

-email3.address

3 つ目の電子メールアドレス。

例

次のコマンドは、ユーザーのホームディレクトリ内のファイル JaneSmith.properties から User のプロパティーを読み込みます。

admin> add user -load ~/JaneSmith.properties

次のコマンド (すべてを 1 行で入力) では、User オブジェクトの作成に最低限必要なプロパティーを指定しています。

admin> add user -ln Smith -postaltype Office -country US 
-phonetype Office -number 333-3333 -emailtype OfficeEmail 
-emailaddress JaneSmith@JaneSmith.com -alias 123 -keypass 123456

cd

RegistryPackage の場所を変更します。

形式

説明

cd コマンドは、指定されたパスまたは指定された URN を持つ RegistryPackage にディレクトリ (メタファー) を変更します。

(現在のロケールに対して) 同じパスを持つ RegistryPackage オブジェクトが複数存在する場合には、指定された URN に変更します。

オペランド

locator

レジストリのルートからリポジトリ内の特定のオブジェクトまでの、複数のレジストリオブジェクト名から成るパス。各オブジェクト名の前にはスラッシュ (/) を付けます。

たとえば、registry RegistryPackage (それ自体はいずれの RegistryPackage のメンバーでもない) のメンバーである userData RegistryPackage のロケータは /registry/userData です。userData RegistryPackage のメンバーである folder1 RegistryPackage のロケータは /registry/userData/folder1 です。

URN

RegistryPackage のURN。これは、urn: で始まる URN でなければいけません。

例

次のコマンドは、URN urn:uuid:92d3fd01-a929-4eba-a5b4-a3f036733017 を持つ RegistryPackage にディレクトリを変更します。

admin> cd urn:uuid:92d3fd01-a929-4eba-a5b4-a3f036733017

次のコマンドは、場所 /registry/userData/myData にディレクトリを変更します。

admin> cd /registry/userData/myData

chown

特定の RegistryObject の所有者を変更します。

形式

説明

chown コマンドは、先行する select コマンドで選択されたオブジェクトの所有者を、URN として指定されたユーザー、または先行する users コマンドで表示された一覧内の URN への参照として指定されたユーザーに変更します。

このコマンドを正常に実行できるのは、管理者のロールを持つユーザーだけです。

オペランド

URN

URN によって指定された User オブジェクト。

%index

先行する users コマンドで表示された一覧内に含まれる User オブジェクトの URN への番号参照。

例

次のコマンドは、選択されたオブジェクトの所有者を、URN urn:uuid:26aa17e6-d669-4775-bfe8-a3a484d3e079 で指定されるユーザーに変更します。

admin> chown urn:uuid:26aa17e6-d669-4775-bfe8-a3a484d3e079

次のコマンドは、選択されたオブジェクトの所有者を、先行する users コマンドで番号 2 に対応しているユーザーに変更します。

admin> chown %2

関連項目

• 「select」

• 「users」

cp

ファイルとフォルダをレジストリにコピーします。

形式

説明

cp コマンドは、フォルダおよびファイルをそれぞれ RegistryPackage オブジェクトおよび ExtrinsicObject オブジェクトとして、レジストリ内にコピーします。

ファイルやフォルダのコピー元となるローカルファイルシステム上のローカルディレクトリはデフォルトで、管理ツールの起動元である現在のディレクトリになります。-localdir オプションを使えば、管理ツール起動時にローカルディレクトリを変更できます。lcd コマンドを使えば、管理ツール起動後にローカルディレクトリを変更できます。show localdir コマンドを使えば、現在のローカルディレクトリの絶対パスを取得できます。

このコマンドは再帰的です。つまり、ユーザーが特定のディレクトリを指定すると、このコマンドはそのディレクトリの下にあるすべてのファイルとフォルダをコピーします。

オプション

-owner

引数の URN または %index に指定されたユーザーに、コピー先のレジストリオブジェクトの所有者を設定します。これらの引数については、chown コマンドの説明を参照してください。自分以外の所有者を指定するには、管理者のロールを持っている必要があります。

-exclude

指定されたパターンを名前に含むファイル以外のすべてのファイルをコピーします。ここで、pattern は、リテラル文字と、特殊文字のアスタリスク (*) (0 個以上の文字を表現) または疑問符 (?) (1 文字を表現) で構成されるパターンです。

このオプションは複数回指定可能です。

-include

指定されたパターンを名前に含むファイルをすべてコピーします。ここで、pattern は、リテラル文字と、特殊文字のアスタリスク (*) (0 個以上の文字を表現) または疑問符 (?) (1 文字を表現) で構成されるパターンです。

このオプションは複数回指定可能です。

オペランド

pattern

コピー対象のファイルまたはフォルダ。リテラル文字と、特殊文字のアスタリスク (*) (0 個以上の文字を表現) または疑問符 (?) (1 文字を表現) で構成されるパターンを使って指定します。pattern は複数個指定可能です。

例

次のコマンドは、ディレクトリ mydir をレジストリにコピーし、その所有者として、先行する users コマンドの番号 4 に対応するユーザーを設定します。

admin> cp -owner %4 mydir

次のコマンドは、ディレクトリ mydir をレジストリにコピーします。ただし、文字列 .z、.c のいずれかで終わるファイルやディレクトリは除外されます。

admin> cp mydir -exclude \\.z -exclude \\.c

関連項目

• 「lcd」

• 「show」

echo

特定の文字列をエコーします。

形式

説明

echo コマンドは、指定された string を出力先にエコーします。このコマンドは、管理ツールをバッチモードで実行する場合に -command オプション内で指定すると、非常に便利です。

オペランド

string

文字シーケンス。

例

次のコマンドは、「date」と ls コマンドの結果をログファイルに出力します。

java -jar admin-tool.jar -command "echo ”date”; ls" > admin.log

help

コマンドに関する情報を表示します。

形式

説明

help コマンドは、利用可能なコマンドまたは指定された特定のコマンドに関する情報を表示します。

add や show など、サブコマンドを持つコマンドが指定された場合、help コマンドはそのサブコマンドに関する情報を表示します。

引数が指定されなかった場合、help コマンドは、すべてのコマンドの使用法に関する情報を表示します。

オペランド

command_name

特定の管理ツールコマンドの名前。

例

次のコマンドは、すべてのコマンドの使用法に関する情報を表示します。

admin> help

次のコマンドは、lcd コマンドの使用法に関する情報を表示します。

admin> help lcd

次のコマンドは、add サブコマンドの使用法に関する情報を表示します。

admin> help add

import

レジストリオブジェクトを定義する XML ファイルをインポートします。

形式

説明

import コマンドは 、 ebXML Registry Services and Protocols Version 3.0 の仕様で規定される SubmitObjectsRequest プロトコルに従った XML ファイルを送信することで、1 つ以上の新しいオブジェクトまたはリポジトリ項目をレジストリに追加します。

XML ファイルおよび指定した任意の添付ファイルは、レジストリに送られてそこで処理される SOAP メッセージのコンテンツを形成します。したがって、この処理は極めて低レベルであり、ebXML の仕様を熟知しているユーザーのために用意されています。

オプション

-a | --attach

付帯オブジェクトのリポジトリ項目としてファイルを添付します。pathname は、追加されるファイルのパス名です。mimeType には、ファイルの MIME タイプを指定します。id は、リポジトリ項目が属する付帯オブジェクトの一意の識別子です。このオプションは複数回指定可能です。

オペランド

submitObjectsRequest

レジストリオブジェクトの定義を含む XML ファイル。

例

次のコマンドは、ファイル MyRequest.xml に定義されたオブジェクトのグループをインポートします。

admin> import MyRequest.xml

次のコマンド (すべてを 1 行で入力) は、付帯オブジェクトとそのリポジトリ項目であるイメージファイルをインポートします。

admin> import --attach chicken.jpg, image/jpeg, urn:bird:poultry:chicken 
ChickenRequest.xml

keystoreMover

あるキーストア形式から別のキーストア形式へ 1 つ以上のキーをエクスポートします。

形式

説明

レジストリの開発者インタフェースには JKS キーストアの使用が必要です。一方、Web コンソールには、Web ブラウザにインポート可能な PKCS12 または DER の証明書が必要です。

レジストリで生成された PKCS12 証明書を使用してユーザーアカウントを作成し、管理ツールを使用してコンテンツをレジストリに発行する場合は、keystoreMover コマンドを使用して証明書を JKS キーストアにエクスポートします。また、レジストリに対して開発者アプリケーションを実行するためにこのコマンドを使用することも可能です。

add user コマンドを使用してユーザーを作成し、そのユーザーが Web コンソールを使えるようにする場合は、このコマンドを使用して、add user によって作成された JKS キーストアを PKCS12 形式にエクスポートすることができます。

Web コンソールを使用してユーザーアカウントを作成する方法の詳細については、『Service Registry 3.1 ユーザーズガイド (2006Q4)』の「ユーザーアカウントの作成」を参照してください。管理ツールと連携して keystoreMover を使用する方法については、「管理ツールを使用した、コンテンツのレジストリへの発行」を参照してください。add user コマンドの使用方法については、「add user」を参照してください。

レジストリに関するアプリケーションの開発については、『Service Registry 3.1 開発ガイド』を参照してください。

オプション

-sourceKeystoreType

エクスポートするキーストアのタイプを指定します。引数は PKCS12 または JKS のいずれかにしてください。デフォルトは PKCS12 です。

-sourceKeystorePath

エクスポート元キーストアを含むファイルのパス名を指定します。 このオプションは必須です。通常、これはユーザーの作成時に作成された証明書ファイルのパス名です。

-sourceKeystorePassword

エクスポート元キーストアのパスワードを指定します。通常、これはユーザーの作成時に指定したパスワードです。 このオプションは必須です。

-sourceAlias

エクスポートするエイリアスを指定します。このオプションを指定しないと、キーストア内のすべてのエイリアスがエクスポートされます。Web コンソールからダウンロードされたキーストアに含まれるエイリアスは 1 つだけです。

-sourceKeyPassword

キーストアパスワードではなく、エイリアスに固有のパスワードを指定します。このオプションを指定しないと、パスワードはキーストアパスワードと同じになります (通常はこのようになる)。

-destinationKeystoreType

エクスポート先キーストアのタイプを指定します。引数は JKS または PKCS12 のいずれかにすることができます。デフォルトは JKS です。

-destinationKeystorePath

エクスポート先キーストアを含ませるファイルのパス名を指定します。 このオプションは必須です。通常、この引数は HOME/soar/3.0/jaxr-ebxml/security/keystore.jks です。ここで、 HOME はユーザーのホームディレクトリです。

-destinationKeystorePassword

エクスポート先キーストアのパスワードを指定します。この引数は必須です。このプロパティーのデフォルト値は ebxmlrr です。

-destinationAlias

エイリアス名を変更する場合、新しいエイリアス名を指定します。このオプションを指定しないと、新しいエイリアスの名前はエクスポート元の証明書のエイリアスと同じになります。

-destinationKeyPassword

キーストアパスワードではなく、エイリアスに固有のパスワードを指定します。このオプションを指定しないと、パスワードはキーストアパスワードと同じになります (通常はこのようになる)。

すべてのパスワードは 6 文字以上にしてください。

例

次のコマンドは、ユーザーのホームディレクトリに存在する generated-key.p12 の証明書を、同様にユーザーのホームディレクトリに存在する soar/3.0/jaxr-ebxml/security/keystore.jks の JKS キーストアにエクスポートします。エクスポート元キーストアのパスワードは、ユーザーがレジストリに登録されたときに指定されたパスワードです。エクスポート先キーストアのパスワードは、ebxmlrr のデフォルト値です。コマンドはすべて 1 行で入力します。

admin> keystoreMover -sourceKeystorePath /home/myname/generated-key.p12 
-sourceKeystorePassword mypass -destinationKeystorePath 
/home/myname/soar/3.0/jaxr-ebxml/security/keystore.jks 
-destinationKeystorePassword ebxmlrr

lcd

ローカルファイルシステム上の現在のディレクトリを変更します。

形式

説明

lcd コマンドは、ローカルファイルシステム上の現在のローカルディレクトリを変更します。

引数が指定されなかった場合、lcd コマンドは、現在のディレクトリをユーザーのデフォルトホームディレクトリに変更します。

オペランド

pathname

ディレクトリ名。絶対パス、相対パスのいずれを使ってもかまいません。

例

次のコマンドは、現在のローカルディレクトリを /usr/share ディレクトリに変更します。

admin> lcd /usr/share

次のコマンドは、ローカルファイルシステム上の現在のローカルディレクトリをユーザーのデフォルトホームディレクトリに変更します。

admin> lcd

ls

現在の RegistryPackage 内のオブジェクトを一覧表示します。

形式

説明

引数が指定されなかった場合、ls コマンドは、現在の RegistryPackage 内のオブジェクトを一覧表示します。pattern または URN が指定された場合、現在の RegistryPackage 内のオブジェクトのうち、(現在のロケールにおける) 名前または 一意の識別子が pattern または URN に一致するものを一覧表示します。

オペランド

pattern

リテラル文字と、特殊文字のアスタリスク (*) (0 個以上の文字を表現) または疑問符 (?) (1 文字を表現) で構成されるパターン。pattern は複数個指定可能です。

URN

urn:uuid:4a6741e7-4be1-4cfb-960a-e5520356c4fd などの、urn: で始まる URN。URN は複数個指定可能です。この URN は、オブジェクトの論理識別子ではなく、一意の識別子である必要があります。

例

次のコマンドは、現在の RegistryPackage 内のすべてのオブジェクトを一覧表示します。

admin> ls

次のコマンドは、パターン urn:bird:poultry:chicken に一致する名前を持つか urn:bird:poultry:chicken を ID に持つすべてのオブジェクトを一覧表示します。

admin> ls urn:bird:poultry:chicken

次のコマンドは、パターン *bird* に一致する名前を持つすべてのオブジェクトを一覧表示します (*bird* が有効な ID である場合、このコマンドは、*bird* を ID に持つオブジェクトも一覧表示する)。

admin> ls *bird*

次のコマンドは、パターン *bird* に一致する名前を持つか、パターン urn:bird:poultry:chicken に一致する名前を持つか、urn:bird:poultry:chicken を ID に持つような、すべてのオブジェクトを一覧表示します。

admin> ls *bird* urn:bird:poultry:chicken

pwd

現在の RegistryPackage へのパスを表示します。

形式

説明

pwd コマンドは、現在の RegistryPackage への 1 つまたは複数のパスを、現在のロケールにもっともふさわしい名前を使って表示します。また、そのパスに対するロケールも表示します。

例

admin> pwd
(en_US) /registry/userData

quit

管理ツールを終了します。

形式

説明

quit コマンドは管理ツールを終了します。

例

admin> quit

rm

特定の RegistryPackage からオブジェクトを削除します。

形式

説明

rm コマンドは、現在の RegistryPackage のメンバーオブジェクトのうち、現在のロケールにおける名前が pattern または URN で指定されたパターンに一致するものを削除します。

一致する RegistryObject が複数の RegistryPackage オブジェクトのメンバーになっている場合、このコマンドは、現在の RegistryPackage とそのオブジェクトとの間の関連付けだけを削除します。そのオブジェクトがレジストリから削除されるのは、関連付けの削除によって、包含 RegistryPackage オブジェクトを含むあらゆる RegistryObject との関連付けを持たないオブジェクトが残される場合だけです。

一致するメンバーオブジェクト自身がほかのオブジェクトを含む RegistryPackage である場合には、-r、-d のいずれかのオプションが指定されない限り、そのオブジェクトが削除されたり、現在の RegistryPackage とそのメンバー RegistryPackage との間の関連付けが削除されたりすることはありません。

-d オプションと -r オプションが両方とも指定された場合は -d オプションが再帰的に適用されますが、これは、-r の選択対象となるすべてのオブジェクト (とそれらの関連付け) が、ほかの関連付けの有無にかかわらず削除されるようにするためです。

オプション

-d

現在の RegistryPackage と指定された RegistryPackage との間の関連付けを削除します。指定された RegistryPackage が削除されるのは、残りの関連付けが自身のメンバーオブジェクトに対するものだけである場合に限ります。削除された RegistryPackage のメンバーオブジェクトのうち、ほかの HasMember 関連付けのターゲットとして固定されていないものは、レジストリのルートのメンバーとしてアクセスできるようになります。

-r

指定された RegistryPackage オブジェクトとその配下にあるすべてのオブジェクトを削除します (ただし、ほかの関連付けを持つオブジェクトが存在する場合を除く)。

オペランド

pattern

リテラル文字と、特殊文字のアスタリスク (*) (0 個以上の文字を表現) または疑問符 (?) (1 文字を表現) で構成されるパターン。pattern は複数個指定可能です。

URN

urn:uuid:4a6741e7-4be1-4cfb-960a-e5520356c4fd などの、urn: で始まる URN。URN は複数個指定可能です。

例

次のコマンドは、文字列 "stat" を含むすべての RegistryPackage オブジェクトと、それらの配下にあるすべてのオブジェクトを削除します。

admin> rm -r *stat*

select

SQL の select 文を実行します。

形式

説明

select コマンドは、コマンド全体を 1 つの SQL クエリーとして評価することで、指定されたオブジェクトを選択および一覧表示します。引数が指定されなかった場合、このコマンドは、先行する select コマンドまたは -sqlselect オプションによって選択されたすべてのオブジェクトを一覧表示します。

オペランド

SQL

SQL の select 文 (ただし、先頭の select はすでにコマンド名として存在しているので含めない)。

例

次のコマンドは、レジストリ内のすべての ClassificationScheme オブジェクトを一覧表示します。

admin> select s.* from ClassificationScheme s

set

特定のプロパティーの値を設定します。

形式

説明

set コマンドは、管理ツールシェルの特定のプロパティーの値を設定します。

ツールがサポートするプロパティーと値は、次のとおりです。

デバッグメッセージの出力を有効または無効にします。

対話型エディタ起動時に管理ツールが使用するコマンドを設定します。UNIX および Linux システムでのデフォルト値は /bin/vi です。

コマンド実行時における冗長メッセージの出力を有効または無効にします。

オペランド

property

次のプロパティーのいずれかです。debug, editor, verbose.

value

指定されたプロパティーのサポートされている値。詳細については、「説明」を参照してください。

例

次のコマンドは、エディタをデフォルトの /bin/vi ではなく、/usr/bin/vi に設定します。

admin> set editor /usr/bin/vi

次のコマンドは、デバッグをオンにします。

admin> set debug true

次のコマンドは、冗長な出力をオフにします。

admin> set verbose off

show

特定のプロパティーの値を表示します。

形式

説明

show コマンドは、管理ツールシェルの特定のプロパティーの値を表示します。

引数が指定されなかった場合、このコマンドはすべてのプロパティーの値を表示します。

このコマンドがサポートするプロパティーは、次のとおりです。

debug

デバッグ出力が有効になっているかどうか。

editor

対話型エディタ起動時に管理ツールが使用するエディタ。

exception

直前に実行されたコマンドで発生した例外スタックトレース (存在する場合のみ)。

localdir

ローカルファイルシステム上の現在のディレクトリ。このプロパティーを設定するには lcd コマンドを使用します。詳細については、「lcd」を参照してください。

locale

現在のロケール。

verbose

冗長出力が有効になっているかどうか。

オペランド

property

現在の値を表示すべきプロパティー。プロパティー exception と locale については、表示は可能ですが、set コマンドによる値の設定は行えません。

例

次のコマンドは、直前のコマンドで発生した例外を表示します。

admin> show exception

users

現在の User オブジェクトを一覧表示します。

形式

説明

users コマンドは、現在レジストリ内に存在している User オブジェクトを一覧表示します。

出力の書式は次のとおりです。

%index: URN lastname, firstname middlename

出力内の index は数値ですが、chown コマンドまたは cp コマンドを実行する際にこの数値をパーセント記号 (%) も含めて使用すれば、特定のユーザーを参照することができます。lastname、firstname、および middlename は、ユーザーの姓、名、およびミドルネームです。

例

次のコマンドは、現在のユーザーを表示します。

admin> users
%0:  urn:freebxml:registry:predefinedusers:registryoperator  Operator, Registry 
%1:  urn:freebxml:registry:predefinedusers:registryguest  Guest, Registry 
%2:  urn:freebxml:registry:predefinedusers:farrukh  Najmi, Farrukh Salahudin
%3:  urn:freebxml:registry:predefinedusers:nikola  Stojanovic, Nikola 
%4:  urn:uuid:799cc524-b7cd-4e51-8b34-d93b79ac52de  User, Test 
%5:  urn:uuid:85428d8e-1bd5-473b-a8c8-b9d595f82728  Parker, Miles

関連項目

• 「chown」

• 「cp」