|
|||||||||||
PREV NEXT | FRAMES NO FRAMES |
Packages that use AMPException | |
---|---|
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 AMPException in com.ibm.datapower.wamt.amp |
---|
Subclasses of AMPException in com.ibm.datapower.wamt.amp | |
---|---|
class |
AMPIOException
An I/O problem occurred while communicating to the device via the network such as hostname not found, connection refused, connection timed out, etc. |
class |
DeviceExecutionException
The device had an internal error while executing an AMP command. |
class |
InvalidCredentialsException
The device userid and password supplied inside a DeviceContext
parameter were not accepted by the device. |
class |
NotExistException
The requested item does not exist in the device. |
class |
NotificationCatcherResourceException
The NotificationCatcher encountered a problem while trying to acquire sufficient resources to start itself. |
Methods in com.ibm.datapower.wamt.amp that throw AMPException | |
---|---|
java.util.Hashtable |
Commands.backupDevice(DeviceContext device,
java.lang.String cryptoCertificateName,
byte[] cryptoImage,
java.lang.String secureBackupDestination,
boolean includeISCSI,
boolean includeRaid)
Perform a backup of the entire device. |
org.w3c.dom.Node |
SOAPHelper.call(DeviceContext device,
byte[] header,
byte[] footer,
java.io.InputStream requestDocument)
Given a requestDocument (as an combination of header bytes, an InputStream containing the blob, and footer bytes), this method provides a high-level API to wrap the SOAP envelope, create an SSL connection, send the SOAP request, get the SOAP response, and return the response XML (without the SOAP envelope). |
org.w3c.dom.Node |
SOAPHelper.call(DeviceContext device,
java.lang.StringBuffer requestDocument)
Given a requestDocument (as an StringBuffer), this method provides a high-level API to wrap the SOAP envelope, create an SSL connection, send the SOAP request, get the SOAP response, and return the response XML (without the SOAP envelope) |
void |
Commands.deleteDomain(DeviceContext device,
java.lang.String domainName)
Delete a DataPower domain and all the contents of that domain from the specified device. |
void |
Commands.deleteFile(DeviceContext device,
java.lang.String domainName,
java.lang.String fileNameOnDevice)
Delete a file to the persistent store on the device. |
DeleteObjectResult[] |
Commands.deleteService(DeviceContext device,
java.lang.String domainName,
java.lang.String objectName,
java.lang.String objectClassName,
ConfigObject[] excludeObjects,
boolean deleteReferencedFiles)
Given domain name, service class, service name, delete the service object and all its dependent objects. |
static Commands |
CommandFactory.getCommands(java.lang.String commandsImplementationClassName,
java.lang.String soapHelperImplementationClassName)
Get an instance of a class that implements the Commands interface. |
DeviceMetaInfo |
Commands.getDeviceMetaInfo(DeviceContext device)
Get the high-level information about this device, as listed in DeviceMetaInfo . |
byte[] |
Commands.getDomain(DeviceContext device,
java.lang.String domainName)
Get a domain from the device into an opaque blob (byte array). |
java.net.URL |
Commands.getDomainDifferences(java.lang.String domainName,
byte[] configImage1,
byte[] configImage2,
DeviceContext device)
Compare two configuration images obtained from getDomainViaBackup , and return
a URL where the differences can be viewed. |
java.lang.String[] |
Commands.getDomainList(DeviceContext device)
Get a list of all the domains on the specified device, even the ones not managed by any external manager. |
DomainStatus |
Commands.getDomainStatus(DeviceContext device,
java.lang.String domainName)
Get the domain status (op-state). |
ErrorReport |
Commands.getErrorReport(DeviceContext device)
Retrieve error report stored on the device. |
static DeviceType |
Utilities.getFirmwareDeviceType(Blob firmwareImage)
Get the deviceType that this firmware image is for. |
static java.lang.String |
Utilities.getFirmwareLevel(Blob firmwareImage)
Get the manufacturer's level (i.e., "3.5.0.9") that is embedded in a firmware file. |
static ModelType |
Utilities.getFirmwareModelType(Blob firmwareImage)
Get the modelType that this firmware image is for. |
static java.lang.String |
Utilities.getFirmwareScryptVersion(Blob firmwareImage)
Get the scrypt version of this firmware file. |
InterDependentServiceCollection |
Commands.getInterDependentServices(DeviceContext device,
java.lang.String domainName,
byte[] packageImage,
ConfigObject[] objectArray)
Getting inter-dependent service on device. |
InterDependentServiceCollection |
Commands.getInterDependentServices(DeviceContext device,
java.lang.String domainName,
java.lang.String fileDomainName,
java.lang.String fileNameOnDevice,
ConfigObject[] objects)
Getting inter-dependent service on device. |
java.lang.String[] |
Commands.getKeyFilenames(DeviceContext device,
java.lang.String domainName)
For the specified domain, get a list of filenames of items in the special device filestores that are used by services in this domain. |
static StringCollection |
Utilities.getNonStrictFirmwareFeatures(Blob firmwareImage)
Get the list of non-strict features (libraries) that are included in this firmware image. |
static NotificationCatcher |
NotificationCatcherFactory.getNotificationCatcher(java.lang.String implementationClassName)
Get a reference to a NotificationCatcher that has the specified implementation name. |
ReferencedObjectCollection |
Commands.getReferencedObjects(DeviceContext device,
java.lang.String domainName,
java.lang.String objectName,
java.lang.String objectClassName)
Get the referenced objects |
java.lang.String |
Commands.getSAMLToken(DeviceContext device,
java.lang.String domainName)
Retrieve a SAML token for automatic login to the WebGUI. |
RuntimeService[] |
Commands.getServiceListFromDomain(DeviceContext device,
java.lang.String domainName)
Getting all the services under that domain together with their status. |
ConfigService[] |
Commands.getServiceListFromExport(DeviceContext device,
byte[] packageImage)
Getting all services from an export/backup package. |
ConfigService[] |
Commands.getServiceListFromExport(DeviceContext device,
java.lang.String fileDomainName,
java.lang.String fileNameOnDevice)
Getting all services from an export/backup package. |
static SOAPHelper |
SOAPHelperFactory.getSOAPHelper(java.lang.String implementationClassName)
Get an instance of a class that implements the SOAPHelper interface. |
static StringCollection |
Utilities.getStrictFirmwareFeatures(Blob firmwareImage)
Get the list of strict features (libraries) that are included in this firmware image. |
boolean |
Commands.isDomainDifferent(java.lang.String domainName,
byte[] configImage1,
byte[] configImage2,
DeviceContext device)
Compare two configuration images obtained from Commands.getDomain(DeviceContext, String) , and see if they are
equivalent. |
PingResponse |
Commands.pingDevice(DeviceContext device,
java.lang.String subscriptionID)
This is used periodically to send a heartbeat request to a device and verify that it responds, and to check on the subscription state. |
void |
Commands.quiesceDevice(DeviceContext device,
int timeout)
Quiesce a device. |
void |
Commands.quiesceDomain(DeviceContext device,
java.lang.String domain,
int timeout)
Quiesce a domain. |
void |
Commands.quiesceService(DeviceContext device,
java.lang.String domain,
ConfigObject[] objects,
int timeout)
Quiesce all the services specified in the request for the domain. |
void |
Commands.reboot(DeviceContext device)
Reboot the referenced device, based on the Shutdown -> Reboot System command in the System Control
menu of the WebGUI. |
void |
Commands.restartDomain(DeviceContext device,
java.lang.String domainName)
Restart the referenced domain on the referenced device, based on the action of the same name in the System Control menu of the WebGUI. |
void |
Commands.restoreDevice(DeviceContext device,
java.lang.String cryptoCredentialName,
boolean validate,
java.net.URI secureBackupSource,
java.util.Hashtable<java.lang.String,byte[]> backupFilesTable)
Restore a device from a backup. |
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. |
void |
Commands.setFile(DeviceContext device,
java.lang.String domainName,
java.lang.String filenameOnDevice,
byte[] contents)
Send a file to the persistent store on the device. |
void |
Commands.setFirmware(DeviceContext device,
byte[] firmwareImage)
Deprecated. |
void |
Commands.setFirmware(DeviceContext device,
byte[] firmwareImage,
boolean acceptLicense)
Transmit the specified firmware image into the device, make it the active firmware. |
void |
Commands.setFirmware(DeviceContext device,
java.io.InputStream inputStream)
Deprecated. |
void |
Commands.setFirmware(DeviceContext device,
java.io.InputStream inputStream,
boolean acceptLicense)
Same as Commands.setFirmware(DeviceContext, byte[], boolean) , but allows for the
large boot image to be specified in in a stream instead of in-memory byte
array. |
void |
Commands.startDomain(DeviceContext device,
java.lang.String domainName)
Set the domain op-state to "up". |
void |
Commands.startService(DeviceContext device,
java.lang.String domainName,
ConfigObject[] objects)
Start a service by changing its administrative state to "enabled" |
void |
NotificationCatcher.startup()
When the Manager is started, the Manager will invoke this method. |
void |
Commands.stopDomain(DeviceContext device,
java.lang.String domainName)
Set the domain op-state to "down". |
void |
Commands.stopService(DeviceContext device,
java.lang.String domainName,
ConfigObject[] objects)
Stop a service by changing its administrative state to "disabled" |
SubscriptionResponseCode |
Commands.subscribeToDevice(DeviceContext device,
java.lang.String subscriptionId,
StringCollection topics,
java.net.URL callback)
Create a subscription so that the device will inform the callback when a configuration change or related action
happens on the specified device. |
void |
Commands.unquiesceDevice(DeviceContext device)
Unquiesce a device, which brings the device to an operationally ready state. |
void |
Commands.unquiesceDomain(DeviceContext device,
java.lang.String domain)
Unquiesce a domain which brings the domain objects to an operationally ready state. |
void |
Commands.unquiesceService(DeviceContext device,
java.lang.String domainName,
ConfigObject[] objects)
UnQuiesce all the services specified in the request for the specified domain. |
void |
Commands.unsubscribeFromDevice(DeviceContext device,
java.lang.String subscriptionID,
StringCollection topics)
Delete a subscription that was created with Commands.subscribeToDevice(DeviceContext, String, StringCollection, URL) . |
Uses of AMPException in com.ibm.datapower.wamt.clientAPI |
---|
Methods in com.ibm.datapower.wamt.clientAPI that throw AMPException | |
---|---|
ProgressContainer |
ManagedSet.addDevice(Device device)
Adds a device to this managed set. |
Domain |
Device.createManagedDomain(java.lang.String domainName)
Create a managed domain on this Device. |
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. |
ConfigService[] |
ServiceConfiguration.getAvailableServices(Device device)
Get all available services in the Service Configuration for deployment. |
Blob |
URLSource.getBlob()
This method returns a Blob object from the spec sent to the constructor (e.g. |
Commands |
Device.getCommands()
Get the commands implementation to use for this device. |
StringCollection |
ServiceDeployment.getFilesToBeOverwritten()
Get a file list to be overwritten. |
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. |
ConfigObject[] |
ServiceDeployment.getObjectsToBeOverwritten()
Get ConfigObject(s) to be overwritten. |
void |
Manager.importAll(java.io.InputStream inputStream)
Import to the manager datastore from the specified InputStream. |
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 |
void |
Domain.restart()
To restart this domain |
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 |
|
|||||||||||
PREV NEXT | FRAMES NO FRAMES |