BPMConfigurationMBean Interface

com.bea.wli.management.configuration
BPMConfigurationMBean Interface

public interface BPMConfigurationMBean

    extends ConfigurationMBean

MBean for managing general properties of BPM subsystem. The properties exposed via this MBean can be changed to affect certain aspects of BPM engine.


All Superinterfaces
ConfigurationMBean, DynamicMBean, MBeanRegistration, NotificationBroadcaster, WebLogicMBean

Field Summary

public static final long
CACHING_STUB_SVUID
The magic number that is used to generate the serialVersionUID of the generated MBean Stub (xxxMBean_Stub).
   
Fields from interface weblogic.management.configuration.ConfigurationMBean
CACHING_STUB_SVUID, DEFAULT_EMPTY_BYTE_ARRAY
 

Method Summary

public long
getArchiveProcessInterval()
Returns time in milliseconds to indicate how often Archive process is run.
public long
getArchiveProcessStart()
UTC time in milliseconds when the 1st automated invocation of the Archive process will take place.
public String
getArchiverDataSourceName()
Returns JNDI name for the DataSource that points to archvie DB.
public boolean
getArchiverEnabled()
Returns whether the archiver is enabled.
public ArchivingPolicy
getDefaultArchivingPolicy()
Returns the default archiving policy for processes whose archiving policy is ArchivingPolicy.DEFAULT.
public TrackingLevel
getDefaultProcessTrackingLevel()
Returns the default Process tracking level for processes whose tracking level is TrackingLevel.DEFAULT.
public int
getPurgeDelay()
Returns the purge delay in seconds.
public void
registerAdminMBeans(byte[] appManifest, String appName)
Internal operation that is used by managed servers to trigger MBean registration upon deployment.
public void
registerVersioningMBeans(Map configMap, String appName)
Internal operation that is used by managed servers to trigger Versioning-specific MBean registration upon application deployment.
public void
setArchiveProcessInterval(long time)
Sets time in milliseconds to indicate how often Archive process is run.
public void
setArchiveProcessStart(long time)
Sets UTC time in milliseconds when the 1st automated invocation of the Archive process will take place.
public void
setArchiverDataSourceName(String jndiName)
Sets JNDI name for the DataSource that points to archive DB.
public void
setArchiverEnabled(boolean isEnabled)
Global switch to enable/disable WLI Archiver.
public void
setDefaultArchivingPolicy(ArchivingPolicy newArchivingPolicy)
Sets the default archiving policy for processes whose archiving policy is ArchivingPolicy.DEFAULT.
public void
setDefaultProcessTrackingLevel(TrackingLevel newTrackingLevel)
Sets the default process tracking level for processes whose tracking level is TrackingLevel.DEFAULT.
public void
setPurgeDelay(int delay)
Sets the purge delay in seconds.
public void
unregisterAdminMBeans(byte[] appManifest, String appName)
Internal operation that is used by managed servers to trigger.
public void
unregisterVersioningMBeans(Map configMap, String appName)
Internal operation that is used by managed servers to trigger Versioning-specific MBean unregistration upon application deployment.
public void
updateArchiveProcessStartPropertyOnly(long time)
 
Methods from interface weblogic.management.configuration.ConfigurationMBean
freezeCurrentValue, getAttributeStringValue, getComments, getNotes, getSetFields, getXml, getXmlConverter, isDefaultedMBean, isPersistenceEnabled, preDeregister, registerConfigMBean, restoreDefaultValue, setComments, setDefaultedMBean, setNotes, setPersistenceEnabled, touch, unRegisterConfigMBean
 
Methods from interface javax.management.DynamicMBean
getAttribute, getAttributes, getMBeanInfo, invoke, setAttribute, setAttributes
 
Methods from interface javax.management.MBeanRegistration
postDeregister, postRegister, preDeregister, preRegister
 
Methods from interface javax.management.NotificationBroadcaster
addNotificationListener, getNotificationInfo, removeNotificationListener
 
Methods from interface weblogic.management.WebLogicMBean
getMBeanInfo, getName, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setName, setParent
   

Field Detail

CACHING_STUB_SVUID

public static final long CACHING_STUB_SVUID
The magic number that is used to generate the serialVersionUID of the generated MBean Stub (xxxMBean_Stub). You must change this value whenever you make one of the changes to this interface:

- remove an existing method.
- change the signature of an existing "getter" or "setter" method.
- change the signature of an existing "boolean getter", i.e, "boolean isEnabled()"

Otherwise you don't need to change this value. For instance you can add new methods, or you can change the signature of methods that don't start with "get", "set" or "is". If you are in doubt then change the SVUID. It is a good idea to increment this value when changing.

 

Method Detail

getArchiveProcessInterval() Method

public long getArchiveProcessInterval()
Returns time in milliseconds to indicate how often Archive process is run.


getArchiveProcessStart() Method

public long getArchiveProcessStart()
UTC time in milliseconds when the 1st automated invocation of the Archive process will take place.

Returns

UTC time in milliseconds when the 1st automated invocation of the Archive process will take place.

getArchiverDataSourceName() Method

public String getArchiverDataSourceName()
Returns JNDI name for the DataSource that points to archvie DB.

Returns

JNDI name for the DataSource that points to archvie DB.

getArchiverEnabled() Method

public boolean getArchiverEnabled()
Returns whether the archiver is enabled.

Returns

whether the archiver is enabled.

getDefaultArchivingPolicy() Method

public ArchivingPolicy getDefaultArchivingPolicy()
Returns the default archiving policy for processes whose archiving policy is ArchivingPolicy.DEFAULT.

Returns

the default archiving policy for processes whose archiving policy is ArchivingPolicy.DEFAULT.

getDefaultProcessTrackingLevel() Method

public TrackingLevel getDefaultProcessTrackingLevel()
Returns the default Process tracking level for processes whose tracking level is TrackingLevel.DEFAULT.

Returns

the default Process tracking level for processes whose tracking level is TrackingLevel.DEFAULT.

getPurgeDelay() Method

public int getPurgeDelay()
Returns the purge delay in seconds.

Returns

purge delay in seconds.

registerAdminMBeans(byte[], String) Method

public void registerAdminMBeans(byte[] appManifest, 
                                String appName)
throws MBeanException
Internal operation that is used by managed servers to trigger MBean registration upon deployment.

Parameters

appManifest
the application Manifest
appName
the application Name

Exceptions

MBeanException
on error

registerVersioningMBeans(Map, String) Method

public void registerVersioningMBeans(Map configMap, 
                                     String appName)
throws MBeanException
Internal operation that is used by managed servers to trigger Versioning-specific MBean registration upon application deployment. This is called for packaged EARS and exploded EARS as well

Parameters

configMap
configuration map
appName
the application name

Exceptions

MBeanException
on error

setArchiveProcessInterval(long) Method

public void setArchiveProcessInterval(long time)
throws MBeanException
Sets time in milliseconds to indicate how often Archive process is run.

Parameters

time
the archive interval in milliseconds

Exceptions

MBeanException

setArchiveProcessStart(long) Method

public void setArchiveProcessStart(long time)
throws MBeanException
Sets UTC time in milliseconds when the 1st automated invocation of the Archive process will take place.

Parameters

time
archive process time in UTC milliseconds.

Exceptions

MBeanException

setArchiverDataSourceName(String) Method

public void setArchiverDataSourceName(String jndiName)
throws MBeanException
Sets JNDI name for the DataSource that points to archive DB.

Parameters

jndiName
The JNDI name of the data source where the archive data is stored.

Exceptions

MBeanException

setArchiverEnabled(boolean) Method

public void setArchiverEnabled(boolean isEnabled)
throws MBeanException
Global switch to enable/disable WLI Archiver.

Parameters

isEnabled
true to enable the archiver, false to disable.

Exceptions

MBeanException

setDefaultArchivingPolicy(ArchivingPolicy) Method

public void setDefaultArchivingPolicy(ArchivingPolicy newArchivingPolicy)
throws MBeanException, InvalidAttributeValueException
Sets the default archiving policy for processes whose archiving policy is ArchivingPolicy.DEFAULT.

Parameters

newArchivingPolicy
the new archiving policy

Exceptions

MBeanException
if another error occurs while setting the archiving policy
InvalidAttributeValueException
if an invalid policy is provided

setDefaultProcessTrackingLevel(TrackingLevel) Method

public void setDefaultProcessTrackingLevel(TrackingLevel newTrackingLevel)
throws MBeanException, InvalidAttributeValueException
Sets the default process tracking level for processes whose tracking level is TrackingLevel.DEFAULT.

Parameters

newTrackingLevel
the new process tracking level

Exceptions

MBeanException
indicates any other exception
InvalidAttributeValueException
when newTrackingLevel is an invalid tracking level.

setPurgeDelay(int) Method

public void setPurgeDelay(int delay)
throws MBeanException
Sets the purge delay in seconds.

Parameters

delay
the purge delay in seconds.

Exceptions

MBeanException

unregisterAdminMBeans(byte[], String) Method

public void unregisterAdminMBeans(byte[] appManifest, 
                                  String appName)
throws MBeanException
Internal operation that is used by managed servers to trigger. MBean unregistration upon undeployment.

Parameters

appManifest
the application Manifest
appName
the application Name

Exceptions

MBeanException
on error

unregisterVersioningMBeans(Map, String) Method

public void unregisterVersioningMBeans(Map configMap, 
                                       String appName)
throws MBeanException
Internal operation that is used by managed servers to trigger Versioning-specific MBean unregistration upon application deployment. This is called for packaged EARS and exploded EARS as well.

Parameters

configMap
configuration map
appName
the application name

Exceptions

MBeanException
on error

updateArchiveProcessStartPropertyOnly(long) Method

public void updateArchiveProcessStartPropertyOnly(long time)
throws MBeanException

Exceptions

MBeanException