org.jscsi.target.settings

Class SettingsNegotiator

java.lang.Object

org.jscsi.target.settings.SettingsNegotiator

Direct Known Subclasses:

ConnectionSettingsNegotiator, SessionSettingsNegotiator

public abstract class SettingsNegotiator
extends Object

This is an abstract parent-class to ConnectionSettingsNegotiator and SessionSettingsNegotiator. The former one is in charge of all Entry objects with connection-specific parameters, the latter is in charge of all session-wide parameter Entry objects.

Author:

Andreas Ergenzinger

Field Summary

Fields

Modifier and Type	Field and Description
protected List<Entry>	backUpEntries A back-up copy of the last consistent state of all elements in entries or null.
protected List<Entry>	entries All Entry objects managed by this SettingsNegotiator.

Constructor Summary

Constructors

Constructor and Description
SettingsNegotiator() The abstract constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	backUpEntries() Stores an exact copy of entries in backUpEntries.
abstract boolean	checkConstraints() Checks constraints that cannot be checked at the Entry level, e.g.
protected void	commitOrRollBackChanges(boolean commitChanges) This method must be called at the end of a parameter negotiation task, either to roll back any changes that must not take effect, or in order to ensure that consecutive negotiations are carried out correctly.
protected static List<Entry>	copy(List<Entry> entries) Returns a deep copy of the passed List with exact copies of all contained Entry objects.
protected abstract void	initializeEntries() Adds a properly initialized Entry object to entries for every parameter managed by this SettingsNegotiator.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

entries

protected List<Entry> entries

All Entry objects managed by this SettingsNegotiator.

These elements might change consecutively during parameter negotiations.

backUpEntries

protected List<Entry> backUpEntries

A back-up copy of the last consistent state of all elements in entries or null.

See Also:

backUpEntries, commitOrRollBackChanges(boolean)

Constructor Detail

SettingsNegotiator

public SettingsNegotiator()

The abstract constructor.

Calls initializeEntries().

Method Detail

copy

protected static final List<Entry> copy(List<Entry> entries)

Returns a deep copy of the passed List with exact copies of all contained Entry objects.

Parameters:

entries - the List to copy

Returns:

a copy of entries

backUpEntries

protected final void backUpEntries()

Stores an exact copy of entries in backUpEntries.

commitOrRollBackChanges

protected final void commitOrRollBackChanges(boolean commitChanges)

This method must be called at the end of a parameter negotiation task, either to roll back any changes that must not take effect, or in order to ensure that consecutive negotiations are carried out correctly.

Parameters:

commitChanges - true if and only if the negotiated changes to the elements in entries are to be remembered.

initializeEntries

protected abstract void initializeEntries()

Adds a properly initialized Entry object to entries for every parameter managed by this SettingsNegotiator.

checkConstraints

public abstract boolean checkConstraints()

Checks constraints that cannot be checked at the Entry level, e.g. because they depend on the values of multiple parameters.

Returns:

true if everything is fine, false if that is not the case