Top Methods
org.apache.derby.iapi.services.property

public Interface PropertySetCallback

Known Direct Subinterfaces
org.apache.derby.iapi.services.locks.LockFactory
Known Direct Implementers
org.apache.derby.impl.jdbc.authentication.AuthenticationServiceBase, org.apache.derby.impl.store.access.RAMAccessManager, org.apache.derby.impl.db.BasicDatabase, org.apache.derby.impl.sql.conn.GenericLanguageConnectionFactory, org.apache.derby.impl.sql.LanguageDbPropertySetter
Imports
org.apache.derby.shared.common.error.StandardException, org.apache.derby.iapi.services.daemon.Serviceable, java.io.Serializable, java.util.Dictionary

Method Summary

Modifier and TypeMethod and Description
public Serviceable

Returns:

post commit work for the property change.
apply
(String
Property key for the property being set
key
,
Serializable
proposed new value for the property being set or null if the property is being dropped.
value
,
Dictionary<K, V>
Property set before the change. SettingProperty may read but must never change p.
p
)

Apply a property change.

public void
init(boolean
true if only per-database properties are to be looked at
dbOnly
,
Dictionary<K, V>
the complete set of per-database properties.
p
)

Initialize the properties for this callback.

public Serializable

Returns:

new value for the change
map
(String
Property key for the property being set
key
,
Serializable
proposed new value for the property being set or null if the property is being dropped.
value
,
Dictionary<K, V>
Property set before the change. SettingProperty may read but must never change p.
p
)

Map a proposed new value for a property to an official value.

public boolean

Returns:

true if this object was interested in this property, false otherwise.
validate
(String
Property key for the property being set
key
,
Serializable
proposed new value for the property being set or null if the property is being dropped.
value
,
Dictionary<K, V>
Property set before the change. SettingProperty may read but must never change p.
p
)

Validate a property change.

Method Detail

applyback to summary
public Serviceable apply(String key, Serializable value, Dictionary<K, V> p) throws StandardException

Apply a property change. Will only be called after validate has been called and only if validate returned true. If this method is called then the new value is the value to be used, ie. the property is not set in the overriding JVM system set.

Parameters
key:String

Property key for the property being set

value:Serializable

proposed new value for the property being set or null if the property is being dropped.

p:Dictionary<K, V>

Property set before the change. SettingProperty may read but must never change p.

Returns:Serviceable

post commit work for the property change.

Exceptions
StandardException:
Oh well.
initback to summary
public void init(boolean dbOnly, Dictionary<K, V> p)

Initialize the properties for this callback. Called when addPropertySetNotification() is called with a non-null transaction controller. This allows code to set read its initial property values at boot time.

Code within an init() method should use the 3 argument PropertyUtil method getPropertyFromSet() to obtain a property's value.

Parameters
dbOnly:boolean

true if only per-database properties are to be looked at

p:Dictionary<K, V>

the complete set of per-database properties.

mapback to summary
public Serializable map(String key, Serializable value, Dictionary<K, V> p) throws StandardException

Map a proposed new value for a property to an official value. Will only be called after apply() has been called.

Parameters
key:String

Property key for the property being set

value:Serializable

proposed new value for the property being set or null if the property is being dropped.

p:Dictionary<K, V>

Property set before the change. SettingProperty may read but must never change p.

Returns:Serializable

new value for the change

Exceptions
StandardException:
Oh well.
validateback to summary
public boolean validate(String key, Serializable value, Dictionary<K, V> p) throws StandardException

Validate a property change.

Parameters
key:String

Property key for the property being set

value:Serializable

proposed new value for the property being set or null if the property is being dropped.

p:Dictionary<K, V>

Property set before the change. SettingProperty may read but must never change p.

Returns:boolean

true if this object was interested in this property, false otherwise.

Exceptions
StandardException:
Oh well.