Package weblogic.management.configuration

Interface LifecycleManagerConfigMBean

All Superinterfaces:

ConfigurationMBean, DescriptorBean, javax.management.DynamicMBean, javax.management.MBeanRegistration, javax.management.NotificationBroadcaster, SettableBean, WebLogicMBean

public interface LifecycleManagerConfigMBean
extends ConfigurationMBean

LifecycleManagerConfigMBean maintains the information necessary to enable and configure a LifecycleManager instance associated with this domain. LifecycleManager instances may either be local or remote to this domain. User credentials may be configured to support authentication, especially important when interaction with a remote domain.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DEPLOYMENT_TYPE_ADMIN	Specifies that the LifecycleManager will be targeted and available on the admin server of this domain.
static java.lang.String	DEPLOYMENT_TYPE_HA	Specifies that the LifecycleManager will be targeted and available on a cluster in this domain, identified by the Target attribute.
static java.lang.String	DEPLOYMENT_TYPE_NONE	Specifies that the LifecycleManager services will be not be started as part of this domain.
static java.lang.String	PERSISTENCE_TYPE_DB	Specifies that the LifecycleManager will persist its configuration in a database, and will use the DataSource specified in the DataSourceName attribute to interact with this database.
static java.lang.String	PERSISTENCE_TYPE_XML	Specifies that the LifecycleManager persist its configuration in a single local XML file.

Fields inherited from interface weblogic.management.configuration.ConfigurationMBean

DEFAULT_EMPTY_BYTE_ARRAY

Method Summary

Modifier and Type	Method	Description
LifecycleManagerEndPointMBean	createConfiguredEndPoint(java.lang.String name)	Factory for creating a new LifecycleManager endpoint configuration.
void	destroyConfiguredEndPoint(LifecycleManagerEndPointMBean endpoint)	Deletes a LifecycleManager endpoint.
long	getConfigFileLockTimeout()	Returns the Lifecycle configuration lock timeout.
LifecycleManagerEndPointMBean[]	getConfiguredEndPoints()	Returns the LifecycleManager endpoints that have been configured as involved with this domain.
java.lang.String	getDataSourceName()	Returns the name of the DataSource that should be used when LifecycleManager is configured to maintain its configuration in a database.
java.lang.String	getDeploymentType()	The deployment model for LifecycleManager services in this domain.
LifecycleManagerEndPointMBean[]	getEndPoints()	Returns the REST endpoints for each LifecycleManager that is participating in the management of this domain.
int	getPeriodicSyncInterval()	Get periodic interval for lifecycle configuration synchronization in hours.
java.lang.String	getPersistenceType()	The persistence model that is used by this LifecycleManager service.
long	getPropagationActivateTimeout()	Returns the activation timeout in milliseconds for Lifecycle configuration propagation to managed server.
long	getServerReadyTimeout()	The timeout in milliseconds for waiting for a server to be ready to receive requests.
long	getServerRuntimeTimeout()	Returns the timeout in milliseconds for accessing server runtime mbeans.
TargetMBean	getTarget()	The cluster target defined in the current domain that should host the LifecycleManager service when running deployed in Cluster mode.
boolean	isEnabled()	Determine if LifeycleManager features are available, either locally on this admin server or remotely via a configured endpoint.
boolean	isOutOfBandEnabled()	Determine if LifecycleManager should listen for configuration changes on this server.
LifecycleManagerEndPointMBean	lookupConfiguredEndPoint(java.lang.String name)	Lookup a LifecycleManager EndPoint configuration by name.
void	setConfigFileLockTimeout(long timeInMillis)	Specify Lifecycle configuration lock timeout.
void	setDataSourceName(java.lang.String name)	Changes the name of the DataSource to be used when LifecycleManager is configured to maintain its configuration in a database.
void	setDeploymentType(java.lang.String type)	Specifies the deployment model for LifecycleManager services in this domain.
void	setOutOfBandEnabled(boolean value)	Specify that LifecycleManager should listen for configuration changes on this server.
void	setPeriodicSyncInterval(int numberOfHours)	Specify the periodic interval in hours after which Lifecycle Manager will synchronize its configuration.
void	setPersistenceType(java.lang.String type)	Specifies the persistence model for LifecycleManager services in this domain.
void	setPropagationActivateTimeout(long timeInMillis)	Activation timeout for Lifecycle configuration propagation to managed server in milliseconds .
void	setServerReadyTimeout(long timeInMillis)	The timeout in milliseconds for waiting for a server to be ready to receive requests.
void	setServerRuntimeTimeout(long timeInMillis)	Server runtime mbeans access timeout in milliseconds .
void	setTarget(TargetMBean Target)	Change the cluster target the value for the getTarget attribute.

Methods inherited from interface weblogic.management.configuration.ConfigurationMBean

freezeCurrentValue, getId, getInheritedProperties, getName, getNotes, isDynamicallyCreated, isInherited, isSet, restoreDefaultValue, setComments, setDefaultedMBean, setName, setNotes, setPersistenceEnabled, unSet

Methods inherited from interface weblogic.descriptor.DescriptorBean

addPropertyChangeListener, createChildCopyIncludingObsolete, getParentBean, isEditable, removePropertyChangeListener

Methods inherited from interface javax.management.DynamicMBean

getAttribute, getAttributes, invoke, setAttribute, setAttributes

Methods inherited from interface javax.management.MBeanRegistration

postDeregister, postRegister, preDeregister, preRegister

Methods inherited from interface javax.management.NotificationBroadcaster

addNotificationListener, getNotificationInfo, removeNotificationListener

Methods inherited from interface weblogic.management.WebLogicMBean

getMBeanInfo, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setParent

Field Detail

DEPLOYMENT_TYPE_NONE

static final java.lang.String DEPLOYMENT_TYPE_NONE

Specifies that the LifecycleManager services will be not be started as part of this domain.

See Also:

Constant Field Values

DEPLOYMENT_TYPE_ADMIN

static final java.lang.String DEPLOYMENT_TYPE_ADMIN

Specifies that the LifecycleManager will be targeted and available on the admin server of this domain.

See Also:

Constant Field Values

DEPLOYMENT_TYPE_HA

static final java.lang.String DEPLOYMENT_TYPE_HA

Specifies that the LifecycleManager will be targeted and available on a cluster in this domain, identified by the Target attribute.

See Also:

Constant Field Values

PERSISTENCE_TYPE_XML

static final java.lang.String PERSISTENCE_TYPE_XML

Specifies that the LifecycleManager persist its configuration in a single local XML file.

See Also:

Constant Field Values

PERSISTENCE_TYPE_DB

static final java.lang.String PERSISTENCE_TYPE_DB

Specifies that the LifecycleManager will persist its configuration in a database, and will use the DataSource specified in the DataSourceName attribute to interact with this database.

See Also:

Constant Field Values

Method Detail

getDeploymentType

java.lang.String getDeploymentType()

The deployment model for LifecycleManager services in this domain.

Returns:

the deployment model type

Default Value:

LifecycleManagerConfigMBean.DEPLOYMENT_TYPE_NONE

Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.

Valid Values:

LifecycleManagerConfigMBean.DEPLOYMENT_TYPE_NONE, LifecycleManagerConfigMBean.DEPLOYMENT_TYPE_ADMIN, LifecycleManagerConfigMBean.DEPLOYMENT_TYPE_HA

setDeploymentType

void setDeploymentType(java.lang.String type)

Specifies the deployment model for LifecycleManager services in this domain.

See Also:

getDeploymentType()

getTarget

TargetMBean getTarget()

The cluster target defined in the current domain that should host the LifecycleManager service when running deployed in Cluster mode.

Returns:

the target where LifecycleManager should be available

Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.

setTarget

void setTarget(TargetMBean Target)
        throws javax.management.InvalidAttributeValueException,
               DistributedManagementException

Change the cluster target the value for the getTarget attribute.

Throws:

javax.management.InvalidAttributeValueException

DistributedManagementException

See Also:

getTarget()

getPersistenceType

java.lang.String getPersistenceType()

The persistence model that is used by this LifecycleManager service. Either database or a local XML file may be used for an admin server deployment, but a database configuration model is required for a cluster deployment.

Returns:

the persistence model type

Default Value:

LifecycleManagerConfigMBean.PERSISTENCE_TYPE_XML

Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.

Valid Values:

LifecycleManagerConfigMBean.PERSISTENCE_TYPE_XML, LifecycleManagerConfigMBean.PERSISTENCE_TYPE_DB

setPersistenceType

void setPersistenceType(java.lang.String type)

Specifies the persistence model for LifecycleManager services in this domain.

See Also:

getPersistenceType()

getDataSourceName

java.lang.String getDataSourceName()

Returns the name of the DataSource that should be used when LifecycleManager is configured to maintain its configuration in a database.

Returns:

the name of a DataSource

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

setDataSourceName

void setDataSourceName(java.lang.String name)

Changes the name of the DataSource to be used when LifecycleManager is configured to maintain its configuration in a database.

Parameters:

name -

See Also:

getDataSourceName()

getEndPoints

LifecycleManagerEndPointMBean[] getEndPoints()

Returns the REST endpoints for each LifecycleManager that is participating in the management of this domain.

Returns:

an array of LifecycleManagerEndPointMBean objects

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

getConfiguredEndPoints

LifecycleManagerEndPointMBean[] getConfiguredEndPoints()

Returns the LifecycleManager endpoints that have been configured as involved with this domain.

Returns:

an array of LifecycleManagerEndPointMBean objects

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

lookupConfiguredEndPoint

LifecycleManagerEndPointMBean lookupConfiguredEndPoint(java.lang.String name)

Lookup a LifecycleManager EndPoint configuration by name.

Parameters:

name - The name of the LifecycleManager endpoint configuration

Returns:

LifecycleManagerEndPointMBean object

createConfiguredEndPoint

LifecycleManagerEndPointMBean createConfiguredEndPoint(java.lang.String name)

Factory for creating a new LifecycleManager endpoint configuration.

Parameters:

name - The name of the LifecycleManager endpoint configuration

Returns:

LifecycleManagerEndPointMBean object

destroyConfiguredEndPoint

void destroyConfiguredEndPoint(LifecycleManagerEndPointMBean endpoint)

Deletes a LifecycleManager endpoint.

Parameters:

endpoint - to remove

isEnabled

boolean isEnabled()

Determine if LifeycleManager features are available, either locally on this admin server or remotely via a configured endpoint.

Returns:

true if LifecycleManager is enabled.

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

isOutOfBandEnabled

boolean isOutOfBandEnabled()

Determine if LifecycleManager should listen for configuration changes on this server.

setOutOfBandEnabled

void setOutOfBandEnabled(boolean value)

Specify that LifecycleManager should listen for configuration changes on this server.

Default Value:

false

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

getPeriodicSyncInterval

int getPeriodicSyncInterval()

Get periodic interval for lifecycle configuration synchronization in hours. When synchronizing configuration, Lifecycle contacts the different runtimes that are registered with it, gets the list of partitions from those runtimes, and ensure that its configuration is synchronized with those runtimes.

Returns:

periodic sync interval in hours

Default Value:

2

setPeriodicSyncInterval

void setPeriodicSyncInterval(int numberOfHours)

Specify the periodic interval in hours after which Lifecycle Manager will synchronize its configuration. When synchronizing configuration, Lifecycle contacts the different runtimes that are registered with it, gets the list of partitions from those runtimes, and ensure that its configuration is synchronized with those runtimes.

Parameters:

numberOfHours - number of hours after which periodic sync will be attempted. Specify a value of 0 or less to disable periodic synchronization.

See Also:

getPeriodicSyncInterval()

getConfigFileLockTimeout

long getConfigFileLockTimeout()

Returns the Lifecycle configuration lock timeout. This is used when the persistence type is LifecycleManagerConfigMBean.PERSISTENCE_TYPE_XML, while attempting to lock the configuration file to persist configuration changes.

Returns:

config lock timeout in milliseconds

Default Value:

120000

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

setConfigFileLockTimeout

void setConfigFileLockTimeout(long timeInMillis)

Specify Lifecycle configuration lock timeout. This is used when the persistence type is LifecycleManagerConfigMBean.PERSISTENCE_TYPE_XML, while attempting to lock the configuration file to persist configuration changes. .

Parameters:

timeInMillis - time in milliseconds, for config file lock timeout

See Also:

getConfigFileLockTimeout()

getPropagationActivateTimeout

long getPropagationActivateTimeout()

Returns the activation timeout in milliseconds for Lifecycle configuration propagation to managed server.

Returns:

propagation activation timeout in milliseconds

Default Value:

180000

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

setPropagationActivateTimeout

void setPropagationActivateTimeout(long timeInMillis)

Activation timeout for Lifecycle configuration propagation to managed server in milliseconds .

Parameters:

timeInMillis - propagation activation timeout in milliseconds

See Also:

getPropagationActivateTimeout()

getServerRuntimeTimeout

long getServerRuntimeTimeout()

Returns the timeout in milliseconds for accessing server runtime mbeans.

Returns:

server runtime timeout in milliseconds

Default Value:

600000

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

setServerRuntimeTimeout

void setServerRuntimeTimeout(long timeInMillis)

Server runtime mbeans access timeout in milliseconds .

Parameters:

timeInMillis - timeout in milliseconds

See Also:

getServerRuntimeTimeout()

getServerReadyTimeout

long getServerReadyTimeout()

The timeout in milliseconds for waiting for a server to be ready to receive requests.

Returns:

server ready timeout in milliseconds

Default Value:

60000

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

setServerReadyTimeout

void setServerReadyTimeout(long timeInMillis)

The timeout in milliseconds for waiting for a server to be ready to receive requests.

Parameters:

timeInMillis - timeout in milliseconds

See Also:

getServerReadyTimeout()