info.pppc.base.system.nf

Class NFCollection

java.lang.Object

info.pppc.base.system.nf.NFCollection

All Implemented Interfaces:

ISerializable, IExtension

public final class NFCollection
extends java.lang.Object
implements ISerializable, IExtension

The non-functional collection is used to represent requirements on the communication stack. The collection consists of several dimensions that specify the individual requirements. Convenience methods are provided for typical compositions. These can be overwritten in proxies to define specific requirements.

Author:

Marcus Handte

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ABBREVIATION The abbreviation used for this class during serialization.
static short	TYPE_ASYNCHRONOUS A type that can be used to create the default collection for an invocation that is a asynchronous.
static short	TYPE_EXCHANGE A type that can be used to create the default collection for an invocation that establishes a session key using Diffie Hellmann over an authenticated 3-way handshake.
static short	TYPE_STREAM A type that can be used to create the default collection for an invocation that opens a stream.
static short	TYPE_SYNCHRONOUS A type that can be used to create the default collection for an invocation that is asynchronous.

Fields inherited from interface info.pppc.base.system.IExtension

EXTENSION_COMPRESSION, EXTENSION_DISCOVERY, EXTENSION_ENCRYPTION, EXTENSION_ROUTING, EXTENSION_SEMANTIC, EXTENSION_SERIALIZATION, EXTENSION_TRANSCEIVER

Constructor Summary

Constructors

Constructor and Description
NFCollection() Creates a new collection with no properties set.

Method Summary

Methods

Modifier and Type	Method and Description
NFDimension	addDimension(short extension, NFDimension dimension) Adds a dimension to the specified extension.
NFCollection	copy(boolean deep) Creates a copy of this collection of parameters.
static NFCollection	getDefault(short type, boolean gateway) A factory method that creates the default non-functional collections for invocations delivered with statically generated proxies.
NFDimension	getDimension(short extension, short dimension) Returns the dimension from the specified extension with the specified dimension identifier.
NFDimension[]	getDimensions(short extension) Returns all dimensions that have been specified for the specified extension.
void	readObject(IObjectInput input) Deserializes the object from the stream.
void	removeDimension(short extension, short dimension) Removes the specified dimension from the specified extension requirement.
java.lang.String	toString() Returns a string representation of the collection.
void	writeObject(IObjectOutput output) Serializes the object to the stream.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ABBREVIATION

public static final java.lang.String ABBREVIATION

The abbreviation used for this class during serialization.

See Also:

Constant Field Values

TYPE_EXCHANGE

public static final short TYPE_EXCHANGE

A type that can be used to create the default collection for an invocation that establishes a session key using Diffie Hellmann over an authenticated 3-way handshake.

See Also:

Constant Field Values

TYPE_STREAM

public static final short TYPE_STREAM

A type that can be used to create the default collection for an invocation that opens a stream. The stream will bypass most of base's robustness mechanisms, however, it will be faster if large amounts of data need to be transferred.

See Also:

Constant Field Values

TYPE_ASYNCHRONOUS

public static final short TYPE_ASYNCHRONOUS

A type that can be used to create the default collection for an invocation that is a asynchronous. An asynchronous invocation does not have a return value and thus, it can be sent best effort without signaling.

See Also:

Constant Field Values

TYPE_SYNCHRONOUS

public static final short TYPE_SYNCHRONOUS

A type that can be used to create the default collection for an invocation that is asynchronous. A synchronous invocation or a deferred synchronous invocation do have results and thus they must be delivered with signaling.

See Also:

Constant Field Values

Constructor Detail

NFCollection

public NFCollection()

Creates a new collection with no properties set.

Method Detail

getDefault

public static NFCollection getDefault(short type,
                      boolean gateway)

A factory method that creates the default non-functional collections for invocations delivered with statically generated proxies.

Parameters:

gateway - The type that indicates whether routing should use remote gateways to connect.

type - The type of collection to create. This can be one of the type constants specified in this class.

Returns:

An collection that will enforce the default usage for the specified type.

addDimension

public NFDimension addDimension(short extension,
                       NFDimension dimension)

Adds a dimension to the specified extension.

Parameters:

extension - The extension to add the dimension.

dimension - The dimension that is added to the extension.

Returns:

The dimension that got replaced if any, else null.

getDimension

public NFDimension getDimension(short extension,
                       short dimension)

Returns the dimension from the specified extension with the specified dimension identifier.

Parameters:

extension - The extension to search for.

dimension - The identifier of the dimension to lookup

Returns:

The dimension or null if it doesn't exist.

getDimensions

public NFDimension[] getDimensions(short extension)

Returns all dimensions that have been specified for the specified extension.

Parameters:

extension - The extension to lookup.

Returns:

The dimensions that have been specified for the extension.

removeDimension

public void removeDimension(short extension,
                   short dimension)

Removes the specified dimension from the specified extension requirement.

Parameters:

extension - The extension point to consider during removal.

dimension - The dimension to remove from the specified extension.

readObject

public void readObject(IObjectInput input)
                throws java.io.IOException

Deserializes the object from the stream.

Specified by:

readObject in interface ISerializable

Parameters:

input - The input to read from.

Throws:

java.io.IOException - Thrown if the deserialization failed.

writeObject

public void writeObject(IObjectOutput output)
                 throws java.io.IOException

Serializes the object to the stream.

Specified by:

writeObject in interface ISerializable

Parameters:

output - The output to write to.

Throws:

java.io.IOException - Thrown if the serialization failed.

copy

public NFCollection copy(boolean deep)

Creates a copy of this collection of parameters. The flag indicates whether the returned copy is deep or shallow. If a deep copy is created, all dimensions are copied, too.

Parameters:

deep - Set to true to create a deep copy, set to false to create a shallow copy.

Returns:

A copy of the collection of non-functional parameters.

toString

public java.lang.String toString()

Returns a string representation of the collection.

Overrides:

toString in class java.lang.Object

Returns:

A string representation.