Previous | Table of Contents | Next |
The PropertyManager interface provides operations that set properties for object groups, such as the ReplicationStyle, MembershipStyle,
ConsistencyStyle, InitialNumberReplicas, MinimumNumberReplicas, etc. It may set these properties statically as defaults for
the fault tolerance domain or for a particular type, or may set or change the properties dynamically while the application
is executing.
module FT { interface PropertyManager { void set_default_properties(in Properties props) raises (InvalidProperty, UnsupportedProperty);
Properties get_default_properties();
void remove_default_properties(in Properties props) raises (InvalidProperty, UnsupportedProperty);
void set_type_properties(in TypeId type_id, in Properties overrides) raises (InvalidProperty, UnsupportedProperty);
Properties get_type_properties(in TypeId type_id);
void remove_type_properties(in TypeId type_id, in Properties props) raises (InvalidProperty, UnsupportedProperty);
void set_properties_dynamically(in ObjectGroup object_group, in Properties overrides)
raises(ObjectGroupNotFound, InvalidProperty, UnsupportedProperty);
Properties get_properties(in ObjectGroup object_group) raises(ObjectGroupNotFound); }; };
23.3.7.1 Operations
set_default_properties
This operation sets the default properties for all object groups that are to be created within the fault tolerance domain.
void set_default_properties(in Properties props)raises (InvalidProperty,UnsupportedProperty);
Parameters
Raises
InvalidProperty if one or more of the properties in the sequence is not valid. UnsupportedProperty if one or more of the properties
in the sequence is not supported.
get_default_properties
This operation returns the default properties for the object groups within the fault tolerance domain.
Properties get_default_properties();
Return Value
The default properties that have been set for the object groups.
remove_default_properties
This operation removes the given default properties.
void remove_default_properties(in Properties props)raises (InvalidProperty,
UnsupportedProperty);
Parameters
Raises
InvalidProperty if one or more of the properties in the sequence is not valid. UnsupportedProperty if one or more of the properties
in the sequence is not supported.
set_type_properties
This operation sets the properties that override the default properties of the object groups, with the given type identifier,
that are created in the future.
void set_type_properties(in TypeId type_id,in Properties overrides)raises (InvalidProperty,UnsupportedProperty);
Parameters
type_id | The repository id for which the properties, that are to | ||||
override the existing properties, are set. | |||||
overrides | The overriding properties. |
Raises
InvalidProperty if one or more of the properties in the sequence is not valid.
UnsupportedProperty if one or more of the properties in the sequence is not supported.
get_type_properties
This operation returns the properties of the object groups, with the given type identifier, that are created in the future.
These properties include the properties determined by set_type_properties(), as well as the default properties that are not
overridden by set_type_properties().
Properties get_type_properties(in TypeId type_id);
Parameters
Return Value
The effective properties for the given type identifier.
remove_type_properties
This operation removes the given properties, with the given type identifier.
void remove_type_properties(in TypeId type_id,in Properties props)raises (InvalidProperty,UnsupportedProperty);
Parameters
type_id | The repository id for which the given properties are to | ||||
be removed. | |||||
props | The properties to be removed. |
Raises
InvalidProperty if one or more of the properties in the sequence is not valid.
UnsupportedProperty if one or more of the properties in the sequence is not supported.
set_properties_dynamically
This operation sets the properties for the object group with the given reference dynamically while the application executes.
The properties given as a parameter override the properties for the object when it was created which, in turn, override the
properties for the given type which, in turn, override the default properties.
void set_properties_dynamically(in ObjectGroup object_group, in Properties overrides)
raises(ObjectGroupNotFound,InvalidProperty,UnsupportedProperty);
Parameters
object_group | The reference of the object group for which the | ||||
overriding properties are set. | |||||
overrides | The overriding properties. |
Raises
InvalidProperty if one or more of the properties in the sequence is invalid.
UnsupportedProperty if one or more of the properties in the sequence is not supported.
23.3.7.2 get_properties
This operation returns the current properties of the given object group. These properties include those that are set dynamically,
those that are set when the object group was created but are not overridden by set_properties_dynamically(), those that are
set as properties of a type but are not overridden by create_object() and set_properties_dyamically(), and those that are
set as defaults but are not overridden by set_type_properties(), create_object(), and set_properties_dyamically().
Properties get_properties(in ObjectGroup object_group) raises(ObjectGroupNotFound);
Parameters
Return Value
The set of current properties for the object group with the given reference.
Raises
ObjectGroupNotFound if the object group is not found by the Replication Manager.