|
|||||||||||
PREV NEXT | FRAMES NO FRAMES |
Packages that use DeletedException | |
---|---|
com.ibm.datapower.wamt.amp | The Appliance Management Protocol (AMP) provides an abstraction layer for message and command communication between the Manager and the DataPower devices. |
com.ibm.datapower.wamt.clientAPI | The clientAPI package encapsulates the logic
for managing DataPower appliances, providing the API that should be used by
a user interface to interact with one or more appliances. |
Uses of DeletedException in com.ibm.datapower.wamt.amp |
---|
Methods in com.ibm.datapower.wamt.amp that throw DeletedException | |
---|---|
void |
Commands.setDomain(DeviceContext device,
java.lang.String domainName,
byte[] domainImage,
DeploymentPolicy policy)
Load a domain onto a device using an image that was previously retrived via Commands.getDomain(DeviceContext, String) . |
void |
Commands.setDomainByService(DeviceContext device,
java.lang.String domainName,
ConfigObject[] objects,
byte[] domainImage,
DeploymentPolicy policy,
boolean importAllFiles)
Given an export/backup package, a domain name and a list of services, all the dependent configuration objects and files will be deploied to the specified domain. |
void |
Commands.setDomainByService(DeviceContext device,
java.lang.String domainName,
ConfigObject[] objects,
java.lang.String fileDomainName,
java.lang.String fileNameOnDevice,
DeploymentPolicy policy,
boolean importAllFiles)
Given an export/backup package, a domain name and a list of services, all the dependent configuration objects and files will be deploy to the specified domain. |
Uses of DeletedException in com.ibm.datapower.wamt.clientAPI |
---|
Methods in com.ibm.datapower.wamt.clientAPI that throw DeletedException | |
---|---|
ProgressContainer |
ManagedSet.addDevice(Device device)
Adds a device to this managed set. |
void |
Device.addTag(java.lang.String name,
java.lang.String value)
|
void |
Domain.addTag(java.lang.String name,
java.lang.String value)
|
void |
Taggable.addTag(java.lang.String name,
java.lang.String value)
Add a new tag. |
ProgressContainer |
Device.backup(java.lang.String cryptoCertificateName,
URLSource cryptoImage,
java.net.URI backupDestination,
boolean includeISCSI,
boolean includeRaid)
Takes a backup of a DataPower appliance which can be replicated to a compatible appliance. |
Domain |
Device.createManagedDomain(java.lang.String domainName)
Create a managed domain on this Device. |
java.util.Hashtable<Device,java.lang.Exception> |
ManagedSet.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. |
ServiceDeployment |
Domain.createServiceDeployment(ServiceConfiguration svcConfig,
boolean importAllFiles)
Create the ServiceDeployment object with service configuration only, no deployment policy for deployment. |
ServiceDeployment |
Domain.createServiceDeployment(ServiceConfiguration svcConfig,
URLSource policyURL,
java.lang.String policyDomain,
java.lang.String policyObjName,
boolean importAllFiles)
Create the ServiceDeployment object with service configuration and deployment policy to be deployed in this domain. |
void |
Device.deleteDomain(java.lang.String domainName)
Delete a domain on a device. |
DeleteObjectResult[] |
Domain.deleteService(RuntimeService service,
ConfigObject[] excludeObjects,
boolean deleteReferencedFiles)
Delete a RuntimeService, and return the result of each objects in a RuntimeService. |
ProgressContainer |
Domain.deployConfiguration()
Push a configuration onto the device that was previously set by calling Domain.setSourceConfiguration(URLSource) and Domain.setDeploymentPolicy(URLSource, String, String) |
ProgressContainer |
ServiceDeployment.deployServiceConfiguration()
Push a service source configuration onto the device. |
MacroProgressContainer |
ManagedSet.deploySourceConfigurationForDomain(java.lang.String domainName)
Deploys the previously set domain configuration to all managed domains in this managed set with the specified domain name. |
ProgressContainer |
Device.deploySourceFirmwareVersion()
Schedules a task to deploy a FirmwareVersion. |
MacroProgressContainer |
ManagedSet.deploySourceFirmwareVersion()
Schedules tasks to deploy the FirmwareVersion to all devices in this managed set. |
ProgressContainer |
DomainVersion.diff(DomainVersion that)
Generate a background task to get a visual representation of the differences of a domain between two versions. |
AdminStatus |
Domain.getAdminStatus()
Get AdminStatus of this domain, enabled (AdminState.ENABLED) or disabled (AdminState.DISABLED). |
java.util.Map<java.lang.String,java.util.List<Status>> |
Domain.getAllStatus()
Get all status |
ConfigService[] |
ServiceConfiguration.getAvailableServices(Device device)
Get all available services in the Service Configuration for deployment. |
ConfigService[] |
ServiceConfiguration.getAvailableServices(Device device)
Get all available services in the Service Configuration for deployment. |
Blob |
DeploymentPolicyVersion.getBlob()
|
Blob |
DomainVersion.getBlob()
|
Blob |
FirmwareVersion.getBlob()
Get the Blob for this FirmwareVersion. |
Blob |
URLSource.getBlob()
This method returns a Blob object from the spec sent to the constructor (e.g. |
Blob |
Version.getBlob()
Get the Blob that is attached to this Version. |
static DeploymentPolicyVersion |
DeploymentPolicyVersion.getByPrimaryKey(java.lang.String targetKey)
Retrieve a reference to the DeploymentPolicyVersion that has the specified primary key. |
ModelType[] |
Firmware.getCompatibleModelTypes()
Get all ModelTypes that are compatible with the ModelType of this Firmware. |
java.lang.String |
Device.getCurrentAMPVersion()
Returns the current AMP version supported by this device. |
DeploymentPolicy |
DeploymentPolicyVersion.getDeploymentPolicy()
Get the DeploymentPolicy that this object is a Version of. |
DeploymentPolicy |
Domain.getDeploymentPolicy()
Get the deployment policy owned by this Domain. |
Device |
Domain.getDevice()
Get the device that owns this Domain. |
Device |
Manager.getDeviceBySerialNumber(java.lang.String targetSerialNumber)
Deprecated. Get a Device that has a particular hardware serial number. This method does not care if the Device is a member of a ManagedSet or not. |
Device |
Manager.getDeviceBySymbolicName(java.lang.String targetSymbolicName)
Get a Device that has a particular symbolic name. |
DeviceContext |
Device.getDeviceContext()
Returns the DeviceContext for this device, necessary for AMP calls. |
Device[] |
ManagedSet.getDeviceMembers()
Get the devices which are members of this ManagedSet. |
Device[] |
Manager.getDevicesBySerialNumber(java.lang.String targetSerialNumber)
Get all Devices that have a particular hardware serial number. |
DeviceType |
Device.getDeviceType()
Get the device type. |
DeviceType |
Firmware.getDeviceType()
Get the DeviceType of this Firmware. |
Domain |
DeploymentPolicy.getDomain()
|
Domain |
DomainVersion.getDomain()
Get the Domain that this object is a Version of. |
StringCollection |
Device.getFeatureLicenses()
Get the list of Strings that represent the feature entitlements (licensed features) for this device. |
StringCollection |
ServiceDeployment.getFilesToBeOverwritten()
Get a file list to be overwritten. |
Firmware |
FirmwareVersion.getFirmware()
The same as FirmwareVersion.getVersionedObject() , but casts the return value to
a Firmare class. |
int |
Device.getGUIPort()
Get the device's port for the WebGUI. |
int |
DeploymentPolicy.getHighestVersionNumber()
Get the highest version number of all the DeploymentPolicyVersions in this DeploymentPolicy. |
int |
Domain.getHighestVersionNumber()
Get the highest version number of all the DomainVersions in this Domain. |
int |
Firmware.getHighestVersionNumber()
Get the highest version number of all the FirmwareVersions in this Firmware. |
int |
Device.getHLMPort()
Get the device's port number for AMP (HLM) communication. |
java.lang.String |
Device.getHostname()
Get the hostname or IP address of this device. |
static Manager |
Manager.getInstance(java.util.Map options)
Get an instance of the manager. |
RuntimeService[] |
ServiceDeployment.getInterDependentServices()
Get all interdependent service(s) when this class is instantiated. |
java.lang.String |
FirmwareVersion.getLevel()
Get the version level of this firmware. |
FirmwareVersion |
Firmware.getLevel(java.lang.String targetLevel)
Get the FirmwareVersion object that corresponds to the requested level. |
Domain |
Device.getManagedDomain(java.lang.String targetDomainName)
Get the managed Domain with the specified domain name on this device. |
Domain[] |
Device.getManagedDomains()
Get the managed Domains on this Device |
ManagedSet |
Device.getManagedSet()
Return this device's ManagedSet membership. |
ManagedSet |
Manager.getManagedSet(java.lang.String name)
Get the existing ManagedSet that has the specified name from the manager. |
java.util.Date |
FirmwareVersion.getManufactureDate()
Get the manufacture date of this firmware. |
ModelType |
Device.getModelType()
Get the device's model type. |
ModelType |
Firmware.getModelType()
Get the ModelType of this Firmware. |
java.lang.String |
DeploymentPolicy.getName()
Only used for stored instance. |
java.lang.String |
Domain.getName()
Get the name of this Domain. |
java.lang.String |
ManagedSet.getName()
Get the name of this ManagedSet. |
StringCollection |
Firmware.getNonstrictFeatures()
Get the non-strict features that are in this Firmware. |
ConfigObject[] |
ServiceDeployment.getObjectsToBeOverwritten()
Get ConfigObject(s) to be overwritten. |
OperationStatus |
Device.getOperationStatusOfDomain(Domain domain)
Get the operation status of a managed domain. |
OpStatus |
Domain.getOpStatus()
Get OpStatus of this domain, up (OpState.UP) or down (OpState.DOWN). |
java.lang.String |
DeploymentPolicy.getPolicyDomainName()
Returns the name of the domain that contains the deployment policy in the blob. |
java.lang.String |
DeploymentPolicyVersion.getPolicyDomainName()
|
java.lang.String |
DeploymentPolicyVersion.getPolicyName()
|
java.lang.String |
DeploymentPolicy.getPolicyObjectName()
Returns the name of the deployment policy object to use. |
DeploymentPolicyType |
DeploymentPolicy.getPolicyType()
Returns the deployment policy enum type. |
DeploymentPolicyType |
DeploymentPolicyVersion.getPolicyType()
|
URLSource |
DeploymentPolicy.getPolicyURLSource()
Returns the policy URL source. |
java.lang.String |
DeploymentPolicy.getPrimaryKey()
|
java.lang.String |
DeploymentPolicyVersion.getPrimaryKey()
|
java.lang.String |
Device.getPrimaryKey()
Returns the primary key of this device as a String |
java.lang.String |
Domain.getPrimaryKey()
|
java.lang.String |
DomainVersion.getPrimaryKey()
|
java.lang.String |
Firmware.getPrimaryKey()
|
java.lang.String |
FirmwareVersion.getPrimaryKey()
|
java.lang.String |
ManagedSet.getPrimaryKey()
|
QuiesceStatus |
Domain.getQuiesceStatus()
Get Quiesce Status of this domain. |
java.lang.String |
Device.getSerialNumber()
Get the unique ID of this device, which is its hardware serial number. |
RuntimeService[] |
Domain.getServices()
Get all services in this domain. |
URLSource |
Domain.getSourceConfiguration()
This method can be used to retrieve the URLSource specified by Domain.setSourceConfiguration(URLSource) |
java.util.List<Status> |
Domain.getStatus(java.lang.String name)
Get a status |
StringCollection |
Firmware.getStrictFeatures()
Get the strict features that are in this Firmware. |
java.lang.String |
Device.getSymbolicName()
Get the symbolic name of this Device. |
DomainSynchronizationMode |
Domain.getSynchronizationMode()
This method can be used to determine the current synchronization mode for this Domain |
java.util.Set<java.lang.String> |
Device.getTagNames()
|
java.util.Set<java.lang.String> |
Domain.getTagNames()
|
java.util.Set<java.lang.String> |
Taggable.getTagNames()
Get all of the tag names on the resource. |
java.util.Set<java.lang.String> |
Device.getTagValues(java.lang.String name)
|
java.util.Set<java.lang.String> |
Domain.getTagValues(java.lang.String name)
|
java.util.Set<java.lang.String> |
Taggable.getTagValues(java.lang.String name)
Get the values for a given tag name. |
java.util.Date |
DeploymentPolicyVersion.getTimestamp()
|
java.util.Date |
DomainVersion.getTimestamp()
|
java.util.Date |
FirmwareVersion.getTimestamp()
|
java.util.Date |
Version.getTimestamp()
Get the timestamp that signifies when the Version was created in the Manager. |
Device[] |
Manager.getUnmanagedDevices(DeviceType desiredDeviceType,
ModelType desiredModelType,
StringCollection desiredFeatures)
Gets the list of known devices in the manager that are not assigned to a ManagedSet. |
java.lang.String |
DeploymentPolicyVersion.getUserComment()
|
java.lang.String |
DomainVersion.getUserComment()
|
java.lang.String |
FirmwareVersion.getUserComment()
|
java.lang.String |
Version.getUserComment()
Get the user comment that corresponds to this Version. |
java.lang.String |
Device.getUserId()
Get the administrative userid of this device. |
DeploymentPolicyVersion |
DeploymentPolicy.getVersion(int targetVersionNumber)
|
Version |
Domain.getVersion(int targetVersionNumber)
|
Version |
Firmware.getVersion(int targetVersionNumber)
Deprecated. Instead of this method you probably want to use Firmware.getLevel(String) . A level is a
String value (i.e., "3.6.1.0") which is probably what you are
searching for. The version number in a FirmwareVersion
object will be an opaque int and not anything meaningful to
the user. This method will return a valid value when invoked
with a valid parameter (i.e., 2), but you probably want to
use getLevel . |
Version |
Versionable.getVersion(int versionNumber)
Get the specified Version of this Versionable object. |
Versionable |
DeploymentPolicyVersion.getVersionedObject()
|
Versionable |
DomainVersion.getVersionedObject()
|
Versionable |
FirmwareVersion.getVersionedObject()
|
Versionable |
Version.getVersionedObject()
Get a reference to the object that this Version is a version of. |
int |
DeploymentPolicyVersion.getVersionNumber()
|
int |
DomainVersion.getVersionNumber()
|
int |
FirmwareVersion.getVersionNumber()
Deprecated. Although this method will return a valid version number (i.e., 2), you probably want to use the more meaningful method FirmwareVersion.getLevel() . This method should work and is
supported, but probably isn't the value you are looking for.
It is anticipated that a user interface would reference a
FirmwareVersion via the level instead of versionNumber. |
int |
Version.getVersionNumber()
Get the version number that this Version object represents. |
DeploymentPolicyVersion[] |
DeploymentPolicy.getVersions()
|
Version[] |
Domain.getVersions()
|
Version[] |
Firmware.getVersions()
|
Version[] |
Versionable.getVersions()
Get all the versions that exist of this Versionable object. |
ProgressContainer |
Device.getWebGUIURL(Domain domain)
Create a background task to get the URL of the device's WebGUI. |
void |
Device.quiesce()
Quiesce all the domains on a device (managed domains and unmanaged domains). |
void |
Domain.quiesce()
Quiesce a domain The quiece operation is used on firmware versions 3.8.1 or higher to stop a domain before updating it. |
void |
RuntimeService.quiesce()
Quiesce this RuntimeService |
ProgressContainer |
Device.reboot()
reboot this device. |
void |
Domain.refresh()
Update the latest status of domain and all services in this domain. |
void |
Manager.remove(Device device)
Removes a device from the manager. |
void |
Manager.remove(Firmware firmware)
Remove a Firmware object from the Manager. |
void |
Domain.remove(Version version)
Trim the specified DomainVersion from the repository. |
void |
Firmware.remove(Version version)
|
ProgressContainer |
ManagedSet.removeDevice(Device device)
Remove the specified device from this managed set. |
ProgressContainer |
ManagedSet.removeDeviceWithoutUnsubscribe(Device device)
Remove the specified device from this managed set without trying to unsubscribe. |
void |
Device.removeManagedDomain(java.lang.String domainName)
Stop managing a domain on the device. |
java.util.Hashtable |
ManagedSet.removeManagedDomain(java.lang.String domainName)
Removes specified managed domain from all devices in this managed set. |
void |
Device.removeTag(java.lang.String name)
|
void |
Domain.removeTag(java.lang.String name)
|
void |
Taggable.removeTag(java.lang.String name)
Remove all tags with the provided name. |
void |
Device.removeTag(java.lang.String name,
java.lang.String value)
|
void |
Domain.removeTag(java.lang.String name,
java.lang.String value)
|
void |
Taggable.removeTag(java.lang.String name,
java.lang.String value)
Remove the exactly matching tag. |
void |
Device.removeTags()
|
void |
Domain.removeTags()
|
void |
Taggable.removeTags()
Remove all the tags from the resource. |
void |
Domain.restart()
To restart this domain |
ProgressContainer |
Device.restore(java.lang.String cryptoCredentialName,
java.net.URI backupSource,
boolean validate)
Restores the configuration and secure data from a successful secure backup. |
void |
Domain.setDeploymentPolicy(URLSource url,
java.lang.String policyDomain,
java.lang.String policyObjName)
Use this method to specify the deployment policy to apply to this domain during deployment. |
java.util.Hashtable |
ManagedSet.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. |
void |
Domain.setDeploymentPolicyXML(URLSource url)
Use this method to specify the deployment policy in XML format. |
void |
Device.setGUIPort(int guiPort)
Set the device's port for the WebGUI. |
void |
Device.setHLMPort(int hlmPort)
Set the device's port number to which the AMP (HLM) client will attempt to connect. |
void |
Device.setHostname(java.lang.String hostname)
Set the hostname or IP address of this device. |
void |
Device.setPassword(java.lang.String password)
Set the password for the administrative userid for this device. |
void |
DeploymentPolicy.setPolicyExport(URLSource url,
java.lang.String policyDomain,
java.lang.String policyObjName)
When calling setPolicyExport, the URLSource is a reference to the configuration blob, the domainName and policyObjectName serve as an "index" into the blob, pointing to the domain, and associated deployment policy within the blob. |
void |
DeploymentPolicy.setPolicyNone()
This method is called when null parameters are passed to
setDeploymentPolicy(null, null, null) in Domain |
void |
DeploymentPolicy.setPolicyXML(URLSource url)
When calling setPolicyXML, the URLSource is a reference to a deployment policy in XML format. |
void |
Device.setQuiesceTimeout(int timeout)
Set the timeout value (in seconds) for checking the status of a domain quiesce or unquiesce operation. |
void |
Domain.setQuiesceTimeout(int timeout)
Set the timeout value (in seconds) for checking the status of a domain quiesce or unquiesce operation. |
java.util.Hashtable |
ManagedSet.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 |
void |
Domain.setSourceConfiguration(URLSource sourceConfiguration)
Use this method to specify the domain configuration URLSource that should be deployed for this Domain. |
java.util.Hashtable |
ManagedSet.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. |
void |
Device.setSourceFirmwareLevel(java.lang.String desiredLevel)
An alternative to Device.setSourceFirmwareVersion(FirmwareVersion) , this
method accepts a firmware "level" (e.g., "3.8.0.1") instead of a specific
FirmwareVersion object. |
java.util.Hashtable |
ManagedSet.setSourceFirmwareLevel(java.lang.String level)
Set the source firmware level for each Device in this ManagedSet. |
ProgressContainer |
Device.setSourceFirmwareVersion(FirmwareVersion desiredFirmwareVersion)
Schedules a task to set the FirmwareVersion for this device. |
void |
Device.setSymbolicName(java.lang.String name)
Set the symbolic name of this Device. |
void |
Domain.setSynchronizationMode(DomainSynchronizationMode synchMode)
Set configuration synchronization mode on the Domain. |
java.util.Hashtable |
ManagedSet.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.util.Hashtable |
Device.setSynchronizationModeForManagedDomains(DomainSynchronizationMode synchMode)
Set the Synchronization Mode for the all domains on device. |
void |
DeploymentPolicyVersion.setUserComment(java.lang.String userComment)
|
void |
DomainVersion.setUserComment(java.lang.String userComment)
|
void |
FirmwareVersion.setUserComment(java.lang.String userComment)
|
void |
Version.setUserComment(java.lang.String userComment)
This is the method to set the user comment that can be later retrieved via Version.getUserComment() . |
void |
Device.setUserId(java.lang.String userid)
Set the administrative userid for this device. |
void |
RuntimeService.start()
Start this RuntimeService |
void |
RuntimeService.stop()
Stop this RuntimeService |
void |
Device.unquiesce()
Unquiesce all the domains on a device (managed domains and unmanaged domains). |
void |
Domain.unquiesce()
Unquiesce a domain The quiece operation is used on firmware versions 3.8.1 or higher to stop a domain before updating it. |
void |
RuntimeService.unquiesce()
Unquiesce this RuntimeService |
void |
Domain.uploadFile(java.lang.String fileName,
URLSource urlSource)
Upload file to device of this domain |
Constructors in com.ibm.datapower.wamt.clientAPI that throw DeletedException | |
---|---|
ManagedSet(java.lang.String name)
Create a new ManagedSet that is empty and add it to the Manager. |
|
|||||||||||
PREV NEXT | FRAMES NO FRAMES |