プライマリ・コンテンツに移動
Oracle® Fusion Middleware Oracle WebCenter Contentサービス・リファレンス
12c (12.2.1.2.0)
E82753-01
目次へ移動
目次 		索引へ移動
索引
前
前へ 		次
次へ

12 拡張ユーザー属性サービス

この章では、拡張ユーザー属性コンポーネントの使用時およびカスタマイズ時に利用可能なOracle WebCenter Contentサービスについて説明します。

この章の構成は、次のとおりです。

12.1 拡張ユーザー属性サービスについて

WebCenter Contentサービスの内容およびサービスの使用方法に関する情報は、「サービスの使用」で説明されています。基本的なサービスの構造、属性、アクションおよびサービスの例に関する情報は、「サービスのカスタマイズ」で説明されています。現在のサービスをカスタマイズするか、新しいサービスを作成する前に、この情報に精通しておく必要があります

個々の拡張ユーザー属性サービスの場所は、それぞれのサービスの説明の中で示します。

注意:

この章で最も一般的に使用されるサービスには、より広範囲な説明があります。

注意:

最も一般的に使用されるサービスには、より広範囲な説明があります。

一般的な拡張ユーザー属性サービス・エントリを次に示します。

ADD_EXTENDED_USER_ATTRIBUTES
UserService 0 null null null !csUnableToAddExtendedAttr(dName)
3:checkSubAdmin:UserAdmin:0:null
3:loadUserAndCheckEditAllowedWithExtendedAttributes::4:null
3:setLocalValues:alwaysSave,1,doAdminFields,1:0:null
3:removeCachedUser::0:null
3:setConditionVars:IsModifyExisting,1,IsAddingAttributes,1:0:null
3:modifyExtendedUserAttributes:IuserExtendedAttribute:8:null
3:checkRefreshUsers::0:null

  • 1行目にはサービス名(ADD_EXTENDED_USER_ATTRIBUTES)を指定します。

  • 2行目にはサービスの属性を指定します。

    • サービス・クラス: UserService

    • アクセス・レベル: 0

    • テンプレート: null (使用されない)

    • サービス・タイプ: null (サブサービスではない)

    • 通知された件名: null

    • エラー・メッセージ: ユーザーの新しい拡張属性を追加できません

  • エントリのこの他の部分では、各行に1つずつサービスのアクションを指定します。

    • アクション・タイプ: たとえば、3はJavaメソッドを示します。

    • アクション名: たとえば、modifyExtendedUserAttributes

    • アクション・パラメータ: たとえば、IuserExtendedAttribute。パラメータを指定しない場合は、2つのコロン(::)を指定します。

    • アクションの制御マスク: たとえば、8はデータベース・トランザクションの終了を意味します。コロン2つのインジケータ(::)も指定できます。

    • アクションのエラー・メッセージ: たとえば、メッセージがない場合はnull。

サービス・アクションの各要素はコロン(:)で区切ります。

注意:

すべてのサービスには、少なくとも1つの必須パラメータがあります。IdcServiceパラメータはサービス名をその引数として取ります。他のパラメータが必要な場合は、サービスの説明に記載されています。

サービスの属性とアクションの詳細は、「サービスのカスタマイズ」を参照してください。

12.2 拡張ユーザー属性サービス

Content Serverインスタンスのインストール時には、次の拡張ユーザー属性コンポーネント・サービスがインストールされます。

次のサービスは、拡張ユーザー属性コンポーネントをサポートするように拡張されました。

12.2.1 ADD_EXTENDED_USER_ATTRIBUTES

ユーザーに対して拡張属性を追加するサービス。このサービスを使用する前にユーザーが存在することは、必須条件ではありません。すでに存在する拡張属性をユーザーに対して追加するようにこのサービスに要求した場合、このサービスは以前のエントリを変更します。

場所: IdcHomeDir/components/ExtendedUserAttributes/resources/extendeduserattributes_services.htm

追加の必須サービス・パラメータ

  • dName: ユーザー名。

  • ExtUserAttribInfo Resultset: 拡張ユーザー属性情報を格納する結果セット。

オプションのサービス・パラメータ

  • CheckUserMustExist: trueに設定すると、拡張属性の追加前に、ユーザーが存在していることを検証する限定チェックが実行されます。このチェックはローカル・ユーザーに対してのみ機能します。標準のサービス・コールでこの値を設定することはお薦めしません。

例

add_user_attr.txtの次の例は、このサービスの使用方法を示しています。

# Add a security group and an account to the user's extended attributes
# with different applications
@Properties LocalData
IdcService=ADD_EXTENDED_USER_ATTRIBUTES
dName=jsmith
@end
@ResultSet ExtUserAttribInfo
3
dUserName
dApplication
AttributeInfo
jsmith
appl
account,abc/def,15
jsmith
app2
role,contributor,15
@end

12.2.2 EDIT_EXTENDED_USER_ATTRIBUTES

ユーザーの拡張ユーザー属性を編集するサービス。このサービスを使用する前にユーザーが存在することは、必須条件ではありません。以前の拡張属性はすべて、指定した新しい拡張属性に置換されます。

場所:

IdcHomeDir/components/ExtendedUserAttributes/resources/extendeduserattributes_services.htm

追加の必須サービス・パラメータ

  • dName: ユーザー名。

  • ExtUserAttribInfo ResultSet: 拡張ユーザー属性情報を格納する結果セット。

オプションのサービス・パラメータ

  • CheckUserMustExist: trueに設定すると、拡張属性の追加前に、ユーザーが存在していることを検証する限定チェックが実行されます。このチェックはローカル・ユーザーに対してのみ機能します。標準のサービス・コールでこの値を設定することはお薦めしません。

例

edit_user_attr.txtの次の例は、このサービスの使用方法を示しています。

# Change the user to have all permissions with #all
@Properties LocalData
IdcService=EDIT_EXTENDED_USER_ATTRIBUTES
dName=jsmith
@end
@ResultSet ExtUserAttribInfo
3
dUserName
dApplication
AttributeInfo
jsmith
appl
account,\#all,15
@end

12.2.3 DELETE_EXTENDED_USER_ATTRIBUTES

ユーザーの特定の拡張ユーザー属性を削除するサービス。

場所:

IdcHomeDir/components/ExtendedUserAttributes/resources/extendeduserattributes_services.htm

追加の必須サービス・パラメータ

  • dName: ユーザー名。

  • ExtUserAttribInfo ResultSet: 拡張ユーザー属性情報を格納する結果セット。

  • allowMissingAttributes: trueに設定すると、存在しない属性を削除しようとしたときのエラーが抑止されます(デフォルトはfalse)。

オプションのサービス・パラメータ

  • CheckUserMustExist: trueに設定すると、拡張属性の追加前に、ユーザーが存在していることを検証する限定チェックが実行されます。このチェックはローカル・ユーザーに対してのみ機能します。標準のサービス・コールでこの値を設定することはお薦めしません。

例

# Delete the #all account from extended attributes for jsmith
@Properties LocalData
IdcService=DELETE_EXTENDED_USER_ATTRIBUTES
dName=jsmith
@end
@ResultSet ExtUserAttribInfo
3
dUserName
dApplication
AttributeInfo
jsmith
appl
account,\#all,15
@end

12.2.4 DELETE_EXTENDED_ATTRIBUTES_BY_APPLICATION

指定したアプリケーションの特定のロール/アカウントのすべての拡張属性を削除するサービス。

場所:

IdcHomeDir/components/ExtendedUserAttributes/resources/extendeduserattributes_services.htm

追加の必須サービス・パラメータ

  • dAttributeType: 削除する属性のタイプ。

  • dAttributeName: 削除する属性の名前。

  • dApplication: 削除対象の属性が含まれているアプリケーション。

例

delete_attr_by_app.txtの次の例は、このサービスの使用方法を示しています。

# Delete the xyz account from extended attributes for appl
@Properties LocalData
IdcService=DELETE_EXTENDED_ATTRIBUTES_BY_APPLICATION
dAttributeName=xyz
dAttributeType=account
dApplication=appl
@end

12.2.5 DELETE_ALL_EXTENDED_ATTRIBUTES_FOR_USER

ユーザーのすべての拡張属性を削除するサービス。

追加の必須サービス・パラメータ

  • dName: ユーザー名。

オプションのサービス・パラメータ

  • CheckUserMustExist: trueに設定すると、拡張属性の追加前に、ユーザーが存在していることを検証する限定チェックが実行されます。このチェックはローカル・ユーザーに対してのみ機能します。標準のサービス・コールでこの値を設定することはお薦めしません。

例

delete_user_attr_all.txtの次の例は、このサービスの使用方法を示しています。

# Add roles
@Properties LocalData
IdcService=DELETE_ALL_EXTENDED_ATTRIBUTES_FOR_USER
dName=jsmith
@end

12.2.6 DELETE_ALL_EXTENDED_ATTRIBUTES_FOR_APPLICATION

アプリケーションのすべての拡張ユーザー属性を削除するサービス。

場所: IdcHomeDir/components/ExtendedUserAttributes/resources/extendeduserattributes_services.htm

追加の必須サービス・パラメータ

  • dApplication: アプリケーション。

例

del_all_attr_app.txtの次の例は、このサービスの使用方法を示しています。

# Delete all extended attribute information for appl
@Properties LocalData
IdcService=DELETE_ALL_EXTENDED_ATTRIBUTES_FOR_APPLICATION
dApplication=appl
@end

12.2.7 QUERY_EXTENDED_USER_ATTRIBUTES

ユーザーのすべての拡張属性をバインダ内の結果セットに配置するサービス。すべてのデータがExtUserAttribInfo ResultSetに入力されます。

場所: IdcHomeDir/components/ExtendedUserAttributes/resources/extendeduserattributes_services.htm

追加の必須サービス・パラメータ

  • dName: ユーザー名。

オプションのサービス・パラメータ

  • dApplication: 属性のアプリケーション名。

  • dAttributeType: 属性のタイプ。

  • dAttributeName: 属性の名前。

例

1つ以上のオプション・パラメータを追加することによって、問合せをより柔軟に絞り込むことができます。query_user_attr_ext.txtの次の例は、このサービスの使用方法を示しています。

# Query the extended attributes of a user
@Properties LocalData
IdcService=QUERY_EXTENDED_USER_ATTRIBUTES
dName=jsmith
@end

12.2.8 QUERY_EXTENDED_ATTRIBUTE_MAPPINGS

特定の属性からのマップされたすべての拡張属性をバインダ内の結果セットに配置するサービス。すべてのデータがExtUserAttribInfo ResultSetに入力されます。

場所: IdcHomeDir/components/ExtendedUserAttributes/resources/extendeduserattributes_services.htm

追加の必須サービス・パラメータ

  • dMappedAttributeName: マップする属性の名前。

オプションのサービス・パラメータ

  • dApplication: 属性のアプリケーション名。

  • dAttributeType: 属性のタイプ。

  • dAttributeName: 属性の名前。

例

1つ以上のオプション・パラメータを追加することによって、問合せをより柔軟に絞り込むことができます。query_attr_map_ext.txtの次の例は、このサービスの使用方法を示しています。

<?hda version="11gR1-dev" jcharset=Cp1252 encoding=iso-8859-1?>

# Query the attributes mapped from role 'guest'
@Properties LocalData
IdcService=QUERY_EXTENDED_ATTRIBUTE_MAPPINGS
dMappedAttributeName=guest
@end

12.2.9 EC_SET_PROPERTY

拡張構成プロパティを設定するサービス。新規プロパティの追加または既存のプロパティの編集に使用できます。

場所: IdcHomeDir/components/ExtendedUserAttributes/resources/extendeduserattributes_services.htm

追加の必須サービス・パラメータ

  • dECPropType: プロパティのタイプ。

  • dECPropKey: キー(通常、dECPropTypeに関連)。

  • dECPropValue: プロパティ値。

オプションのサービス・パラメータ

  • dECPropSubKey: (推奨) 2番目のキー。たとえば、dECPropTypeおよびdEDPropKeyによる定義内容の機能をこのキーとして指定できます。

例

set_property.txtの次の例は、このサービスの使用方法を示しています。

# Set an extended configuration property
@Properties LocalData
IdcService=EC_SET_PROPERTY
dECPropType=account
dECPropKey=#abc
dECPropSubKey=URL
dECPropValue=http://www.example.com
@end

12.2.10 EC_DELETE_PROPERTY

拡張構成プロパティを削除するサービス。削除対象のキーを正確に指定することが重要です。このサービスでは、キー内のすべてのサブキーの自動削除は実行されません。

場所: IdcHomeDir/components/ExtendedUserAttributes/resources/extendeduserattributes_services.htm

追加の必須サービス・パラメータ

  • dECPropType: プロパティのタイプ。

  • dECPropKey: キー(通常、dECPropTypeに関連)。

オプションのサービス・パラメータ

  • dECPropSubKey: (推奨) 2番目のキー。たとえば、dECPropTypeおよびdEDPropKeyによる定義内容の機能をこのキーとして指定できます。

例

del_property.txtの次の例は、このサービスの使用方法を示しています。

# Delete an extended configuration property
@Properties LocalData
IdcService=EC_DELETE_PROPERTY
dECPropType=account
dECPropKey=#abc
dECPropSubKey=URL
@end

12.2.11 EC_GET_PROPERTY

指定した拡張構成プロパティをResultSet PROPERTY_LISTに返すサービス。対象のキーを正確に指定することが重要です。そのキーのみ(サブキーではなく)に基づいて検索する場合は、EC_GET_PROPERTY_BY_KEYを使用します。

場所: IdcHomeDir/components/ExtendedUserAttributes/resources/extendeduserattributes_services.htm

追加の必須サービス・パラメータ

  • dECPropType: プロパティのタイプ。

  • dECPropKey: キー(通常、dECPropTypeに関連)。

オプションのサービス・パラメータ

  • dECPropSubKey: (推奨) 2番目のキー。たとえば、dECPropTypeおよびdEDPropKeyによる定義内容の機能をこのキーとして指定できます。

例

get_property.txtの次の例は、このサービスの使用方法を示しています。

# Retrieve an extended configuration property
@Properties LocalData
IdcService=EC_GET_PROPERTY
dECPropType=account
dECPropKey=#abc
dECPropSubKey=URL
@end

12.2.12 EC_GET_PROPERTY_BY_KEY

指定した拡張構成プロパティをResultSet PROPERTY_LISTに返すサービス。

場所: IdcHomeDir/components/ExtendedUserAttributes/resources/extendeduserattributes_services.htm

追加の必須サービス・パラメータ

  • dECPropType: プロパティのタイプ。

  • dECPropKey: キー(通常、dECPropTypeに関連)。

例

get_property_by_key.txtの次の例は、このサービスの使用方法を示しています。

# Retrieve an extended configuration property by key - gets all
# accounts of key #abc (regardless of subkey)
@Properties LocalData
IdcService=EC_GET_PROPERTY_BY_KEY
dECPropType=account
dECPropKey=#abc
@end

12.2.13 SET_DEFAULT_ATTRIBUTES

常にユーザーに適用されるいくつかのデフォルト属性を設定するサービス。タイプはdefaultsで、キーはuserattributesです。したがって、これらの指定は不要です。

場所: IdcHomeDir/components/ExtendedUserAttributes/resources/extendeduserattributes_services.htm

追加の必須サービス・パラメータ

  • dDefAttribs: 3つのエントリで構成される、カンマ区切りのエントリの形式のデフォルト属性。

オプションのサービス・パラメータ

  • dECPropSubKey: 2番目のキー。このキーが指定されているかどうかにかかわらず、デフォルト属性はすべてのユーザーに対してロードされます。

  • IsSecureDefaultAttribute: デフォルトのWebサービス( )の使用時にこのパラメータをデータ・バインダとともに使用した場合、値を1に設定すると、ログインしているユーザーにのみ適用されるデフォルトが登録されます。(デフォルトでは、デフォルト属性は、anonymousも含むすべてのユーザーに適用されます。)

例

set_defs.txtの次の例は、このサービスの使用方法を示しています。

# Sets some default attributes for all users
@Properties LocalData
IdcService=SET_DEFAULT_ATTRIBUTES
dECPropSubKey=extprops
dDefAttribs=account,#abc,15
@end

12.2.14 DELETE_DEFAULT_ATTRIBUTES

常にユーザーに適用されるいくつかのデフォルト属性を削除するサービス。

場所: IdcHomeDir/components/ExtendedUserAttributes/resources/extendeduserattributes_services.htm

オプションのサービス・パラメータ

  • dECPropSubKey: 2番目のキー。このパラメータが指定されていないと、このサービスはサブキーなしで指定されているデフォルト属性のみを削除します。他の属性は削除されません。

  • IsSecureDefaultAttribute: デフォルトのWebサービス( )の使用時にこのパラメータをデータ・バインダとともに使用した場合、値を1に設定すると、ログインしているユーザーにのみ適用されるデフォルトが削除されます。(デフォルトでは、デフォルト属性は、anonymousも含むすべてのユーザーに適用されます。)

例

del_defs.txtの次の例は、このサービスの使用方法を示しています。

# Deletes some default attributes for all users
@Properties LocalData
IdcService=DELETE_DEFAULT_ATTRIBUTES
dECPropSubKey=extprops
@end

12.2.15 GET_DEFAULT_ATTRIBUTES

このサービスは、すべてのユーザーに適用されるデフォルト属性をResultSet DEFAULT_ATTRIBUTESに返します。

場所: IdcHomeDir/components/ExtendedUserAttributes/resources/extendeduserattributes_services.htm

オプションのサービス・パラメータ

  • dECPropSubKey: 指定すると、デフォルト属性の検索が、このサブキーに一致するものに絞り込まれます。

  • IsSecureDefaultAttribute: デフォルトのWebサービス( )の使用時にこのパラメータをデータ・バインダとともに使用した場合、値を1に設定すると、ログインしているユーザーにのみ適用されるデフォルトが取得されます。(デフォルトでは、デフォルト属性は、anonymousも含むすべてのユーザーに適用されます。)

例

get_defs.txtの次の例は、このサービスの使用方法を示しています。

# Returns all default attributes for all users
@Properties LocalData
IdcService=GET_DEFAULT_ATTRIBUTES
@end

12.2.16 SET_EXTENDED_ATTRIBUTE_MAPPINGS

あるユーザー属性から別のユーザー属性へのマッピングを設定するサービス。ロールから他の属性へのマッピングのみがサポートされています(ソースがアカウントの場合、マッピングは機能しません)。

場所: IdcHomeDir/components/ExtendedUserAttributes/resources/extendeduserattributes_services.htm

追加の必須サービス・パラメータ

  • ExtUserAttribInfo: 拡張ユーザー属性情報を格納する結果セット。

例

set_attr_mapping.txtの次の例は、このサービスの使用方法を示しています。

<?hda version="11gR1-dev" jcharset=Cp1252 encoding=iso-8859-1?>

# Add the 'contributor' role to all users with the
# 'guest' role, and then consequently give all users
# with the 'contributor' role read/write access to
# account 'abc'. (This does mean that users with 
# the 'guest' role ultimately end up with access to 'abc').
@Properties LocalData
IdcService=SET_EXTENDED_ATTRIBUTE_MAPPINGS
@end
@ResultSet ExtUserAttribInfo
3
dAttributeName
dApplication
guest
appl
role,contributor,15
contributor
app2
account,abc,3
@end

12.2.17 DELETED_EXTENDED_ATTRIBUTE_MAPPINGS

あるユーザー属性から別のユーザー属性へのマッピングを削除するサービス。

場所: IdcHomeDir/components/ExtendedUserAttributes/resources/extendeduserattributes_services.htm

追加の必須サービス・パラメータ

  • ExtUserAttribInfo: 拡張ユーザー属性情報を格納する結果セット。

オプションのサービス・パラメータ

  • allowMissingAttributes: trueに設定すると、存在しない属性を削除しようとしたときのエラーが抑止されます。デフォルトは、falseです。

例

del_attr_mapping.txtの次の例は、このサービスの使用方法を示しています。

<?hda version="11gR1-dev" jcharset=Cp1252 encoding=iso-8859-1?>

# Delete two attribute mappings
@Properties LocalData
IdcService=DELETE_EXTENDED_ATTRIBUTE_MAPPINGS
@end
@ResultSet ExtUserAttribInfo
3
dAttributeName
dApplication
AttributeInfo
guest
appl
role,contributor,15
contributor
app2
account,abc,3
@end

12.2.18 ADD_USER

このサービスは変更され、ユーザーの追加時に拡張ユーザー属性も同時に追加されるようになりました。詳細は、「ADD_USER」を参照してください。

場所: IdcHomeDir/components/ExtendedUserAttributes/resources/extendeduserattributes_services.htm

オプションのサービス・パラメータ

  • ExtUserAttribInfo ResultSet: 拡張ユーザー属性情報を格納する結果セット。これを含んでいない場合、拡張属性は追加されません。

例

add_user.txtの次の例は、このサービスの使用方法を示しています。

# Add user with extended security data
@Properties LocalData
IdcService=ADD_USER
dName=jsmith
dUserAuthType=Local
dFullName=Jennifer Smith
dPassword=password
dEmail=email@example.com
@end
@ResultSet UserAttribInfo
2
dUserName
AttributeInfo
jsmith
role,guest,15
@end
@ResultSet ExtUserAttribInfo
3
dUserName
dApplication
AttributeInfo
jsmith
appl
account,abc,15
@end

12.2.19 EDIT_USER

このサービスは変更され、拡張ユーザー属性も同時に編集できるようになりました。以前の値のすべてが新しい値に置換されます。詳細は、「ADD_USER」を参照してください。

場所: IdcHomeDir/components/ExtendedUserAttributes/resources/extendeduserattributes_services.htm

オプションのサービス・パラメータ

  • ExtUserAttribInfo ResultSet: 拡張ユーザー属性情報を格納する結果セット。これを含んでいない場合、拡張属性は置換されません。

例

edit_user.txtの次の例は、このサービスの使用方法を示しています。

# Edit user with extended security data
@Properties LocalData
IdcService=EDIT_USER
dName=jsmith
dUserAuthType=Local
dFullName=Justin Smith
dPassword=12345
dEmail=real@real.com
@end
@ResultSet UserAttribInfo
2
dUserName
AttributeInfo
jsmith
role,guest,15
@end
@ResultSet ExtUserAttribInfo
3
dUserName
dApplication
AttributeInfo
jsmith
appl
account,abc,7,account,xyz,15
@end

12.2.20 DELETE_USER

このサービスは変更され、ユーザーの拡張属性が削除されるようになりました(拡張属性が存在する場合)。詳細は、「DELETE_USER」を参照してください。

場所: IdcHomeDir/components/ExtendedUserAttributes/resources/extendeduserattributes_services.htm

例

delete_user.txtの次の例は、このサービスの使用方法を示しています。

# Delete user with extended security data
@Properties LocalData
IdcService=DELETE_USER
dName=jsmith
@end

12.2.21 QUERY_USER_ATTRIBUTES

このサービスは通常どうり動作しますが、このサービスによって返される属性はgetAllAttributesパラメータに依存します。このパラメータがtrueとして渡された場合、このサービスは通常のユーザー属性と拡張ユーザー属性の混合を返します。詳細は、「QUERY_USER_ATTRIBUTES」を参照してください。

場所: IdcHomeDir/components/ExtendedUserAttributes/resources/extendeduserattributes_services.htm

例

query_user_attr.txtの次の例は、このサービスの使用方法を示しています。

# The normal QUERY_USER_ATTRIBUTES, except it gathers all
# attributes now
@Properties LocalData
IdcService=QUERY_USER_ATTRIBUTES
dName=jsmith
getAllAttributes=true
@end
前
前へ 		次
次へ
目次へ移動
目次 		索引へ移動
索引