Service Registry 3 2005Q4 管理指南

Previous: Admin Tool 功能

使用 Admin Tool 指令

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

斜體指示在您執行指令時應由實際值替代的選項引數或運算元。
大括號 ({ }) 分隔選項或運算元的選擇，其中必須包含一個選項或運算元。選項或運算元由豎線 (|) 分隔。
方括號 ([ ]) 分隔可以省略的選項或運算元，或者可以省略的選項或運算元的選擇。
選項或運算元後面的省略號 (...) 指示您可以重複引數或運算元。

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

`add association`

將 Association 物件增加至 Registry。

提要

add association -type association-type sourceURN targetURN

說明

add association 指令會將指定類型的 Association 物件增加至 Registry。您可以使用以下任一類型︰

AccessControlPolicyFor
AffiliatedWith (具有子概念 EmployeeOf 和 MemberOf)
Contains
ContentManagementServiceFor
EquivalentTo
Extends
ExternallyLinks
HasFederationMember
HasMember
Implements
InstanceOf
InvocationControlFileFor (具有子概念 CatalogingControlFileFor 和 ValidationControlFileFor)
OffersService
OwnerOf
RelatedTo
Replaces
ResponsibleFor
SubmitterOf
Supersedes
Uses

選項

-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 filename] [-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 主控台或 JAXR 增加。

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

對於每個使用者均需要的某些一般資訊，您可以在指令行中使用簡略選項 (例如 -fn)，但在特性檔案中提供資訊時，必須使用較長的形式。例如，可以使用- email1.address、-emailAddress 或 -email 在指令行指定使用者的第一個電子郵件地址。但是，在特性檔案中指定第一個電子郵件地址時，必須使用 email1.address=。因為使用者的第二個電子郵件地址僅有一個選項，所以您必須在指令行中使用 -email2.address，在特性檔案中使用 email2.address=。

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

備註 –

您使用 -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 和 NetBeans^TM 指令 bin/runide.sh --open 配合使用 (但效果不佳)，但不能與 vi 配合使用。

-load

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

-fn | -firstName

指定使用者的名字。

-ln | -lastName

指定使用者的姓氏。姓氏是必需的；必須在指令行或特性檔案中指定姓氏。

-mn | -middleName

指定使用者的中間名。

-alias

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

-keypass

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

-postalType | -post1.type

第一個 PostalAddress 的類型。類型是必需的；必須在指令行或特性檔案中指定類型。該值可以是隨意的字串 (例如，Office 或 Home)。

-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，則類型是必需的；必須在指令行或特性檔案中指定類型。此值可以是隨意的字串 (例如，Office 或 Home)。

-post2.city

第二個 PostalAddress 的城市。

-post2.country

第二個 PostalAddress 的國家/地區。

-post2.postalcode

第二個 PostalAddress 的郵遞區號。

-post2.stateOrProvince

第二個 PostalAddress 的州或省。

-post2.street

第二個 PostalAddress 的街道名稱。

-post2.streetNumber

第二個 PostalAddress 的街道號碼。

-post3.type

第三個 PostalAddress 的類型。如果指定第三個 PostalAddress，則類型是必需的；必須在指令行或特性檔案中指定類型。此值可以是隨意的字串 (例如，Office 或 Home)。

-post3.city

第三個 PostalAddress 的城市。

-post3.country

第三個 PostalAddress 的國家/地區。

-post3.postalcode

第三個 PostalAddress 的郵遞區號。

-post3.stateOrProvince

第三個 PostalAddress 的州或省。

-post3.street

第三個 PostalAddress 的街道名稱。

-post3.streetNumber

第三個 PostalAddress 的街道號碼。

-phoneType | -telephone1.type

第一個 TelephoneNumber 的類型。類型是必需的；必須在指令行或特性檔案中指定類型。此值可以是隨意的字串，但您可以指定以下任一已知類型︰Beeper、FAX、HomePhone、MobilePhone 或 OfficePhone。

-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，則類型是必需的；必須在指令行或特性檔案中指定類型。此值可以是隨意的字串，但您可以指定以下任一已知類型︰Beeper、FAX、HomePhone、MobilePhone 或 OfficePhone。

-telephone2.areaCode

第二個 TelephoneNumber 的區域代碼。

-telephone2.countryCode

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

-telephone2.extension

第二個 TelephoneNumber 的分機號碼。

-telephone2.number

第二個 TelephoneNumber 的電話號碼尾碼 (不包含國家/地區或區域代碼)。如果指定第二個 TelephoneNumber，則號碼是必需的；必須在指令行或特性檔案中指定號碼。

-telephone2.URL

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

-telephone3.type

第三個 TelephoneNumber 的類型。如果指定第三個 TelephoneNumber，則類型是必需的；必須在指令行或特性檔案中指定類型。此值可以是隨意的字串，但您可以指定以下任一已知類型︰Beeper、FAX、HomePhone、MobilePhone 或 OfficePhone。

-telephone3.areaCode

第三個 TelephoneNumber 的區域代碼。

-telephone3.countryCode

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

-telephone3.extension

第三個 TelephoneNumber 的分機號碼。

-telephone3.number

第三個 TelephoneNumber 的電話號碼尾碼 (不包含國家/地區或區域代碼)。如果指定第三個 TelephoneNumber，則號碼是必需的；必須在指令行或特性檔案中指定號碼。

-telephone3.URL

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

-emailType | -email1.type

第一個 EmailAddress 的類型。類型是必需的；必須在指令行或特性檔案中指定類型。此值可以是隨意的字串，但您可以指定以下任一已知類型︰HomeEmail 或 OfficeEmail。

-emailAddress | -email | - email1.address

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

-email2.type

第二個 EmailAddress 的類型。如果指定第二個 EmailAddress，則類型是必需的；必須在指令行或特性檔案中指定類型。此值可以是隨意的字串，但您可以指定以下任一已知類型︰HomeEmail 或 OfficeEmail。

-email2.address

第二個電子郵件地址。

-email3.type

第三個 EmailAddress 的類型。如果指定第三個 EmailAddress，則類型是必需的；必須在指令行或特性檔案中指定類型。此值可以是隨意的字串，但您可以指定以下任一已知類型︰HomeEmail 或 OfficeEmail。

-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`

變更 RegistryPackage 位置。

提要

cd { locator | URN}

說明

cd 指令可將目錄變更 (隱喻地) 至指定路徑下的或具有指定 URN 的 RegistryPackage。

當多個 RegistryPackage 物件具有同一路徑 (對於目前的語言環境) 時，指令可變更至指定的 URN。

運算元

locator

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

例如，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 {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 指令會將資料夾和檔案分別作為 RegistryPackage 和 ExtrinsicObject 物件複製到 Registry。

從其上複製檔案和資料夾的本機檔案系統上的本機目錄預設為啟動 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 指令會顯示有關可用指令或指定指令的資訊。

對於帶有子指令的指令 (例如 add 和 show)，help 指令會顯示有關子指令的資訊。

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

運算元

command_name: Admin Tool 指令的名稱。

範例

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

admin> help

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

admin> help lcd

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

admin> help add

`lcd`

變更本機檔案系統上的目前目錄。

提要

lcd [path_name]

說明

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

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

運算元

path_name: 目錄名稱，可以是絕對的，也可以是相對的。

範例

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

admin> lcd /usr/share

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

admin> lcd

`ls`

列出目前 RegistryPackage 中的物件。

提要

ls { pattern | URN}

說明

如果沒有引數，ls 指令會列出目前 RegistryPackage 中的物件。如果提供 pattern 或 URN，該指令會列出目前 RegistryPackage 中名稱 (在目前語言環境中) 或唯一識別碼符合 pattern 或 URN 的物件。

運算元

pattern: 包含文字字元和特殊字元星號 (*) (表示零個或多個字元) 及問號 (?) (表示有且僅有一個字元) 的式樣。您可以指定多個 pattern。
URN: 以 urn: 起始的 URN，例如 urn:uuid:4a6741e7-4be1-4cfb-960a-e5520356c4fd。您可以指定多個 URN。URN 必須是物件的唯一識別碼 (而非邏輯識別碼)。

範例

以下指令會列出目前 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`

顯示目前 RegistryPackage 的路徑。

提要

pwd

說明

pwd 指令會使用目前語言環境的最相符名稱顯示目前 RegistryPackage 的一條或多條路徑。該指令還會顯示路徑的語言環境。

範例

admin> pwd
(en_US) /registry/userData

`quit`

結束 Admin Tool。

提要

quit

說明

quit 指令會結束 Admin Tool。

範例

admin> quit

`rm`

從 RegistryPackage 中移除物件。

提要

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

說明

rm 指令會移除目前 RegistryPackage 中名稱 (在目前的語言環境中) 與 pattern 或 URN 指定的式樣相符的成員物件。

如果相符的 RegistryObject 是多個 RegistryPackage 物件的成員，則此指令僅移除目前 RegistryPackage 和該物件之間的關聯。僅當移除關聯使得該物件與其他任何 RegistryObject 均沒有關聯時，才會從 Registry 中移除該物件。

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

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

選項

-d: 移除目前的 RegistryPackage 與指定的 RegistryPackage 之間的關聯。僅當指定的 RegistryPackage 僅剩餘與其成員物件的關聯時，才會將其移除。未透過成為其他 HasMember 關聯的目標固定的立即移除 RegistryPackage 之成員物件現在可以作為 Registry 根的成員存取。
-r: 移除指定的 RegistryPackage 物件及其所有派生物件 (物件具有其他關聯時除外)。

運算元

pattern: 包含文字字元和特殊字元星號 (*) (表示零個或多個字元) 及問號 (?) (表示有且僅有一個字元) 的式樣。您可以指定多個 pattern。
URN: 以 urn: 起始的 URN，例如 urn:uuid:4a6741e7-4be1-4cfb-960a-e5520356c4fd。您可以指定多個 URN。

範例

以下指令會移除含有字串 "stat" 的所有 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: 以下特性之一︰debug、editor 和 verbose。
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: 其目前值要顯示的特性。特性 exception 和 locale 可以顯示，但您無法使用 set 指令對其進行設定。

範例

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

admin> show exception

`users`

列出目前的 User 物件。

提要

users

說明

users 指令會列出目前在 Registry 中的 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

Previous: Admin Tool 功能