com.ibm.retail.si.mgmt.swdist
Interface MgmtSoftwareDistMasterMBean


public interface MgmtSoftwareDistMasterMBean

MBean that manages the signalling of software distributions and keeps a record of distribution policies and distribution records.

The ObjectName of this MBean includes the following attributes, in addition to the SIF attribute of DeviceID:

This management interface includes the following attributes. These attributes are described in more detail in the accessor methods.

The following operations are included in this management interface. These are described in more detail in the corresponding method documentation.

This MBean emits a MgmtSDStartedNotification when an installation is triggered. A MgmtSDCompletionNotification is emitted when an installation is cancelled, when the failed connection threshold is reached, when the busy client threshold is reached, or when a general error occurs.

Author:
Chris D Arrington
See Also:
MgmtSoftwareDistMaster

Field Summary
static java.lang.String OBJECT_NAME
          ObjectName for this MBean
 
Method Summary
 void cancelDistribution(com.ibm.retail.si.mgmt.MgmtDeviceInfo device, com.ibm.retail.si.mgmt.swdist.MgmtSftPackage swPackage, boolean isInstall)
          Cancel the pending distribution matching the supplied information.
 void cancelDistributionsOnDevice(com.ibm.retail.si.mgmt.MgmtDeviceInfo device)
          Cancel all pending distributions for the supplied device
 com.ibm.retail.si.mgmt.swdist.DeviceDistributionRecord[] getAllDeviceDistributionRecords()
           
 com.ibm.retail.si.mgmt.swdist.DeviceTypeSWDistPolicy[] getAllDeviceTypePolicies()
           
 long getBusyClientWaitTime()
           
 int getBusyThreshold()
           
 com.ibm.retail.si.mgmt.swdist.DeviceDistributionRecord[] getCompletedDistributions(com.ibm.retail.si.mgmt.swdist.MgmtSftPackage swPackage)
          Returns a List of all completed distributions for the supplied package
 com.ibm.retail.si.mgmt.swdist.DeviceDistributionRecord getDeviceDistributionRecord(com.ibm.retail.si.mgmt.MgmtDeviceInfo device, com.ibm.retail.si.mgmt.swdist.MgmtSftPackage swPackage, boolean isInstall)
          Retrieves the DeviceDistributionRecord associated with the supplied information
 com.ibm.retail.si.mgmt.swdist.DeviceDistributionRecord[] getDeviceDistributionRecords(int deviceType)
          Returns an Array of all DeviceDistributionRecords of a particular device type
 com.ibm.retail.si.mgmt.swdist.DeviceDistributionRecord[] getDeviceDistributionRecords(int deviceType, com.ibm.retail.si.mgmt.swdist.MgmtSftPackage swPackage)
          Returns an Array of all DeviceDistributionRecords of a particular device type and package
 com.ibm.retail.si.mgmt.swdist.DeviceDistributionRecord[] getDeviceDistributionRecords(com.ibm.retail.si.mgmt.MgmtDeviceInfo device)
          Return an Array of all DeviceDistributionRecords for the supplied device
 int getFailedConnectionThreshold()
           
 java.lang.String getFtpAddress()
           
 java.lang.String getFtpPassword()
           
 int getFtpPort()
           
 java.lang.String getFtpUser()
           
 com.ibm.retail.si.mgmt.swdist.DeviceDistributionRecord[] getIncompletedDistributions(com.ibm.retail.si.mgmt.swdist.MgmtSftPackage swPackage)
          Returns an Array of all incomplete distributions for the supplied package
 com.ibm.retail.si.mgmt.swdist.DeviceDistributionRecord[] getIncompletedDistributions(com.ibm.retail.si.mgmt.swdist.MgmtSftPackage swPackage, int rc)
          Returns an of all incomplete distributions for the supplied package and that match the supplied return code
 int getMaxCurrentJobsPerDevice()
           
 long getMaxJobsWaitTime()
           
 void installPackageByDeviceType(int deviceType, com.ibm.retail.si.mgmt.swdist.MgmtSftPackage swpkg, boolean signalNow, int intervalPercentage)
          Adds a DeviceDistributionRecord to install the supplied package on to devices of the specified type
 void installPackageOnDevice(com.ibm.retail.si.mgmt.MgmtDeviceInfo device, com.ibm.retail.si.mgmt.swdist.MgmtSftPackage swpkg, boolean signalNow, int intervalPercentage)
          Adds a DeviceDistributionRecord to install the supplied package on the specified device
 boolean isPaused()
           
 boolean isStarted()
          Whether or not the distribution engine is currently running
 void pause()
          Pauses the distribution engine.
 void removeDeviceInstallRecord(com.ibm.retail.si.mgmt.MgmtDeviceInfo device, com.ibm.retail.si.mgmt.swdist.MgmtSftPackage swpkg)
          Removes the installation DeviceDistributionRecord for the supplied device and package, if such an entry exists.
 void removeDeviceTypeInstallPolicy(int deviceType, com.ibm.retail.si.mgmt.swdist.MgmtSftPackage swpkg)
          Removes the installation DeviceTypeSWDistPolicy entry for the supplied device type and package, if such an entry exists.
 void removeDeviceTypeUninstallPolicy(int deviceType, com.ibm.retail.si.mgmt.swdist.MgmtSftPackage swpkg)
          Removes the uninstallation DeviceTypeSWDistPolicy entry for the supplied device type and package, if such an entry exists.
 void removeDeviceUninstallRecord(com.ibm.retail.si.mgmt.MgmtDeviceInfo device, com.ibm.retail.si.mgmt.swdist.MgmtSftPackage swpkg)
          Removes the uninstallation DeviceDistributionRecord for the supplied device and package, if such an entry exists.
 void resume()
          Resumes the distribution engine after being paused
 void setBusyClientWaitTime(long l)
           
 void setBusyThreshold(int i)
           
 void setFailedConnectionThreshold(int i)
           
 void setFtpAddress(java.lang.String address)
           
 void setFtpPassword(java.lang.String pw)
           
 void setFtpPort(int port)
           
 void setFtpUser(java.lang.String user)
           
 void setMaxCurrentJobsPerDevice(int i)
           
 void setMaxJobsWaitTime(long l)
           
 boolean start()
          Starts the distribution engine
 boolean stop()
          Stops the distribution engine, persisting all policies and DeviceDistributionRecords
 void triggerDevice(com.ibm.retail.si.mgmt.MgmtDeviceInfo device)
          Trigger a distribution request for all packages on the supplied device
 void triggerDevicesByType(int deviceType)
          Trigger all currently known devices of the supplied type
 void uninstallPackageByDeviceType(int deviceType, com.ibm.retail.si.mgmt.swdist.MgmtSftPackage swpkg, boolean signalNow, int intervalPercentage)
          Adds a DeviceTypeSWDistPolicy entry to install the supplied package on to devices of the specified type
 void uninstallPackageOnDevice(com.ibm.retail.si.mgmt.MgmtDeviceInfo device, com.ibm.retail.si.mgmt.swdist.MgmtSftPackage swpkg, boolean signalNow, int intervalPercentage)
          Adds a DeviceTypeSWDistPolicy entry to uninstall the supplied package on the specified device
 

Field Detail

OBJECT_NAME

public static final java.lang.String OBJECT_NAME
ObjectName for this MBean

See Also:
Constant Field Values
Method Detail

start

public boolean start()
Starts the distribution engine

Returns:
boolean The result of the operation. true if the MBean was started successfully, or false if there was an error starting or the MBean was already started

stop

public boolean stop()
Stops the distribution engine, persisting all policies and DeviceDistributionRecords

Returns:
boolean The result of the operation. true if the MBean was stopped successfully, or false if there was an error stopping or the MBean was already stopped.

isStarted

public boolean isStarted()
Whether or not the distribution engine is currently running

Returns:
True if the engine is running, false otherwise

pause

public void pause()
Pauses the distribution engine. Newly discovered devices will still be processed and their distributions queued up to the maximum number allowed


isPaused

public boolean isPaused()
Returns:
True if the engine is currently paused, false otherwise

resume

public void resume()
Resumes the distribution engine after being paused


installPackageOnDevice

public void installPackageOnDevice(com.ibm.retail.si.mgmt.MgmtDeviceInfo device,
                                   com.ibm.retail.si.mgmt.swdist.MgmtSftPackage swpkg,
                                   boolean signalNow,
                                   int intervalPercentage)
                            throws MgmtException
Adds a DeviceDistributionRecord to install the supplied package on the specified device

Parameters:
device - Destination device
swpkg - Target package
signalNow - Whether or not to trigger an update for all packages on that device immediately after adding the entry
intervalPercentage - A non-zero value indicates the percentage fragment size for which MgmtSDProgressNotifications should be sent during the installation
Throws:
MgmtException - Attempt to add an existing device installation policy

installPackageByDeviceType

public void installPackageByDeviceType(int deviceType,
                                       com.ibm.retail.si.mgmt.swdist.MgmtSftPackage swpkg,
                                       boolean signalNow,
                                       int intervalPercentage)
Adds a DeviceDistributionRecord to install the supplied package on to devices of the specified type

Parameters:
deviceType - Destination device type
swpkg - Target package
signalNow - Whether or not to trigger an update for all packages on devices of that type immediately after adding the entry
intervalPercentage - A non-zero value indicates the percentage fragment size for which MgmtSDProgressNotifications should be sent during the installation
See Also:
MgmtConst

uninstallPackageOnDevice

public void uninstallPackageOnDevice(com.ibm.retail.si.mgmt.MgmtDeviceInfo device,
                                     com.ibm.retail.si.mgmt.swdist.MgmtSftPackage swpkg,
                                     boolean signalNow,
                                     int intervalPercentage)
                              throws MgmtException
Adds a DeviceTypeSWDistPolicy entry to uninstall the supplied package on the specified device

Parameters:
device - Destination device
swpkg - Target package
signalNow - Whether or not to trigger an update for all packages on that device immediately after adding the entry
intervalPercentage - A non-zero value indicates the percentage fragment size for which MgmtSDProgressNotifications should be sent during the uninstallation
MgmtException

uninstallPackageByDeviceType

public void uninstallPackageByDeviceType(int deviceType,
                                         com.ibm.retail.si.mgmt.swdist.MgmtSftPackage swpkg,
                                         boolean signalNow,
                                         int intervalPercentage)
Adds a DeviceTypeSWDistPolicy entry to install the supplied package on to devices of the specified type

Parameters:
deviceType - Destination device type
swpkg - Target package
signalNow - Whether or not to trigger an update for all packages on devices of that type immediately after adding the entry
intervalPercentage - A non-zero value indicates the percentage fragment size for which MgmtSDProgressNotifications should be sent during the uninstallation
See Also:
MgmtConst

triggerDevice

public void triggerDevice(com.ibm.retail.si.mgmt.MgmtDeviceInfo device)
Trigger a distribution request for all packages on the supplied device

Parameters:
device - The device to trigger

triggerDevicesByType

public void triggerDevicesByType(int deviceType)
Trigger all currently known devices of the supplied type

Parameters:
deviceType - int Device type to trigger

removeDeviceInstallRecord

public void removeDeviceInstallRecord(com.ibm.retail.si.mgmt.MgmtDeviceInfo device,
                                      com.ibm.retail.si.mgmt.swdist.MgmtSftPackage swpkg)
Removes the installation DeviceDistributionRecord for the supplied device and package, if such an entry exists. If no entry exists, then the method will do nothing

Parameters:
device - Target device
swpkg - Target package

removeDeviceUninstallRecord

public void removeDeviceUninstallRecord(com.ibm.retail.si.mgmt.MgmtDeviceInfo device,
                                        com.ibm.retail.si.mgmt.swdist.MgmtSftPackage swpkg)
Removes the uninstallation DeviceDistributionRecord for the supplied device and package, if such an entry exists. If no entry exists, then the method will do nothing

Parameters:
device - Target device
swpkg - Target package

removeDeviceTypeInstallPolicy

public void removeDeviceTypeInstallPolicy(int deviceType,
                                          com.ibm.retail.si.mgmt.swdist.MgmtSftPackage swpkg)
Removes the installation DeviceTypeSWDistPolicy entry for the supplied device type and package, if such an entry exists. Any DeviceDistributionRecords created will not be removed. If no entry exists, then the method will do nothing

Parameters:
deviceType - Target device type
swpkg - Target package
See Also:
MgmtConst

removeDeviceTypeUninstallPolicy

public void removeDeviceTypeUninstallPolicy(int deviceType,
                                            com.ibm.retail.si.mgmt.swdist.MgmtSftPackage swpkg)
Removes the uninstallation DeviceTypeSWDistPolicy entry for the supplied device type and package, if such an entry exists. Any DeviceDistributionRecords created will not be removed. If no entry exists, then the method will do nothing

Parameters:
deviceType - Target device type
swpkg - Target package
See Also:
MgmtConst

cancelDistribution

public void cancelDistribution(com.ibm.retail.si.mgmt.MgmtDeviceInfo device,
                               com.ibm.retail.si.mgmt.swdist.MgmtSftPackage swPackage,
                               boolean isInstall)
Cancel the pending distribution matching the supplied information. The record matching the distribution will be persisted with a cancelled return code and a MgmtSDCompletion notification sent.

Parameters:
device - Client device
swPackage - Target package
isInstall - True if an installation, false otherwise

cancelDistributionsOnDevice

public void cancelDistributionsOnDevice(com.ibm.retail.si.mgmt.MgmtDeviceInfo device)
Cancel all pending distributions for the supplied device

Parameters:
device - Client device
See Also:
cancelDistribution(MgmtDeviceInfo, MgmtSftPackage, boolean)

getAllDeviceTypePolicies

public com.ibm.retail.si.mgmt.swdist.DeviceTypeSWDistPolicy[] getAllDeviceTypePolicies()
Returns:
Array of all DeviceTypeSWDistPolicy entries

getAllDeviceDistributionRecords

public com.ibm.retail.si.mgmt.swdist.DeviceDistributionRecord[] getAllDeviceDistributionRecords()
Returns:
Array of all DeviceDistributionRecords for all devices

getDeviceDistributionRecords

public com.ibm.retail.si.mgmt.swdist.DeviceDistributionRecord[] getDeviceDistributionRecords(com.ibm.retail.si.mgmt.MgmtDeviceInfo device)
Return an Array of all DeviceDistributionRecords for the supplied device

Parameters:
device - MgmtDeviceInfo Target device
Returns:
DeviceDistributionRecord[], or empty array if no records exist

getDeviceDistributionRecord

public com.ibm.retail.si.mgmt.swdist.DeviceDistributionRecord getDeviceDistributionRecord(com.ibm.retail.si.mgmt.MgmtDeviceInfo device,
                                                                                          com.ibm.retail.si.mgmt.swdist.MgmtSftPackage swPackage,
                                                                                          boolean isInstall)
Retrieves the DeviceDistributionRecord associated with the supplied information

Parameters:
device - MgmtDeviceInfo target device
swPackage - MgmtSftPackage target package
isInstall - boolean True for an installation, false for an uninstall
Returns:
DeviceDistributionRecord matching the supplied information, or null if it doesn't exist

getDeviceDistributionRecords

public com.ibm.retail.si.mgmt.swdist.DeviceDistributionRecord[] getDeviceDistributionRecords(int deviceType)
Returns an Array of all DeviceDistributionRecords of a particular device type

Parameters:
deviceType - Target device type
Returns:
DeviceDistributionRecord[] matching the supplied device type, or an empty Array if none exist

getDeviceDistributionRecords

public com.ibm.retail.si.mgmt.swdist.DeviceDistributionRecord[] getDeviceDistributionRecords(int deviceType,
                                                                                             com.ibm.retail.si.mgmt.swdist.MgmtSftPackage swPackage)
Returns an Array of all DeviceDistributionRecords of a particular device type and package

Parameters:
deviceType - Target device type
swPackage - Target package
Returns:
DeviceDistributionRecord[] matching the supplied device type and package, or an empty Array if none exist

getCompletedDistributions

public com.ibm.retail.si.mgmt.swdist.DeviceDistributionRecord[] getCompletedDistributions(com.ibm.retail.si.mgmt.swdist.MgmtSftPackage swPackage)
Returns a List of all completed distributions for the supplied package

Parameters:
swPackage - Target package
Returns:
DeviceDistributionRecord[] of all completed distributions for the supplied package, or an empty Array if none exist

getIncompletedDistributions

public com.ibm.retail.si.mgmt.swdist.DeviceDistributionRecord[] getIncompletedDistributions(com.ibm.retail.si.mgmt.swdist.MgmtSftPackage swPackage)
Returns an Array of all incomplete distributions for the supplied package

Parameters:
swPackage - Target package
Returns:
DeviceDistributionRecord[] of all incomplete distributions for the supplied package, or an empty Array if none exist

getIncompletedDistributions

public com.ibm.retail.si.mgmt.swdist.DeviceDistributionRecord[] getIncompletedDistributions(com.ibm.retail.si.mgmt.swdist.MgmtSftPackage swPackage,
                                                                                            int rc)
Returns an of all incomplete distributions for the supplied package and that match the supplied return code

Parameters:
swPackage - Target package
rc - Return code to match
Returns:
DeviceDistributionRecord[] of all incomplete distributions for the supplied package and return code, or an empty Array if none exist

getFtpAddress

public java.lang.String getFtpAddress()
Returns:
Hostname or IP Address to passed to clients for retrieving files

getFtpPort

public int getFtpPort()
Returns:
FTP Port number passed to clients for retrieving files

setFtpAddress

public void setFtpAddress(java.lang.String address)
                   throws javax.management.InvalidAttributeValueException
Parameters:
address - String IP Address or hostname to be passed to clients for retrieving files
javax.management.InvalidAttributeValueException

setFtpPort

public void setFtpPort(int port)
                throws javax.management.InvalidAttributeValueException
Parameters:
port - FTP Port number passed to clients for retrieving files
javax.management.InvalidAttributeValueException

getFtpPassword

public java.lang.String getFtpPassword()
Returns:
FTP password used by clients to retrieve files

getFtpUser

public java.lang.String getFtpUser()
Returns:
FTP username used by clients to retrieve files

setFtpPassword

public void setFtpPassword(java.lang.String pw)
                    throws javax.management.InvalidAttributeValueException
Parameters:
pw - String FTP password used by clients to retrieve files
javax.management.InvalidAttributeValueException

setFtpUser

public void setFtpUser(java.lang.String user)
                throws javax.management.InvalidAttributeValueException
javax.management.InvalidAttributeValueException

getBusyClientWaitTime

public long getBusyClientWaitTime()
Returns:
long The amount of time to wait, in ms, before retrying a software distribution on a busy client

getBusyThreshold

public int getBusyThreshold()
Returns:
int The number of consecutive tries performed for a distribution on a busy client before ending the distribution in error

getFailedConnectionThreshold

public int getFailedConnectionThreshold()
Returns:
int The number of failed connection attempts before a distribution is ended in error

getMaxCurrentJobsPerDevice

public int getMaxCurrentJobsPerDevice()
Returns:
int The maximum number of distributions per device that are at eny time queued to be signalled

getMaxJobsWaitTime

public long getMaxJobsWaitTime()
Returns:
long The amount of time to wait, in ms, before attempting to enqueue software distributions for a device that has reached the maxCurrentJobsPerDevice threshold

setBusyClientWaitTime

public void setBusyClientWaitTime(long l)
                           throws javax.management.InvalidAttributeValueException
Parameters:
l -
javax.management.InvalidAttributeValueException
See Also:
getBusyClientWaitTime()

setBusyThreshold

public void setBusyThreshold(int i)
                      throws javax.management.InvalidAttributeValueException
Parameters:
i -
javax.management.InvalidAttributeValueException
See Also:
getBusyThreshold()

setFailedConnectionThreshold

public void setFailedConnectionThreshold(int i)
                                  throws javax.management.InvalidAttributeValueException
Parameters:
i -
javax.management.InvalidAttributeValueException
See Also:
getFailedConnectionThreshold()

setMaxCurrentJobsPerDevice

public void setMaxCurrentJobsPerDevice(int i)
                                throws javax.management.InvalidAttributeValueException
Parameters:
i -
javax.management.InvalidAttributeValueException
See Also:
getMaxCurrentJobsPerDevice()

setMaxJobsWaitTime

public void setMaxJobsWaitTime(long l)
                        throws javax.management.InvalidAttributeValueException
Parameters:
l -
javax.management.InvalidAttributeValueException
See Also:
getMaxJobsWaitTime()


Copyright © 2004 IBM. All Rights Reserved.
Generated: July 19 2004