DOFDomain Class

OpenDOF Object Access Library

This class represents a route to a domain and provides a view for the state of that domain.

Inheritance Hierarchy

SystemObject
org.opendof.core.oalDOFDomain

Namespace: org.opendof.core.oal
Assembly: dof-oal (in dof-oal.dll) Version: 7.0.1.2

Syntax

public sealed class DOFDomain

The DOFDomain type exposes the following members.

Methods

	Name	Description
	addStateListener	Add a new state listener to the domain.
	destroy	Destroys an domain.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	getState	Get the current instantaneous state of the domain.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	removeStateListener	Remove a state listener from the domain.
	ToString	(Overrides ObjectToString.)

Top

Fields

	Name	Description
	DEFAULT_MAX_SILENCE	The default max silence for a DOFDomain object in milliseconds (1 hour).
	DEFAULT_RETRY_PERIOD	The default retry period for a DOFDomain object in milliseconds (1 minute).

Top

Remarks

This class represents a route to a domain and provides a view for the state of that domain. Domains form the basis of DOF security for DOFConnection and DOFServer. These are not configured because they may (and often do) require the DOF to exist in order for their support classes to be created. Because of this the DOF itself is often created unsecure, and then security is added through the creation of at least one DOFDomain.

The OAL attempts to re-validate the domain's credentials periodically. The period is determined by Config.getMaxSilence() . If the route fails to re-validate, the resulting behavior is determined by the type of domain.

There are 4 varieties of domains:

Static domains. Upon failure to re-validate, the route is dropped, but the connection is closed.
Dynamic domains. Upon failure to re-validate, the route is dropped, but the connection is not closed.
Monitor domains. Upon failure to re-validate, the route is dropped, but the connection is not closed.

If the domain is created with credentials that cannot be validated, then corresponding connections, etc., will fail.

Constructing DOFDomain:

Static domains are added through Builder.addDomains(Config[]) .
Dynamic domains are added through DOFConnection.addDomain(Config) .
Monitor domains are added through DOF.createDomain(Config)

Reference

org.opendof.core.oal Namespace