com.neeve.sma

Class MessageEncodingTypeDescriptor

java.lang.Object

com.neeve.root.RootObject

com.neeve.sma.SmaObject

com.neeve.sma.MessageEncodingTypeDescriptor

public final class MessageEncodingTypeDescriptor
extends SmaObject

A message encoding type descriptor.

This class contains information to describe a message encoding type. It also contains methods to persist and load encoding type descriptors to/from Rumi configuration respositories.

Threading:

This class is safe for concurrent access by multiple threads.

Method Summary

Modifier and Type	Method and Description
static MessageEncodingTypeDescriptor	create(String name, int id, String serializerClassName, String reflectorClassName) Create an smaty message encoding type descriptor.
void	delete(IConfigRepository repo) Delete a message encoding type descriptor from a configuration repository.
static boolean	exists(IConfigRepository repo, String name) Checks if a message encoding type descriptor is present in a configuration repository.
static boolean	exists(String name) Checks if a message encoding type descriptor is present in the local configuration repository
int	getId() Get the id of the message encoding type that this descriptor describes.
String	getName() Get the name of the message encoding type that this descriptor describes.
String	getReflectorClassName() Get the java class implementing reflectors that can generically introspect messages with encoding types described by this class.
String	getSerializerClassName() Get the java class implementing serializers of messages with encoding types described by this class.
static MessageEncodingTypeDescriptor	load(IConfigRepository repo, String name) Create a message encoding type descriptor from a configuration repository.
static MessageEncodingTypeDescriptor	load(String name) Create a message encoding type descriptor from the local configuration repository.
static Map<Integer,MessageEncodingTypeDescriptor>	loadAll() Create message encoding type descriptors for all encodings in the local configuration repository.
static Map<Integer,MessageEncodingTypeDescriptor>	loadAll(IConfigRepository repo) Create message encoding type descriptors for all encodings in a configuration repository.
void	save(IConfigRepository repo) Save a message encoding type descriptor to a configuration repository.
String	toString() Returns a string representation of this object

Methods inherited from class com.neeve.root.RootObject

getChecked, getThreaded, getTracer

Methods inherited from class java.lang.Object

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

Method Detail

getName

public final String getName()

Get the name of the message encoding type that this descriptor describes.

getId

public final int getId()

Get the id of the message encoding type that this descriptor describes.

getSerializerClassName

public final String getSerializerClassName()

Get the java class implementing serializers of messages with encoding types described by this class.

getReflectorClassName

public final String getReflectorClassName()

Get the java class implementing reflectors that can generically introspect messages with encoding types described by this class.

save

public final void save(IConfigRepository repo)
                throws SmaException

Save a message encoding type descriptor to a configuration repository.

Parameters:

repo - The configuration respository to save the descriptor to.

Throws:

SmaException - Thrown in case an error in encountered during the saving of the object.

Threading:

This method is notsafe for concurrent access by multiple threads.

This method saves a message encoding type descriptor to a configuration repository. The descriptor is stored in a format suitable for loading subsequently using any of the load methods offered by this class.

delete

public final void delete(IConfigRepository repo)
                  throws SmaException

Delete a message encoding type descriptor from a configuration repository.

Parameters:

repo - The configuration respository to delete from.

Throws:

SmaException - Thrown in case an error in encountered during the deletion of the descriptor.

Threading:

This method is notsafe for concurrent access by multiple threads.

This method deletes a message encoding type descriptor from a configuration repository.

toString

public final String toString()

Returns a string representation of this object

Overrides:

toString in class Object

exists

public static boolean exists(IConfigRepository repo,
                             String name)

Checks if a message encoding type descriptor is present in a configuration repository.

Parameters:

repo - The configuration respository to check in.

name - The name of the encoding to check for.

Threading:

This method is safe for concurrent access by multiple threads.

exists

public static boolean exists(String name)

Checks if a message encoding type descriptor is present in the local configuration repository

Parameters:

name - The name of the encoding type to check for.

Threading:

This method is safe for concurrent access by multiple threads.

create

public static MessageEncodingTypeDescriptor create(String name,
                                                   int id,
                                                   String serializerClassName,
                                                   String reflectorClassName)

Create an smaty message encoding type descriptor.

Parameters:

name - The name of the encoding.

id - The encoding's unique identifier.

serializerClassName - The name of the encodings's serializer class.

reflectorClassName - The name of the class that can generically introspect messages of an encoding type.

Threading:

This method is safe for concurrent access by multiple threads.

load

public static MessageEncodingTypeDescriptor load(IConfigRepository repo,
                                                 String name)
                                          throws SmaException

Create a message encoding type descriptor from a configuration repository.

Parameters:

repo - The configuration respository to create the descriptor from.

name - The name of the encoding.

Throws:

SmaException

Threading:

This method is safe for concurrent access by multiple threads.

This method creates and creates a message encoding type descriptor from a configuration repository.

load

public static MessageEncodingTypeDescriptor load(String name)
                                          throws SmaException

Create a message encoding type descriptor from the local configuration repository.

Parameters:

name - The name of the encoding.

Throws:

SmaException

Threading:

This method is safe for concurrent access by multiple threads.

This method creates and initializes a message encoding type descriptor from the local configuration repository.

loadAll

public static Map<Integer,MessageEncodingTypeDescriptor> loadAll(IConfigRepository repo)
                                                          throws SmaException

Create message encoding type descriptors for all encodings in a configuration repository.

Parameters:

repo - The configuration respository to load the encodings from.

Returns:

Returns the set of encoding type descriptors.

This method creates and initializes message encoding type descriptors for each of the providers present in the configuration repository.

Throws:

SmaException

Threading:

This method is safe for concurrent access by multiple threads.

loadAll

public static Map<Integer,MessageEncodingTypeDescriptor> loadAll()
                                                          throws SmaException

Create message encoding type descriptors for all encodings in the local configuration repository.

Returns:

Returns the set of message encoding types.

This method creates and initializes message encoding type descriptors for each of the encodings present in the local configuration repository.

Throws:

SmaException

Threading:

This method is safe for concurrent access by multiple threads.