Java Doc for Component.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.Component

All known Subclasses:   com.sun.jbi.framework.AbstractComponent,
Component
public class Component implements com.sun.jbi.ComponentInfo(Code)
This class holds information about a Binding Component (BC) or a Service Engine (SE). This information is used by the JBI framework to install and manage BCs and SEs. Some of the information is permanent, and is persisted by the Component Registry across restarts of the JBI framework. Other information is only relevant for the duration of a JBI framework lifecycle. All attributes that are not persisted are marked transient.
author:
   Sun Microsystems, Inc.



Constructor Summary
public  Component()
     Create a new Component instance.
public  Component(com.sun.jbi.ComponentInfo compInfo)
    

Method Summary
public  voidaddServiceUnit(ServiceUnit serviceUnit)
     Add a ServiceUnit object to the list of Service Units deployed to this BC or SE.
public  voidclearBootstrapInstance()
     Clear the instance reference for the Bootstrap implementation for this BC or SE.
public  voidclearBusy()
     Clear the "busy" flag.
public  voidclearLifeCycleInstance()
     Clear the instance reference for the Component implementation for this BC or SE.
public  voidclearStatisticsInstance()
     Clear the reference to the ComponentStatistics instance for this BC or SE.
public  voidclearUpdating()
     Clear the Updating flag.
public  booleanequals(Object object)
     Compare another Object with this one for equality.
Parameters:
  object - The object to be compared with this one.
public  StringgetBootstrapClassName()
     Get the class name of the bootstrap implementation for this BC or SE.
public  java.util.List<String>getBootstrapClassPathElements()
     Get the class path elements that this BC or SE needs in its bootstrap runtime environment.
public  javax.jbi.component.BootstrapgetBootstrapInstance(boolean canCreate)
     Get an instance of the bootstrap class for this BC or SE.
public  List<String>getClassPathElements()
     Get the class path elements that this BC or SE needs in its runtime environment.
public  StringgetComponentClassName()
     Get the class name of the component implementation for this BC or SE.
public  StringgetComponentClassPathAsString()
     Get the complete classpath for this component as a String.
public  List<String>getComponentClassPathElements()
     Get the class path elements that this BC or SE needs in its runtime environment.
public  javax.jbi.component.ComponentgetComponentInstance()
     Get the javax.jbi.component.Component instance for the BC or SE.
public  ComponentTypegetComponentType()
     Get the component type for this BC or SE.
public  StringgetComponentTypeAsString()
     Get the component type for this BC or SE as a string.
public  javax.management.ObjectNamegetConfigurationMBeanName()
     Get the JMX ObjectName for the component configuration Dynamic MBean.
public  ComponentContextgetContext()
     Get the ComponentContext for this BC or SE.
public  DeployergetDeployerInstance()
     Get the Deployer instance for the BC or SE.
public  javax.management.ObjectNamegetDeployerMBeanName()
     Get the JMX ObjectName for the Deployer MBean.
public  StringgetDescription()
     Get the description for this BC or SE.
public  ComponentStategetDesiredState()
     Get the desired state of this component.
public  javax.management.ObjectNamegetExtensionMBeanName()
     Get the JMX ObjectName for the bootstrap extension MBean.
public  StringgetInstallRoot()
     Get the root installation directory for this BC or SE.
public  StringgetInstallationDescriptor()
     Get the installation descriptor (jbi.xml) for the component as a String.
public  com.sun.jbi.management.descriptor.ComponentDescriptorgetInstallationDescriptorModel()
     Get the wrapped JAXB model for the installation descriptor (jbi.xml) for the component.
public  javax.management.ObjectNamegetInstallerMBeanName()
     Get the JMX ObjectName for the Installer MBean.
public  javax.jbi.component.ComponentLifeCyclegetLifeCycleInstance(boolean canCreate)
     Get an instance of the life cycle class for this BC or SE.
public  javax.management.ObjectNamegetLifeCycleMBeanName()
     Get the JMX ObjectName for the LifeCycle MBean.
public  ComponentLoggergetLoggerInstance()
     Get the logger MBean instance.
public  javax.management.ObjectNamegetLoggerMBeanName()
     Get the JMX ObjectNames for the logger MBean.
public  StringgetName()
     Get the unique name for this BC or SE.
public  MapgetProperties()
     Get the component properties.
public  ServiceUnitgetServiceUnit(String serviceUnitName)
     Get the ServiceUnit object for a specified Service Unit name.
public  List<com.sun.jbi.ServiceUnitInfo>getServiceUnitList()
     Get the list of ServiceUnit objects representing all Service Units currently deployed to this BC or SE.
public  javax.jbi.component.ServiceUnitManagergetServiceUnitManager()
     Get the ServiceUnitManager instance for this component, if one is available.
public  List<String>getSharedLibraryNames()
     Get the list of Shared Library names required by this BC or SE.
public  ComponentStatisticsgetStatisticsInstance()
     Get the instance of the statistics MBean.
public  javax.management.ObjectNamegetStatisticsMBeanName()
     Get the JMX ObjectName for the statistics MBean.
public  ComponentStategetStatus()
     Get the status of this component.
public  StringgetStatusAsString()
     Get the status of this component as a string value.
public  StringgetStatusAsString(ComponentState status)
     Get a component state as a string value.
Parameters:
  status - A state, either LOADED, SHUTDOWN,STARTED, or STOPPED.
public  StringgetWorkspaceRoot()
     Get the workspace root directory for this BC or SE.
public  inthashCode()
     Get the hash code for this Component instance.
public  booleanisBinding()
     Check to see if this component is a BC.
public  booleanisBootstrapClassLoaderSelfFirst()
     Check to see if the bootstrap class loader should use a self-first search hierarchy.
public  booleanisBootstrapCleanUpNeeded()
     Check to see if the bootstrap cleanUp() method needs to be called.
public  booleanisBusy()
     Check to see if this component is processing a life cycle request.
public  booleanisClassLoaderSelfFirst()
     Return an indication of whether the class loaders for this component should use the self-first hierarchy.
public  booleanisComponentClassLoaderSelfFirst()
     Check to see if the component class loader should use a self-first search hierarchy.
public  booleanisEngine()
     Check to see if this component is a SE.
public  booleanisInitialized()
     Check to see if this component is initialized.
public  booleanisInstalled()
     Check to see if this component is installed.
public  booleanisLoaded()
     Check to see if this component is loaded.
public  booleanisObserver()
     Check to see if this component is an NMR observer.
public  booleanisServiceUnitRegistered(String serviceUnitName)
     Check to see if a Service Unit is registered to this component.
Parameters:
  serviceUnitName - the unique name of the Service Unit.
public  booleanisShutDown()
     Check to see if this component is shut down.
public  booleanisStarted()
     Check to see if this component is started.
public  booleanisStopped()
     Check to see if this component is stopped.
public  booleanisUpdating()
     Check to see if this component is being updated.
public  voidremoveServiceUnit(String serviceUnitName)
     Remove a ServiceUnit object from the list of Service Units deployed to this BC or SE.
public  voidsetBootstrapClassLoaderSelfFirst(boolean isSelfFirst)
     Set the flag that determines the hierarchy for the bootstrap class loader which is true for self-first or false for parent-first.
public  voidsetBootstrapClassName(String className)
     Set the class name of the bootstrap implementation for this BC or SE.
public  voidsetBootstrapClassPathElements(List classPathElements)
     Set the class path elements for the bootstrap implementation for this BC or SE.
public  voidsetBootstrapCleanUpNeeded(boolean isCleanUpNeeded)
     Set the flag that indicates whether the bootstrap cleanUp() method needs to be called.
public synchronized  voidsetBusy()
     Set the flag indicating the component is busy processing a life cycle operation.
public  voidsetBusyForce()
     Set the flag indicating the component is busy processing a life cycle operation.
public  voidsetComponentClassLoaderSelfFirst(boolean isSelfFirst)
     Set the flag that determines the hierarchy for the component class loader which is true for self-first or false for parent-first.
public  voidsetComponentClassName(String className)
     Set the class name of the Component implementation for this component.
public  voidsetComponentClassPathElements(List classPathElements)
     Set the class path elements that this BC or SE needs in its runtime environment.
public  voidsetComponentInstance(javax.jbi.component.Component classInstance)
     Set the class instance of the Component implementation for this BC or SE.
public  voidsetComponentType(ComponentType type)
     Set the component type.
public  voidsetComponentTypeBinding()
     Set the component type for a BC.
public  voidsetComponentTypeEngine()
     Set the component type for a SE.
public  voidsetConfigurationMBeanName(javax.management.ObjectName objectName)
     Set the JMX ObjectName for the component configuration Dynamic MBean.
public  voidsetContext(ComponentContext context)
     Set the ComponentContext for this BC or SE.
public  voidsetDeployerInstance(Deployer deployer)
     Set the component's Deployer instance.
public  voidsetDeployerMBeanName(javax.management.ObjectName objectName)
     Set the JMX ObjectName for the DeployerMBean.
public  voidsetDescription(String description)
     Set the description of this BC or SE.
public  voidsetDesiredState(ComponentState state)
     Set the desired state of a component.
public  voidsetExtensionMBeanName(javax.management.ObjectName objectName)
     Set the JMX ObjectName for the bootstrap ExtensionMBean.
public  voidsetInstallRoot(String installRoot)
     Set the root installation directory for this BC or SE.
public  voidsetInstallationDescriptor(String jbiXml)
     Set the installation descriptor for this component.
public  voidsetInstallerMBeanName(javax.management.ObjectName objectName)
     Set the JMX ObjectName for the InstallerMBean.
public  voidsetLifeCycleMBeanName(javax.management.ObjectName objectName)
     Set the JMX ObjectName for the LifeCycleMBean.
public  voidsetLoaded()
     Set the component state to loaded.
public  voidsetLoggerInstance(ComponentLogger instance)
     Set the ComponentLoggerMBean instance for this component.
public  voidsetLoggerMBeanName(javax.management.ObjectName objectName)
     Set the LoggerMBean ObjectName for this component.
public  voidsetName(String name)
     Set the name for this BC or SE.
public  voidsetObserver(boolean isObserver)
     Set the observer flag for this component.
public  voidsetSharedLibraryNames(List<String> nameList)
     Set the list of Shared Library names required by this BC or SE.
public  voidsetShutdown()
     Set the component state to shutdown (installed but not active).
public  voidsetStarted()
     Set the component state to started.
public  voidsetStatisticsInstance(ComponentStatistics classInstance)
     Set the instance of ComponentStatistics for this BC or SE.
public  voidsetStatisticsMBeanName(javax.management.ObjectName objectName)
     Set the JMX ObjectName for the StatisticsMBean.
public  voidsetStatus(ComponentState status)
     Set the component state.
public  voidsetStopped()
     Set the component state to stopped.
public  voidsetUpdating()
     Set the Updating flag indicating the component is being updated.
public  voidsetWorkspaceRoot(String workspaceRoot)
     Set the workspace root directory for this BC or SE.
public  StringtoString()
     Convert to a String.


Constructor Detail
Component
public Component()(Code)
Create a new Component instance.



Component
public Component(com.sun.jbi.ComponentInfo compInfo)(Code)
Constructor for building an instance from a ComponentInfo instance
Parameters:
  compInfo - - the ComponentInfo instance




Method Detail
addServiceUnit
public void addServiceUnit(ServiceUnit serviceUnit) throws javax.jbi.JBIException(Code)
Add a ServiceUnit object to the list of Service Units deployed to this BC or SE.
Parameters:
  serviceUnit - The ServiceUnit object representing the Service Unit.
throws:
  javax.jbi.JBIException - if the Service Unit is already in the list.



clearBootstrapInstance
public void clearBootstrapInstance()(Code)
Clear the instance reference for the Bootstrap implementation for this BC or SE.



clearBusy
public void clearBusy()(Code)
Clear the "busy" flag.



clearLifeCycleInstance
public void clearLifeCycleInstance()(Code)
Clear the instance reference for the Component implementation for this BC or SE. Also remove the class loader if it exists.



clearStatisticsInstance
public void clearStatisticsInstance()(Code)
Clear the reference to the ComponentStatistics instance for this BC or SE.



clearUpdating
public void clearUpdating()(Code)
Clear the Updating flag. This also clears the Busy flag.



equals
public boolean equals(Object object)(Code)
Compare another Object with this one for equality.
Parameters:
  object - The object to be compared with this one. True if the object is equal to this Component, falseif they are not equal.



getBootstrapClassName
public String getBootstrapClassName()(Code)
Get the class name of the bootstrap implementation for this BC or SE. The bootstrap class name.



getBootstrapClassPathElements
public java.util.List<String> getBootstrapClassPathElements()(Code)
Get the class path elements that this BC or SE needs in its bootstrap runtime environment. A list of the elements of the bootstrap class path as strings.



getBootstrapInstance
public javax.jbi.component.Bootstrap getBootstrapInstance(boolean canCreate) throws javax.jbi.JBIException(Code)
Get an instance of the bootstrap class for this BC or SE. This method can create a new instance if necessary. This is controlled by the canCreate parameter. If the value of canCreate is true, then if there is no instance of the bootstrap class a new one is created. In this case, the return value is guaranteed to be non-null. If the value of canCreate is false, then a new instance of the bootstrap class is never created. In this case, the return value can be null if there is no bootstrap instance.
Parameters:
  canCreate - Is true if a new instance of the bootstrap class canbe created if one does not already exist, and false if no new instancecan be created. The bootstrap class instance.
throws:
  javax.jbi.JBIException - if the class cannot be loaded.



getClassPathElements
public List<String> getClassPathElements()(Code)
Get the class path elements that this BC or SE needs in its runtime environment. A list of the elements of the component's class path as strings.



getComponentClassName
public String getComponentClassName()(Code)
Get the class name of the component implementation for this BC or SE. The component class name.



getComponentClassPathAsString
public String getComponentClassPathAsString()(Code)
Get the complete classpath for this component as a String. The full classpath value.



getComponentClassPathElements
public List<String> getComponentClassPathElements()(Code)
Get the class path elements that this BC or SE needs in its runtime environment. A list of the elements of the component's class path as strings.



getComponentInstance
public javax.jbi.component.Component getComponentInstance()(Code)
Get the javax.jbi.component.Component instance for the BC or SE. If none is available, returns null. The instance of javax.jbi.component.Component or null if noinstance is currently available.



getComponentType
public ComponentType getComponentType()(Code)
Get the component type for this BC or SE. The component type (BINDING or ENGINE).



getComponentTypeAsString
public String getComponentTypeAsString()(Code)
Get the component type for this BC or SE as a string. The component type as a string ("binding" or "engine").



getConfigurationMBeanName
public javax.management.ObjectName getConfigurationMBeanName()(Code)
Get the JMX ObjectName for the component configuration Dynamic MBean. the objectName The JMX ObjectName of the component configurationDynamic MBean.



getContext
public ComponentContext getContext()(Code)
Get the ComponentContext for this BC or SE. The context for the component.



getDeployerInstance
public Deployer getDeployerInstance()(Code)
Get the Deployer instance for the BC or SE. If none is available, returns null. The instance of Deployer or null if no instance is currentlyavailable.



getDeployerMBeanName
public javax.management.ObjectName getDeployerMBeanName()(Code)
Get the JMX ObjectName for the Deployer MBean. The ObjectName if the MBean is registered, null if not.



getDescription
public String getDescription()(Code)
Get the description for this BC or SE. The component description.



getDesiredState
public ComponentState getDesiredState()(Code)
Get the desired state of this component. The state, either, SHUTDOWN, STARTED,or STOPPED.



getExtensionMBeanName
public javax.management.ObjectName getExtensionMBeanName()(Code)
Get the JMX ObjectName for the bootstrap extension MBean. The ObjectName if the MBean is registered, null if not.



getInstallRoot
public String getInstallRoot()(Code)
Get the root installation directory for this BC or SE. The component installation root directory.



getInstallationDescriptor
public String getInstallationDescriptor()(Code)
Get the installation descriptor (jbi.xml) for the component as a String. the Installation Descriptor for the component.



getInstallationDescriptorModel
public com.sun.jbi.management.descriptor.ComponentDescriptor getInstallationDescriptorModel()(Code)
Get the wrapped JAXB model for the installation descriptor (jbi.xml) for the component. the wrapped JAXB model for the installation descriptor.



getInstallerMBeanName
public javax.management.ObjectName getInstallerMBeanName()(Code)
Get the JMX ObjectName for the Installer MBean. The ObjectName if the MBean is registered, null if not.



getLifeCycleInstance
public javax.jbi.component.ComponentLifeCycle getLifeCycleInstance(boolean canCreate) throws javax.jbi.JBIException(Code)
Get an instance of the life cycle class for this BC or SE. This method can create a new instance if necessary. This is controlled by the canCreate parameter. If the value of canCreate is true, then if there is no instance of the life cycle class a new one is created. In this case, the return value is guaranteed to be non-null. If the value of canCreate is false, then a new instance of the life cycle class is never created. In this case, the return value can be null if there is no life cycle instance.
Parameters:
  canCreate - is true if a new instance of the life cycle class canbe created if one does not already exist, and false if no new instancecan be created. The life cycle class instance.
throws:
  javax.jbi.JBIException - if the class cannot be loaded.



getLifeCycleMBeanName
public javax.management.ObjectName getLifeCycleMBeanName()(Code)
Get the JMX ObjectName for the LifeCycle MBean. The ObjectName if the MBean is registered, null if not.



getLoggerInstance
public ComponentLogger getLoggerInstance()(Code)
Get the logger MBean instance. the ComponentLogger object.



getLoggerMBeanName
public javax.management.ObjectName getLoggerMBeanName()(Code)
Get the JMX ObjectNames for the logger MBean. the LoggerMBean object name.



getName
public String getName()(Code)
Get the unique name for this BC or SE. The name.



getProperties
public Map getProperties()(Code)
Get the component properties. TODO the component properties



getServiceUnit
public ServiceUnit getServiceUnit(String serviceUnitName)(Code)
Get the ServiceUnit object for a specified Service Unit name. If none is found, return null.
Parameters:
  serviceUnitName - The unique name of the Service Unit. The Service Unit or null if not found.



getServiceUnitList
public List<com.sun.jbi.ServiceUnitInfo> getServiceUnitList()(Code)
Get the list of ServiceUnit objects representing all Service Units currently deployed to this BC or SE. A list of the ServiceUnit objects.



getServiceUnitManager
public javax.jbi.component.ServiceUnitManager getServiceUnitManager()(Code)
Get the ServiceUnitManager instance for this component, if one is available. the Service Unit Manager or null if there is none.



getSharedLibraryNames
public List<String> getSharedLibraryNames()(Code)
Get the list of Shared Library names required by this BC or SE. A list of the Shared Library names as strings.



getStatisticsInstance
public ComponentStatistics getStatisticsInstance()(Code)
Get the instance of the statistics MBean. If there is none, return null. Instance of com.sun.jbi.monitoring.ComponentStatisticsBaseor null if no instance is currently available.



getStatisticsMBeanName
public javax.management.ObjectName getStatisticsMBeanName()(Code)
Get the JMX ObjectName for the statistics MBean. The ObjectName if the MBean is registered, null if not.



getStatus
public ComponentState getStatus()(Code)
Get the status of this component. The status, either LOADED, SHUTDOWN,STARTED, or STOPPED.



getStatusAsString
public String getStatusAsString()(Code)
Get the status of this component as a string value. The status as a string, either "loaded", "installed", "started",or "stopped".



getStatusAsString
public String getStatusAsString(ComponentState status)(Code)
Get a component state as a string value.
Parameters:
  status - A state, either LOADED, SHUTDOWN,STARTED, or STOPPED. The status as a string, either "loaded", "installed", "started",or "stopped".



getWorkspaceRoot
public String getWorkspaceRoot()(Code)
Get the workspace root directory for this BC or SE. The workspace root directory.



hashCode
public int hashCode()(Code)
Get the hash code for this Component instance. The hash code.



isBinding
public boolean isBinding()(Code)
Check to see if this component is a BC. True if the component is a BC, false if not.



isBootstrapClassLoaderSelfFirst
public boolean isBootstrapClassLoaderSelfFirst()(Code)
Check to see if the bootstrap class loader should use a self-first search hierarchy. True if the bootstrap class loader should use a self-firstsearch hierarchy, false if it should use parent-first.



isBootstrapCleanUpNeeded
public boolean isBootstrapCleanUpNeeded()(Code)
Check to see if the bootstrap cleanUp() method needs to be called. true if the bootstrap cleanUp() method should be called, orfalse if it has already been called.



isBusy
public boolean isBusy()(Code)
Check to see if this component is processing a life cycle request. True if the component busy, false if not.



isClassLoaderSelfFirst
public boolean isClassLoaderSelfFirst()(Code)
Return an indication of whether the class loaders for this component should use the self-first hierarchy. true/false depending on the value of the ClassLoaderSelfFirst attribute.



isComponentClassLoaderSelfFirst
public boolean isComponentClassLoaderSelfFirst()(Code)
Check to see if the component class loader should use a self-first search hierarchy. True if the component class loader should use a self-firstsearch hierarchy, false if it should use parent-first.



isEngine
public boolean isEngine()(Code)
Check to see if this component is a SE. True if the component is a SE, false if not.



isInitialized
public boolean isInitialized()(Code)
Check to see if this component is initialized. True if the component is initialized, false if not.



isInstalled
public boolean isInstalled()(Code)
Check to see if this component is installed. True if the component is installed, false if not.



isLoaded
public boolean isLoaded()(Code)
Check to see if this component is loaded. True if the component is loaded, false if not.



isObserver
public boolean isObserver()(Code)
Check to see if this component is an NMR observer. true if the component is an observer,false if not.



isServiceUnitRegistered
public boolean isServiceUnitRegistered(String serviceUnitName)(Code)
Check to see if a Service Unit is registered to this component.
Parameters:
  serviceUnitName - the unique name of the Service Unit. true if the Service Unit is registered, false if not.



isShutDown
public boolean isShutDown()(Code)
Check to see if this component is shut down. True if the component is shut down, false if not.



isStarted
public boolean isStarted()(Code)
Check to see if this component is started. True if the component is started, false if not.



isStopped
public boolean isStopped()(Code)
Check to see if this component is stopped. True if the component is stopped, false if not.



isUpdating
public boolean isUpdating()(Code)
Check to see if this component is being updated. True if the component is being updated, false if not.



removeServiceUnit
public void removeServiceUnit(String serviceUnitName) throws javax.jbi.JBIException(Code)
Remove a ServiceUnit object from the list of Service Units deployed to this BC or SE.
Parameters:
  serviceUnitName - The name of the Service Unit.
throws:
  javax.jbi.JBIException - if no service unit is found by thespecified name.



setBootstrapClassLoaderSelfFirst
public void setBootstrapClassLoaderSelfFirst(boolean isSelfFirst)(Code)
Set the flag that determines the hierarchy for the bootstrap class loader which is true for self-first or false for parent-first.
Parameters:
  isSelfFirst - is true for a self-first class loading hierarchy, orfalse for a parent-first hierarchy.



setBootstrapClassName
public void setBootstrapClassName(String className)(Code)
Set the class name of the bootstrap implementation for this BC or SE.
Parameters:
  className - The bootstrap class name.



setBootstrapClassPathElements
public void setBootstrapClassPathElements(List classPathElements)(Code)
Set the class path elements for the bootstrap implementation for this BC or SE.
Parameters:
  classPathElements - The list of class path elements as strings.



setBootstrapCleanUpNeeded
public void setBootstrapCleanUpNeeded(boolean isCleanUpNeeded)(Code)
Set the flag that indicates whether the bootstrap cleanUp() method needs to be called.
Parameters:
  isCleanUpNeeded - true if the bootstrap cleanUp() method should becalled, or false if it has already been called.



setBusy
public synchronized void setBusy() throws javax.jbi.JBIException(Code)
Set the flag indicating the component is busy processing a life cycle operation. This method is synchronized so that the flag can be set by only one caller at any time. If the flag is already set, an exception is thrown indicating that an operation is already in progress on the component.
throws:
  javax.jbi.JBIException - when the component is already busy.



setBusyForce
public void setBusyForce()(Code)
Set the flag indicating the component is busy processing a life cycle operation. This method is used only when processing a forced shutdown of the component. No checking is done for the busy flag already being set. Do NOT use this method for any purpose other than during a forced shutdown of the component, or the results will be unpredictable.



setComponentClassLoaderSelfFirst
public void setComponentClassLoaderSelfFirst(boolean isSelfFirst)(Code)
Set the flag that determines the hierarchy for the component class loader which is true for self-first or false for parent-first.
Parameters:
  isSelfFirst - is true for a self-first class loading hierarchy, orfalse for a parent-first hierarchy.



setComponentClassName
public void setComponentClassName(String className)(Code)
Set the class name of the Component implementation for this component.
Parameters:
  className - The life cycle class name.



setComponentClassPathElements
public void setComponentClassPathElements(List classPathElements)(Code)
Set the class path elements that this BC or SE needs in its runtime environment.
Parameters:
  classPathElements - A list containing the class path elements asstrings.



setComponentInstance
public void setComponentInstance(javax.jbi.component.Component classInstance)(Code)
Set the class instance of the Component implementation for this BC or SE.
Parameters:
  classInstance - The Component class instance.



setComponentType
public void setComponentType(ComponentType type)(Code)
Set the component type.
Parameters:
  type - The component type.



setComponentTypeBinding
public void setComponentTypeBinding()(Code)
Set the component type for a BC.



setComponentTypeEngine
public void setComponentTypeEngine()(Code)
Set the component type for a SE.



setConfigurationMBeanName
public void setConfigurationMBeanName(javax.management.ObjectName objectName)(Code)
Set the JMX ObjectName for the component configuration Dynamic MBean.
Parameters:
  objectName - The JMX ObjectName of the component configurationDynamic MBean.



setContext
public void setContext(ComponentContext context)(Code)
Set the ComponentContext for this BC or SE.
Parameters:
  context - The componet's context.



setDeployerInstance
public void setDeployerInstance(Deployer deployer)(Code)
Set the component's Deployer instance.
Parameters:
  deployer - the instance of Deployer for the component.



setDeployerMBeanName
public void setDeployerMBeanName(javax.management.ObjectName objectName)(Code)
Set the JMX ObjectName for the DeployerMBean.
Parameters:
  objectName - The JMX ObjectName of the DeployerMBean.



setDescription
public void setDescription(String description)(Code)
Set the description of this BC or SE.
Parameters:
  description - The description.



setDesiredState
public void setDesiredState(ComponentState state)(Code)
Set the desired state of a component.
Parameters:
  state - The desired state to be set.Valid states are SHUTDOWN, STOPPED, andSTARTED.



setExtensionMBeanName
public void setExtensionMBeanName(javax.management.ObjectName objectName)(Code)
Set the JMX ObjectName for the bootstrap ExtensionMBean.
Parameters:
  objectName - The JMX ObjectName of the ExtensionMBean.



setInstallRoot
public void setInstallRoot(String installRoot)(Code)
Set the root installation directory for this BC or SE.
Parameters:
  installRoot - The component's install root directory.



setInstallationDescriptor
public void setInstallationDescriptor(String jbiXml)(Code)
Set the installation descriptor for this component.
Parameters:
  jbiXml - - the string representation of the installation descriptorfor this Component



setInstallerMBeanName
public void setInstallerMBeanName(javax.management.ObjectName objectName)(Code)
Set the JMX ObjectName for the InstallerMBean.
Parameters:
  objectName - The JMX ObjectName of the InstallerMBean.



setLifeCycleMBeanName
public void setLifeCycleMBeanName(javax.management.ObjectName objectName)(Code)
Set the JMX ObjectName for the LifeCycleMBean.
Parameters:
  objectName - The JMX ObjectName of the LifeCycleMBean.



setLoaded
public void setLoaded()(Code)
Set the component state to loaded. The only time a component can be in this state is when its bootstrap class is loaded for an install or an uninstall that has not yet completed.



setLoggerInstance
public void setLoggerInstance(ComponentLogger instance)(Code)
Set the ComponentLoggerMBean instance for this component.
Parameters:
  instance - The ComponentLogger instance.



setLoggerMBeanName
public void setLoggerMBeanName(javax.management.ObjectName objectName)(Code)
Set the LoggerMBean ObjectName for this component.
Parameters:
  objectName - The ObjectName for the logger MBean.



setName
public void setName(String name)(Code)
Set the name for this BC or SE.
Parameters:
  name - The name.



setObserver
public void setObserver(boolean isObserver)(Code)
Set the observer flag for this component. This flag indicates whether the component is an NMR observer.
Parameters:
  isObserver - true indicates that the component is anNMR observer, false indicates that it is not.



setSharedLibraryNames
public void setSharedLibraryNames(List<String> nameList)(Code)
Set the list of Shared Library names required by this BC or SE. The names must be in the list in the order in which the Shared Libraries should appear in the class path.
Parameters:
  nameList - A list containing the names as Strings.



setShutdown
public void setShutdown()(Code)
Set the component state to shutdown (installed but not active).



setStarted
public void setStarted()(Code)
Set the component state to started.



setStatisticsInstance
public void setStatisticsInstance(ComponentStatistics classInstance)(Code)
Set the instance of ComponentStatistics for this BC or SE.
Parameters:
  classInstance - The ComponentStatistics instance.



setStatisticsMBeanName
public void setStatisticsMBeanName(javax.management.ObjectName objectName)(Code)
Set the JMX ObjectName for the StatisticsMBean.
Parameters:
  objectName - The JMX ObjectName of the StatisticsMBean.



setStatus
public void setStatus(ComponentState status)(Code)
Set the component state. This method is used ONLY by startup and unit test code. It does no validation of the state.
Parameters:
  status - The ComponentState to be set.Valid states are LOADED, SHUTDOWN,STOPPED, and STARTED.



setStopped
public void setStopped()(Code)
Set the component state to stopped.



setUpdating
public void setUpdating() throws javax.jbi.JBIException(Code)
Set the Updating flag indicating the component is being updated. This requires first setting the Busy flag to prevent any life cycle operations from being processed for the component while it is being updated. If the Busy flag is already set, this means that a life cycle operation is in progress and the update cannot proceed. In this case an exception is thrown.



setWorkspaceRoot
public void setWorkspaceRoot(String workspaceRoot)(Code)
Set the workspace root directory for this BC or SE.
Parameters:
  workspaceRoot - The component workspace root directory.



toString
public String toString()(Code)
Convert to a String. The String representation of this Component.



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.