com.neeve.sma

Class MessagingProviderDescriptor

java.lang.Object

com.neeve.root.RootObject

com.neeve.sma.SmaObject

com.neeve.sma.MessagingProviderDescriptor

public final class MessagingProviderDescriptor
extends SmaObject

A messaging provider descriptor.

This class contains information to describe a messaging provider and contains methods to persist and load provider descriptors to/from X Platform configuration respositories.

Threading:

This class is safe for concurrent access by multiple threads.

Method Summary

Methods

Modifier and Type	Method and Description
static MessagingProviderDescriptor	create(String name, String className) Create an smaty provider descriptor.
void	delete(IConfigRepository repo) Delete a provider descriptor from a configuration repository.
static boolean	exists(IConfigRepository repo, String name) Checks if a provider descriptor is present in a configuration repository
static boolean	exists(String name) Checks if a provider descriptor is present in the local configuration repository
String	getClassName() Get the java class implementing providers of the type of this class.
String	getName() Get the name of the provider that this descriptor describes.
Properties	getProperties() Get the provider properties
static MessagingProviderDescriptor	load(IConfigRepository repo, String name) Create a provider descriptor from a configuration repository.
static MessagingProviderDescriptor	load(String name) Create a provider descriptor from the local configuration repository.
static Set<MessagingProviderDescriptor>	loadAll() Create provider descriptors for all providers in the local configuration repository.
static Set<MessagingProviderDescriptor>	loadAll(IConfigRepository repo) Create provider descriptors for all providers in a configuration repository.
void	save(IConfigRepository repo) Save a provider descriptor to a configuration repository.
void	setProperties(Properties props) Set a set of provider properties.
void	setProperty(String name, String val) Set a provider property.
String	toString() Returns a string representation of this object

Methods inherited from class com.neeve.root.RootObject

getChecked, getThreaded, getTracer, setChecked, setTracer

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 provider that this descriptor describes.

getClassName

public final String getClassName()

Get the java class implementing providers of the type of this class.

setProperty

public final void setProperty(String name,
               String val)

Set a provider property.

setProperties

public final void setProperties(Properties props)

Set a set of provider properties.

getProperties

public final Properties getProperties()

Get the provider properties

save

public final void save(IConfigRepository repo)
                throws SmaException

Save a provider 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 messaging provider 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 provider descriptor from a configuration repository.

Parameters:

repo - The configuration respository to delete the descriptor 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 provider 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 provider descriptor is present in a configuration repository

Parameters:

repo - The configuration respository to check in.

name - The name of the provider to check for.

Threading:

This method is safe for concurrent access by multiple threads.

exists

public static boolean exists(String name)

Checks if a provider descriptor is present in the local configuration repository

Parameters:

name - The name of the provider to check for.

Threading:

This method is safe for concurrent access by multiple threads.

create

public static MessagingProviderDescriptor create(String name,
                                 String className)

Create an smaty provider descriptor.

Parameters:

name - The name of the provider.

className - The name of the provider's main class.

Threading:

This method is safe for concurrent access by multiple threads.

load

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

Create a provider descriptor from a configuration repository.

Parameters:

repo - The configuration respository to create the descriptor from.

name - The name of the provider.

Throws:

SmaException

Threading:

This method is safe for concurrent access by multiple threads.

This method creates and initializes a provider descriptor from a configuration repository.

load

public static MessagingProviderDescriptor load(String name)
                                        throws SmaException

Create a provider descriptor from the local configuration repository.

Parameters:

name - The name of the provider.

Throws:

SmaException

Threading:

This method is safe for concurrent access by multiple threads.

This method creates and initializes a provider descriptor from the local configuration repository.

loadAll

public static Set<MessagingProviderDescriptor> loadAll(IConfigRepository repo)
                                                throws SmaException

Create provider descriptors for all providers in a configuration repository.

Parameters:

repo - The configuration respository to create the descriptors from.

Returns:

Returns the set of provider descriptors.

This method creates and initializes provider descriptors for each of the providers present in a configuration repository.

Throws:

SmaException

Threading:

This method is safe for concurrent access by multiple threads.

loadAll

public static Set<MessagingProviderDescriptor> loadAll()
                                                throws SmaException

Create provider descriptors for all providers in the local configuration repository.

Returns:

Returns the set of provider descriptors.

This method creates and initializes provider descriptors for each of the providers present in the local configuration repository.

Throws:

SmaException

Threading:

This method is safe for concurrent access by multiple threads.