Package weblogic.management.configuration

Interface ScriptMBean

All Superinterfaces:

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

All Known Subinterfaces:

PostProcessorScriptMBean, PreProcessorScriptMBean

public interface ScriptMBean
extends ConfigurationMBean

Field Summary

Fields inherited from interface weblogic.management.configuration.ConfigurationMBean

DEFAULT_EMPTY_BYTE_ARRAY

Method Summary

Modifier and Type	Method	Description
java.lang.String[]	getArguments()	The arguments to the command script as well as for the error-handler script
java.util.Properties	getEnvironment()	Returns the properties used to create environment for the script sub-process.
int	getNumberOfRetriesAllowed()
java.lang.String	getPathToErrorHandlerScript()	Returns the path to the error handler script to be executed.
java.lang.String	getPathToScript()	Returns the path to the script to be executed.
long	getRetryDelayInMillis()
int	getTimeoutInSeconds()	Returns the timeout interval for script execution in seconds.
java.lang.String	getWorkingDirectory()
boolean	isIgnoreFailures()
void	setArguments(java.lang.String[] arguments)	Sets the arguments to the command script as well as for the error-handler script
void	setEnvironment(java.util.Properties environment)	Set properties to be used to create environment for the script sub-process.
void	setIgnoreFailures(boolean ignore)	Set ignoreFailures flag
void	setNumberOfRetriesAllowed(int retries)	Set number of allowed retries
void	setPathToErrorHandlerScript(java.lang.String pathToErrorHandlerScript)
void	setPathToScript(java.lang.String pathToScript)
void	setRetryDelayInMillis(long retryDelay)	Set retry delay
void	setTimeoutInSeconds(int timeout)	Sets the timeout interval in seconds for script execution.
void	setWorkingDirectory(java.lang.String workingDirectory)	Set working directory for running the script

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

Method Detail

getWorkingDirectory

java.lang.String getWorkingDirectory()

Returns:

Working directory which will be used to run the script. If not set or empty, the working directory of the server will be used.

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

setWorkingDirectory

void setWorkingDirectory(java.lang.String workingDirectory)

Set working directory for running the script

Parameters:

workingDirectory - Working directory to be used while running the script

getPathToScript

java.lang.String getPathToScript()

Returns the path to the script to be executed. If null or empty, the script will not be executed. The value should be the path to the script program. If the command is not set, the script is effectively disabled. When specified as a relative path, it will be relative to DomainDir/bin/scripts directory. When specified as an absolute path, the script must be under DomainDir/bin/scripts directory.

Returns:

Script command.

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

setPathToScript

void setPathToScript(java.lang.String pathToScript)

Parameters:

the - path to the Script command

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

getArguments

java.lang.String[] getArguments()

The arguments to the command script as well as for the error-handler script

Returns:

the arguments to the command script as well as for the error-handler script

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

setArguments

void setArguments(java.lang.String[] arguments)

Sets the arguments to the command script as well as for the error-handler script

Parameters:

arguments - the arguments to the command script as well as for the error-handler script

getEnvironment

java.util.Properties getEnvironment()

Returns the properties used to create environment for the script sub-process.

Returns:

Additional environmental properties that will be used to create environment for the script sub-process.

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

setEnvironment

void setEnvironment(java.util.Properties environment)

Set properties to be used to create environment for the script sub-process.

Parameters:

environment -

isIgnoreFailures

boolean isIgnoreFailures()

Returns:

True if failures while execution of script specified by getPathToScript() should be ignored.

Default Value:

false

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

setIgnoreFailures

void setIgnoreFailures(boolean ignore)

Set ignoreFailures flag

Parameters:

ignore - if true, ignore failures while execution of script specified by getPathToScript()

getNumberOfRetriesAllowed

int getNumberOfRetriesAllowed()

Returns:

Number of times the script should be re-executed in case of failures before declaring failure.

Default Value:

0

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

Minimum Value:

0

setNumberOfRetriesAllowed

void setNumberOfRetriesAllowed(int retries)

Set number of allowed retries

Parameters:

retries - Number of retries

getRetryDelayInMillis

long getRetryDelayInMillis()

Returns:

Number of miliseconds to wait before re-trying failed script

Default Value:

2000

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

Minimum Value:

0

setRetryDelayInMillis

void setRetryDelayInMillis(long retryDelay)

Set retry delay

Parameters:

retryDelay - Number of milli seconds to wait before re-trying failed script

getPathToErrorHandlerScript

java.lang.String getPathToErrorHandlerScript()

Returns the path to the error handler script to be executed. If null or empty, the script will not be executed. The value should be the path to the script program. If the command is not set, the error handler is effectively disabled. Note that the error handler script is executed using the same arguments and and environment as the command script. When specified as a relative path, it will be relative to DomainDir/bin/scripts directory. When specified as an absolute path, the script must be under DomainDir/bin/scripts directory.

Returns:

the path to the error handler Script.

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

setPathToErrorHandlerScript

void setPathToErrorHandlerScript(java.lang.String pathToErrorHandlerScript)

Parameters:

pathToErrorHandlerScript - the path to the error handler Script.

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

getTimeoutInSeconds

int getTimeoutInSeconds()

Returns the timeout interval for script execution in seconds. A zero or negative timeout will imply no timeout.

Returns:

Timeout interval in seconds. If zero or negative, there will be no timeout applied.

Default Value:

-1

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

setTimeoutInSeconds

void setTimeoutInSeconds(int timeout)

Sets the timeout interval in seconds for script execution. If zero or negative, there will be no timeout applied.

Parameters:

timeout -