org.jboss.naming: public class: ExternalContext

org.jboss.naming
public class: ExternalContext [javadoc | source]

java.lang.Object
   org.jboss.mx.util.JBossNotificationBroadcasterSupport
      org.jboss.system.ServiceMBeanSupport
         org.jboss.naming.ExternalContext

All Implemented Interfaces:
ExternalContextMBean, org.jboss.kernel.spi.dependency.KernelControllerContextAware, ServiceMBean, MBeanRegistration, NotificationEmitter

A MBean that binds an arbitrary InitialContext into the JBoss default InitialContext as a Reference. If RemoteAccess is enabled, the reference is a Serializable object that is capable of creating the InitialContext remotely. If RemoteAccess if false, the reference is to a nonserializable object that can only be used from within this VM.

Also see:

org.jboss.naming.NonSerializableFactory

jmx:mbean: extends - ="org.jboss.system.ServiceMBean"

version: < - tt>$Revision: 70435 $

author: Scott.Stark - @jboss.org

author: < - a href="mailto:jason@planet57.com">Jason Dillon

Nested Class Summary:
public static class	ExternalContext.SerializableInitialContext	The external InitialContext information class. It acts as the RefAddr and ObjectFactory for the external IntialContext and can be marshalled to a remote client.
static class	ExternalContext.CachedContext	A proxy implementation of Context that simply intercepts the close() method and ignores it since the underlying Context object is being maintained in memory.

Fields inherited from org.jboss.system.ServiceMBeanSupport:
SERVICE_CONTROLLER_SIG, log, server, serviceName

Constructor:
public ExternalContext() { super(); } No-args constructor for JMX.
public ExternalContext(String jndiName, String contextPropsURL) throws NamingException, IOException { setJndiName(jndiName); setPropertiesURL(contextPropsURL); }

Constructor:

 public ExternalContext() {
           
      super();
}

No-args constructor for JMX.

 public ExternalContext(String jndiName,
    String contextPropsURL) throws NamingException, IOException {
   
      setJndiName(jndiName);
      setPropertiesURL(contextPropsURL);
}

Method from org.jboss.naming.ExternalContext Summary:
getCacheContext, getInitialContext, getJndiName, getProperties, getRemoteAccess, setCacheContext, setInitialContext, setJndiName, setProperties, setPropertiesURL, setRemoteAccess, startService, stopService

Methods from org.jboss.system.ServiceMBeanSupport:
create, createService, destroy, destroyService, getDeploymentInfo, getLog, getName, getNextNotificationSequenceNumber, getObjectName, getServer, getServiceName, getState, getStateString, jbossInternalCreate, jbossInternalDescription, jbossInternalDestroy, jbossInternalLifecycle, jbossInternalStart, jbossInternalStop, pojoChange, pojoCreate, pojoDestroy, pojoStart, pojoStop, postDeregister, postRegister, preDeregister, preRegister, setKernelControllerContext, start, startService, stop, stopService, unsetKernelControllerContext

Methods from org.jboss.system.ServiceMBeanSupport:

create, createService, destroy, destroyService, getDeploymentInfo, getLog, getName, getNextNotificationSequenceNumber, getObjectName, getServer, getServiceName, getState, getStateString, jbossInternalCreate, jbossInternalDescription, jbossInternalDestroy, jbossInternalLifecycle, jbossInternalStart, jbossInternalStop, pojoChange, pojoCreate, pojoDestroy, pojoStart, pojoStop, postDeregister, postRegister, preDeregister, preRegister, setKernelControllerContext, start, startService, stop, stopService, unsetKernelControllerContext

Methods from org.jboss.mx.util.JBossNotificationBroadcasterSupport:
addNotificationListener, getNotificationInfo, handleNotification, nextNotificationSequenceNumber, removeNotificationListener, removeNotificationListener, sendNotification

Methods from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from org.jboss.naming.ExternalContext Detail:
public boolean getCacheContext() { return contextInfo.getCacheContext(); }
public String getInitialContext() { return contextInfo.getInitialContext(); } Get the class name of the InitialContext implementation to use. Should be one of: javax.naming.InitialContext javax.naming.directory.InitialDirContext javax.naming.ldap.InitialLdapContext
public String getJndiName() { return contextInfo.getJndiName(); } Set the jndi name under which the external context is bound.
public Properties getProperties() throws IOException { return contextInfo.getProperties(); } Get the InitialContex class environment properties.
public boolean getRemoteAccess() { return remoteAccess; }
public void setCacheContext(boolean cacheContext) { contextInfo.setCacheContext(cacheContext); }
public void setInitialContext(String className) throws ClassNotFoundException { contextInfo.loadClass(className); } Set the class name of the InitialContext implementation to use. Should be one of: javax.naming.InitialContext javax.naming.directory.InitialDirContext javax.naming.ldap.InitialLdapContext
public void setJndiName(String jndiName) throws NamingException { contextInfo.setJndiName(jndiName); if( super.getState() == STARTED ) { unbind(jndiName); try { rebind(); } catch(Exception e) { NamingException ne = new NamingException("Failed to update jndiName"); ne.setRootCause(e); throw ne; } } } Set the jndi name under which the external context is bound.
public void setProperties(Properties props) throws IOException { contextInfo.setProperties(props); } Set the InitialContex class environment properties.
public void setPropertiesURL(String contextPropsURL) throws IOException { contextInfo.loadProperties(contextPropsURL); } Set the InitialContex class environment properties from the given URL.
public void setRemoteAccess(boolean remoteAccess) { this.remoteAccess = remoteAccess; }
protected void startService() throws Exception { rebind(); } Start the service by binding the external context into the JBoss InitialContext.
protected void stopService() throws Exception { if( contextInfo.getCacheContext() ) unbind(contextInfo.getJndiName()); } Stop the service by unbinding the external context into the JBoss InitialContext.

Method from org.jboss.naming.ExternalContext Detail:

 public boolean getCacheContext() {
      return contextInfo.getCacheContext();
}

 public String getInitialContext() {
      return contextInfo.getInitialContext();
}

javax.naming.InitialContext
javax.naming.directory.InitialDirContext
javax.naming.ldap.InitialLdapContext

 public String getJndiName() {
      return contextInfo.getJndiName();
}

Set the jndi name under which the external context is bound.

 public Properties getProperties() throws IOException {
      return contextInfo.getProperties();
}

Get the InitialContex class environment properties.

 public boolean getRemoteAccess() {
      return remoteAccess;
}

 public  void setCacheContext(boolean cacheContext) {
      contextInfo.setCacheContext(cacheContext);
}

 public  void setInitialContext(String className) throws ClassNotFoundException {
      contextInfo.loadClass(className);
}

javax.naming.InitialContext
javax.naming.directory.InitialDirContext
javax.naming.ldap.InitialLdapContext

 public  void setJndiName(String jndiName) throws NamingException {
      contextInfo.setJndiName(jndiName);
      if( super.getState() == STARTED )
      {
         unbind(jndiName);
         try
         {
            rebind();
         }
         catch(Exception e)
         {
            NamingException ne = new NamingException("Failed to update jndiName");
            ne.setRootCause(e);
            throw ne;
         }
      }
}

Set the jndi name under which the external context is bound.

 public  void setProperties(Properties props) throws IOException {
      contextInfo.setProperties(props);
}

Set the InitialContex class environment properties.

 public  void setPropertiesURL(String contextPropsURL) throws IOException {
      contextInfo.loadProperties(contextPropsURL);
}

Set the InitialContex class environment properties from the given URL.

 public  void setRemoteAccess(boolean remoteAccess) {
      this.remoteAccess = remoteAccess;
}

 protected  void startService() throws Exception {
      rebind();
}

Start the service by binding the external context into the JBoss InitialContext.

 protected  void stopService() throws Exception {
      if( contextInfo.getCacheContext() )
         unbind(contextInfo.getJndiName());
}

Stop the service by unbinding the external context into the JBoss InitialContext.