|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.ObjectWorkArea
com.ibm.datapower.wamt.clientAPI.ManagedSet
public class ManagedSet
A ManagedSet is one of the core objects that callers of the clientAPI will use
to manage DataPower devices. A ManangetSet is a heterogeneous collection of DataPower
devices. The term heterogeneous refers to the hardware and licensing characteristics
of the devices, as well as the domains configured in the managed set (e.g., it is not a
requirement that all devices have identical domain configurations, see
Device.createManagedDomain(String)
for more information on a creating managed
domain on a single device in a ManagedsSet/
Devices can be added to a ManagedSet which indicates that they are managed and identifies a particular management scope. When a Device is not a member of a ManagedSet, it is considered unmanaged.
A managed set can have zero or more Devices as members. A device is managed
only if it is a member of a ManagedSet. When a device is managed, their
managed domain(s) can be are synchronized with a specified domain configuration and
deployment policy. See Domain.setSynchronizationMode(DomainSynchronizationMode)
}
for more information about Domain
synchronization.
Field Summary | |
---|---|
static java.lang.String |
COPYRIGHT_2009_2013
|
Constructor Summary | |
---|---|
ManagedSet(java.lang.String name)
Create a new ManagedSet that is empty and add it to the Manager. |
Method Summary | |
---|---|
ProgressContainer |
addDevice(Device device)
Adds a device to this managed set. |
java.util.Hashtable<Device,java.lang.Exception> |
createManagedDomain(java.lang.String domainName,
URLSource domainSource,
URLSource deploymentPolicySource,
java.lang.String deploymentPolicyDomainName,
java.lang.String deploymentPolicyObjectName)
Creates a domain of the specified name on all devices in this managed set. |
MacroProgressContainer |
deploySourceConfigurationForDomain(java.lang.String domainName)
Deploys the previously set domain configuration to all managed domains in this managed set with the specified domain name. |
MacroProgressContainer |
deploySourceFirmwareVersion()
Schedules tasks to deploy the FirmwareVersion to all devices in this managed set. |
static ManagedSet |
getByPrimaryKey(java.lang.String targetKey)
Get the ManagedSet instance that has the specified primary key. |
Device[] |
getDeviceMembers()
Get the devices which are members of this ManagedSet. |
java.lang.String |
getDisplayName()
Get a human-readable name that represents this object. |
java.lang.String |
getName()
Get the name of this ManagedSet. |
OperationStatus |
getOperationStatus()
Get the OperationStatus of this ManagedSet. |
java.lang.String |
getPrimaryKey()
|
boolean |
isAvailableForUpdate()
Check if the ManagedSet is available for new update commands. |
ProgressContainer |
removeDevice(Device device)
Remove the specified device from this managed set. |
ProgressContainer |
removeDeviceWithoutUnsubscribe(Device device)
Remove the specified device from this managed set without trying to unsubscribe. |
java.util.Hashtable |
removeManagedDomain(java.lang.String domainName)
Removes specified managed domain from all devices in this managed set. |
java.util.Hashtable |
setDeploymentPolicyForDomain(java.lang.String domainName,
URLSource configurationSource,
java.lang.String policyDomainName,
java.lang.String policyName)
Sets the deployment policy for the specified domain name if it is present on any devices in the managed set. |
java.util.Hashtable |
setQuiesceTimeoutForDomain(java.lang.String domainName,
int timeout)
Set the timeout value (in seconds) for checking the status of a domain quiesce or unquiesce operation for the specified domain on all devices members in this managed set |
java.util.Hashtable |
setSourceConfigurationForDomain(java.lang.String domainName,
URLSource configurationSource)
Set the configuration source for the specified domain name if it is is present on any of the devices in the managed set. |
java.util.Hashtable |
setSourceFirmwareLevel(java.lang.String level)
Set the source firmware level for each Device in this ManagedSet. |
java.util.Hashtable |
setSynchronizationModeForDomain(java.lang.String domainName,
DomainSynchronizationMode synchMode)
The valid synchronization modes that can be set for a domain are DomainSynchronizationMode.MANUAL and DomainSynchronizationMode.AUTO. |
java.lang.String |
toString()
Get a String representation of this object for the purpose of debugging or tracing. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String COPYRIGHT_2009_2013
Constructor Detail |
---|
public ManagedSet(java.lang.String name) throws AlreadyExistsInRepositoryException, DatastoreException, DeletedException
name
- a human-consumable symbolic name for this object that will be
for later display of this ManagedSet. This name must be unique
across all ManagedSets in this Manager.Method Detail |
---|
public boolean isAvailableForUpdate()
public java.lang.String getName() throws DeletedException
setName(String)
method.
public java.lang.String getPrimaryKey() throws DeletedException
public static ManagedSet getByPrimaryKey(java.lang.String targetKey)
targetKey
- the key of the target ManagedSet
getPrimaryKey()
public Device[] getDeviceMembers() throws DeletedException
addDevice(Device)
,
removeDevice(Device)
,
"useCases section 4.2"public ProgressContainer addDevice(Device device) throws java.lang.Exception, LockBusyException, AlreadyExistsInRepositoryException, InUseException, InvalidParameterException, NotEmptyException, DeletedException, UndeployableVersionException, AMPException, DatastoreException, DeviceTypeIncompatibilityException, ModelTypeIncompatibilityException, FeaturesNotEqualException, MissingFeaturesInFirmwareException, UnlicensedFeaturesInFirmwareException
The following actions are performed: - this Manager subscribes to the new device - if synchronization mode is AUTO, this Manager synchronizes the configuration on the device - the managed set is persisted with the new device.
An exception is thrown if: - the device is already a member of another managed set
device
-
public ProgressContainer removeDevice(Device device) throws NotExistException, InUseException, InvalidParameterException, NotEmptyException, DatastoreException, LockBusyException, DeletedException, FullException
device
- the device to removeaddDevice(Device)
,
getDeviceMembers()
public ProgressContainer removeDeviceWithoutUnsubscribe(Device device) throws LockBusyException, NotExistException, DeletedException, DirtySaveException, DatastoreException
addDevice(Device)
fails when trying to
subscribe. The failure can be due to a connectivity problem or when the device
is already subscribed to another manager.
device
- the device to removeaddDevice(Device)
,
getDeviceMembers()
public OperationStatus getOperationStatus()
public java.lang.String toString()
public java.lang.String getDisplayName()
public java.util.Hashtable setSourceFirmwareLevel(java.lang.String level) throws DeletedException, NotExistException
Device.setSourceFirmwareLevel(String)
method for each device in this managed
set. If a suitable firmware level has not been loaded into the Manager
for a
device in the set then the device will be added to the returned Hashtable with a
NotExistException. Bear in mind that the devices in this managed set may be
different Device Types, Model Types, or be licensed for different features, so the
manager should be preloaded with all of the correct firmware images, at the level
specified, for all of the devices in this set.
level
- desiredFirmwareVersion
Device.setSourceFirmwareLevel(String)
,
Manager.addFirmware(Blob, String)
,
Firmware
,
FirmwareVersion
public MacroProgressContainer deploySourceFirmwareVersion() throws DeletedException, NotExistException
The MacroProgressContainer.getProgressContainers()
returns a collection of ProgressContainers. You can get the correlator
on each ProgressContainer with a call to ProgressContainer.getCorrelator()
. The correlator
returned is the Device object associated with ProgressContainer. It can be used to correlate a background task to other items that
the caller cares about.
The MacroProgressContainer.getFailedTasks()
returns a Hashtable. The key is the Device object(key) and the value is the
ProgressContainer generated for that device (value)
The MacroProgressContainer.blockAndTrace(Level)
is a convenience method for waiting for the tasks to complete and printing
the progress of each step for each nested ProgressConatiner.
MacroProgressContainer
public MacroProgressContainer deploySourceConfigurationForDomain(java.lang.String domainName) throws DeletedException, NotExistException
Deploys the previously set domain configuration to all managed domains in this managed set with the specified domain name.
The domain configuration is previously set by calling setSourceConfigurationForDomain(String, URLSource)
and setDeploymentPolicyForDomain(String, URLSource, String, String)
domainName
- Name of domain to be created
The MacroProgressContainer.getProgressContainers()
returns a collection of ProgressContainers. You can get the correlator
on each ProgressContainer with a call to ProgressContainer.getCorrelator()
. The correlator
returned is the Device object associated with ProgressContainer. It can be used to correlate a background task to other items that
the caller cares about.
The MacroProgressContainer.getFailedTasks()
returns a Hashtable. The key is the Device object(key) and the value is the
ProgressContainer generated for that device (value)
The MacroProgressContainer.blockAndTrace(Level)
is a convenience method for waiting for the tasks to complete and printing
the progress of each step for each nested ProgressConatiner.
setSourceConfigurationForDomain(String, URLSource)
public java.util.Hashtable<Device,java.lang.Exception> createManagedDomain(java.lang.String domainName, URLSource domainSource, URLSource deploymentPolicySource, java.lang.String deploymentPolicyDomainName, java.lang.String deploymentPolicyObjectName) throws DeletedException, NotExistException, LockBusyException
FirmwareVersion.meetsMinimumLevel(String)
domainName
- Name of domain to be createddomainSource
- Source configuration to be deployed on device for the domain. Optional, must pass in null if not to be used.deploymentPolicySource
- Policy Source to be used during deployment. Optional, must pass in null if not to be used.deploymentPolicyDomainName
- Domain name for the deployment policy source. Used to locate the domain within the policy source. Only used if deploymentPolicySource is non-null.deploymentPolicyObjectName
- Name for the deployment policy use to locate the policy within the policy source. Only used if deploymentPolicySource is non-null.
Domain.deployConfiguration()
,
Domain.setDeploymentPolicy(URLSource, String, String)
,
Domain.setSourceConfiguration(URLSource)
public java.util.Hashtable removeManagedDomain(java.lang.String domainName) throws DeletedException, NotExistException, LockBusyException
domainName
- Name of domain to be removed.
public java.util.Hashtable setSourceConfigurationForDomain(java.lang.String domainName, URLSource configurationSource) throws DeletedException, NotExistException, LockBusyException
domainName
- Name of domain for setting the configuration sourceconfigurationSource
- The configuration source to set
Domain.setSourceConfiguration(URLSource)
,
URLSource
,
deploySourceConfigurationForDomain(String)
public java.util.Hashtable setDeploymentPolicyForDomain(java.lang.String domainName, URLSource configurationSource, java.lang.String policyDomainName, java.lang.String policyName) throws DeletedException, NotExistException, LockBusyException
domainName
- Name of managed domain for which policy export options will be setconfigurationSource
- The configuration sourcepolicyDomainName
- name of theDomain that is used as an index into blob that will be deployed on the devicepolicyName
- name of Deployment Policy which will be used as an index into the blob that will be deployed on a device
Domain.setSourceConfiguration(URLSource)
,
URLSource
public java.util.Hashtable setSynchronizationModeForDomain(java.lang.String domainName, DomainSynchronizationMode synchMode) throws DeletedException, NotExistException, LockBusyException
The valid synchronization modes that can be set for a domain are DomainSynchronizationMode.MANUAL and DomainSynchronizationMode.AUTO.
By default the synchronization mode is set to DomainSynchronizationMode.MANUAL. Configuration deployment must be scheduled and done manually by an administrator.
When synchronization mode is set to DomainSynchronizationMode.AUTO, domain configuration deployment is synchronized automatically. An automatic domain deployment can occur when the following conditions are detected:
Set the synchronization mode on all managed domains with the specified domain name
domainName
- name of domainsynchMode
- - The synchronization mode to set for the specified domains in this managed set.
synchMode defaults to DomainSynchronizationMode.MANUAL. Valid synchronization
modes are DomainSynchronizationMode.MANUAL and DomainSynchronizationMode.AUTO
Domain.setSynchronizationMode(DomainSynchronizationMode)
,
Manager.setDomainSynchronizationDaemonSleepMS(long)
public java.util.Hashtable setQuiesceTimeoutForDomain(java.lang.String domainName, int timeout) throws DeletedException, NotExistException, LockBusyException, InvalidParameterException
domainName
- Name of domains on which to set the timeout valuetimeout
- timeout value for checking the status of a quiesce operation
Domain.setQuiesceTimeout(int)
,
Manager.OPTION_DEBUG_DOMAIN_QUIESCE_TIMEOUT
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |