jp.go.aist.rtm.RTC.SDOPackage
クラス Configuration_impl

java.lang.Object
  上位を拡張 org.omg.PortableServer.Servant
      上位を拡張 _SDOPackage.ConfigurationPOA
          上位を拡張 jp.go.aist.rtm.RTC.SDOPackage.Configuration_impl
すべての実装されたインタフェース:
ConfigurationOperations, org.omg.CORBA.portable.InvokeHandler

public class Configuration_impl
extends ConfigurationPOA

SDO Configuration 実装クラス

Configuration interface は Resource Data Model で定義されたデータの 追加、削除等の操作を行うためのインターフェースです。 DeviceProfile, ServiceProfile, ConfigurationProfile および Organization の変更を行うためのオペレーションを備えています。SDO の仕様ではアクセス制御 およびセキュリティに関する詳細については規定していません。
複数の設定 (Configuration) を保持することにより、容易かつ素早くある設定 を反映させることができます。事前に定義された複数の設定を ConfigurationSets および configuration profile として保持することができます。ひとつの ConfigurationSet は特定の設定に関連付けられた全プロパティ値のリストを、 ユニークID、詳細とともに持っています。これにより、各設定項目の詳細を記述し 区別することができます。Configuration interface のオペレーションはこれら ConfiguratioinSets の管理を支援します。

  1. ConfigurationSet: id, description, NVList から構成される1セットの設定
  2. ConfigurationSetList: ConfigurationSet のリスト
  3. Parameter: name, type, allowed_values から構成されるパラメータ定義。
  4. ActiveConfigurationSet: 現在有効なコンフィギュレーションの1セット。

以下、SDO仕様に明記されていないもしくは解釈がわからないため独自解釈

以下の関数は ParameterList に対して処理を行います。

  1. get_configuration_parameters()

以下の関数はアクティブなConfigurationSetに対する処理を行います

  1. get_configuration_parameter_values()
  2. get_configuration_parameter_value()
  3. set_configuration_parameter()

以下の関数はConfigurationSetListに対して処理を行います。

  1. get_configuration_sets()
  2. get_configuration_set()
  3. set_configuration_set_values()
  4. get_active_configuration_set()
  5. add_configuration_set()
  6. remove_configuration_set()
  7. activate_configuration_set()


フィールドの概要
protected  java.util.Map<java.lang.String,Properties> m_configsetopts
           
protected  ConfigAdmin m_configsets
          コンフィギュレーションセット情報
protected  DeviceProfile m_deviceProfile
          DeviceProfile
protected  Configuration m_objref
          オブジェクト参照
protected  OrganizationListHolder m_organizations
          Organization リスト
protected  ParameterListHolder m_parameters
          Parameter リスト
protected  ServiceProfileListHolder m_serviceProfiles
          ServiceProfile リスト
protected  Logbuf rtcout
          Logging用フォーマットオブジェクト
 
コンストラクタの概要
Configuration_impl(ConfigAdmin configsets)
          コンストラクタ
 
メソッドの概要
 Configuration _this()
          オブジェクト・リファレンスを取得する。
 boolean activate_configuration_set(java.lang.String config_id)
          [CORBA interface] ConfigurationSet をアクティブ化する。
 boolean add_configuration_set(ConfigurationSet configuration_set)
          [CORBA interface] ConfigurationSet を追加する。
 boolean add_organization(Organization org)
          [CORBA interface] Organization を追加する。
 boolean add_service_profile(ServiceProfile sProfile)
          [CORBA interface] SDO の ServiceProfile を設定する。
 ConfigurationSet get_active_configuration_set()
          [CORBA interface] アクティブな ConfigurationSet を取得する。
 org.omg.CORBA.Any get_configuration_parameter_value(java.lang.String name)
          [CORBA interface] Configuration parameter の値を取得する。
 NameValue[] get_configuration_parameter_values()
          [CORBA interface] Configuration parameter の値のリストを取得する。
 Parameter[] get_configuration_parameters()
          [CORBA interface] 設定パラメータのリストを取得する。
 ConfigurationSet get_configuration_set(java.lang.String config_id)
          [CORBA interface] ConfigurationSet を取得します。
 ConfigurationSet[] get_configuration_sets()
          [CORBA interface] ConfigurationSet リストを取得する。
 DeviceProfile getDeviceProfile()
          [CORBA interface] SDO の DeviceProfile を取得する。
 Configuration getObjRef()
          オブジェクト参照を取得する。
 OrganizationListHolder getOrganizations()
          [CORBA interface] 設定された全Organizationを取得する。
 ServiceProfile getServiceProfile(java.lang.String id)
          [CORBA interface] SDO の ServiceProfile を取得する。
 ServiceProfileListHolder getServiceProfiles()
          [CORBA interface] SDO の 全DeviceProfile を取得する。
 boolean remove_configuration_set(java.lang.String config_id)
          [CORBA interface] ConfigurationSet を削除する。
 boolean remove_organization(java.lang.String organization_id)
          [CORBA interface] Organization の参照を削除する。
 boolean remove_service_profile(java.lang.String id)
          [CORBA interface] ServiceProfile を削除する。
 boolean set_configuration_parameter(java.lang.String name, org.omg.CORBA.Any value)
          [CORBA interface] Configuration パラメータを変更する。
 boolean set_configuration_set_values(ConfigurationSet configuration_set)
          [CORBA interface] ConfigurationSet をセットする このオペレーションは指定された id の ConfigurationSet を更新する。
 boolean set_device_profile(DeviceProfile dProfile)
          [CORBA interface] SDO の DeviceProfile をセットする。
 
クラス _SDOPackage.ConfigurationPOA から継承されたメソッド
_all_interfaces, _invoke, _this
 
クラス org.omg.PortableServer.Servant から継承されたメソッド
_default_POA, _get_delegate, _get_interface_def, _is_a, _non_existent, _object_id, _orb, _poa, _set_delegate, _this_object, _this_object
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

m_objref

protected Configuration m_objref
オブジェクト参照


m_deviceProfile

protected DeviceProfile m_deviceProfile
DeviceProfile


m_serviceProfiles

protected ServiceProfileListHolder m_serviceProfiles
ServiceProfile リスト


m_parameters

protected ParameterListHolder m_parameters
Parameter リスト


m_configsets

protected ConfigAdmin m_configsets
コンフィギュレーションセット情報


m_configsetopts

protected java.util.Map<java.lang.String,Properties> m_configsetopts

m_organizations

protected OrganizationListHolder m_organizations
Organization リスト


rtcout

protected Logbuf rtcout
Logging用フォーマットオブジェクト

コンストラクタの詳細

Configuration_impl

public Configuration_impl(ConfigAdmin configsets)
コンストラクタ

パラメータ:
configsets - コンフィギュレーション情報
メソッドの詳細

_this

public Configuration _this()
オブジェクト・リファレンスを取得する。

オーバーライド:
クラス ConfigurationPOA 内の _this
戻り値:
オブジェクト・リファレンス

set_device_profile

public boolean set_device_profile(DeviceProfile dProfile)
                           throws InvalidParameter,
                                  NotAvailable,
                                  InternalError
[CORBA interface] SDO の DeviceProfile をセットする。

このオペレーションは SDO の DeviceProfile をセットする。SDO が DeviceProfile を保持していない場合は新たな DeviceProfile を生成し、 DeviceProfile をすでに保持している場合は既存のものと置き換える。

パラメータ:
dProfile - SDO に関連付けられる DeviceProfile。
戻り値:
オペレーションが成功したかどうかを返す。
例外:
NotAvailable - SDOは存在するが応答がない。
InvalidParameter - i 引数 "dProfile" が null である。
InternalError - 内部的エラーが発生した。

add_service_profile

public boolean add_service_profile(ServiceProfile sProfile)
                            throws InvalidParameter,
                                   NotAvailable,
                                   InternalError
[CORBA interface] SDO の ServiceProfile を設定する。

このオペレーションはこの Configuration interface を所有する対象 SDO の ServiceProfile を設定する。もし引数の ServiceProfile の id が 空であれば新しい ID が生成されその ServiceProfile を格納する。 もし id が空でなければ、SDO は同じ id を持つ ServiceProfile を検索する。 同じ id が存在しなければこの ServiceProfile を追加し、id が存在すれば 上書きをする。

パラメータ:
sProfile - 追加する ServiceProfile
戻り値:
オペレーションが成功したかどうかを返す。
例外:
InvalidParameter - 引数 "sProfile" が nullである。
NotAvailable - SDOは存在するが応答がない。
InternalError - 内部的エラーが発生した。

add_organization

public boolean add_organization(Organization org)
                         throws InvalidParameter,
                                NotAvailable,
                                InternalError
[CORBA interface] Organization を追加する。

このオペレーションは Organization object のリファレンスを 追加する。

パラメータ:
org - 追加する Organization
戻り値:
オペレーションが成功したかどうかを返す。
例外:
NotAvailable - SDOは存在するが応答がない。
InvalidParameter - 引数 "organization" が null である。
InternalError - 内部的エラーが発生した。

remove_service_profile

public boolean remove_service_profile(java.lang.String id)
                               throws InvalidParameter,
                                      NotAvailable,
                                      InternalError
[CORBA interface] ServiceProfile を削除する。

このオペレーションはこの Configuration interface を持つ SDO の Service の ServiceProfile を削除する。 削除する ServiceProfileは引数により指定される。

パラメータ:
id - 削除する ServcieProfile の serviceID。
戻り値:
オペレーションが成功したかどうかを返す。
例外:
InvalidParameter - 引数 "id" が null である。もしくは "id" に 関連付けられた ServiceProfile が存在しない。
NotAvailable - SDOは存在するが応答がない。
InternalError - 内部的エラーが発生した。

remove_organization

public boolean remove_organization(java.lang.String organization_id)
                            throws InvalidParameter,
                                   NotAvailable,
                                   InternalError
[CORBA interface] Organization の参照を削除する。

このオペレーションは Organization の参照を削除する。

パラメータ:
organization_id - 削除する Organization の一意な id。
戻り値:
オペレーションが成功したかどうかを返す。
例外:
InvalidParameter - 引数 "id" が null である。もしくは "id" に 関連付けられた Organization が存在しない。
NotAvailable - SDOは存在するが応答がない。
InternalError - 内部的エラーが発生した。

get_configuration_parameters

public Parameter[] get_configuration_parameters()
                                         throws NotAvailable,
                                                InternalError
[CORBA interface] 設定パラメータのリストを取得する。

このオペレーションは configuration parameter のリストを返す。 SDO が設定可能なパラメータを持たなければ空のリストを返す。

戻り値:
設定を特徴付けるパラメータ定義のリスト。
例外:
NotAvailable - SDOは存在するが応答がない。
InternalError - 内部的エラーが発生した。

get_configuration_parameter_values

public NameValue[] get_configuration_parameter_values()
                                               throws NotAvailable,
                                                      InternalError
[CORBA interface] Configuration parameter の値のリストを取得する。

このオペレーションは configuration パラメータおよび値を返す。

戻り値:
全ての configuration パラメータと値のリスト。
例外:
NotAvailable - SDOは存在するが応答がない。
InternalError - 内部的エラーが発生した。

get_configuration_parameter_value

public org.omg.CORBA.Any get_configuration_parameter_value(java.lang.String name)
                                                    throws InvalidParameter,
                                                           NotAvailable,
                                                           InternalError
[CORBA interface] Configuration parameter の値を取得する。

このオペレーションは引数 "name" で指定されたパラメータ値を返す。

パラメータ:
name - 値を要求するパラメータの名前。
戻り値:
指定されたパラメータの値。
例外:
InvalidParameter - 引数 "name" が null である。
NotAvailable - SDOは存在するが応答がない。
InternalError - 内部的エラーが発生した。

set_configuration_parameter

public boolean set_configuration_parameter(java.lang.String name,
                                           org.omg.CORBA.Any value)
                                    throws InvalidParameter,
                                           NotAvailable,
                                           InternalError
[CORBA interface] Configuration パラメータを変更する。

このオペレーションは "name" で指定したパラメータの値を "value" に 変更する。

パラメータ:
name - 変更したいパラメータの名前。
value - 変更したいパラメータの値。
戻り値:
オペレーションが成功したかどうかを返す。
例外:
InvalidParameter - 引数 "name" が null である。
NotAvailable - SDOは存在するが応答がない。
InternalError - 内部的エラーが発生した。

get_configuration_sets

public ConfigurationSet[] get_configuration_sets()
                                          throws NotAvailable,
                                                 InternalError
[CORBA interface] ConfigurationSet リストを取得する。

このオペレーションは ConfigurationProfile が持つ ConfigurationSet のリストを返す。 SDO が ConfigurationSet を持たなければ空のリストを返す。

戻り値:
保持している ConfigurationSet のリストの現在値。
例外:
NotAvailable - SDOは存在するが応答がない。
InternalError - 内部的エラーが発生した。

get_configuration_set

public ConfigurationSet get_configuration_set(java.lang.String config_id)
                                       throws NotAvailable,
                                              InternalError

[CORBA interface] ConfigurationSet を取得します。
このオペレーションは引数で指定された ConfigurationSet の ID に関連 付けられた ConfigurationSet を返します。

パラメータ:
config_id - ConfigurationSet の識別子。
戻り値:
引数により指定された ConfigurationSet。
例外:
NotAvailable - SDOは存在するが応答がない。
InternalError - 内部的エラーが発生した。

set_configuration_set_values

public boolean set_configuration_set_values(ConfigurationSet configuration_set)
                                     throws InvalidParameter,
                                            NotAvailable,
                                            InternalError
[CORBA interface] ConfigurationSet をセットする

このオペレーションは指定された id の ConfigurationSet を更新する。

パラメータ:
configuration_set - 変更する ConfigurationSet そのもの。
戻り値:
ConfigurationSet が正常に更新できた場合は true。 そうでなければ false を返す。
例外:
InvalidParameter - config_id が null か、指定された id で格納された ConfigurationSetが存在しないか、指定された configuration_set内 の属性の1つが不正。
SDONotExists - ターゲットのSDOが存在しない。 (本例外は、CORBA標準システム例外のOBJECT_NOT_EXISTに マッピングされる)
NotAvailable - SDOは存在するが応答がない。
InternalError - 内部的エラーが発生した。

get_active_configuration_set

public ConfigurationSet get_active_configuration_set()
                                              throws NotAvailable,
                                                     InternalError
[CORBA interface] アクティブな ConfigurationSet を取得する。

このオペレーションは当該SDOの現在アクティブな ConfigurationSet を返す。 (もしSDOの現在の設定が予め定義された ConfigurationSet により設定されて いるならば。) ConfigurationSet は以下の場合にはアクティブではないものとみなされる。

  1. 現在の設定が予め定義された ConfigurationSet によりセットされていない
  2. SDO の設定がアクティブになった後に変更された
  3. SDO を設定する ConfigurationSet が変更された
    1. これらの場合には、空の ConfigurationSet が返される。

      戻り値:
      現在アクティブな ConfigurationSet。
      例外:
      NotAvailable - SDOは存在するが応答がない。
      InternalError - 内部的エラーが発生した。

add_configuration_set

public boolean add_configuration_set(ConfigurationSet configuration_set)
                              throws InvalidParameter,
                                     NotAvailable,
                                     InternalError
[CORBA interface] ConfigurationSet を追加する。

ConfigurationProfileにConfigurationSetを追加するオペレーション。

パラメータ:
configuration_set - 追加される ConfigurationSet。
戻り値:
オペレーションが成功したかどうか。
例外:
InvalidParameter - 引数 "configuration_set" が null である、 もしくは、引数で指定された ConfigurationSet が存在しない。
NotAvailable - SDOは存在するが応答がない。
InternalError - 内部的エラーが発生した。

remove_configuration_set

public boolean remove_configuration_set(java.lang.String config_id)
                                 throws InvalidParameter,
                                        NotAvailable,
                                        InternalError
[CORBA interface] ConfigurationSet を削除する。

ConfigurationProfile から ConfigurationSet を削除する。

パラメータ:
config_id - 削除する ConfigurationSet の id。
戻り値:
オペレーションが成功したかどうか。
例外:
InvalidParameter - 引数 "configurationSetID" が null である、 もしくは、引数で指定された ConfigurationSet が存在しない。
NotAvailable - SDOは存在するが応答がない。
InternalError - 内部的エラーが発生した。

activate_configuration_set

public boolean activate_configuration_set(java.lang.String config_id)
                                   throws InvalidParameter,
                                          NotAvailable,
                                          InternalError
[CORBA interface] ConfigurationSet をアクティブ化する。

ConfigurationProfile に格納された ConfigurationSet のうち一つを アクティブにする。 このオペレーションは特定の ConfigurationSet をアクティブにする。 すなわち、SDO のコンフィギュレーション・プロパティがその格納されている ConfigurationSet により設定されるプロパティの値に変更される。 指定された ConfigurationSet の値がアクティブ・コンフィギュレーション にコピーされるということを意味する。

パラメータ:
config_id - アクティブ化する ConfigurationSet の id。
戻り値:
オペレーションが成功したかどうか。
例外:
InvalidParameter - 引数 "config_id" が null である、もしくは 引数で指定された ConfigurationSet が存在しない。
NotAvailable - SDOは存在するが応答がない。
InternalError - 内部的エラーが発生した。

getObjRef

public Configuration getObjRef()
オブジェクト参照を取得する。

戻り値:
オブジェクト参照

getDeviceProfile

public final DeviceProfile getDeviceProfile()
[CORBA interface] SDO の DeviceProfile を取得する。

戻り値:
SDOのDeviceProfile。

getServiceProfiles

public final ServiceProfileListHolder getServiceProfiles()
[CORBA interface] SDO の 全DeviceProfile を取得する。

戻り値:
SDOのDeviceProfile。

getServiceProfile

public final ServiceProfile getServiceProfile(java.lang.String id)
[CORBA interface] SDO の ServiceProfile を取得する。

指定したIDのServiceProfileが存在しない場合は, 空のServiceProfileを返す。

パラメータ:
id - 取得対象 ServiceProfile の id
戻り値:
SDOのServiceProfile

getOrganizations

public final OrganizationListHolder getOrganizations()
[CORBA interface] 設定された全Organizationを取得する。

戻り値:
Organizationリスト