Java Doc for EnvironmentContext.java in  » ESB » open-esb » com » sun » jbi » framework » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » ESB » open esb » com.sun.jbi.framework 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   com.sun.jbi.framework.EnvironmentContext

All known Subclasses:   com.sun.jbi.framework.ScaffoldEnvironmentContext,
EnvironmentContext
public class EnvironmentContext implements com.sun.jbi.EnvironmentContext(Code)
This context contains data needed by all components and services running in the JBI environment.
author:
   Sun Microsystems, Inc.



Constructor Summary
 EnvironmentContext(PlatformContext platform, JBIFramework framework, Properties initialProperties)
     Constructor.

Method Summary
public  voidcreateLoggerMBeans()
    
 voiddestroyInstance()
     Destroy the instance of this context created by the constructor.
public  StringgetAppServerInstallRoot()
     Get the installation root directory of the AppServer.
public  StringgetAppServerInstanceRoot()
     Get the instance root directory of the AppServer instance.
 ComponentFrameworkgetComponentFramework()
     Get the Component Framework service handle.
public  com.sun.jbi.ComponentManagergetComponentManager()
     Get the Component Manager handle.
public  com.sun.jbi.ComponentQuerygetComponentQuery()
     Get the Component Query handle.
public  com.sun.jbi.ComponentQuerygetComponentQuery(String targetName)
    
 ComponentRegistrygetComponentRegistry()
     Get the Component Registry service handle.
 longgetComponentTimeout()
     Get the timeout value for component life cycle operations.
public  com.sun.jbi.management.system.ConfigurationServicegetConfigurationService()
     Get the Configuration Service handle.
public  com.sun.jbi.messaging.ConnectionManagergetConnectionManager()
     Get the Connection Manager handle.
public  java.util.logging.LevelgetDefaultLogLevel()
     Get the default log level specified at startup.
 longgetDeploymentTimeout()
     Get the timeout value for Service Unit deploy/undeploy operations.
 FrameworkStatisticsgetFrameworkStatistics()
     Get the framework statistics handle.
public  java.util.PropertiesgetInitialProperties()
     Get the initial properties provided by the AppServer from the properties specified in the lifecycle module definition in the domain.xml file.
 longgetInstallationTimeout()
     Get the timeout value for component install/uninstall operations.
public static  EnvironmentContextgetInstance()
     Get the instance of this context created by the constructor.
public  StringgetJbiInstallRoot()
     Get the installation root directory of the JBI system.
public  StringgetJbiInstanceRoot()
     Get the instance root directory of the JBI system.
 LoggergetJbiLogger()
     Get the top-level logger for the runtime.
public  com.sun.jbi.registry.RegistrygetJustRegistry()
     This is used by the ComponentRegistry Service to bypass the deferred initialization checks.
 LoggergetLogger()
     Get the logger for the framework.
public  com.sun.jbi.management.MBeanHelpergetMBeanHelper()
     Get the MBean helper service which enables JBI components to request that the Management Service create and register MBeans on their behalf.
public  com.sun.jbi.management.MBeanNamesgetMBeanNames()
     Get the MBean naming service which enables JBI components to construct MBean names that follow the JBI conventions.
public  javax.management.MBeanServergetMBeanServer()
     Get the MBean server with which all MBeans are registered.
public  ObjectgetManagementClass(String aServiceName)
     Get a handle to the class implementing management for the named JBI system service.
Parameters:
  aServiceName - - the name of the JBI system service.
public  com.sun.jbi.management.ManagementMessageFactorygetManagementMessageFactory()
     Get the management message factory which enables JBI components to construct status and exception messages.
public  com.sun.jbi.management.system.ManagementServicegetManagementService()
     Get the Management Service handle.
public  com.sun.jbi.management.facade.ManagementRuntimeServicegetMgmtRuntimeService()
     Get the Management Runtime Service handle.
public  javax.naming.InitialContextgetNamingContext()
     Get the JNDI naming context currently in effect.
public  StringgetNamingPrefix()
     Gets the naming prefix.
public  com.sun.jbi.messaging.MessageServicegetNormalizedMessageService()
     Get the Normalized Message Service handle.
public  EventNotifierCommongetNotifier()
     Get the Event Notifier for emitting event notifications from the runtime.
public  PlatformContextgetPlatformContext()
     Get the PlatformContext implementation.
public  JBIProvidergetProvider()
     Returns the Provider of JBI.
public  org.w3c.dom.DocumentgetReadOnlyRegistry()
     Get a read-only reference to the persisted JBI Registry.
public  com.sun.jbi.registry.RegistrygetRegistry()
     Get a reference to the persisted JBI registry.
public  com.sun.jbi.ServiceUnitRegistrationgetServiceUnitRegistration()
     Get the Service Unit registration handle.
 longgetServiceUnitTimeout()
     Get the timeout value for Service Unit life cycle operations.
public  com.sun.jbi.StringTranslatorgetStringTranslator(String packageName)
     Get the StringTranslator for a specified package name.
Parameters:
  packageName - - the name of the package containing the resourcebundle to be used by this StringTranslator.
public  com.sun.jbi.StringTranslatorgetStringTranslator(String packageName, String componentId)
     Get the StringTranslator for a specified package name using the class loader for a specified component ID.
Parameters:
  packageName - - the name of the package containing the resourcebundle to be used by this StringTranslator.
Parameters:
  componentId - - the component ID for which the classloader is tobe used.
public  com.sun.jbi.StringTranslatorgetStringTranslatorFor(Object object)
     Get the StringTranslator for a specified object.
Parameters:
  object - - an object in the package that contains the resourcebundle to be used for this StringTranslator.
public  javax.transaction.TransactionManagergetTransactionManager()
     Get a TransactionManager from the AppServer.
public  com.sun.jbi.VersionInfogetVersionInfo()
     Get the VersionInfo for this runtime.
public  WsdlFactorygetWsdlFactory()
     Get a copy of the WSDL factory.
public  booleanisFrameworkReady(boolean start)
     Indicates whether or not the JBI framework has been fully started.
public  booleanisStartOnDeployEnabled()
     This method is used to find out if start-on-deploy is enabled. When this is enabled components are started automatically when there is deployment for them.
public  booleanisStartOnVerifyEnabled()
     This method is used to find out if startOnVerify is enabled. When this is enabled components are started automatically when an application has to be verified for them.
 voidsetAppServerInstanceRoot(String instanceRoot)
     Set the instance root directory of the AppServer.
 voidsetComponentTimeout(long timeout)
     Set the component timeout value (used for junit testing only).
 voidsetDeploymentTimeout(long timeout)
     Set the deployment timeout value (used for junit testing only).
 voidsetInstallationTimeout(long timeout)
     Set the installation timeout value (used for junit testing only).
 voidsetJbiInstallRoot(String installRoot)
     Set the installation root directory of the JBI framework.
 voidsetJbiInstanceRoot(String instanceRoot)
     Set the instance root directory of the JBI framework.
 voidsetManagementService(com.sun.jbi.management.system.ManagementService ms)
     Set the JNDI naming context.
 voidsetNamingContext(InitialContext namingContext)
     Set the JNDI naming context.
 voidsetNamingPrefix(String prefix)
     Set the JNDI naming prefix.
 voidsetPlatformContext(PlatformContext platform)
     Set the platform context implementation.
 voidsetRegistry(Registry registry)
     This method is for junit tests to use a Scaffold registry.
 voidsetServiceUnitTimeout(long timeout)
     Set the service unit timeout value (used for junit testing only).


Constructor Detail
EnvironmentContext
EnvironmentContext(PlatformContext platform, JBIFramework framework, Properties initialProperties) throws javax.jbi.JBIException(Code)
Constructor.
Parameters:
  platform - the platform context for the AppServer.
Parameters:
  framework - the representing the JBI Framework instance.
Parameters:
  initialProperties - is the Properties object provided bythe AppServer, containing all properties specified in thedefinition of the JBI lifecycle module.
throws:
  javax.jbi.JBIException - if any error occurs.




Method Detail
createLoggerMBeans
public void createLoggerMBeans()(Code)
Create Logger MBean



destroyInstance
void destroyInstance()(Code)
Destroy the instance of this context created by the constructor.



getAppServerInstallRoot
public String getAppServerInstallRoot()(Code)
Get the installation root directory of the AppServer. String containing the installation root directory path



getAppServerInstanceRoot
public String getAppServerInstanceRoot()(Code)
Get the instance root directory of the AppServer instance. String containing the instance root directory path



getComponentFramework
ComponentFramework getComponentFramework()(Code)
Get the Component Framework service handle. The ComponentFramework instance.



getComponentManager
public com.sun.jbi.ComponentManager getComponentManager()(Code)
Get the Component Manager handle. The ComponentManager handle, which is a thin interface to theComponentFramework service.



getComponentQuery
public com.sun.jbi.ComponentQuery getComponentQuery()(Code)
Get the Component Query handle. This returns the ComponentQuery with this instances target. the ComponentQuery for the current server instance. This ComponentQueryprovides information on components and shared libraries installed to theserver instance.



getComponentQuery
public com.sun.jbi.ComponentQuery getComponentQuery(String targetName)(Code)
Get the ComponentQuery for a specified target The ComponentQuery instance.
Parameters:
  targetName - - either "domain" or a valid server / cluster name



getComponentRegistry
ComponentRegistry getComponentRegistry()(Code)
Get the Component Registry service handle. The ComponentRegistry instance.



getComponentTimeout
long getComponentTimeout()(Code)
Get the timeout value for component life cycle operations. The timeout value in milliseconds for calls to the component'sComponentLifeCycle methods.



getConfigurationService
public com.sun.jbi.management.system.ConfigurationService getConfigurationService()(Code)
Get the Configuration Service handle. The ConfigurationService instance.



getConnectionManager
public com.sun.jbi.messaging.ConnectionManager getConnectionManager()(Code)
Get the Connection Manager handle. The ConnectionManager instance.



getDefaultLogLevel
public java.util.logging.Level getDefaultLogLevel()(Code)
Get the default log level specified at startup. The default log level as a Level instance.



getDeploymentTimeout
long getDeploymentTimeout()(Code)
Get the timeout value for Service Unit deploy/undeploy operations. The timeout value in milliseconds for calls to the component'sServiceUnitManager deploy and undeploy methods.



getFrameworkStatistics
FrameworkStatistics getFrameworkStatistics()(Code)
Get the framework statistics handle. The FrameworkStatistics instance.



getInitialProperties
public java.util.Properties getInitialProperties()(Code)
Get the initial properties provided by the AppServer from the properties specified in the lifecycle module definition in the domain.xml file. The initial properties from the AppServer.



getInstallationTimeout
long getInstallationTimeout()(Code)
Get the timeout value for component install/uninstall operations. The timeout value in milliseconds for calls to the component'sBootstrap onInstall and onUninstall methods.



getInstance
public static EnvironmentContext getInstance()(Code)
Get the instance of this context created by the constructor. instance of the EnvironmentContext created by the constructor.



getJbiInstallRoot
public String getJbiInstallRoot()(Code)
Get the installation root directory of the JBI system. The JBI installation root directory path.



getJbiInstanceRoot
public String getJbiInstanceRoot()(Code)
Get the instance root directory of the JBI system. The JBI instance root directory path.



getJbiLogger
Logger getJbiLogger()(Code)
Get the top-level logger for the runtime. The Logger instance.



getJustRegistry
public com.sun.jbi.registry.Registry getJustRegistry()(Code)
This is used by the ComponentRegistry Service to bypass the deferred initialization checks.



getLogger
Logger getLogger()(Code)
Get the logger for the framework. The Logger instance.



getMBeanHelper
public com.sun.jbi.management.MBeanHelper getMBeanHelper()(Code)
Get the MBean helper service which enables JBI components to request that the Management Service create and register MBeans on their behalf. The MBeanHelper instance.



getMBeanNames
public com.sun.jbi.management.MBeanNames getMBeanNames()(Code)
Get the MBean naming service which enables JBI components to construct MBean names that follow the JBI conventions. The MBeanNames instance.



getMBeanServer
public javax.management.MBeanServer getMBeanServer()(Code)
Get the MBean server with which all MBeans are registered. javax.management.MBeanServer the main MBean server



getManagementClass
public Object getManagementClass(String aServiceName)(Code)
Get a handle to the class implementing management for the named JBI system service.
Parameters:
  aServiceName - - the name of the JBI system service. The class implementing management for the system service.



getManagementMessageFactory
public com.sun.jbi.management.ManagementMessageFactory getManagementMessageFactory()(Code)
Get the management message factory which enables JBI components to construct status and exception messages. The ManagementMessageFactory instance.



getManagementService
public com.sun.jbi.management.system.ManagementService getManagementService()(Code)
Get the Management Service handle. The ManagementService instance.



getMgmtRuntimeService
public com.sun.jbi.management.facade.ManagementRuntimeService getMgmtRuntimeService()(Code)
Get the Management Runtime Service handle. The ManagementRuntimeService instance.



getNamingContext
public javax.naming.InitialContext getNamingContext()(Code)
Get the JNDI naming context currently in effect. javax.naming.InitialContext the JNDI naming context



getNamingPrefix
public String getNamingPrefix()(Code)
Gets the naming prefix. naming prefix



getNormalizedMessageService
public com.sun.jbi.messaging.MessageService getNormalizedMessageService()(Code)
Get the Normalized Message Service handle. The NormalizedMessageService instance.



getNotifier
public EventNotifierCommon getNotifier()(Code)
Get the Event Notifier for emitting event notifications from the runtime. The EventNotifier instance.



getPlatformContext
public PlatformContext getPlatformContext()(Code)
Get the PlatformContext implementation. The PlatformContext instance.



getProvider
public JBIProvider getProvider()(Code)
Returns the Provider of JBI. provider



getReadOnlyRegistry
public org.w3c.dom.Document getReadOnlyRegistry()(Code)
Get a read-only reference to the persisted JBI Registry. A DOM registry document object is returned. If the registry file is missing or cannot be read then a null value is returned. the registry document



getRegistry
public com.sun.jbi.registry.Registry getRegistry()(Code)
Get a reference to the persisted JBI registry. The registry is created if not already available and the result is cached for later callers. The framework will transition from lazy to normal if the registry is requested (or if the Framework is explicitly enabled.) After creating the registry we will make sure the Framework is ready before continuing. Note: JBIFramework.frameReady() will indirectly call getRegistry() and getRegistry() will directly call JBIFramework.frameworkRead(). The recursion is broken by carefully setting the internal framework ready flag. See: JBIFramework.readyFramework() and JBIFramework.prepare() Registry instance



getServiceUnitRegistration
public com.sun.jbi.ServiceUnitRegistration getServiceUnitRegistration()(Code)
Get the Service Unit registration handle. The ServiceUnitRegistration handle, which is a thin interfaceto the ComponentRegistry service.



getServiceUnitTimeout
long getServiceUnitTimeout()(Code)
Get the timeout value for Service Unit life cycle operations. The timeout value in milliseconds for calls to the component'sServiceUnitManager life cycle methods.



getStringTranslator
public com.sun.jbi.StringTranslator getStringTranslator(String packageName)(Code)
Get the StringTranslator for a specified package name.
Parameters:
  packageName - - the name of the package containing the resourcebundle to be used by this StringTranslator. The StringTranslator instance.



getStringTranslator
public com.sun.jbi.StringTranslator getStringTranslator(String packageName, String componentId)(Code)
Get the StringTranslator for a specified package name using the class loader for a specified component ID.
Parameters:
  packageName - - the name of the package containing the resourcebundle to be used by this StringTranslator.
Parameters:
  componentId - - the component ID for which the classloader is tobe used. The StringTranslator instance.



getStringTranslatorFor
public com.sun.jbi.StringTranslator getStringTranslatorFor(Object object)(Code)
Get the StringTranslator for a specified object.
Parameters:
  object - - an object in the package that contains the resourcebundle to be used for this StringTranslator. The StringTranslator instance.



getTransactionManager
public javax.transaction.TransactionManager getTransactionManager()(Code)
Get a TransactionManager from the AppServer. A TransactionManager instance.



getVersionInfo
public com.sun.jbi.VersionInfo getVersionInfo()(Code)
Get the VersionInfo for this runtime. The VersionInfo instance.



getWsdlFactory
public WsdlFactory getWsdlFactory() throws WsdlException(Code)
Get a copy of the WSDL factory. This needs to be done before any reading, writing, or manipulation of WSDL documents can be performed using the WSDL API. An instance of the WSDL factory.
exception:
  WsdlException - If the factory cannot be instantiated.



isFrameworkReady
public boolean isFrameworkReady(boolean start)(Code)
Indicates whether or not the JBI framework has been fully started. This method provides clients with a way of determining if the JBI framework started up in passive mode as a result of on-demand initialization. The 'start' parameter instructs the framework to start completely if it has not already done so. If the framework has already been started, the request to start again is ignored.
Parameters:
  start - requests that the framework start completely beforereturning. true if the framework is completely started, false otherwise.



isStartOnDeployEnabled
public boolean isStartOnDeployEnabled()(Code)
This method is used to find out if start-on-deploy is enabled. When this is enabled components are started automatically when there is deployment for them. By default start-on-deploy is enabled. true if startOnDeploy is enabled.



isStartOnVerifyEnabled
public boolean isStartOnVerifyEnabled()(Code)
This method is used to find out if startOnVerify is enabled. When this is enabled components are started automatically when an application has to be verified for them. By default startOnVerify is enabled. true if startOnVerify is enabled.



setAppServerInstanceRoot
void setAppServerInstanceRoot(String instanceRoot)(Code)
Set the instance root directory of the AppServer.
Parameters:
  instanceRoot - String containing the instance root directoryof the AppServer.



setComponentTimeout
void setComponentTimeout(long timeout)(Code)
Set the component timeout value (used for junit testing only).
Parameters:
  timeout - the timeout value in milliseconds.



setDeploymentTimeout
void setDeploymentTimeout(long timeout)(Code)
Set the deployment timeout value (used for junit testing only).
Parameters:
  timeout - the timeout value in milliseconds.



setInstallationTimeout
void setInstallationTimeout(long timeout)(Code)
Set the installation timeout value (used for junit testing only).
Parameters:
  timeout - the timeout value in milliseconds.



setJbiInstallRoot
void setJbiInstallRoot(String installRoot)(Code)
Set the installation root directory of the JBI framework.
Parameters:
  installRoot - String containing the installation root directoryof the JBI framework



setJbiInstanceRoot
void setJbiInstanceRoot(String instanceRoot)(Code)
Set the instance root directory of the JBI framework.
Parameters:
  instanceRoot - String containing the instance root directoryof the JBI framework



setManagementService
void setManagementService(com.sun.jbi.management.system.ManagementService ms)(Code)
Set the JNDI naming context.
Parameters:
  namingContext - the JNDI naming context from the AppServer.



setNamingContext
void setNamingContext(InitialContext namingContext)(Code)
Set the JNDI naming context.
Parameters:
  namingContext - the JNDI naming context from the AppServer.



setNamingPrefix
void setNamingPrefix(String prefix)(Code)
Set the JNDI naming prefix.
Parameters:
  prefix - naming prefix for binding JNDI names.



setPlatformContext
void setPlatformContext(PlatformContext platform)(Code)
Set the platform context implementation.
Parameters:
  platform - platform context impl



setRegistry
void setRegistry(Registry registry)(Code)
This method is for junit tests to use a Scaffold registry.



setServiceUnitTimeout
void setServiceUnitTimeout(long timeout)(Code)
Set the service unit timeout value (used for junit testing only).
Parameters:
  timeout - the timeout value in milliseconds.



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.