RedDwarf Server 0.10.1 Internal API

Provides the interface to the Project Darkstar Server.

See:
Description

External API

com.sun.sgs.app	Provides the interface to the RedDwarf Server used by application developers.
com.sun.sgs.app.util	Provides utilities for use by RedDwarf Server application developers.
com.sun.sgs.internal	Provides implementation hooks for a RedDwarf Server to configure the underlying behavior of the system.
com.sun.sgs.protocol.simple	Protocol specification classes.

Internal API

com.sun.sgs.auth	Provides interfaces for identities and how to authenticate them.
com.sun.sgs.kernel	Provides the core system interfaces used by the RedDwarf Server.
com.sun.sgs.kernel.schedule	Provides queue ordering and retry behavior abstractions that may be used by scheduler implementations.
com.sun.sgs.management	Provides the RedDwarf management interfaces exposed via JMX.
com.sun.sgs.nio.channels	Defines asynchronous channels that are connected to a stream-oriented connecting or listening socket, or a datagram-oriented socket.
com.sun.sgs.nio.channels.spi	Service-provider classes for the com.sun.sgs.nio.channels package.
com.sun.sgs.profile	Interfaces used to create profiling information.
com.sun.sgs.protocol	Provides interfaces for the protocol layer.
com.sun.sgs.service	Provides interfaces and classes for services provided by the RedDwarf Server.
com.sun.sgs.service.store	Provides interfaces and classes for pluggable data stores of DataService implementations.
com.sun.sgs.service.store.db	Provides a database abstraction layer for use by the default implementation of the DataStore class.
com.sun.sgs.service.task	Provides interfaces and classes for pluggable TaskService implementations.
com.sun.sgs.transport	Provides interfaces for the transport layer.

Provides the interface to the Project Darkstar Server.

API conventions

Interfaces in this API do not extend Serializable even if classes that implement those interfaces are required to implement it.

The API uses this approach to avoid an issue involving the serialVersionUID field. To guard against serialVersionUID mismatches, as well as to improve performance, any class or interface that extends Serializable should declare a serialVersionUID field. Since public interfaces can only declare public members, a public interface that extends Serializable would need to have a public serialVersionUID field, meaning that any classes implementing the interface would inherit its serialVersionUID, and so would be prevented from controlling their versioning separately. This issue does not crop up for interfaces that do not extend Serializable, since they by definition have a serialVersionUID of 0.

Documentation conventions

Unless explicitly specified otherwise, all documentation for these APIs uses the following conventions:

• If null is not explicitly specified as an acceptable value for a method parameter, then the method does not permit null to be passed as a value for that parameter, and will throw a NullPointerException if null is passed (though it is left unspecified whether or not NullPointerException takes precedence over other types of exceptions that could also be thrown).
• If null is not explicitly specified as an acceptable value for a method to return, then the method is not permitted to return null.
• If null is not explicitly specified as an acceptable value for a given collection (e.g. Collection, List, or Set) to contain, then the collection is not permitted to contain null elements.

Methods that can accept or return null values generally specify this at least in their parameter-level (i.e. @param tag) or return value-level (i.e. @return tag) documentation.

License

All classes available in the above packages are released under the GNU GPLv2 with Classpath exception license. Their use is subject to the terms of this license.