Interface | Description |
---|---|
DOF.DomainListener |
The DomainListener interface enables you to be notified when a route to the Authentication Server
for a remote domain is discovered.
|
DOF.InterestListener |
The DOF.InterestListener interface enables you to create functionality for monitoring all interest requests.
|
DOF.Log.Listener |
The DOF.Log.Listener interface enables you to receive log messages when implemented.
|
DOF.PermissionListener |
The PermissionListener interface enables you to be notified when a terminal permission is granted or denied.
|
DOF.Runtime.ConnectionStateListener |
The ConnectionStateListener interface, when implemented, enables you to receive notifications when any of this DOF's connections, either inbound
or outbound, are established or go down.
|
DOF.Runtime.ServerStateListener |
The ServerStateListener interface, when implemented, enables you to receive notifications when any of the DOF's servers
start or stop.
|
DOF.State |
A State instance represents a snapshot of the DOF's configuration information as it exists at the moment when you call
DOF.getState() . |
DOF.TrafficStats |
A TrafficStats instance contains information about a DOF's traffic-related statistical data, including packet counts and bytes counts.
|
DOF.UncaughtExceptionListener |
The definition of the listener for uncaught exceptions.
|
DOFAuditListener |
Auditing interface.
|
DOFAuthenticator.CredentialStorage |
This interface defines the methods necessary for the
DOFAuthenticator.Storage.resolve(org.opendof.core.oal.DOFAuthenticator.CredentialStorage) method to set the identity
and private data of a credential. |
DOFAuthenticator.State |
This represents the instantaneous state of the authenticator at a given time.
|
DOFAuthenticator.Storage |
The
Storage interface defines the methods necessary for authentication, and
is used to create storage implementations for different types of storage mediums. |
DOFConnection.ConnectOperationListener |
This interface is used for the completion notification for asynchronous
connect requests.
|
DOFConnection.PeerListener |
Implement this interface to monitor the addition/removal of peers (within a secure group) at runtime.
|
DOFConnection.State |
This class represents the instantaneous state of the connection at a given time.
|
DOFConnection.StateListener |
StateListener is used to receive notifications about a particular connection's state, such as when a connection
is established or terminated.
|
DOFConnection.StreamRequestListener |
Implement this interface to monitor requests to upgrade a
DOFConnection.Type.DATAGRAM connection to a
DOFConnection.Type.STREAM type. |
DOFConnectionStack |
DOFConnectionStack represents a stack for receiving and sending packets across a network.
|
DOFDomain.State |
This class represents the instantaneous state of a
DOFDomain . |
DOFDomain.StateListener |
This interface can be implemented to provide a listener for the state of a
DOFDomain . |
DOFImmutable |
DOFImmutable is a marker interface which is a clue to developers that objects may be treated as immutable.
|
DOFObject.DefineOperationListener |
This interface is used to receive asynchronous define completion for define requests.
|
DOFObject.EventOperationListener | Deprecated
Replaced by
DOFRegistration.Listener |
DOFObject.GetOperationListener |
This interface is implemented by requestors to receive information from asynchronous get operations.
|
DOFObject.InvokeOperationListener |
This interface is implemented by requestors to receive information from asynchronous invoke operations.
|
DOFObject.Provider |
This interface is implemented by providers to provide Properties, Methods, Events, etc.
|
DOFObject.SessionOperationListener |
This interface is implemented by requestors to receive asynchronous session completion for session requests.
|
DOFObject.SetOperationListener |
This interface is implemented by requestors to receive information from asynchronous set operations.
|
DOFObject.SubscribeOperationListener | Deprecated
Replaced by
DOFSubscription.Listener |
DOFOperation |
DOFOperation encapsulates methods for working with
operations while they are pending processing or during various phases of
processing.
|
DOFOperation.Advertise |
Extends DOFOperation with capabilities and data specific to an Advertise operation.
|
DOFOperation.Connect |
Extends DOFOperation with capabilities and data specific to a opening a DOFConnection.
|
DOFOperation.Define |
Extends DOFOperation with capabilities and data specific to a Define operation.
|
DOFOperation.Get |
Extends DOFOperation with capabilities and data specific to a Get operation.
|
DOFOperation.Interest |
Extends DOFOperation with capabilities and data specific to an Interest operation.
|
DOFOperation.Invoke |
Extends DOFOperation with capabilities and data specific to an Invoke operation.
|
DOFOperation.OperationListener |
Base interface for listening to operations.
|
DOFOperation.Provide |
Extends DOFOperation with capabilities and data specific to a Provide operation.
|
DOFOperation.Query |
Extends DOFOperation with capabilities and data specific to a Query operation.
|
DOFOperation.Register |
Extends DOFOperation with capabilities and data specific to a Register operation.
|
DOFOperation.RetryTime |
RetryTime is used to determine when to send the next retry.
|
DOFOperation.Session |
Extends DOFOperation with capabilities and data specific to a Session operation.
|
DOFOperation.Session.DataTransform |
The data transform mechanism adds to the security of the data through a
DOFOperation.Session . |
DOFOperation.Set |
Extends DOFOperation with capabilities and data specific to a Set operation.
|
DOFOperation.Start |
Extends DOFOperation with capabilities and data specific to a starting a DOFServer.
|
DOFOperation.Subscribe |
Extends DOFOperation with capabilities and data specific to a Subscribe operation.
|
DOFProtocolFactory |
Creates protocol layers and instances.
|
DOFProviderInfo |
This class contains information about a provider.
|
DOFRegistration.Listener |
This interface is implemented by requestors to receive updates.
|
DOFRequest |
Encapsulates general information about a DOF request.
|
DOFRequest.Get |
This class extends DOFRequest with capabilities and data specific to returning results from
DOFObject.Provider.get(org.opendof.core.oal.DOFOperation.Provide, org.opendof.core.oal.DOFRequest.Get, org.opendof.core.oal.DOFInterface.Property) via either either DOFRequest.Get.respond(org.opendof.core.oal.DOFValue) method. |
DOFRequest.Invoke |
This class extends DOFRequest with capabilities and data specific to returning results from
DOFObject.Provider.invoke(org.opendof.core.oal.DOFOperation.Provide, org.opendof.core.oal.DOFRequest.Invoke, org.opendof.core.oal.DOFInterface.Method, java.util.List<org.opendof.core.oal.DOFValue>) via one of the respond methods. |
DOFRequest.Register |
This class extends DOFRequest with capabilities and data specific to returning results from
DOFObject.Provider.register(org.opendof.core.oal.DOFOperation.Provide, org.opendof.core.oal.DOFRequest.Register, org.opendof.core.oal.DOFInterface.Event) via one of the respond methods. |
DOFRequest.Session |
This class extends DOFRequest with capabilities and data specific to returning results from
DOFObject.Provider.session(org.opendof.core.oal.DOFOperation.Provide, org.opendof.core.oal.DOFRequest.Session, org.opendof.core.oal.DOFObject, org.opendof.core.oal.DOFInterfaceID, org.opendof.core.oal.DOFObjectID, org.opendof.core.oal.DOFInterfaceID) via one of the respond methods. |
DOFRequest.Set |
This class extends DOFRequest with capabilities and data specific to returning results from
DOFObject.Provider.set(org.opendof.core.oal.DOFOperation.Provide, org.opendof.core.oal.DOFRequest.Set, org.opendof.core.oal.DOFInterface.Property, org.opendof.core.oal.DOFValue) via one of the respond methods. |
DOFRequest.Subscribe |
This class extends DOFRequest with capabilities and data specific to returning results from
DOFObject.Provider.subscribe(org.opendof.core.oal.DOFOperation.Provide, org.opendof.core.oal.DOFRequest.Subscribe, org.opendof.core.oal.DOFInterface.Property, int) via one of the respond methods. |
DOFRequest.SubscribeGet |
This class extends DOFRequest.Get so as to identify the specific Subscribe request.
|
DOFResult<T> |
DOFResult encapsulates possible errors returned by a DOF request along with information
about the provider of the result.
|
DOFServer.StartOperationListener |
This interface is used for the completion notification for asynchronous
start requests.
|
DOFServer.State |
This class represents the instantaneous state of the server at a given time.
|
DOFServer.StateListener |
StateListener is used for notification purposes when a server's state changes.
|
DOFSubscription.Listener |
This interface is implemented by requestors to receive updates.
|
DOFSystem.ActivateInterestListener |
Listener for
DOFInterestLevel.ACTIVATE -level interest (and higher) requests, used by Providers to react to interest being expressed by Requestor. |
DOFSystem.InterestOperationListener |
This interface is used by Requestors to receive asynchronous interest completion for interest requests.
|
DOFSystem.QueryOperationListener |
The QueryOperationListener defines listener methods that provide notification
of objects and their provided interfaces being added and removed from the system.
|
DOFSystem.RouteListener |
Objects implement the RouteListener interface to receive information about routes being added and removed.
|
DOFSystem.State |
This class represents the instantaneous state of the system at a given time.
|
DOFSystem.StateListener |
This interface can be implemented to provide a listener for the state of a
DOFSystem . |
DOFType.Context.Resolver |
In order to resolve forward references, classes must register the routine
that will be called by the context when the type is finally read in.
|
DOFValue |
This interface defines common functionality for all values that can be used by the OAL.
|
Class | Description |
---|---|
DOF |
The DOF class represents a DOF networking node.
|
DOF.Config |
The Config class specifies the initial configuration to use when creating a DOF.
|
DOF.Config.Builder |
This class enables you to customize the configuration of a DOF.
|
DOF.DefaultProtocolFactory |
The default protocol factory implements
DOFProtocolFactory and is the factory that is used unless
you create your own. |
DOF.Log |
The Log class contains logging methods for both sending (
DOF.Log ) and receiving (DOF.Log.Listener ) log messages. |
DOF.Runtime |
The Runtime class enables access to runtime information about the associated DOF, including traffic statistics and information
about active connections and servers.
|
DOFAddress |
This class represents an address in the DOF network.
|
DOFAuthenticator |
This class is the basis for authenticating credentials within a domain.
|
DOFAuthenticator.AuthenticationNode |
This represents an Authentication-type node in the Storage.
|
DOFAuthenticator.Config |
This class represents the configuration for an authenticator.
|
DOFAuthenticator.Config.Builder |
The authenticator configuration builder.
|
DOFAuthenticator.RemoteDomainNode |
This represents a Remote Domain-type node in the Storage.
|
DOFAuthenticator.SecureGroupNode |
This represents a Secure Group-type node in the Storage.
|
DOFAuthenticator.SecureGroupNode.GroupConfig |
The secure group configuration parameters for a node that represents a secure group.
|
DOFConnection |
DOFConnection represents an ability to communicate with other nodes in a DOF
network.
|
DOFConnection.Config |
This class contains configuration information required for a DOFConnection.
|
DOFConnection.Config.Builder |
This class creates connection configurations.
|
DOFConnection.Config.BuilderAS |
This class creates connection configurations for connecting to an Authentication Server.
|
DOFConnection.Config.BuilderGroup |
This class creates
DOFConnection.Type.GROUP connection configurations. |
DOFConnection.Config.BuilderHub |
This class creates
DOFConnection.Type.HUB connection configurations. |
DOFConnection.Config.BuilderPoint |
This class creates
DOFConnection.Type.POINT connection configurations. |
DOFConnection.Config.BuilderSecureDatagram |
This class creates secure
DOFConnection.Type.DATAGRAM connection configurations. |
DOFConnection.Config.BuilderSecureStream |
This class creates secure
DOFConnection.Type.STREAM connection configurations. |
DOFConnection.Config.BuilderStateless |
This class creates unsecure
DOFConnection.Type.DATAGRAM_STATELESS connection configurations. |
DOFConnection.Config.BuilderUnsecureDatagram |
This class creates unsecure
DOFConnection.Type.DATAGRAM connection configurations. |
DOFConnection.Config.BuilderUnsecureMulticast |
This class creates unsecure multicast
DOFConnection.Type.DATAGRAM connection configurations. |
DOFConnection.Config.BuilderUnsecureStream |
This class creates unsecure
DOFConnection.Type.STREAM connection configurations. |
DOFConnection.StreamRequest |
This represents a request for a
DOFConnection.Type.STREAM connection to a specific, target DOFAddress.Type.UNICAST
address based on the desire (expressed by interest operations) for a STREAM connection and the presence of a matching
binding. |
DOFCredentials |
This class represents authentication credentials (identity, secret, etc.).
|
DOFCredentials.Key |
This class represents authentication using a preshared 256-bit key.
|
DOFCredentials.Password |
Password credentials are used to authenticate with a password.
|
DOFDomain |
This class represents a route to a domain and provides a view for the state of that domain.
|
DOFDomain.Config |
Represents a configuration for a DOFDomain.
|
DOFDomain.Config.Builder |
This class is the builder for a
DOFDomain.Config . |
DOFGroupAddress |
This class represents group addresses that are used to join secure multicast groups.
|
DOFInterface |
A DOFInterface defines a set of possible interactions with a DOFObject, which
is typically remote (across the network).
|
DOFInterface.Builder |
Builder is used to build DOFInterfaces.
|
DOFInterface.Event |
Defines an Event as part of a DOFInterface.
|
DOFInterface.Exception |
Defines an Exception as part of a DOFInterface.
|
DOFInterface.Item |
Defines Interface items.
|
DOFInterface.Method |
Defines a Method (or function) as part of a DOFInterface.
|
DOFInterface.Property |
Defines a property as part of a DOFInterface.
|
DOFInterfaceID |
Represents an Interface Identifier (IID).
|
DOFInterfaceID.Type |
Implementation of
DOFType that matches DOFInterfaceID . |
DOFListenerInvoker |
Wraps application behavior in a Runnable and a try/catch
that will redirect the exception to the registered
DOF.UncaughtExceptionListener s
and to DOF.Log at level ERROR . |
DOFObject |
The DOFObject class represents an DOF Provider Object and is one of the core
classes of the framework.
|
DOFObject.DefaultProvider |
The DefaultProvider class implements
DOFObject.Provider . |
DOFObjectID |
DOFObjectID is the common representation for all DOF object identifiers.
|
DOFObjectID.Attribute |
The Attribute class is used to add attributes to a DOFObjectID.
|
DOFObjectID.Authentication |
The Authentication class is a subclass of DOFObjectID which is used to designate the DOFObjectID as an Authentication type.
|
DOFObjectID.Authentication.Type |
Implementation of
DOFType that matches DOFObjectID.Authentication . |
DOFObjectID.Domain |
The Domain class is a subclass of DOFObjectID which is used to designate the DOFObjectID as a Domain type.
|
DOFObjectID.Domain.Type |
Implementation of
DOFType that matches DOFObjectID.Domain . |
DOFObjectID.Source |
The Source class is a subclass of DOFObjectID which is used to designate the DOFObjectID as a Source type.
|
DOFObjectID.Source.Type |
Implementation of
DOFType that matches DOFObjectID.Source . |
DOFObjectID.Type | |
DOFOperation.Bridge |
A Bridge allows incoming operations on a connection or server to 'bridge' into a new security scope.
|
DOFOperation.Bridge.Config |
Represents a configuration for a Bridge.
|
DOFOperation.Bridge.Config.Builder |
This class can be used to build a new
DOFOperation.Bridge.Config |
DOFOperation.Control |
The Control class is used with DOFRequestors for controlling the behavior of request operations.
|
DOFOperation.Filter |
The Filter class provides a way for applications to specify the type of traffic
that can be sent or received on connections, servers, and systems.
|
DOFOperation.Filter.Builder |
This class creates filters.
|
DOFPacket |
DOFPacket represents a packet, suitable for transmission across a network.
|
DOFProtocolNegotiator |
Protocol negotiators control the behavior of connected stacks.
|
DOFQuery |
The DOFQuery class is used to specify filters for calling
DOFSystem.QueryOperationListener when object interfaces are added to or
removed from the system. |
DOFQuery.Builder |
Builder is used to build DOFQueries.
|
DOFRegistration |
This class maintains an event registration.
|
DOFRegistration.State |
This is a snapshot of the DOFRegistration's state.
|
DOFRouteInfo |
This class adds additional information to DOFProviderInfo that is useful for routing.
|
DOFSecurityScope |
DOFSecurityScope represents a single security scope, implicitly associated with a permission.
|
DOFServer |
DOFServer is associated with a DOF.
|
DOFServer.Config |
This class represents server configuration options.
|
DOFServer.Config.Builder |
This class creates server configurations.
|
DOFServer.Config.BuilderAS |
This class creates secure
DOFServer.Type.DATAGRAM server configurations. |
DOFServer.Config.BuilderSecureDatagram |
This class creates secure
DOFServer.Type.DATAGRAM server configurations. |
DOFServer.Config.BuilderSecureStream |
This class creates secure
DOFServer.Type.STREAM server configurations. |
DOFServer.Config.BuilderUnsecureDatagram |
This class creates unsecure
DOFServer.Type.DATAGRAM server configurations. |
DOFServer.Config.BuilderUnsecureMulticast |
This class creates unsecure multicast
DOFServer.Type.DATAGRAM server configurations. |
DOFServer.Config.BuilderUnsecureStream |
This class creates unsecure
DOFServer.Type.STREAM server configurations. |
DOFSubscription |
This class maintains a subscription.
|
DOFSubscription.State |
This is a snapshot of the DOFSubscription's state.
|
DOFSystem |
DOFSystem is the primary class within DOF for handling DOF objects within a security context.
|
DOFSystem.Config |
This class contains configuration information required for a DOFSystem.
|
DOFSystem.Config.Builder |
This class creates system configurations.
|
DOFSystem.Config.BuilderSecure |
This class creates secure
DOFSystem configurations. |
DOFSystem.Config.BuilderUnsecure |
This class creates unsecure
DOFSystem configurations. |
DOFType |
This base class defines common functionality for all types that can be used by the OAL,
and provides a base implementation for most of that functionality.
|
DOFType.Context |
Manages a set of type definitions that can refer to each other by using indexes.
|
DOFType.Nullable |
Create a type that references another type or can take the value
null . |
DOFType.Typedef |
Create a type that is defined in terms of another type.
|
DOFUtil |
Utility class for the DOF library.
|
Enum | Description |
---|---|
DOF.Log.Level |
Logging priority levels.
|
DOF.SecurityDesire |
The SecurityDesire enumeration types represent the security levels that can be imposed on connections
DOFConnection and servers DOFServer . |
DOFAddress.Type |
Address types.
|
DOFAuthenticator.SecurityType |
The type of security associated with a security request.
|
DOFConnection.Direction |
This enumeration represents the different connection directions.
|
DOFConnection.Type |
This enumeration represents the different types of connections.
|
DOFInterestLevel |
Indicates the level of interest a requestor has in provided objects and interfaces.
|
DOFInterface.ItemType |
Defines the different types of interface items: Property, Method, Event, Exception.
|
DOFMarshalContext |
This interface represents the context of a marshal operation.
|
DOFOperation.ResponseLevel |
ResponseLevel specifies the level of responses resulting from a request.
|
DOFQuery.MatchStyle |
Represents the various styles of matching that may be performed during a query.
|
DOFRequest.Type |
Request transport types.
|
DOFRouteInfo.State |
This enumeration contains the reasons that a RouteListener will be notified.
|
DOFServer.Type |
This enumeration lists the types of servers.
|
Exception | Description |
---|---|
DOFAckTimeoutException |
This exception means that an operation has not been acknowledged within the time limit.
|
DOFApplicationErrorException |
This exception occurs when the provider implementation (or any application OperationListener implementation) has failed.
|
DOFDuplicateException |
This exception occurs when an operation or entry already exists and cannot be entered again.
|
DOFErrorException |
DOFErrorException encapsulates exceptions for error conditions that are not defined by an interface -- internal
exceptions, protocol defined exceptions, etc.
|
DOFException |
DOFException is the base class for all exceptions in the DOF and consists of an error code and error message.
|
DOFInsufficientResourcesException |
This exception occurs when a node, either a proxy or the provider, does not have resources available to accept or process the command.
|
DOFIOFailedException |
This exception means that a send or receive failed over a transport or I/O channel.
|
DOFMarshalException |
This exception represents errors in marshalling data to wire format.
|
DOFNotFoundException |
This exception means that the requested information cannot be found.
|
DOFNotReadableException |
This exception means that the property is not readable.
|
DOFNotSupportedException |
This exception means that the request does not match the interface (for example, a Get on a write-only property, or an Invoke on an Event).
|
DOFNotWritableException |
This exception means that the property is not writable.
|
DOFProtocolNegotiationFailedException |
This exception means that protocol negotiation failed when attempting to establish a connection.
|
DOFProviderException |
DOFProviderException is used by providers to throw exceptions that are defined
as part of a DOFInterface.
|
DOFRejectedException |
This exception occurs when an operation has been rejected.
|
DOFResultLostException |
This exception means that one or more results for this operation have been lost (not received).
|
DOFTerminatedException |
This exception occurs when the connection, server, or operation has been terminated.
|
DOFTimeoutException |
This exception occurs when an operation timed out.
|
DOFTooManyException |
This exception occurs when a limit has been reached.
|
DOFTransportFailedException |
This exception means that a transport has failed, usually resulting in a connection or server being shutdown.
|
DOFTypeMismatchException |
This exception means that a value or value list could not be written to or read from the wire.
|