weblogic.descriptor

Interface DescriptorBean

All Superinterfaces:

SettableBean

All Known Subinterfaces:

AdjudicatorMBean, AdminConsoleMBean, AdminMBean, AdminServerMBean, AdminVirtualTargetMBean, AnyIdentityDomainAuthenticatorMBean, AppDeploymentMBean, ApplicationMBean, ApplicationVersionerMBean, AuditorMBean, AuthConfigProviderMBean, AuthenticationProviderMBean, AuthenticatorMBean, AuthModuleMBean, AuthorizerMBean, BaseExecutorServiceMBean, BaseThreadFactoryMBean, BasicDeploymentMBean, BatchConfigMBean, BridgeDestinationCommonMBean, BridgeDestinationMBean, CacheAsyncListenersMBean, CacheExpirationMBean, CacheLoaderMBean, CacheMBean, CacheStoreMBean, CacheTransactionMBean, CapacityMBean, CdiContainerMBean, CertPathBuilderMBean, CertPathProviderMBean, CertPathValidatorMBean, CertRevocCaMBean, CertRevocMBean, ClassDeploymentMBean, ClusterMBean, CoherenceCacheConfigMBean, CoherenceClusterSystemResourceMBean, CoherenceManagementAddressProviderMBean, CoherenceManagementClusterMBean, CoherenceMemberConfigMBean, CoherencePartitionCacheConfigMBean, CoherencePartitionCachePropertyMBean, CoherenceServerMBean, CoherenceServerStartMBean, CoherenceTierMBean, COMMBean, CommonLogMBean, ComponentMBean, ConfigurationExtensionMBean, ConfigurationMBean, ConfigurationPropertiesMBean, ConfigurationPropertyMBean, ConnectorComponentMBean, ContextCaseMBean, ContextHandlerMBean, ContextRequestClassMBean, ConversationServiceMBean, CpuUtilizationMBean, CredentialCacheMBean, CredentialMapperMBean, CustomAuthConfigProviderMBean, CustomResourceMBean, DatabaseLessLeasingBasisMBean, DatasourceInterceptorMBean, DataSourceLogFileMBean, DataSourceMBean, DataSourcePartitionMBean, DebugMBean, DebugPatchesMBean, DebugScopeMBean, DefaultFileStoreMBean, DeployableAuthorizerMBean, DeployableCredentialMapperMBean, DeployableRoleMapperMBean, DeploymentConfigOverridesMBean, DeploymentConfigurationMBean, DeploymentMBean, DeploymentValidationPluginMBean, DomainLibraryMBean, DomainMBean, DomainTargetedMBean, DynamicDeploymentMBean, DynamicServersMBean, EJBComponentMBean, EJBContainerMBean, EmbeddedLDAPMBean, ExecuteQueueMBean, ExportMBean, FairShareConstraintMBean, FairShareRequestClassMBean, FederationServicesMBean, FileOpenMBean, FileStoreMBean, FileT3MBean, ForeignConnectionFactoryOverrideMBean, ForeignDestinationOverrideMBean, ForeignJMSConnectionFactoryMBean, ForeignJMSDestinationMBean, ForeignJMSServerMBean, ForeignJNDILinkMBean, ForeignJNDILinkOverrideMBean, ForeignJNDIObjectMBean, ForeignJNDIProviderMBean, ForeignJNDIProviderOverrideMBean, ForeignServerOverrideMBean, GenericFileStoreMBean, GenericJDBCStoreMBean, GroupEditorMBean, GroupMemberListerMBean, GroupMembershipHierarchyCacheMBean, GroupReaderMBean, GroupRemoverMBean, GroupUserListerMBean, GzipCompressionMBean, HeapRetainedMBean, HTTPProxyMBean, IdentityAsserterMBean, IdentityDomainAuthenticatorMBean, IdentityDomainAwareProviderMBean, IIOPMBean, ImportMBean, InterceptorMBean, InterceptorsMBean, JASPICMBean, JDBCPoolComponentMBean, JDBCPropertyOverrideMBean, JDBCStoreMBean, JDBCSystemResourceMBean, JDBCSystemResourceOverrideMBean, JMSBridgeDestinationMBean, JMSConnectionConsumerMBean, JMSConnectionFactoryMBean, JMSDestCommonMBean, JMSDestinationKeyMBean, JMSDestinationMBean, JMSDistributedDestinationMBean, JMSDistributedDestinationMemberMBean, JMSDistributedQueueMBean, JMSDistributedQueueMemberMBean, JMSDistributedTopicMBean, JMSDistributedTopicMemberMBean, JMSFileStoreMBean, JMSInteropModuleMBean, JMSJDBCStoreMBean, JMSMessageLogFileMBean, JMSQueueMBean, JMSSAFMessageLogFileMBean, JMSServerMBean, JMSSessionPoolMBean, JMSStoreMBean, JMSSystemResourceMBean, JMSSystemResourceOverrideMBean, JMSTemplateMBean, JMSTopicMBean, JMSVirtualDestinationMBean, JMXMBean, JoltConnectionPoolMBean, JPAMBean, JTAClusterMBean, JTAMBean, JTAMigratableTargetMBean, JTAPartitionMBean, KernelDebugMBean, KernelMBean, KeyStoreMBean, LDAPServerMBean, LeastOccupiedPartitionConfiguratorMBean, LibraryMBean, LifecycleManagerConfigMBean, LifecycleManagerEndPointMBean, ListerMBean, LogFileMBean, LogFilterMBean, LogMBean, MachineMBean, MailSessionMBean, MailSessionOverrideMBean, ManagedExecutorServiceMBean, ManagedExecutorServiceTemplateMBean, ManagedExternalServerMBean, ManagedExternalServerStartMBean, ManagedScheduledExecutorServiceMBean, ManagedScheduledExecutorServiceTemplateMBean, ManagedThreadFactoryMBean, ManagedThreadFactoryTemplateMBean, MaxThreadsConstraintMBean, MemberGroupListerMBean, MessagingBridgeMBean, MigratableRMIServiceMBean, MigratableTargetMBean, MinThreadsConstraintMBean, MultiIdentityDomainAuthenticatorMBean, NameListerMBean, NetworkAccessPointMBean, NetworkChannelMBean, NodeManagerMBean, OptionalFeatureDeploymentMBean, OptionalFeatureMBean, OsgiFrameworkMBean, OverloadProtectionMBean, ParameterMBean, PartitionConfiguratorMBean, PartitionFileSystemMBean, PartitionLogMBean, PartitionMBean, PartitionPropertyMBean, PartitionTemplateMBean, PartitionUserFileSystemMBean, PartitionWorkManagerMBean, PasswordValidatorMBean, PathServiceMBean, PersistentStoreMBean, PKICredentialMapEditorMBean, PKICredentialMapExtendedEditorMBean, PKICredentialMapExtendedReaderMBean, PKICredentialMapReaderMBean, PolicyAuxiliaryMBean, PolicyConsumerMBean, PolicyEditorMBean, PolicyListerMBean, PolicyReaderMBean, PolicyStoreMBean, PostProcessorScriptMBean, PredicateEditorMBean, PredicateReaderMBean, PreProcessorScriptMBean, PropertiesListerMBean, ProviderMBean, RCMResourceFairShareMBean, RCMResourceMBean, RDBMSSecurityStoreMBean, RealmMBean, ReplicatedStoreMBean, ResourceGroupMBean, ResourceGroupTemplateMBean, ResourceManagementMBean, ResourceManagerMBean, ResponseTimeRequestClassMBean, RestartLoopProtectionMBean, RestfulManagementServicesMBean, RMCFactoryMBean, RoleAuxiliaryMBean, RoleConsumerMBean, RoleEditorMBean, RoleListerMBean, RoleMapperMBean, RoleReaderMBean, RunawayThreadsMBean, SAFAgentMBean, SCAContainerMBean, ScriptInterceptorMBean, ScriptMBean, SecureModeMBean, SecurityConfigurationMBean, SelfTuningMBean, ServerDebugMBean, ServerFailureTriggerMBean, ServerMBean, ServerStartMBean, ServerTemplateMBean, ServletAuthenticationFilterMBean, ShutdownClassMBean, SingleSignOnServicesMBean, SingletonServiceAppScopedMBean, SingletonServiceBaseMBean, SingletonServiceMBean, SNMPAgentDeploymentMBean, SNMPAgentMBean, SNMPAttributeChangeMBean, SNMPCounterMonitorMBean, SNMPGaugeMonitorMBean, SNMPJMXMonitorMBean, SNMPLogFilterMBean, SNMPProxyMBean, SNMPStringMonitorMBean, SNMPTrapDestinationMBean, SNMPTrapSourceMBean, SSLMBean, StartupClassMBean, StuckThreadActionMBean, SubDeploymentMBean, SystemComponentConfigurationMBean, SystemComponentMBean, SystemComponentStartMBean, SystemResourceMBean, TargetInfoMBean, TargetMBean, ThreadRunningMBean, TLSMBean, TransactionLogJDBCStoreMBean, TransactionLogStoreMBean, TriggerMBean, UnixMachineMBean, UserAttributeEditorMBean, UserAttributeReaderMBean, UserEditorMBean, UserLockoutManagerMBean, UserPasswordCredentialMapEditorMBean, UserPasswordCredentialMapExtendedEditorMBean, UserPasswordCredentialMapExtendedReaderMBean, UserPasswordCredentialMapExtendedV2ReaderMBean, UserPasswordCredentialMapReaderMBean, UserPasswordEditorMBean, UserReaderMBean, UserRemoverMBean, VirtualDestinationMBean, VirtualHostMBean, VirtualTargetMBean, WebAppComponentMBean, WebAppContainerMBean, WebDeploymentMBean, WebServerLogMBean, WebServerMBean, WebServiceBufferingMBean, WebServiceBufferingQueueMBean, WebServiceComponentMBean, WebserviceCredentialProviderMBean, WebServiceLogicalStoreMBean, WebServiceMBean, WebServicePersistenceMBean, WebServicePhysicalStoreMBean, WebServiceReliabilityMBean, WebServiceRequestBufferingQueueMBean, WebServiceResponseBufferingQueueMBean, WebserviceSecurityConfigurationMBean, WebserviceSecurityMBean, WebserviceSecurityTokenMBean, WebserviceTestpageMBean, WebserviceTimestampMBean, WebserviceTokenHandlerMBean, WLDFDataRetirementByAgeMBean, WLDFDataRetirementMBean, WLDFServerDiagnosticMBean, WLDFSystemResourceMBean, WLSAuthConfigProviderMBean, WorkManagerMBean, WorkManagerShutdownTriggerMBean, WSReliableDeliveryPolicyMBean, WTCExportMBean, WTCImportMBean, WTCLocalTuxDomMBean, WTCPasswordMBean, WTCRemoteTuxDomMBean, WTCResourcesMBean, WTCServerMBean, WTCtBridgeGlobalMBean, WTCtBridgeRedirectMBean, XMLEntityCacheMBean, XMLEntitySpecRegistryEntryMBean, XMLParserSelectRegistryEntryMBean, XMLRegistryEntryMBean, XMLRegistryMBean

All Known Implementing Classes:

AbstractCommoConfigurationBean, weblogic.descriptor.internal.AbstractDescriptorBean

public interface DescriptorBean
extends SettableBean

The DescriptorBean interface is implemented by every bean in a descriptor bean graph.

Note that a descriptor bean may be implemented either as editable or runtime. A runtime implmentation is read-only from the caller's point of view and will throw UnsupportedOperationException from all mutating methods as well as methods on this interface that are not useful in a runtime setting.

Method Summary

Modifier and Type	Method and Description
void	addBeanUpdateListener(BeanUpdateListener listener) Registers a listener for handling batch updates introduced through Descriptor.prepareUpdate(weblogic.descriptor.Descriptor) and Descriptor.activateUpdate().
void	addPropertyChangeListener(java.beans.PropertyChangeListener listener) Add a normal property change listener.
DescriptorBean	createChildCopy(java.lang.String propertyName, DescriptorBean beanToCopy) Creates a new child bean property that is a copy of beanToCopy and associates it with the property named propertyName.
DescriptorBean	createChildCopyIncludingObsolete(java.lang.String propertyName, DescriptorBean beanToCopy) Variation on createChildCopy that also copies @obsolete properties
Descriptor	getDescriptor() Returns the descriptor to which this bean belongs.
DescriptorBean	getParentBean() Returns the bean that is the parent of this bean.
boolean	isEditable()
void	removeBeanUpdateListener(BeanUpdateListener listener) Remove previously registered prepare listener.
void	removePropertyChangeListener(java.beans.PropertyChangeListener listener) Remove property change listener.

Methods inherited from interface weblogic.descriptor.SettableBean

isSet, unSet

Method Detail

getDescriptor

Descriptor getDescriptor()

Returns the descriptor to which this bean belongs.

Returns:

containing descriptor see bug 16344045

Excluded in public API Reference.

getParentBean

DescriptorBean getParentBean()

Returns the bean that is the parent of this bean.

Returns:

parent bean or null if this bean is the root.

addPropertyChangeListener

void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

Add a normal property change listener. This listener is fired whenever a setter is called on this bean. Use DescriptorBean.addBeanUpdateListener(weblogic.descriptor.BeanUpdateListener) for batch updates. While it is called when the setter is called, a BeanUpdateListener is not called until all updates have been applied to entire descriptor graph.

Parameters:

listener -

removePropertyChangeListener

void removePropertyChangeListener(java.beans.PropertyChangeListener listener)

Remove property change listener.

Parameters:

listener -

addBeanUpdateListener

void addBeanUpdateListener(BeanUpdateListener listener)

Registers a listener for handling batch updates introduced through Descriptor.prepareUpdate(weblogic.descriptor.Descriptor) and Descriptor.activateUpdate(). It will be called whenever changes to this bean are prepared, activated or rolled back.

Parameters:

listener - Listener to be called when change is prepared, activated or rolled back. see bug 16344045

Excluded in public API Reference.

removeBeanUpdateListener

void removeBeanUpdateListener(BeanUpdateListener listener)

Remove previously registered prepare listener. see bug 16344045

Excluded in public API Reference.

isEditable

boolean isEditable()

Returns:

true if this bean is part of a modifiable descriptor

createChildCopy

DescriptorBean createChildCopy(java.lang.String propertyName,
                               DescriptorBean beanToCopy)
                        throws java.lang.IllegalArgumentException,
                               BeanAlreadyExistsException

Creates a new child bean property that is a copy of beanToCopy and associates it with the property named propertyName. This call is equivalent to calling create() where the returned bean is a deep copy of beanToCopy.

Parameters:

propertyName - Child property name. This may be either a singleton child property name or the property component name of an array of children.

beanToCopy - Bean to copy

Returns:

New child

Throws:

java.lang.IllegalArgumentException - if propertyName is not the name of a singleton child property or the component name of a array of children property; also if the type of beanToCopy is not compatible with the property type.

BeanAlreadyExistsException - if beanToCopy has the same key as an existing child. see bug 16344045

Excluded in public API Reference.

createChildCopyIncludingObsolete

DescriptorBean createChildCopyIncludingObsolete(java.lang.String propertyName,
                                                DescriptorBean beanToCopy)
                                         throws java.lang.IllegalArgumentException,
                                                BeanAlreadyExistsException

Variation on createChildCopy that also copies @obsolete properties

Parameters:

propertyName -

beanToCopy -

Returns:

copy

Throws:

java.lang.IllegalArgumentException

BeanAlreadyExistsException