com.neeve.ods
Interface IStoreObjectFactory

All Known Implementing Classes:

AepEnvironmentFactory, AepFlowFactory, SrvMonAlertFactory, SrvMonCncFactory, SrvMonFactory, SrvMonLifecycleFactory

public interface IStoreObjectFactory

Represents an ODS object factory.

Threading:

An ODS object factory is safe for concurrent access by multiple threads.

An ODS object factory manufactures ODS store objects. Each object factory is uniquely identified in the system via an identifier (a short value). Factories are dynamically loaded by the ODS runtime. Although they can be used to create store objects explictly for the user, their primary role is to reconsitute replicated objects.

Field Summary

static short	OFID_ADM_ANNOTATED_CODE_TEST Identifies the ADM Annotated Code Test Root object factory.
static short	OFID_AEP_ENVIRONMENT_FACTORY Identifies the AEP Environment Factory
static short	OFID_AEP_FLOW_FACTORY Identifies the AEP Flow Factory
static short	OFID_NULL Signifies a 'null' object factory.
static short	OFID_ODS_BINDING_UNIT_TEST Identifies the ODS Binding Unit Test object factory.
static short	OFID_ODS_PERF_TOOL Identifies the ODS Perf Tool object factory.
static short	OFID_ODS_STRESS_TOOL Identifies the ODS Stress Tool object factory.
static short	OFID_ODS_TOOL Identifies the ODS Tool object factory.
static short	OFID_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 SMA VIEW FACTORY.
static short	OFID_ROG_RAW_FACTORY Identifies the Rog Raw Message Factory
static short	OFID_SERVER_FLOW_FACTORY

Method Summary

IStoreObject	create(short type, com.eaio.uuid.UUID id, IStoreObject.EncodingType encodingType, PktPacket serializedObject) Create an object from its serialized form
short	getOfid() Get the factory's unique identifier

Field Detail

OFID_NULL

static final short OFID_NULL

Signifies a 'null' object factory.

See Also:

Constant Field Values

OFID_ODS_TOOL

static final short OFID_ODS_TOOL

Identifies the ODS Tool object factory. Note: This tool does not interface with any other component. It executes in isolation and, therefore, the object factory repository will not have any other factories registered with it. Therefore, it is ok for other factories to reuse this factory id.

See Also:

Constant Field Values

OFID_ODS_PERF_TOOL

static final short OFID_ODS_PERF_TOOL

Identifies the ODS Perf Tool object factory. Note: This tool does not interface with any other component. It executes in isolation and, therefore, the object factory repository will not have any other factories registered with it. Therefore, it is ok for other factories to reuse this factory id.

See Also:

Constant Field Values

OFID_ODS_STRESS_TOOL

static final short OFID_ODS_STRESS_TOOL

Identifies the ODS Stress Tool object factory. Note: This tool does not interface with any other component. It executes in isolation and, therefore, the object factory repository will not have any other factories registered with it. Therefore, it is ok for other factories to reuse this factory id.

See Also:

Constant Field Values

OFID_ODS_BINDING_UNIT_TEST

static final short OFID_ODS_BINDING_UNIT_TEST

Identifies the ODS Binding Unit Test object factory. Note: This test does not interface with any other component. It executes in isolation and, therefore, the object factory repository will not have any other factories registered with it. Therefore, it is ok for other factories to reuse this factory id.

See Also:

Constant Field Values

OFID_ADM_ANNOTATED_CODE_TEST

static final short OFID_ADM_ANNOTATED_CODE_TEST

Identifies the ADM Annotated Code Test Root object factory. Note: This test does not interface with any other component. It executes in isolation and, therefore, the object factory repository will not have any other factories registered with it. Therefore, it is ok for other factories to reuse this factory id.

See Also:

Constant Field Values

OFID_AEP_FLOW_FACTORY

static final short OFID_AEP_FLOW_FACTORY

Identifies the AEP Flow Factory

See Also:

Constant Field Values

OFID_SERVER_FLOW_FACTORY

static final short OFID_SERVER_FLOW_FACTORY

See Also:

Constant Field Values

OFID_AEP_ENVIRONMENT_FACTORY

static final short OFID_AEP_ENVIRONMENT_FACTORY

Identifies the AEP Environment Factory

See Also:

Constant Field Values

OFID_ROG_RAW_FACTORY

static final short OFID_ROG_RAW_FACTORY

Identifies the Rog Raw Message Factory

See Also:

Constant Field Values

OFID_PLATFORM_STATIC_LAST

static final short OFID_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 SMA VIEW FACTORY. IF YOU NEED TO CHANGE THIS VALUE, THEN MAKE SURE YOU MAKE THE CORRESPONDING CHANGES IN SMA, STO AND ADM.

See Also:

Constant Field Values

Method Detail

getOfid

short getOfid()

Get the factory's unique identifier

Threading:

This method can be invoked concurrently by multiple threads.

create

IStoreObject create(short type,
                    com.eaio.uuid.UUID id,
                    IStoreObject.EncodingType encodingType,
                    PktPacket serializedObject)
                    throws Exception

Create an object from its serialized form

Parameters:

type - The type of the object to create. The object type is the unique identifier of the object relative to its object factory. The type is used to identify the object's Java class to instantiate

id - The id of the object to create. The object id is the unique identifier of an object in its ODS store.

encodingType - The object's content encoding type.

serializedObject - The serialized form of the object.

Throws:

Exception

Threading:

This method can be invoked concurrently by multiple threads.

This method is intended for use by the ODS runtime to reconstitute replicated store objects. The method should create an empty object, associate it with the specified id and deserialize its contents from the supplied packet (object's serialized form).