WLDFActionBean (Java API Reference for Oracle WebLogic Server)

All Superinterfaces:

WLDFBean, WLDFNotificationBean
```
public interface WLDFActionBean
extends WLDFNotificationBean
```
WLDF action configuration bean. This is a configuration point for action extensions developed outside of WebLogic.

A WLDF action extension is an action that is managed by, but not owned by, to WLDF. It must have a "type" associated with it, which must be provided to the WLDFWatchNotificationBean.createAction(String, String) method when an instance of this object is created. An instance of a WLDFActionBean defines a single instance configuration of an action extension, which can be referenced from WLDFWatchBean instances like any other action/notification type.

It acts as a container of an action properties, each property being a name/value pair. An action can have simple properties of intrinsic Java types (String, int, float, etc), encrypted properties, Map properties, and array properties.

Map and array properties can not contain nested collections or complex objects; that is, the leaf values of those objects must be simple values represented as String values.

WLDF will map these properties to the proper configuration points on the target action instance. Each action type will have different configuration points, so consult the documentation for those actions to see what the valid configuration properties are for that action type.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`WLDFArrayPropertyBean`	`createArrayProperty(java.lang.String name)` Creates a named array property bean.
`WLDFEncryptedPropertyBean`	`createEncryptedProperty(java.lang.String name)` Creates an encrypted WLDFConfigurationPropertyBean object on the container
`WLDFConfigurationPropertiesBean`	`createMapProperty(java.lang.String name)` Creates a named map property object, similar to a nested map of values for the action configuration.
`WLDFPropertyBean`	`createProperty(java.lang.String name)` Creates an unencrypted WLDFConfigurationPropertyBean object on the container
`void`	`destroyArrayProperty(WLDFArrayPropertyBean property)` Destroys the array property bean.
`void`	`destroyEncryptedProperty(WLDFEncryptedPropertyBean propertyBean)` Destroys a WLDFConfigurationPropertyBean object on the container
`void`	`destroyMapProperty(WLDFConfigurationPropertiesBean property)` Destroys the child map property.
`void`	`destroyProperty(WLDFPropertyBean propertyBean)` Destroys a WLDFConfigurationPropertyBean object on the container
`WLDFArrayPropertyBean[]`	`getArrayProperties()` Returns all the array properties of the action configuration.
`WLDFConfigurationPropertyBean[]`	`getConfigurationProperties()` Returns the list of all WLDFConfigurationPropertyBean objects that are associated with this container object.
`WLDFEncryptedPropertyBean[]`	`getEncryptedProperties()` Returns all the encrypted properties.
`WLDFConfigurationPropertiesBean[]`	`getMapProperties()` Returns the map properties of the action configuration.
`WLDFPropertyBean[]`	`getProperties()` Returns all of the simple properties for this configured action.
`java.lang.String`	`getType()` Defines the action type.
`WLDFArrayPropertyBean`	`lookupArrayProperty(java.lang.String name)` Returns the existing array property corresponding to the specified name.
`WLDFConfigurationPropertyBean`	`lookupConfigurationProperty(java.lang.String name)` Looks up a WLDFConfigurationPropertyBean by name.
`WLDFEncryptedPropertyBean`	`lookupEncryptedProperty(java.lang.String name)` Look up WLDFConfigurationPropertyBean.
`WLDFConfigurationPropertiesBean`	`lookupMapProperty(java.lang.String name)` Returns the existing map property corresponding to the specified name.
`WLDFPropertyBean`	`lookupProperty(java.lang.String name)` Look up WLDFConfigurationPropertyBean.
`void`	`setType(java.lang.String type)` Defines the action type.

Methods inherited from interface weblogic.diagnostics.descriptor.WLDFNotificationBean
getTimeout, isEnabled, setEnabled, setTimeout

Methods inherited from interface weblogic.diagnostics.descriptor.WLDFBean
getId, getName, setName

- Method Detail
  - getType
```
java.lang.String getType()
```
    Defines the action type.
    
    Returns:
    
    Action type
    
    Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.
  - setType
```
void setType(java.lang.String type)
```
    Defines the action type.
    
    Excluded in public API Reference (Marked as @internal).
  - createProperty
```
WLDFPropertyBean createProperty(java.lang.String name)
```
    Creates an unencrypted WLDFConfigurationPropertyBean object on the container
    
    Parameters:
    
    name - of WLDFConfigurationPropertyBean
    
    Returns:
    
    WLDFConfigurationPropertyBean object
  - getProperties
```
WLDFPropertyBean[] getProperties()
```
    Returns all of the simple properties for this configured action.
    
    Returns:
    
    Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.
  - lookupProperty
```
WLDFPropertyBean lookupProperty(java.lang.String name)
```
    Look up WLDFConfigurationPropertyBean.
    
    Parameters:
    
    name - The name of WLDFConfigurationPropertyBean to find
    
    Returns:
    
    The WLDFConfigurationPropertyBean object mapped to the given name
  - destroyProperty
```
void destroyProperty(WLDFPropertyBean propertyBean)
```
    Destroys a WLDFConfigurationPropertyBean object on the container
    
    Parameters:
    
    propertyBean - The WLDFConfigurationPropertyBean instance to destroy
  - createEncryptedProperty
```
WLDFEncryptedPropertyBean createEncryptedProperty(java.lang.String name)
```
    Creates an encrypted WLDFConfigurationPropertyBean object on the container
    
    Parameters:
    
    name - of WLDFConfigurationPropertyBean
    
    Returns:
    
    the new encrypted WLDFConfigurationPropertyBean instance
  - getEncryptedProperties
```
WLDFEncryptedPropertyBean[] getEncryptedProperties()
```
    Returns all the encrypted properties.
    
    Returns:
    
    Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.
  - lookupEncryptedProperty
```
WLDFEncryptedPropertyBean lookupEncryptedProperty(java.lang.String name)
```
    Look up WLDFConfigurationPropertyBean.
    
    Parameters:
    
    name - The name of WLDFConfigurationPropertyBean to find
    
    Returns:
    
    The WLDFConfigurationPropertyBean object mapped to the given name
  - destroyEncryptedProperty
```
void destroyEncryptedProperty(WLDFEncryptedPropertyBean propertyBean)
```
    Destroys a WLDFConfigurationPropertyBean object on the container
    
    Parameters:
    
    propertyBean - The WLDFConfigurationPropertyBean instance to destroy
  - createMapProperty
```
WLDFConfigurationPropertiesBean createMapProperty(java.lang.String name)
```
    Creates a named map property object, similar to a nested map of values for the action configuration.
    
    Parameters:
    
    name -
    
    Returns:
  - lookupMapProperty
```
WLDFConfigurationPropertiesBean lookupMapProperty(java.lang.String name)
```
    Returns the existing map property corresponding to the specified name.
    
    Parameters:
    
    name -
    
    Returns:
  - getMapProperties
```
WLDFConfigurationPropertiesBean[] getMapProperties()
```
    Returns the map properties of the action configuration.
    
    Returns:
    
    Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.
  - destroyMapProperty
```
void destroyMapProperty(WLDFConfigurationPropertiesBean property)
```
    Destroys the child map property.
    
    Parameters:
    
    property - The map properties bean to destroy
  - createArrayProperty
```
WLDFArrayPropertyBean createArrayProperty(java.lang.String name)
```
    Creates a named array property bean.
    
    Parameters:
    
    name -
    
    Returns:
  - getArrayProperties
```
WLDFArrayPropertyBean[] getArrayProperties()
```
    Returns all the array properties of the action configuration.
    
    Returns:
    
    Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.
  - lookupArrayProperty
```
WLDFArrayPropertyBean lookupArrayProperty(java.lang.String name)
```
    Returns the existing array property corresponding to the specified name.
    
    Parameters:
    
    name -
    
    Returns:
  - destroyArrayProperty
```
void destroyArrayProperty(WLDFArrayPropertyBean property)
```
    Destroys the array property bean.
    
    Parameters:
    
    property - The array property bean to destroy
  - getConfigurationProperties
```
WLDFConfigurationPropertyBean[] getConfigurationProperties()
```
    Returns the list of all WLDFConfigurationPropertyBean objects that are associated with this container object.
    
    Returns:
    
    The set of WLDFConfigurationPropertyBean objects associated with this container
    
    Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.
  - lookupConfigurationProperty
```
WLDFConfigurationPropertyBean lookupConfigurationProperty(java.lang.String name)
```
    Looks up a WLDFConfigurationPropertyBean by name.
    
    Parameters:
    
    name - the name of the configuration property being requested
    
    Returns:
    
    the WLDFConfigurationPropertyBean for this name

Interface WLDFActionBean

Method Summary

Methods inherited from interface weblogic.diagnostics.descriptor.WLDFNotificationBean

Methods inherited from interface weblogic.diagnostics.descriptor.WLDFBean

Method Detail

getType

setType

createProperty

getProperties

lookupProperty

destroyProperty

createEncryptedProperty

getEncryptedProperties

lookupEncryptedProperty

destroyEncryptedProperty

createMapProperty

lookupMapProperty

getMapProperties

destroyMapProperty

createArrayProperty

getArrayProperties

lookupArrayProperty

destroyArrayProperty

getConfigurationProperties

lookupConfigurationProperty