org.jboss.as.naming

Interface NamingStore

All Known Subinterfaces:

WritableNamingStore

All Known Implementing Classes:

InMemoryNamingStore, ServiceBasedNamingStore, WritableServiceBasedNamingStore

public interface NamingStore

Interface to layout a contract for naming entry back-end storage. This will be used by NamingContext instances to manage naming entries.

Author:

John E. Bailey, Eduardo Martins

Method Summary

Modifier and Type	Method and Description
void	addNamingListener(Name target, int scope, NamingListener listener) Add a NamingListener for a specific target and scope.
void	close() Close the naming store and cleanup any resource used by the store.
Name	getBaseName() Retrieves the store's base name, which is the prefix for the absolute name of each entry in the store.
List<NameClassPair>	list(Name name) List the NameClassPair instances for the provided name.
List<Binding>	listBindings(Name name) List the binding objects for a specified name.
Object	lookup(Name name) Look up an object from the naming store.
Object	lookup(Name name, boolean dereference) Look up an object from the naming store.
void	removeNamingListener(NamingListener listener) Remove a NamingListener from all targets and scopes

Method Detail

getBaseName

Name getBaseName()
          throws NamingException

Retrieves the store's base name, which is the prefix for the absolute name of each entry in the store.

Returns:

Throws:

NamingException

lookup

Object lookup(Name name)
       throws NamingException

Look up an object from the naming store. An entry for this name must already exist.

Parameters:

name - The entry name

Returns:

The object from the store.

Throws:

NamingException - If any errors occur.

lookup

Object lookup(Name name,
              boolean dereference)
       throws NamingException

Look up an object from the naming store. An entry for this name must already exist.

Parameters:

name - The entry name

dereference - if true indicates that managed references should retrieve the instance.

Returns:

The object from the store.

Throws:

NamingException - If any errors occur.

list

List<NameClassPair> list(Name name)
                  throws NamingException

List the NameClassPair instances for the provided name. An entry for this name must already exist and be bound to a valid context.

Parameters:

name - The entry name

Returns:

The NameClassPair instances

Throws:

NamingException - If any errors occur

listBindings

List<Binding> listBindings(Name name)
                    throws NamingException

List the binding objects for a specified name. An entry for this name must already exist and be bound to a valid context.

Parameters:

name - The entry name

Returns:

The bindings

Throws:

NamingException - If any errors occur

close

void close()
    throws NamingException

Close the naming store and cleanup any resource used by the store.

Throws:

NamingException - If any errors occur

addNamingListener

void addNamingListener(Name target,
                       int scope,
                       NamingListener listener)

Add a NamingListener for a specific target and scope.

Parameters:

target - The target name to add the listener to

scope - The listener scope

listener - The listener

removeNamingListener

void removeNamingListener(NamingListener listener)

Remove a NamingListener from all targets and scopes

Parameters:

listener - The listener