|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
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 DeviceDistributionRecord s |
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 |
public static final java.lang.String OBJECT_NAME
Method Detail |
public boolean start()
true
if the MBean was started successfully,
or false
if there was an error starting or the MBean was already startedpublic boolean stop()
DeviceDistributionRecord
s
true
if the MBean was stopped successfully,
or false
if there was an error stopping or the MBean was already stopped.public boolean isStarted()
public void pause()
public boolean isPaused()
public void resume()
public void installPackageOnDevice(com.ibm.retail.si.mgmt.MgmtDeviceInfo device, com.ibm.retail.si.mgmt.swdist.MgmtSftPackage swpkg, boolean signalNow, int intervalPercentage) throws MgmtException
device
- Destination deviceswpkg
- Target packagesignalNow
- Whether or not to trigger an update for all packages on that device
immediately after adding the entryintervalPercentage
- A non-zero value indicates the percentage fragment size for which
MgmtSDProgressNotifications should be sent during the installation
MgmtException
- Attempt to add an existing device installation policypublic void installPackageByDeviceType(int deviceType, com.ibm.retail.si.mgmt.swdist.MgmtSftPackage swpkg, boolean signalNow, int intervalPercentage)
deviceType
- Destination device typeswpkg
- Target packagesignalNow
- Whether or not to trigger an update for all packages on devices of that type
immediately after adding the entryintervalPercentage
- A non-zero value indicates the percentage fragment size for which
MgmtSDProgressNotifications should be sent during the installationMgmtConst
public void uninstallPackageOnDevice(com.ibm.retail.si.mgmt.MgmtDeviceInfo device, com.ibm.retail.si.mgmt.swdist.MgmtSftPackage swpkg, boolean signalNow, int intervalPercentage) throws MgmtException
device
- Destination deviceswpkg
- Target packagesignalNow
- Whether or not to trigger an update for all packages on that device
immediately after adding the entryintervalPercentage
- A non-zero value indicates the percentage fragment size for which
MgmtSDProgressNotifications should be sent during the uninstallation
MgmtException
public void uninstallPackageByDeviceType(int deviceType, com.ibm.retail.si.mgmt.swdist.MgmtSftPackage swpkg, boolean signalNow, int intervalPercentage)
deviceType
- Destination device typeswpkg
- Target packagesignalNow
- Whether or not to trigger an update for all packages on devices of that type
immediately after adding the entryintervalPercentage
- A non-zero value indicates the percentage fragment size for which
MgmtSDProgressNotifications should be sent during the uninstallationMgmtConst
public void triggerDevice(com.ibm.retail.si.mgmt.MgmtDeviceInfo device)
device
- The device to triggerpublic void triggerDevicesByType(int deviceType)
deviceType
- int Device type to triggerpublic void removeDeviceInstallRecord(com.ibm.retail.si.mgmt.MgmtDeviceInfo device, com.ibm.retail.si.mgmt.swdist.MgmtSftPackage swpkg)
device
- Target deviceswpkg
- Target packagepublic void removeDeviceUninstallRecord(com.ibm.retail.si.mgmt.MgmtDeviceInfo device, com.ibm.retail.si.mgmt.swdist.MgmtSftPackage swpkg)
device
- Target deviceswpkg
- Target packagepublic void removeDeviceTypeInstallPolicy(int deviceType, com.ibm.retail.si.mgmt.swdist.MgmtSftPackage swpkg)
deviceType
- Target device typeswpkg
- Target packageMgmtConst
public void removeDeviceTypeUninstallPolicy(int deviceType, com.ibm.retail.si.mgmt.swdist.MgmtSftPackage swpkg)
deviceType
- Target device typeswpkg
- Target packageMgmtConst
public void cancelDistribution(com.ibm.retail.si.mgmt.MgmtDeviceInfo device, com.ibm.retail.si.mgmt.swdist.MgmtSftPackage swPackage, boolean isInstall)
device
- Client deviceswPackage
- Target packageisInstall
- True if an installation, false otherwisepublic void cancelDistributionsOnDevice(com.ibm.retail.si.mgmt.MgmtDeviceInfo device)
device
- Client devicecancelDistribution(MgmtDeviceInfo, MgmtSftPackage, boolean)
public com.ibm.retail.si.mgmt.swdist.DeviceTypeSWDistPolicy[] getAllDeviceTypePolicies()
public com.ibm.retail.si.mgmt.swdist.DeviceDistributionRecord[] getAllDeviceDistributionRecords()
public com.ibm.retail.si.mgmt.swdist.DeviceDistributionRecord[] getDeviceDistributionRecords(com.ibm.retail.si.mgmt.MgmtDeviceInfo device)
device
- MgmtDeviceInfo Target device
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)
device
- MgmtDeviceInfo target deviceswPackage
- MgmtSftPackage target packageisInstall
- boolean True for an installation, false for an uninstall
public com.ibm.retail.si.mgmt.swdist.DeviceDistributionRecord[] getDeviceDistributionRecords(int deviceType)
deviceType
- Target device type
public com.ibm.retail.si.mgmt.swdist.DeviceDistributionRecord[] getDeviceDistributionRecords(int deviceType, com.ibm.retail.si.mgmt.swdist.MgmtSftPackage swPackage)
deviceType
- Target device typeswPackage
- Target package
public com.ibm.retail.si.mgmt.swdist.DeviceDistributionRecord[] getCompletedDistributions(com.ibm.retail.si.mgmt.swdist.MgmtSftPackage swPackage)
swPackage
- Target package
public com.ibm.retail.si.mgmt.swdist.DeviceDistributionRecord[] getIncompletedDistributions(com.ibm.retail.si.mgmt.swdist.MgmtSftPackage swPackage)
swPackage
- Target package
public com.ibm.retail.si.mgmt.swdist.DeviceDistributionRecord[] getIncompletedDistributions(com.ibm.retail.si.mgmt.swdist.MgmtSftPackage swPackage, int rc)
swPackage
- Target packagerc
- Return code to match
public java.lang.String getFtpAddress()
public int getFtpPort()
public void setFtpAddress(java.lang.String address) throws javax.management.InvalidAttributeValueException
address
- String IP Address or hostname to be passed to clients for retrieving files
javax.management.InvalidAttributeValueException
public void setFtpPort(int port) throws javax.management.InvalidAttributeValueException
port
- FTP Port number passed to clients for retrieving files
javax.management.InvalidAttributeValueException
public java.lang.String getFtpPassword()
public java.lang.String getFtpUser()
public void setFtpPassword(java.lang.String pw) throws javax.management.InvalidAttributeValueException
pw
- String FTP password used by clients to retrieve files
javax.management.InvalidAttributeValueException
public void setFtpUser(java.lang.String user) throws javax.management.InvalidAttributeValueException
javax.management.InvalidAttributeValueException
public long getBusyClientWaitTime()
public int getBusyThreshold()
public int getFailedConnectionThreshold()
public int getMaxCurrentJobsPerDevice()
public long getMaxJobsWaitTime()
public void setBusyClientWaitTime(long l) throws javax.management.InvalidAttributeValueException
l
-
javax.management.InvalidAttributeValueException
getBusyClientWaitTime()
public void setBusyThreshold(int i) throws javax.management.InvalidAttributeValueException
i
-
javax.management.InvalidAttributeValueException
getBusyThreshold()
public void setFailedConnectionThreshold(int i) throws javax.management.InvalidAttributeValueException
i
-
javax.management.InvalidAttributeValueException
getFailedConnectionThreshold()
public void setMaxCurrentJobsPerDevice(int i) throws javax.management.InvalidAttributeValueException
i
-
javax.management.InvalidAttributeValueException
getMaxCurrentJobsPerDevice()
public void setMaxJobsWaitTime(long l) throws javax.management.InvalidAttributeValueException
l
-
javax.management.InvalidAttributeValueException
getMaxJobsWaitTime()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |