com.neeve.sma
Interface MessageViewFactory

All Known Implementing Classes:

RawMessageViewFactory, SrvMonAlertFactory, SrvMonCncFactory, SrvMonFactory, SrvMonLifecycleFactory

public interface MessageViewFactory

Represents a message view factory.

A message view factory manufactures specific message views. Each view factory is uniquely identified in the system via an identifier (a short value). Factories are dynamically loaded by the SMA runtime and used to reconstitute message views on the receive side.

Field Summary

static short	VFID_MAP Identifies the 'map' message view factory
static short	VFID_NULL Signifies a 'null view factory.
static short	VFID_PLATFORM_STATIC_LAST Identifies the last platform static factory id NOTE: BE VERY CAREFUL WHEN CHANGING THIS VALUE SINCE IT IS SYNCHRONIZED WITH THE ADM CODE GENERATOR, THE STO TYPE FACTORY AND ODS OBJECT FACTORY.
static short	VFID_RAW Identifies the 'raw' message view factory
static short	VFID_ROG_PACKET_MANAGER Identifies the ROG Packet Manager (link perf tool plugin) object factory.
static short	VFID_ROG_RAW Identify the 'rog raw' message factory.

Method Summary

MessageView	create(short type) Create a new message by type
short	getVfid() Get the factory's unique identifier
MessageView	wrap(short type, int encodingType, Object message) Wrap a message view around a message.

Field Detail

VFID_NULL

static final short VFID_NULL

Signifies a 'null view factory.

See Also:

Constant Field Values

VFID_RAW

static final short VFID_RAW

Identifies the 'raw' message view factory

See Also:

Constant Field Values

VFID_MAP

static final short VFID_MAP

Identifies the 'map' message view factory

See Also:

Constant Field Values

VFID_ROG_PACKET_MANAGER

static final short VFID_ROG_PACKET_MANAGER

Identifies the ROG Packet Manager (link perf tool plugin) object factory. Note: This tool does not interface with any other component. It executes in isolation and, therefore, the view factory repository will not have any other factories (other than the SMA system factories) registered with it. Therefore, it is ok for other factories to reuse this factory id.

See Also:

Constant Field Values

VFID_ROG_RAW

static final short VFID_ROG_RAW

Identify the 'rog raw' message factory. This factory allows creation of a raw replicatable messages.

See Also:

Constant Field Values

VFID_PLATFORM_STATIC_LAST

static final short VFID_PLATFORM_STATIC_LAST

Identifies the last platform static factory id NOTE: BE VERY CAREFUL WHEN CHANGING THIS VALUE SINCE IT IS SYNCHRONIZED WITH THE ADM CODE GENERATOR, THE STO TYPE FACTORY AND ODS OBJECT FACTORY. IF YOU NEED TO CHANGE THIS VALUE, THEN MAKE SURE YOU MAKE THE CORRESPONDING CHANGES IN ODS, STO AND ADM.

See Also:

Constant Field Values

Method Detail

getVfid

short getVfid()

Get the factory's unique identifier

Threading:

This method can be invoked concurrently by multiple threads.

create

MessageView create(short type)

Create a new message by type

Parameters:

type - The message view's type

Threading:

This method can be invoked concurrently by multiple threads.

wrap

MessageView wrap(short type,
                 int encodingType,
                 Object message)

Wrap a message view around a message.

Parameters:

type - The message view's type

encodingType - The message's encoding type

message - The serialized message to wrap the view around.

Threading:

This method can be invoked concurrently by multiple threads.