Package org.glassfish.api.naming
Interface GlassfishNamingManager
@Contract
public interface GlassfishNamingManager
The NamingManager provides an interface for various components to use naming functionality. It provides methods for
binding and unbinding environment properties, resource and ejb references.
-
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
bindToAppNamespace
(String appName, Collection<? extends JNDIBinding> bindings) Binds the bindings to module namespace of an application
Typically, to get access to application's namespace, invocation context must be set to appropriate application's context.
This API is useful in cases where containers within GlassFish need to bind the objects in application's name-space and do not have application's invocation contextvoid
bindToComponentNamespace
(String appName, String moduleName, String componentId, boolean treatComponentAsModule, Collection<? extends JNDIBinding> bindings) This method enumerates the env properties, ejb and resource references etc for a JEE component and binds them in the applicable java: namespace.void
bindToModuleNamespace
(String appName, String moduleName, Collection<? extends JNDIBinding> bindings) Binds the bindings to module namespace of an application
Typically, to get access to application's module namespace, invocation context must be set to appropriate application's context.
This API is useful in cases where containers within GlassFish need to bind the objects in application's module name-space and do not have application's invocation contextGet the initial context.initializeRemoteNamingSupport
(org.omg.CORBA.ORB orb) Initialize RMI-IIOP naming services<T> T
lookup
(String componentId, SimpleJndiName name) Lookup a naming entry for a particular componentId<T> T
lookup
(SimpleJndiName name) Lookup a naming entry<T> T
lookupFromAppNamespace
(String appName, SimpleJndiName name, Hashtable<?, ?> env) Lookup a naming entry in a particular application's namespace<T> T
lookupFromModuleNamespace
(String appName, String moduleName, SimpleJndiName name, Hashtable<?, ?> env) Lookup a naming entry in a particular application's module's namespacevoid
publishCosNamingObject
(SimpleJndiName name, Object obj, boolean rebind) Publish aRemote
orObject
object.void
publishObject
(Name name, Object obj, boolean rebind) Publish an object in the naming service.void
publishObject
(SimpleJndiName name, Object obj, boolean rebind) Publish an object in the naming service.restoreJavaCompEnvContext
(SimpleJndiName contextName) Recreate a context for java:comp/env or one of its sub-contexts given the context name.void
unbindAppObject
(String appName, SimpleJndiName name) Remove an object from the application's namespace.void
unbindAppObjects
(String appName) Unbind app and module level bindings for the given app name.void
unbindComponentObjects
(String componentId) Unbind component-level bindingsvoid
unbindModuleObject
(String appName, String moduleName, SimpleJndiName name) Remove an object from the module name-space of an application
Typically, to get access to application's module namespace, invocation context must be set to appropriate application's context.
This API is useful in cases where containers within GlassFish need to unbind the objects in application's module name-space and do not have application's invocation contextvoid
Remove aRemote
orObject
instance from the naming service and global naming service.void
unpublishObject
(Name name) Remove an object from the naming service.void
Remove an object from the naming service.
-
Field Details
-
LOGICAL_NAME
- See Also:
-
NAMESPACE_METADATA_KEY
- See Also:
-
-
Method Details
-
getInitialContext
Context getInitialContext()Get the initial context. -
lookup
Lookup a naming entry- Parameters:
name
- name of the object- Returns:
- Object found by the name
- Throws:
NamingException
- when unable to find the object
-
lookup
Lookup a naming entry for a particular componentId- Throws:
NamingException
- when unable to find the object
-
lookupFromAppNamespace
<T> T lookupFromAppNamespace(String appName, SimpleJndiName name, Hashtable<?, ?> env) throws NamingExceptionLookup a naming entry in a particular application's namespace- Parameters:
appName
- application-namename
- name of the objectenv
- Environment- Returns:
- Object found by the name
- Throws:
NamingException
- when unable to find the object
-
lookupFromModuleNamespace
<T> T lookupFromModuleNamespace(String appName, String moduleName, SimpleJndiName name, Hashtable<?, ?> env) throws NamingExceptionLookup a naming entry in a particular application's module's namespace- Parameters:
appName
- application-namemoduleName
- module-namename
- name of the objectenv
- Environment- Returns:
- Object found by the name
- Throws:
NamingException
- when unable to find the object
-
publishObject
Publish an object in the naming service.- Parameters:
name
- Object that needs to be bound.obj
- Name that the object is bound as.rebind
- operation is a bind or a rebind.- Throws:
NamingException
-
publishObject
Publish an object in the naming service.- Parameters:
name
- Object that needs to be bound.obj
- Name that the object is bound as.rebind
- operation is a bind or a rebind.- Throws:
NamingException
-
publishCosNamingObject
Publish aRemote
orObject
object. The object is published to both the server's naming service and the global naming service. Objects published with this method must be unpublished via unpublishCosNamingObject.- Parameters:
name
- Object that needs to be bound.obj
- Name that the object is bound as.rebind
- operation is a bind or a rebind.- Throws:
NamingException
-
bindToComponentNamespace
void bindToComponentNamespace(String appName, String moduleName, String componentId, boolean treatComponentAsModule, Collection<? extends JNDIBinding> bindings) throws NamingException This method enumerates the env properties, ejb and resource references etc for a JEE component and binds them in the applicable java: namespace.- Parameters:
treatComponentAsModule
- true if java:comp and java:module refer to the same namespace- Throws:
NamingException
-
bindToAppNamespace
void bindToAppNamespace(String appName, Collection<? extends JNDIBinding> bindings) throws NamingException Binds the bindings to module namespace of an application
Typically, to get access to application's namespace, invocation context must be set to appropriate application's context.
This API is useful in cases where containers within GlassFish need to bind the objects in application's name-space and do not have application's invocation context- Parameters:
appName
- application-namebindings
- list of bindings- Throws:
NamingException
- when unable to bind the bindings
-
bindToModuleNamespace
void bindToModuleNamespace(String appName, String moduleName, Collection<? extends JNDIBinding> bindings) throws NamingException Binds the bindings to module namespace of an application
Typically, to get access to application's module namespace, invocation context must be set to appropriate application's context.
This API is useful in cases where containers within GlassFish need to bind the objects in application's module name-space and do not have application's invocation context- Parameters:
appName
- application-namemoduleName
- module-namebindings
- list of bindings- Throws:
NamingException
- when unable to bind the bindings
-
unpublishObject
Remove an object from the naming service.- Parameters:
name
- Name that the object is bound as.- Throws:
NamingException
-
unpublishCosNamingObject
Remove aRemote
orObject
instance from the naming service and global naming service.- Parameters:
name
- Name that the object is bound as.- Throws:
NamingException
-
unbindAppObject
Remove an object from the application's namespace.Typically, to get access to application's namespace, invocation context must be set to appropriate application's context.
This API is useful in cases where containers within GlassFish need to unbind the objects in application's name-space and do not have application's invocation context.
- Parameters:
name
- Name that the object is bound as.appName
- application-name- Throws:
NamingException
- when unable to unbind the object
-
unbindModuleObject
void unbindModuleObject(String appName, String moduleName, SimpleJndiName name) throws NamingException Remove an object from the module name-space of an application
Typically, to get access to application's module namespace, invocation context must be set to appropriate application's context.
This API is useful in cases where containers within GlassFish need to unbind the objects in application's module name-space and do not have application's invocation context- Parameters:
name
- Name that the object is bound as.appName
- application-namemoduleName
- module-name- Throws:
NamingException
- when unable to unbind the object
-
unpublishObject
Remove an object from the naming service.- Parameters:
name
- Name that the object is bound as.- Throws:
NamingException
-
unbindComponentObjects
Unbind component-level bindings- Throws:
NamingException
-
unbindAppObjects
Unbind app and module level bindings for the given app name.- Throws:
NamingException
-
restoreJavaCompEnvContext
Recreate a context for java:comp/env or one of its sub-contexts given the context name.- Throws:
NamingException
-
initializeRemoteNamingSupport
Initialize RMI-IIOP naming services- Parameters:
orb
-- Returns:
- RemoteSerialProvider object instance
- Throws:
NamingException
-