WLDFDataRetirementMBean (Java API Reference for Oracle WebLogic Server)

Class

Use

Tree

Help

Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.2.1)

Part Number E55141-01
P4 Change 1723563 on 2015/10/09

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

weblogic.management.configuration
Interface WLDFDataRetirementMBean

All Superinterfaces:: ConfigurationMBean, DescriptorBean, DynamicMBean, MBeanRegistration, NotificationBroadcaster, SettableBean, WebLogicMBean

All Known Subinterfaces:: WLDFDataRetirementByAgeMBean

public interface WLDFDataRetirementMBean

extends ConfigurationMBean

This MBean specifies how data retirement for a WLDF archive will be performed. This base interface is extended by the interfaces which define specific retirement policies, eg. WLDFDataRetirementByAgeMBean

Since:: 10.0.0.0

Field Summary

Fields inherited from interface weblogic.management.configuration.ConfigurationMBean
`DEFAULT_EMPTY_BYTE_ARRAY`

Method Summary
`abstract String`	`getArchiveName()` Name of the archive for which data retirement is configured
`abstract int`	`getRetirementPeriod()` This attribute specifies the period in hours at which the data retirement task will be periodically performed for the archive during the day after it is first executed.
`abstract int`	`getRetirementTime()` This attribute specifies the hour of day at which the data retirement task will first run during the day.
`abstract boolean`	`isEnabled()` Enable data retirement
`abstract void`	`setArchiveName(String name)` Sets the value of the archiveName attribute.
`abstract void`	`setEnabled(boolean enabled)` Enables or disables this retirement policy
`abstract void`	`setRetirementPeriod(int retirementPeriod)` Sets the value of retirement period (in hours)
`abstract void`	`setRetirementTime(int retirementTime)` Sets the time (in hours) at which data retirement will be first performed during the day for specified archive

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.management.WebLogicMBean
`getMBeanInfo, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setParent`

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.descriptor.DescriptorBean
`addPropertyChangeListener, createChildCopyIncludingObsolete, getParentBean, isEditable, removePropertyChangeListener`

Method Detail

isEnabled

boolean isEnabled()

Enable data retirement

Returns:: True if this retirement policy is enabled

setEnabled

void setEnabled(boolean enabled)

Enables or disables this retirement policy

Parameters:: enabled -
See Also:: WLDFDataRetirementMBean.isEnabled()

getArchiveName

String getArchiveName()

Name of the archive for which data retirement is configured

Returns:: Name of WLDF archive for which this retirement policy applies

setArchiveName

void setArchiveName(String name)
                    throws InvalidAttributeValueException,
                           ManagementException

Sets the value of the archiveName attribute.

Throws:: InvalidAttributeValueException; ManagementException
See Also:: WLDFDataRetirementMBean.getArchiveName()

getRetirementTime

int getRetirementTime()

This attribute specifies the hour of day at which the data retirement task will first run during the day.

Returns:: Number of hours since midnight when the retirement task will first run for the specified archive during a day. Valid values are in the range [0 .. 23]

setRetirementTime

void setRetirementTime(int retirementTime)

Sets the time (in hours) at which data retirement will be first performed during the day for specified archive

Parameters:: retirementTime - Number of hours since midnight when the retirement task will first run for this archive during a day
See Also:: WLDFDataRetirementMBean.getRetirementTime()

getRetirementPeriod

int getRetirementPeriod()

This attribute specifies the period in hours at which the data retirement task will be periodically performed for the archive during the day after it is first executed. The value of this attribute must be positive

Returns:: Period (in hours) at which the data retirement task will run.

setRetirementPeriod

void setRetirementPeriod(int retirementPeriod)

Sets the value of retirement period (in hours)

Parameters:: retirementPeriod - Period (in hours) at which the data retirement task will run.
See Also:: WLDFDataRetirementMBean.getRetirementPeriod()

Overview

Package