org.jboss.util.naming

Class NonSerializableFactory

java.lang.Object

org.jboss.util.naming.NonSerializableFactory

All Implemented Interfaces:

ObjectFactory

public class NonSerializableFactory
extends Object
implements ObjectFactory

A utility class that allows one to bind a non-serializable object into a local JNDI context. The binding will only be valid for the lifetime of the VM in which the JNDI InitialContext lives. An example usage code snippet is:

    // The non-Serializable object to bind
    Object nonserializable = ...;
    // An arbitrary key to use in the StringRefAddr. The best key is the jndi
    // name that the object will be bound under.
    String key = ...;
    // This places nonserializable into the NonSerializableFactory hashmap under key
    NonSerializableFactory.rebind(key, nonserializable);

    Context ctx = new InitialContext();
    // Bind a reference to nonserializable using NonSerializableFactory as the ObjectFactory
    String className = nonserializable.getClass().getName();
    String factory = NonSerializableFactory.class.getName();
    StringRefAddr addr = new StringRefAddr("nns", key);
    Reference memoryRef = new Reference(className, addr, factory, null);
    ctx.rebind(key, memoryRef);

Or you can use the rebind(Context, String, Object) convenience method to simplify the number of steps to:

    Context ctx = new InitialContext();
    // The non-Serializable object to bind
    Object nonserializable = ...;
    // The jndiName that the object will be bound into ctx with
    String jndiName = ...;
    // This places nonserializable into the NonSerializableFactory hashmap under key
    NonSerializableFactory.rebind(ctx, jndiName, nonserializable);

To unbind the object, use the following code snippet:

        new InitialContext().unbind(key);
        NonSerializableFactory.unbind(key);

Version:

$Revision$

Author:

Scott Stark.

See Also:

ObjectFactory, rebind(Context, String, Object)

Constructor Summary

Constructors

Constructor and Description
NonSerializableFactory()

Method Summary

Methods

Modifier and Type	Method and Description
static void	bind(String key, Object target) Place an object into the NonSerializableFactory namespace for subsequent access by getObject.
Object	getObjectInstance(Object obj, Name name, Context nameCtx, Hashtable env) Transform the obj Reference bound into the JNDI namespace into the actual non-Serializable object.
static Object	lookup(Name name) Lookup a value from the NonSerializableFactory map.
static Object	lookup(String key) Lookup a value from the NonSerializableFactory map.
static void	rebind(Context ctx, String key, Object target) A convenience method that simplifies the process of rebinding a non-serializable object into a JNDI context.
static void	rebind(Context ctx, String key, Object target, boolean createSubcontexts) A convenience method that simplifies the process of rebinding a non-serializable object into a JNDI context.
static void	rebind(Name name, Object target) A convenience method that simplifies the process of rebinding a non-serializable object into a JNDI context.
static void	rebind(Name name, Object target, boolean createSubcontexts) A convenience method that simplifies the process of rebinding a non-serializable object into a JNDI context.
static void	rebind(String key, Object target) Place or replace an object in the NonSerializableFactory namespce for subsequent access by getObject.
static void	unbind(Name name) Remove a binding from the NonSerializableFactory map.
static void	unbind(String key) Remove a binding from the NonSerializableFactory map.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NonSerializableFactory

public NonSerializableFactory()

Method Detail

bind

public static void bind(String key,
        Object target)
                 throws NameAlreadyBoundException

Place an object into the NonSerializableFactory namespace for subsequent access by getObject. There cannot be an already existing binding for key.

Parameters:

key - the name to bind target under. This should typically be the name that will be used to bind target in the JNDI namespace, but it does not have to be.

target - the non-Serializable object to bind.

Throws:

NameAlreadyBoundException - thrown if key already exists in the NonSerializableFactory map

rebind

public static void rebind(String key,
          Object target)

Place or replace an object in the NonSerializableFactory namespce for subsequent access by getObject. Any existing binding for key will be replaced by target.

Parameters:

key - the name to bind target under. This should typically be the name that will be used to bind target in the JNDI namespace, but it does not have to be.

target - the non-Serializable object to bind.

unbind

public static void unbind(String key)
                   throws NameNotFoundException

Remove a binding from the NonSerializableFactory map.

Parameters:

key - the key into the NonSerializableFactory map to remove.

Throws:

NameNotFoundException - thrown if key does not exist in the NonSerializableFactory map

unbind

public static void unbind(Name name)
                   throws NameNotFoundException

Remove a binding from the NonSerializableFactory map.

Parameters:

name - the name for the key into NonSerializableFactory map to remove. The key is obtained as name.toString().

Throws:

NameNotFoundException - thrown if key does not exist in the NonSerializableFactory map

lookup

public static Object lookup(String key)

Lookup a value from the NonSerializableFactory map.

Parameters:

key -

Returns:

the object bound to key is one exists, null otherwise.

lookup

public static Object lookup(Name name)

Lookup a value from the NonSerializableFactory map.

Parameters:

name -

Returns:

the object bound to key is one exists, null otherwise.

rebind

public static void rebind(Context ctx,
          String key,
          Object target)
                   throws NamingException

A convenience method that simplifies the process of rebinding a non-serializable object into a JNDI context.

Parameters:

ctx - the JNDI context to rebind to.

key - the key to use in both the NonSerializableFactory map and JNDI. It must be a valid name for use in ctx.bind().

target - the non-Serializable object to bind.

Throws:

NamingException - thrown on failure to rebind key into ctx.

rebind

public static void rebind(Name name,
          Object target)
                   throws NamingException

A convenience method that simplifies the process of rebinding a non-serializable object into a JNDI context. This version binds the target object into the default IntitialContext using name path.

Parameters:

name - the name to use as JNDI path name. The key into the NonSerializableFactory map is obtained from the toString() value of name. The name parameter cannot be a 0 length name. Any subcontexts between the root and the name must exist.

target - the non-Serializable object to bind.

Throws:

NamingException - thrown on failure to rebind key into ctx.

rebind

public static void rebind(Context ctx,
          String key,
          Object target,
          boolean createSubcontexts)
                   throws NamingException

A convenience method that simplifies the process of rebinding a non-serializable object into a JNDI context.

Parameters:

ctx - the JNDI context to rebind to.

key - the key to use in both the NonSerializableFactory map and JNDI. It must be a valid name for use in ctx.bind().

target - the non-Serializable object to bind.

createSubcontexts - a flag indicating if subcontexts of name should be created if they do not already exist.

Throws:

NamingException - thrown on failure to rebind key into ctx.

rebind

public static void rebind(Name name,
          Object target,
          boolean createSubcontexts)
                   throws NamingException

A convenience method that simplifies the process of rebinding a non-serializable object into a JNDI context. This version binds the target object into the default IntitialContext using name path.

Parameters:

name - the name to use as JNDI path name. The key into the NonSerializableFactory map is obtained from the toString() value of name. The name parameter cannot be a 0 length name.

target - the non-Serializable object to bind.

createSubcontexts - a flag indicating if subcontexts of name should be created if they do not already exist.

Throws:

NamingException - thrown on failure to rebind key into ctx.

getObjectInstance

public Object getObjectInstance(Object obj,
                       Name name,
                       Context nameCtx,
                       Hashtable env)
                         throws Exception

Transform the obj Reference bound into the JNDI namespace into the actual non-Serializable object.

Specified by:

getObjectInstance in interface ObjectFactory

Parameters:

obj - the object bound in the JNDI namespace. This must be an implementation of javax.naming.Reference with a javax.naming.RefAddr of type "nns" whose content is the String key used to location the non-Serializable object in the NonSerializableFactory map.

name - ignored.

nameCtx - ignored.

env - ignored.

Returns:

the non-Serializable object associated with the obj Reference if one exists, null if one does not.

Throws:

Exception