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 Details

  • Method Details

    • getInitialContext

      Context getInitialContext()
      Get the initial context.

    • lookup

      <T> T lookup(SimpleJndiName name) throws NamingException
      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

      <T> T lookup(String componentId, SimpleJndiName name) throws NamingException
      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 NamingException
      Lookup a naming entry in a particular application's namespace
      Parameters:
      appName - application-name
      name - name of the object
      env - 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 NamingException
      Lookup a naming entry in a particular application's module's namespace
      Parameters:
      appName - application-name
      moduleName - module-name
      name - name of the object
      env - Environment
      Returns:
      Object found by the name
      Throws:
      NamingException - when unable to find the object

    • publishObject

      void publishObject(SimpleJndiName name, Object obj, boolean rebind) throws NamingException
      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

      void publishObject(Name name, Object obj, boolean rebind) throws NamingException
      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

      void publishCosNamingObject(SimpleJndiName name, Object obj, boolean rebind) throws NamingException
      Publish a Remote or Object 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-name
      bindings - 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-name
      moduleName - module-name
      bindings - list of bindings
      Throws:
      NamingException - when unable to bind the bindings

    • unpublishObject

      void unpublishObject(SimpleJndiName name) throws NamingException
      Remove an object from the naming service.
      Parameters:
      name - Name that the object is bound as.
      Throws:
      NamingException

    • unpublishCosNamingObject

      void unpublishCosNamingObject(SimpleJndiName name) throws NamingException
      Remove a Remote or Object instance from the naming service and global naming service.
      Parameters:
      name - Name that the object is bound as.
      Throws:
      NamingException

    • unbindAppObject

      void unbindAppObject(String appName, SimpleJndiName name) throws NamingException
      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-name
      moduleName - module-name
      Throws:
      NamingException - when unable to unbind the object

    • unpublishObject

      void unpublishObject(Name name) throws NamingException
      Remove an object from the naming service.
      Parameters:
      name - Name that the object is bound as.
      Throws:
      NamingException

    • unbindComponentObjects

      void unbindComponentObjects(String componentId) throws NamingException
      Unbind component-level bindings
      Throws:
      NamingException

    • unbindAppObjects

      void unbindAppObjects(String appName) throws NamingException
      Unbind app and module level bindings for the given app name.
      Throws:
      NamingException

    • restoreJavaCompEnvContext

      Context restoreJavaCompEnvContext(SimpleJndiName contextName) throws NamingException
      Recreate a context for java:comp/env or one of its sub-contexts given the context name.
      Throws:
      NamingException

    • initializeRemoteNamingSupport

      Remote initializeRemoteNamingSupport(org.omg.CORBA.ORB orb) throws NamingException
      Initialize RMI-IIOP naming services
      Parameters:
      orb -
      Returns:
      RemoteSerialProvider object instance
      Throws:
      NamingException