Service Registry 3.1 管理指南

第 2 章 使用 Administration Tool

本章說明如何使用 Service Registry 的 Administration Tool (「Admin Tool」)。

本章包含下列小節:

關於 Admin Tool

Service Registry Administration Tool 提供簡單的指令行介面,用於一般的管理工作,例如將關聯增加至登錄 (Registry) 和從登錄 (Registry) 移除物件。

此工具可以在以下兩種模式中作業︰

有幾個指令 (像是 lsrm) 可模擬 UNIX® 中處理檔案和資料夾之常見指令的名稱和運作方式。其他指令沒有相應的 UNIX 指令。

啟動 Admin Tool

若要啟動 Admin Tool,請執行 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 作業系統上的 /opt/SUNWsrvc-registry,若是 Linux 和 HP-UX 系統,則位於 /opt/sun/srvc-registry

您可放心略過啟動工具時出現的警告訊息。

若要結束 Admin Tool,請使用 quit 指令。

批次模式

若要在批次模式中執行 Admin Tool,請在啟動 Admin Tool 時在指令行中指定 -command 選項。

例如,下列指令會執行 ls 指令:


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

Admin Tool 會將您的指令以及工具的回應,回應 (echo) 至螢幕上,然後在指令執行之後結束。

請確定正確退出對 shell 很重要的所有字元。

互動式模式

若要在互動式模式中執行 Admin Tool,請透過在指令行中指定除 -command 之外的任何選項 (或不指定選項),來啟動 Admin Tool shell:


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

Admin Tool 會顯示以下提示並等待您的輸入︰


admin>

Admin Tool 指令行選項

Admin Tool 可辨識之指令行選項的清單和說明,請分別參閱提要選項

提要

[-alias alias] [-command commands] [-debug] [-help] [-keypass keypass] [-localdir localdir] [-locale locale] [-registry url] [-root locator [-create]] [-sqlselect SQL-statement] [-verbose]

選項

-alias

存取金鑰庫中的使用者憑證時要使用的別名。指定您註冊為使用者時所使用的別名。如果您要使用 Admin Tool 發佈資料到登錄 (Registry),則需要此選項。

-command

要執行 (而非從互動式 shell 取得指令) 的 Admin Tool 指令序列。使用分號 (;) 分隔多條指令。您不需要在 commands 中包含 quit 指令。如果您需要使用分號 (不是指令分隔符),請在分號前加反斜線︰


\;

執行 Admin Tool 的 shell 可能需要您使用另一個反斜線來退出此反斜線︰


\\;

如果任何指令中含有空格,請以單引號或雙引號括住整個指令序列,工具便可將序列視為一個 (而非數個) 指令行參數。此外,如果 shell 也會將分號解譯為分隔 shell 指令,則您務必始終以引號括住多條 Admin Tool 指令的序列。

-create

如有必要,依需要建立 -root 選項指定的 Registry 套裝軟體 (RegistryPackage) 以及父系 Registry 套裝軟體 (RegistryPackage) 物件。僅當執行 Admin Tool 的使用者被授權建立物件時此選項才有效。

-debug

輸出有助於除錯的附加資訊。

-help

提供這些選項的清單。

-keypass

存取金鑰庫中的使用者憑證時要使用的密碼。指定您註冊為使用者時所使用的密碼。如果您要使用 Admin Tool 發佈資料到 Registry,則需要此選項。

-localdir

與本機檔案系統中的檔案相關的指令在本機檔案系統中的基底目錄。

-locale

要用於選取資源束以用於錯誤和狀態訊息的語言環境 (例如,enfr)。預設的語言環境由 Java 虛擬機器 (JVM) 決定。

-registry

要連線至的 ebXML Registry 的 URL。預設為 http://localhost:6480/soar/registry/soap

-root

Registry 套裝軟體 (RegistryPackage) 的定位器 (例如 /registry/userData),該定位器將用作將儲存庫視為 Registry 套裝軟體 (RegistryPackage) 物件 (每個均含有其他 RegistryObjectRegistry 套裝軟體 (RegistryPackage) 物件) 之樹狀結構的指令的基底。預設為針對所有使用者資料定義的 Registry 套裝軟體 (RegistryPackage)/registry/userData

-sqlselect

執行 SQL-statement 以選取登錄 (Registry) 物件。敘述必須是以 select 起始的完整 SQL 敘述。SQL 敘述必須以引號括住,但不必以分號終止。如果您指定此選項,然後使用不帶引數的 select 指令,則該指令將執行 SQL-statement,直到您使用帶有 SQL-statement 以外其他引數的 select 指令為止。

-v | -verbose

指定狀態訊息的詳細輸出。


備註 –

-help 選項的輸出列出此發行版本不支援的兩個選項︰-class-property


使用 Admin Tool 將內容發佈到登錄 (Registry)

某些 Admin Tool 指令可用來將內容發佈到登錄 (Registry):例如,cpimport。此外,rm 指令可用來刪除登錄 (Registry) 中的內容。使用這些指令之前,您必須執行某些額外的步驟。

Procedure讓您自己可以將內容發佈到登錄 (Registry)

  1. 依照「Service Registry 3.1 使用者指南」中的「建立使用者帳號」一節的說明,執行使用者註冊。

    請記住您下載 PKCS12 憑證的位置,以及您指定的使用者名稱和密碼。

  2. 啟動 Admin Tool:


    java -jar ServiceRegistry-base/lib/admin-tool.jar
    
  3. 執行 keystoreMover 指令,將 PKCS12 憑證匯出至 JKS 金鑰庫。如需詳細資訊,請參閱keystoreMover

    一般而言,您只需要指定指令範例中所顯示的四個選項。

  4. 停止 Admin Tool:


    quit
    
  5. 再次啟動 Admin Tool。此時指定選項,如下所示:


    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 相關。aliaspassword 值是您在建立使用者帳號時指定的值。

    若要節省鍵入的時間,可建立程序檔執行此指令。

Admin Tool 功能

本小節說明 Admin Tool 的以下功能︰

許可權

使用 Admin Tool 時,您僅能執行在啟動此工具時為其指定金鑰別名和密碼的使用者可以執行的動作。只有身為管理員角色的使用者,才能執行指令以變更非使用者所擁有的物件。如需詳細資訊,請參閱建立管理員

顯示異常

Admin Tool 可讓您避免在指令失敗時檢視很長的堆疊追蹤。

指令失敗時,Admin Tool 會輸出堆疊追蹤的第一行和以下訊息︰


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

如果您需要更多資訊,請接著執行 show exception 指令,以查看完整堆疊追蹤。

show exception 指令會自動顯示前一緊接指令的堆疊追蹤。

識別登錄 (Registry) 物件

識別登錄 (Registry) 物件的主要方法是依名稱。然而,您通常可按照從 registry 根至 RegistryPackage 的路徑來識別 Registry 套裝軟體 (RegistryPackage) 物件。例如,/registry/userDatauserData Registry 套裝軟體 (RegistryPackage) 的路徑。

某些名稱的比對支援萬用字元。使用問號 (?) 可比對單一字元。使用星號 (*) 可比對零個或多個字元。

某些指令 (例如,cdchown) 支援依物件的單一資源名稱 (URN) (必須包含前導字元 urn:) 來識別物件。例如,urn:uuid:2702f889-3ced-4d49-82d1-e4cd846cb9e4 是有效的 URN。

chowncp 指令還支援使用 %number 來參考前一 users 指令列出的使用者 (User)

對於某些指令,如果要輸入含有空格的名稱,請以雙引號括住整個名稱,或在名稱中的每個空格前加上反斜線。

select 指令支援使用 SQL 萬用字元︰百分比符號 (%) 用於比對多個字元,而底線 (_) 則用於比對單一字元。

語言環境對指定名稱的影響

RegistryObject (或 Registry 套裝軟體 (RegistryPackage)) 可具有多個名稱,每個名稱關聯一個不同的語言環境。

您指定的路徑和物件名稱僅根據目前的語言環境計算。嘗試依名稱選取具有多個名稱的登錄 (Registry) 物件時,Registry 會嘗試將您提供的名稱僅與一個登錄 (Registry) 物件名稱 (其語言環境與目前的語言環境最相符) 選項相比對,而非與登錄 (Registry) 物件的所有名稱相比對。

例如,假定目前 Registry 套裝軟體 (RegistryPackage) 的成員物件具有兩個名稱,每個名稱關聯一個不同的語言環境︰在 en (英文) 語言環境中為 red,在 fr (法文) 語言環境中為 rouge。目前的語言環境是 en 時,指令 ls rouge 不會顯示該成員物件,但當語言環境是 fr (或其一個變體) 時,則會顯示該成員物件。

大小寫相符性

Admin Tool 辨識的指令名稱和文字參數無須大小寫相符。例如,lsLsLS 均指同一個指令。

您為其提供值的選項會被逐字地傳送至使用該選項的代碼。

使用 Admin Tool 指令

以下小節說明可用的指令。

對於每個指令,選項和運算元的提要和說明遵守以下印刷排版慣例︰

其他內容是執行指令時必須包含的文字。

add association

關聯 (Association) 物件增加至登錄 (Registry)。

提要

add association -type association-type sourceURN targetURN

說明

add association 指令會將指定類型的關聯 (Association) 物件增加至登錄 (Registry)。

您可以使用以下任何類型︰

選項

-type

關聯 (Association) 物件的類型。

運算元

sourceURN

來源物件的 URN。

targetURN

目標物件的 URN。

範例

以下指令 (全部位於同一行) 會在具有指定的兩個 URN 的物件之間建立 RelatedTo 關係。


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

add user

將使用者增加至登錄 (Registry)。

提要

add user [-edit] [- load pathname] [-firstname string] [-lastname string] [-middleName string] -alias string -keypass string [-post1. -type string] [-post1.city string] [-post1.country string] [-post1.postalcode string] [-post1.stateOrProvince string] [-post1.street string] [-post2.streetNumber string] [-post2. -type string] [-post2.city string] [-post2.country string] [-post2.postalcode string] [-post2.stateOrProvince string] [-post2.street string] [-post2.streetNumber string] [-post3. -type string] [-post3.city string] [-post3.country string] [-post3.postalcode string] [-post3.stateOrProvince string] [-post3.street string] [-post3.streetNumber string] [-telephone1. -type string] [-telephone1.areaCode string] [-telephone1.countryCode string] [-telephone1. -extension string] [-telephone1.number string] [-telephone1. -URL string] [-telephone2. -type string] [-telephone2.areaCode string] [-telephone2.countryCode string] [-telephone2. -extension string] [-telephone2.number string] [-telephone2. -URL string] [-telephone3. -type string] [-telephone3.areaCode string] [-telephone3.countryCode string] [-telephone3. -extension string] [-telephone3.number string] [-telephone3. -URL string] [-email1. -type string] [- email1.address string] [-email2. -type string] [-email12address string] [-email3. -type string] [-email3.address string]

說明

add user 指令會增加使用者 (User) 物件。使用者 (User) 物件一般含有至少一個郵遞地址 (PostalAddress)電話號碼 (TelephoneNumber)電子郵件地址 (EmailAddress) 物件。

在指令行本身中或透過使用 -load 選項指定有關使用者的資訊,以指定具有該資訊的 Java 特性檔案。資訊選項和 -load 選項依其在指令行中顯示的順序計算。例如,您可以在指令行中指定某些特性,從特性檔案載入其他特性,然後使用後續的指令行選項置換特性檔案中的資訊。

您可以為新的使用者最多指定三個地址、電話號碼和電子郵件地址。如果您需要更多,可以在稍後使用 Web Console 或 JAXR 予以增加。

指定地址、電話號碼或電子郵件時,您必須提供其類型的值︰例如,-emailType OfficeEmail

對於每個使用者都需要的共用資訊,您可以在指令行使用快捷選項 (例如,-fn)。然而,在特性檔案中提供資訊時,您必須使用較長的格式。例如,您可以使用 -email1.address-emailAddress-email,在指令行指定使用者的第一個電子郵件地址。不過,當您在特性檔案中指定第一個電子郵件地址時,則須使用 email1.address=。由於使用者的第二個電子郵件地址僅有一個選項,所以您必須在指令行中使用 -email2.address,在特性檔案中使用 email2.address=

如果您指定 -edit 選項,則 Admin Tool 會啟動編輯器,以便您可以編輯新使用者的資訊。請參閱選項說明,以取得詳細資訊。

指令會在主目錄中的 $HOME/soar/3.0/jaxr-ebxml/security/keystore.jks 檔案內,建立新使用者的憑證金鑰庫。如果您正以 root 的身份執行工具,主目錄會是 //root


備註 –

您使用 -load 載入或使用 -edit 編輯的特性檔案使用 IS0-8859-1 字元集,所有 Java 特性檔案均如此。請參閱 java.util.Properties.load(InputStream) 的文件,以取得有關如何在特性檔案中表示 ISO-8859-1 以外其他字元的詳細資訊。


選項

-edit

使 Admin Tool 啟動編輯器,以便您可以編輯新使用者的資訊。在計算其他指令行參數之後,工具會啟動編輯器。因此,計算指令行或特性檔案中指定的資訊有了結果時,就要開始進行編輯。編輯程式必須無錯誤終止,指令才能繼續。Admin Tool 啟動 set editor 指令 (請參閱 set) 指定的編輯器;依預設為 vi 編輯器。


備註 –

在此發行版本中,-edit 可以與 emacsclient 和 NetBeansTM 指令 bin/runide.sh --open 搭配使用 (但效果不佳),但不能與 vi 搭配使用。


-load

指定其內容可指定使用者特性的 Java 特性檔案。特性名稱與 add user 指令選項 (例如,lastNamepost1.type) 的長格式特性名稱相同。

-fn | -firstName

指定使用者的名字。

-ln | -lastName

指定使用者的姓氏。您必須在指令行或特性檔案中指定姓氏 (必要項目)。

-mn | -middleName

指定使用者的中間名。

-alias

存取金鑰庫中的使用者憑證時要使用的別名。此選項是必要項目。別名必須至少具有三個字元。

-keypass

存取金鑰庫中的使用者憑證時要使用的密碼。此選項是必要項目。密碼必須至少具有六個字元。

-postalType | -post1.type

第一個 PostalAddress 的類型。您必須在指令行或特性檔案中指定類型 (必要項目)。該值是任意字串 (例如,OfficeHome)。

-city | -post1.city

第一個 PostalAddress 的城市。

-country | -post1.country

第一個 PostalAddress 的國家/地區。

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

第一個 PostalAddress 的郵遞區號。

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

第一個 PostalAddress 的州或省。

-street | -post1.street

第一個 PostalAddress 的街道名稱。

-streetNumber | -number | - -post1.streetNumber

第一個 PostalAddress 的街道號碼。

-post2.type

第二個 PostalAddress 的類型。如果指定第二個 PostalAddress,則必須在指令行或特性檔案中指定類型 (必要項目)。該值是任意字串 (例如,OfficeHome)。

-post2.city

第二個 PostalAddress 的城市。

-post2.country

第二個 PostalAddress 的國家/地區。

-post2.postalcode

第二個 PostalAddress 的郵遞區號。

-post2.stateOrProvince

第二個 PostalAddress 的州或省。

-post2.street

第二個 PostalAddress 的街道名稱。

-post2.streetNumber

第二個 PostalAddress 的街道號碼。

-post3.type

第三個 PostalAddress 的類型。如果指定第三個 PostalAddress,則必須在指令行或特性檔案中指定類型 (必要項目)。該值是任意字串 (例如,OfficeHome)。

-post3.city

第三個 PostalAddress 的城市。

-post3.country

第三個 PostalAddress 的國家/地區。

-post3.postalcode

第三個 PostalAddress 的郵遞區號。

-post3.stateOrProvince

第三個 PostalAddress 的州或省。

-post3.street

第三個 PostalAddress 的街道名稱。

-post3.streetNumber

第三個 PostalAddress 的街道號碼。

-phoneType | -telephone1.type

第一個 TelephoneNumber 的類型。您必須在指令行或特性檔案中指定類型 (必要項目)。該值是任意字串,但您可以指定以下一種已知類型︰BeeperFAXHomePhoneMobilePhoneOfficePhone

-areaCode | -telephone1.areaCode

第一個 TelephoneNumber 的區域代碼。

-countryCode | -telephone1.countryCode

第一個 TelephoneNumber 的國家/地區代碼。

-extension | -telephone1.extension

第一個 TelephoneNumber 的分機號碼。

-number | -telephone1.number

第一個 TelephoneNumber 的電話號碼尾碼 (不包含國碼或區碼)。您必須在指令行或特性檔案中指定號碼 (必要項目)。

-URL | -telephone1.URL

第一個 TelephoneNumber 的 URL (可透過電子方式撥打此號碼的 URL)。

-telephone2.type

第二個 TelephoneNumber 的類型。如果指定第二個 TelephoneNumber,則必須在指令行或特性檔案中指定類型 (必要項目)。該值是任意字串,但您可以指定以下一種已知類型︰BeeperFAXHomePhoneMobilePhoneOfficePhone

-telephone2.areaCode

第二個 TelephoneNumber 的區域代碼。

-telephone2.countryCode

第二個 TelephoneNumber 的國碼。

-telephone2.extension

第二個 TelephoneNumber 的分機號碼。

-telephone2.number

第二個 TelephoneNumber 的電話號碼尾碼 (不包含國碼或區碼)。如果指定第二個 TelephoneNumber,則必須在指令行或特性檔案中指定號碼 (必要項目)。

-telephone2.URL

第二個 TelephoneNumber 的 URL (可透過電子方式撥打此號碼的 URL)。

-telephone3.type

第三個 TelephoneNumber 的類型。如果指定第三個 TelephoneNumber,則必須在指令行或特性檔案中指定類型 (必要項目)。該值是任意字串,但您可以指定以下一種已知類型︰BeeperFAXHomePhoneMobilePhoneOfficePhone

-telephone3.areaCode

第三個 TelephoneNumber 的區域代碼。

-telephone3.countryCode

第三個 TelephoneNumber 的國家/地區代碼。

-telephone3.extension

第三個 TelephoneNumber 的分機號碼。

-telephone3.number

第三個 TelephoneNumber 的電話號碼尾碼 (不包含國碼或區碼)。如果指定第三個 TelephoneNumber,則必須在指令行或特性檔案中指定號碼 (必要項目)。

-telephone3.URL

第三個 TelephoneNumber 的 URL (可透過電子方式撥打此號碼的 URL)。

-emailType | -email1.type

第一個 EmailAddress 的類型。您必須在指令行或特性檔案中指定類型 (必要項目)。該值是任意字串,但您可以指定以下一種已知類型︰HomeEmailOfficeEmail

-emailAddress | -email | - email1.address

第一個電子郵件地址。第一個電子郵件地址是必需的。

-email2.type

第二個 EmailAddress 的類型。如果指定第二個 EmailAddress,則必須在指令行或特性檔案中指定類型 (必要項目)。該值是任意字串,但您可以指定以下一種已知類型︰HomeEmailOfficeEmail

-email2.address

第二個電子郵件地址。

-email3.type

第三個 EmailAddress 的類型。如果指定第三個 EmailAddress,則必須在指令行或特性檔案中指定類型 (必要項目)。該值是任意字串,但您可以指定以下一種已知類型︰HomeEmailOfficeEmail

-email3.address

第三個電子郵件地址。

範例

以下指令會從使用者主目錄中的檔案 JaneSmith.properties 載入使用者 (User) 特性。


admin> add user -load ~/JaneSmith.properties

以下指令 (全部位於同一行) 會指定建立使用者 (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

變更 Registry 套裝軟體 (RegistryPackage) 位置。

提要

cd {locator | URN}

說明

cd 指令會將目錄變更 (隱喻地) 至指定路徑下的或具有指定 URN 的 Registry 套裝軟體 (RegistryPackage)

當多個 Registry 套裝軟體 (RegistryPackage) 物件具有相同路徑 (對於目前的語言環境) 時,指令會變更至指定的 URN。

運算元

locator

登錄 (Registry) 物件名稱的路徑,從儲存庫根到儲存庫中的物件,每個名稱前均加有正斜線 (/)。

例如,registry Registry 套裝軟體 (RegistryPackage) (本身不是任何 Registry 套裝軟體 (RegistryPackage) 的成員) 所屬成員 userData Registry 套裝軟體 (RegistryPackage) 的定位器是 /registry/userDatauserData Registry 套裝軟體 (RegistryPackage) 所屬成員 folder1 Registry 套裝軟體 (RegistryPackage) 的定位器是 /registry/userData/folder1

URN

RegistryPackage 的 URN,必須是以 urn: 起始的 URN。

範例

以下指令會將目錄變更至 URN 為 urn:uuid:92d3fd01-a929-4eba-a5b4-a3f036733017Registry 套裝軟體 (RegistryPackage)


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

以下指令會將目錄變更至位置 /registry/userData/myData


admin> cd /registry/userData/myData

chown

變更 RegistryObject 的所有者。

提要

chown {URN | %index}

說明

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

另請參閱

cp

將檔案和資料夾複製到登錄 (Registry)。

提要

cp [-owner {URN | % index}] [- exclude pattern]… [-include pattern]… pattern

說明

cp 指令會將資料夾和檔案分別複製到登錄 (Registry) 做為Registry 套裝軟體 (RegistryPackage)外部物件 (ExtrinsicObject) 物件。

從其上複製檔案和資料夾的本機檔案系統上的本機目錄預設為啟動 Admin Tool 的目前目錄。啟動 Admin Tool 時,您可以使用 -localdir 選項變更本機目錄。啟動 Admin Tool 之後,您可以使用 lcd 指令變更本機目錄。您可以使用 show localdir 指令,取得目前本機目錄的絕對路徑。

此指令是遞迴的。也就是說,如果您指定目錄,此指令會複製該目錄下的所有檔案和資料夾。

選項

-owner

將複製的登錄 (Registry) 物件所有者設定為 URN%index 引數指定的使用者。請參閱 chown 指令的說明,以取得這些引數的說明。您必須具有管理員的角色,才能指定除自己之外的所有者。

-exclude

複製除名稱中含有指定式樣的檔案之外的所有檔案,其中 pattern 是一種式樣,包含文字字元和特殊字元星號 (*) (表示零個或多個字元) 及問號 (?) (表示有且僅有一個字元)。

您可以多次指定此選項。

-include

複製除名稱中含有指定式樣的檔案之外的所有檔案,其中 pattern 是一種式樣,包含文字字元和特殊字元星號 (*) (表示零個或多個字元) 及問號 (?) (表示有且僅有一個字元)。

您可以多次指定此選項。

運算元

pattern

要複製的檔案或資料夾,由包含文字字元和特殊字元星號 (*) (表示零個或多個字元) 及問號 (?) (表示有且僅有一個字元) 的式樣指定。您可以指定多個 pattern

範例

以下指令會將目錄 mydir 複製到登錄 (Registry),由前一 users 指令中編號為 4 的使用者所有。


admin> cp -owner %4 mydir

以下指令會將目錄 mydir 複製到登錄 (Registry),排除以字串 .z.c 結束的檔案和目錄。


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

另請參閱

echo

回應字串。

提要

echo string

說明

echo 指令會將指定的 string 回應至輸出。在批次模式中執行 Admin Tool 時,於 -command 選項中指定此指令會非常有用。

運算元

string

字元序列。

範例

以下指令會將 ls 指令的日期和結果輸出至記錄檔。


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

help

顯示有關指令的資訊。

提要

help [command_name]

說明

help 指令會顯示有關可用指令或指定指令的資訊。

對於含有子指令的指令 (例如 addshow),help 指令會顯示有關子指令的資訊。

如果您未指定引數,則 help 指令會顯示所有指令的用法資訊。

運算元

command_name

Admin Tool 指令的名稱。

範例

以下指令會顯示所有指令的用法資訊。


admin> help

以下指令會顯示 lcd 指令的用法資訊。


admin> help lcd

以下指令會顯示 add 子指令的用法資訊。


admin> help add

import

匯入定義登錄 (Registry) 物件的 XML 檔案。

提要

import [ {-a | --attach}pathname, mimeType, id]… submitObjectsRequest

說明

import 指令會提交符合 ebXML Registry Services and Protocols Version 3.0 規格中所述 SubmitObjectsRequest 協定的 XML 檔案,將一或多個新物件或儲存庫項目增加至登錄 (Registry)。

XML 檔案以及 SOAP 訊息內容提供的所有附件會傳送到登錄 (Registry) 進行處理。因此此操作相當低階,適合非常熟悉 ebXML 規格的使用者使用。

'選項

-a | --attach

附加檔案做為外部物件的儲存庫項目。pathname 是所要增加檔案的路徑名稱。mimeType 指定檔案的 MIME 類型。id 是外部物件的唯一識別碼,而此物件是儲存庫項目 (??)。您可以多次指定此選項。

運算元

submitObjectsRequest

包含登錄 (Registry) 物件定義的 XML 檔案。

範例

下列指令會匯入 MyRequest.xml 檔案中定義的物件群組:


admin> import MyRequest.xml

下列指令 (全部位於同一行) 會匯入外部物件和其儲存庫項目 (影像檔):


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

keystoreMover

將一或多個金鑰從一個金鑰庫格式匯出成另一種格式。

提要

keystoreMover [-sourceKeystoreType {JKS | PKCS12}] -sourceKeystorePath pathname -sourceKeystorePassword password [-sourceAlias alias [-sourceKeyPassword password]] [-destinationKeystoreType {JKS | PKCS12}] -destinationKeystorePath pathname -destinationKeystorePassword password [-destinationAlias newAlias] [-destinationKeyPassword password]

說明

Registry 的開發者介面需要使用 JKS 金鑰庫,而 Web Console 需要您可匯入至 Web 瀏覽器的 PKCS12 或 DER 憑證。

如果您使用登錄 (Registry) 產生的 PKCS12 憑證建立使用者帳號,並且希望使用 Admin Tool 將內容發佈至登錄 (Registry),便可使用 keystoreMover 指令將憑證匯出至 JKS 金鑰庫。您也可以使用此指令,針對 Registry 執行開發者應用程式。

如果您曾經使用 add user 指令建立使用者,並且希望該使用者能夠使用 Web Console,您可以使用此指令將 add user 建立的 JKS 金鑰庫匯出為 PKCS12 格式。

如需有關使用 Web Console 建立使用者帳號的詳細資訊,請參閱「Service Registry 3.1 使用者指南」中的「建立使用者帳號」一節。如需有關搭配 Admin Tool 使用 keystoreMover 的資訊,請參閱使用 Admin Tool 將內容發佈到登錄 (Registry)。如需有關使用 add user 指令的資訊,請參閱 add user

如需有關開發 Registry 應用程式的資訊,請參閱 「Service Registry 3.1 Developer’s Guide」

選項

-sourceKeystoreType

指定要匯出的金鑰庫類型。引數必須是 PKCS12JKS。預設值為 PKCS12

-sourceKeystorePath

指定包含來源金鑰庫的檔案路徑名稱。此選項是必要項目。通常,這是您建立使用者時所建立的憑證檔案路徑名稱。

-sourceKeystorePassword

指定來源金鑰庫的密碼。通常,這是您建立使用者時指定的密碼。此選項是必要項目。

-sourceAlias

指定要匯出的別名。如果您不指定此選項,該指令會匯出金鑰庫中所有的別名。從 Web Console 下載的金鑰庫只包含一個別名。

-sourceKeyPassword

指定別名特有的密碼 (相對於金鑰庫密碼)。如果您不指定此選項,該密碼就會與金鑰庫的密碼相同 (這是一般狀況)。

-destinationKeystoreType

指定目標金鑰庫的類型。引數可以是 PKCS12JKS。預設值為 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 金鑰庫。來源金鑰庫密碼是使用者向 Registry 註冊時所提供的密碼。目標金鑰庫密碼是 ebxmlrr 的預設值。在同一行指定全部指令。


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 [pathname]

說明

lcd 指令會變更本機檔案系統上的目前本機目錄。

如果您未指定引數,則 lcd 指令會將目前目錄變更至預設主目錄。

運算元

pathname

目錄名稱可以是絕對的,也可以是相對的。

範例

以下指令會將目前本機目錄變更至 /usr/share 目錄。


admin> lcd /usr/share

以下指令會將目前本機目錄變更至本機檔案系統上的預設主目錄。


admin> lcd

ls

列出目前 Registry 套裝軟體 (RegistryPackage) 中的物件。

提要

ls [ {pattern | URN}…]

說明

ls 指令 (此指令沒有引數) 會列出目前 Registry 套裝軟體 (RegistryPackage) 中的物件。若是提供 pattern URN,該指令會列出其名稱 (在目前的語言環境中) 或唯一識別碼符合 patternURN 之目前 Registry 套裝軟體 (RegistryPackage) 中的物件。

運算元

pattern

包含文字字元和特殊字元星號 (*) (表示零個或多個字元) 及問號 (?) (表示有且僅有一個字元) 的式樣。您可以指定多個 pattern

URN

urn: 起始的 URN,例如 urn:uuid:4a6741e7-4be1-4cfb-960a-e5520356c4fd。您可以指定多個 URN。URN 必須是物件的唯一識別碼,而非邏輯識別碼。

範例

以下指令會列出目前 Registry 套裝軟體 (RegistryPackage) 中的所有物件。


admin> ls

以下指令會列出名稱與式樣 urn:bird:poultry:chicken 相符或 ID 為 urn:bird:poultry:chicken 的所有物件。


admin> ls urn:bird:poultry:chicken

以下指令會列出名稱與式樣 *bird* 相符的所有物件。(如果 *bird* 是有效 ID,則還會列出 ID 為 *bird* 的物件。)


admin> ls *bird*

以下指令會列出名稱與式樣 *bird*urn:bird:poultry:chicken 相符,或 ID 為 urn:bird:poultry:chicken 的所有物件。


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

pwd

顯示目前 Registry 套裝軟體 (RegistryPackage) 的路徑。

提要

pwd

說明

pwd 指令會使用目前語言環境的最相符名稱顯示目前 Registry 套裝軟體 (RegistryPackage) 的一條或多條路徑。該指令也會顯示路徑的語言環境。

範例


admin> pwd
(en_US) /registry/userData

quit

結束 Admin Tool。

提要

quit

說明

quit 指令會結束 Admin Tool。

範例


admin> quit

rm

Registry 套裝軟體 (RegistryPackage) 中移除物件。

提要

rm [-d] [-r] { pattern | URN}…

說明

rm 指令會移除目前 Registry 套裝軟體 (RegistryPackage) 中名稱 (在目前的語言環境中) 與 patternURN 指定的式樣相符的成員物件。

如果相符的 RegistryObject 是多個 Registry 套裝軟體 (RegistryPackage) 物件的成員,則此指令僅移除目前 Registry 套裝軟體 (RegistryPackage) 和該物件之間的關聯。只有在移除關聯時,物件不再與其他任何 RegistryObject 相關聯 (包括其他含有 Registry 套裝軟體 (RegistryPackage) 物件的項目) 的狀況下,才會從登錄 (Registry) 中移除物件。

如果相符的成員物件本身是含有其他物件的 Registry 套裝軟體 (RegistryPackage),則物件和目前 Registry 套裝軟體 (RegistryPackage) 與成員 Registry 套裝軟體 (RegistryPackage) 之間的關聯均不會移除,除非指定 -r-d 選項。

如果指定了 -d-r 選項,則會遞迴套用 -d 選項,所以 -r 要選取的所有物件 (及其關聯) 均會被移除,無論其是否具有其他關聯。

選項

-d

移除目前的 Registry 套裝軟體 (RegistryPackage) 與指定的 Registry 套裝軟體 (RegistryPackage) 之間的關聯。只有在指定的 Registry 套裝軟體 (RegistryPackage) 僅剩餘與其成員物件的關聯時,才會將其移除。未透過成為其他 HasMember 關聯目標固定之立即移除 Registry 套裝軟體 (RegistryPackage) 的成員物件,現在可以成為 Registry 根的成員進行存取。

-r

移除指定的 Registry 套裝軟體 (RegistryPackage) 物件及其所有派生物件 (物件具有其他關聯時除外)。

運算元

pattern

包含文字字元和特殊字元星號 (*) (表示零個或多個字元) 及問號 (?) (表示有且僅有一個字元) 的式樣。您可以指定多個 pattern

URN

urn: 起始的 URN,例如 urn:uuid:4a6741e7-4be1-4cfb-960a-e5520356c4fd。您可以指定多個 URN

範例

以下指令會移除含有字串 "stat" 的所有 Registry 套裝軟體 (RegistryPackage) 物件及其所有派生物件。


admin> rm -r *stat*

select

執行 SQL select 敘述。

提要

select [SQL]

說明

select 指令會選取並列出透過計算整個指令 (將其視為 SQL 查詢進行計算) 指定的物件。如果未指定引數,則該指令會列出前一 select 指令或 -sqlselect 選項選取的所有物件。

運算元

SQL

SQL select 敘述 (沒有前導字元 select,因為其已作為指令的名稱)。

範例

以下指令會列出登錄 (Registry) 中的所有分類方案 (ClassificationScheme) 物件︰


admin> select s.* from ClassificationScheme s

set

設定特性值。

提要

set property value

說明

set 指令會設定 Admin Tool shell 的特性值。

工具支援以下特性和值。

set debug {true | on | yes | false | off | no}

啟用或停用除錯訊息輸出。

set editor string

設定 Admin Tool 啟動互動式編輯器時要使用的指令。在 UNIX 和 Linux 系統上,預設值是 /bin/vi

set verbose {true | on | yes | false | off | no}

執行指令時,啟用或停用更詳細訊息的輸出。

運算元

property

以下特性之一︰debugeditorverbose

value

指定特性的支援值。請參閱「說明」小節,以取得詳細資訊。

範例

以下指令會將編輯器設定為 /usr/bin/vi,而非預設 /bin/vi


admin> set editor /usr/bin/vi

以下指令會啟動除錯。


admin> set debug true

以下指令會關閉詳細輸出。


admin> set verbose off

show

顯示特性值。

提要

show [property]

說明

show 指令會顯示 Admin Tool shell 的特性值。

如果未指定引數,則此指令會顯示所有特性的值。

此指令支援以下特性︰

debug

是否已啟用除錯輸出。

editor

Admin Tool 啟動互動式編輯器時要使用的編輯器。

exception

來自前一緊接執行的指令的異常堆疊追蹤 (如果有) 。

localdir

本機檔案系統上的目前目錄。使用 lcd 指令可設定此特性。請參閱 lcd,以取得詳細資訊。

locale

目前的語言環境。

verbose

是否已啟用詳細輸出。

運算元

property

其目前值要顯示的特性。特性 exceptionlocale 可以顯示,但您無法使用 set 指令對其進行設定。

範例

以下指令會顯示來自前一指令的異常。


admin> show exception

users

列出目前的使用者 (User) 物件。

提要

users

說明

users 指令會列出目前在登錄 (Registry) 中的使用者 (User) 物件。

輸出格式如下︰


%index: URN lastname, firstname middlename

在輸出中,index 是一個數值,您可以在執行 chowncp 指令時,使用該數值 (包含百分比符號 %) 參考使用者。lastnamefirstnamemiddlename 是使用者的姓氏、名字和中間名。

範例

以下指令會顯示目前的使用者︰


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

另請參閱