|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Commands
A list of high-level commands that the DataPower device should support via
SOAP invocation. These are commands sent from a manager to the device. Note
that there is additional event communication sent from the device to the
manager via Notification
. These commands are long-running methods
that contact the device via the network and will block until the device
responds that the command has been completed. For the reason of being
long-running with the potential for high variability in the completion time,
it is recommended that you invoke these methods on a different thread than
what may be running an interactive user interface.
This communication currently is scoped only for multi-box management. It does not include future requirements for application enablement. This should be an interface instead of a class, because it is expected that there may be more than one AMP client implementation.
Notification
Method Summary | |
---|---|
java.util.Hashtable |
backupDevice(DeviceContext device,
java.lang.String cryptoCertificateName,
byte[] cryptoImage,
java.lang.String secureBackupDestination,
boolean includeISCSI,
boolean includeRaid)
Perform a backup of the entire device. |
void |
deleteDomain(DeviceContext device,
java.lang.String domainName)
Delete a DataPower domain and all the contents of that domain from the specified device. |
void |
deleteFile(DeviceContext device,
java.lang.String domainName,
java.lang.String fileNameOnDevice)
Delete a file to the persistent store on the device. |
DeleteObjectResult[] |
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. |
DeviceMetaInfo |
getDeviceMetaInfo(DeviceContext device)
Get the high-level information about this device, as listed in DeviceMetaInfo . |
byte[] |
getDomain(DeviceContext device,
java.lang.String domainName)
Get a domain from the device into an opaque blob (byte array). |
java.net.URL |
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[] |
getDomainList(DeviceContext device)
Get a list of all the domains on the specified device, even the ones not managed by any external manager. |
DomainStatus |
getDomainStatus(DeviceContext device,
java.lang.String domainName)
Get the domain status (op-state). |
ErrorReport |
getErrorReport(DeviceContext device)
Retrieve error report stored on the device. |
InterDependentServiceCollection |
getInterDependentServices(DeviceContext device,
java.lang.String domainName,
byte[] packageImage,
ConfigObject[] objectArray)
Getting inter-dependent service on device. |
InterDependentServiceCollection |
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[] |
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. |
ReferencedObjectCollection |
getReferencedObjects(DeviceContext device,
java.lang.String domainName,
java.lang.String objectName,
java.lang.String objectClassName)
Get the referenced objects |
java.lang.String |
getSAMLToken(DeviceContext device,
java.lang.String domainName)
Retrieve a SAML token for automatic login to the WebGUI. |
RuntimeService[] |
getServiceListFromDomain(DeviceContext device,
java.lang.String domainName)
Getting all the services under that domain together with their status. |
ConfigService[] |
getServiceListFromExport(DeviceContext device,
byte[] packageImage)
Getting all services from an export/backup package. |
ConfigService[] |
getServiceListFromExport(DeviceContext device,
java.lang.String fileDomainName,
java.lang.String fileNameOnDevice)
Getting all services from an export/backup package. |
boolean |
isDomainDifferent(java.lang.String domainName,
byte[] configImage1,
byte[] configImage2,
DeviceContext device)
Compare two configuration images obtained from getDomain(DeviceContext, String) , and see if they are
equivalent. |
PingResponse |
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 |
quiesceDevice(DeviceContext device,
int timeout)
Quiesce a device. |
void |
quiesceDomain(DeviceContext device,
java.lang.String domain,
int timeout)
Quiesce a domain. |
void |
quiesceService(DeviceContext device,
java.lang.String domain,
ConfigObject[] objects,
int timeout)
Quiesce all the services specified in the request for the domain. |
void |
reboot(DeviceContext device)
Reboot the referenced device, based on the Shutdown -> Reboot System command in the System Control
menu of the WebGUI. |
void |
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 |
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 |
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 getDomain(DeviceContext, String) . |
void |
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 |
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 |
setFile(DeviceContext device,
java.lang.String domainName,
java.lang.String filenameOnDevice,
byte[] contents)
Send a file to the persistent store on the device. |
void |
setFirmware(DeviceContext device,
byte[] firmwareImage)
Deprecated. |
void |
setFirmware(DeviceContext device,
byte[] firmwareImage,
boolean acceptLicense)
Transmit the specified firmware image into the device, make it the active firmware. |
void |
setFirmware(DeviceContext device,
java.io.InputStream inputStream)
Deprecated. |
void |
setFirmware(DeviceContext device,
java.io.InputStream inputStream,
boolean acceptLicense)
Same as 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 |
startDomain(DeviceContext device,
java.lang.String domainName)
Set the domain op-state to "up". |
void |
startService(DeviceContext device,
java.lang.String domainName,
ConfigObject[] objects)
Start a service by changing its administrative state to "enabled" |
void |
stopDomain(DeviceContext device,
java.lang.String domainName)
Set the domain op-state to "down". |
void |
stopService(DeviceContext device,
java.lang.String domainName,
ConfigObject[] objects)
Stop a service by changing its administrative state to "disabled" |
SubscriptionResponseCode |
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 |
unquiesceDevice(DeviceContext device)
Unquiesce a device, which brings the device to an operationally ready state. |
void |
unquiesceDomain(DeviceContext device,
java.lang.String domain)
Unquiesce a domain which brings the domain objects to an operationally ready state. |
void |
unquiesceService(DeviceContext device,
java.lang.String domainName,
ConfigObject[] objects)
UnQuiesce all the services specified in the request for the specified domain. |
void |
unsubscribeFromDevice(DeviceContext device,
java.lang.String subscriptionID,
StringCollection topics)
Delete a subscription that was created with subscribeToDevice(DeviceContext, String, StringCollection, URL) . |
Field Detail |
---|
static final java.lang.String COPYRIGHT_2009_2012
static final java.lang.String SCM_REVISION
static final int BACKUP_DEVICE
static final int DELETE_DOMAIN
static final int DELETE_FILE
static final int DELETE_SERVICE
static final int GET_DEVICE_METAINFO
static final int GET_DOMAIN
static final int GET_DOMAIN_DIFFERENCES
static final int GET_DOMAIN_LIST
static final int GET_DOMAIN_STATUS
static final int GET_ERROR_REPORT
static final int GET_INTERDEPENDENT_SERVICES_IMAGE
static final int GET_INTERDEPENDENT_SERVICES_FILE
static final int GET_KEY_FILENAMES
static final int GET_REFERENCED_OBJECTS
static final int GET_SAML_TOKEN
static final int GET_SERVICE_LIST_FROM_DOMAIN
static final int GET_SERVICE_LIST_FROM_EXPORT_IMAGE
static final int GET_SERVICE_LIST_FROM_EXPORT_FILE
static final int IS_DOMAIN_DIFFERENT
static final int PING_DEVICE
static final int QUIESCE_DEVICE
static final int QUIESCE_DOMAIN
static final int QUIESCE_SERVICE
static final int REBOOT
static final int RESTART_DOMAIN
static final int RESTORE_DEVICE
static final int SET_DOMAIN
static final int SET_DOMAIN_BY_SERVICE_IMAGE
static final int SET_DOMAIN_BY_SERVICE_FILE
static final int SET_FILE
static final int SET_FIRMWARE_IMAGE
static final int SET_FIRMWARE_STREAM
static final int SET_FIRMWARE_IMAGE_ACCEPT_LICENSE
static final int SET_FIRMWARE_STREAM_ACCEPT_LICENSE
static final int START_DOMAIN
static final int STOP_DOMAIN
static final int START_SERVICE
static final int STOP_SERVICE
static final int SUBSCRIBE_TO_DEVICE
static final int UNQUIESCE_DEVICE
static final int UNQUIESCE_DOMAIN
static final int UNQUIESCE_SERVICE
static final int UNSUBSCRIBE_FROM_DEVICE
Method Detail |
---|
SubscriptionResponseCode subscribeToDevice(DeviceContext device, java.lang.String subscriptionId, StringCollection topics, java.net.URL callback) throws InvalidCredentialsException, AMPIOException, DeviceExecutionException, AMPException
callback
when a configuration change or related action
happens on the specified device. For a list of the events that we should
be notified of see Notification
. If an attempt is made to create
a duplicate subscription to the same device with the same topic, this
will not result in receiving duplicate notifications. Only one manager
may be subscribed to a device at a time. To check the status of the
subscription, use pingDevice(DeviceContext, String)
.
device
- the DataPower device that the subscriber wants to monitorsubscriptionId
- This id is used later to unsubscribe via
unsubscribeFromDevice(DeviceContext, String, StringCollection)
,
and to check the status of the subscription via
pingDevice(DeviceContext, String)
. This value should be
unique for each subscriber, so it is up to the subscriber to pick
unique ids that will not have collisions on the device.topics
- a collection of String values indicating the topic(s) on
the device to subscribe tocallback
- a URL in the subscriber that should be invoked by the
device to send the notification from the device to the subscriber
unsubscribeFromDevice(DeviceContext, String, StringCollection)
,
pingDevice(DeviceContext, String)
,
Notification
,
NotificationCatcher
void unsubscribeFromDevice(DeviceContext device, java.lang.String subscriptionID, StringCollection topics) throws NotExistException, InvalidCredentialsException, DeviceExecutionException, AMPIOException, AMPException
subscribeToDevice(DeviceContext, String, StringCollection, URL)
.
To check the status of the subscription, use
pingDevice(DeviceContext, String)
.
device
- the DataPower device that the subscriber is monitoringsubscriptionID
- the subscription id that was returned from
subscribeToDevice(DeviceContext, String, StringCollection, URL)
topics
- a collection of String values indicating the topic(s) on
the device to unsubscribe fromsubscribeToDevice(DeviceContext, String, StringCollection, URL)
,
pingDevice(DeviceContext, String)
PingResponse pingDevice(DeviceContext device, java.lang.String subscriptionID) throws InvalidCredentialsException, DeviceExecutionException, AMPIOException, AMPException
device
- the DataPower device to querysubscriptionID
- the subscription id that was returned from
subscribeToDevice(DeviceContext, String, StringCollection, URL)
.
This will keep the subscription alive on the device, and it will
enable the device to indicate in a PingResponse any error state
regarding the subscription.
PingResponse
, which indicates the state of the
subscription on the device.PingResponse
,
getDeviceMetaInfo(DeviceContext)
DeviceMetaInfo getDeviceMetaInfo(DeviceContext device) throws InvalidCredentialsException, DeviceExecutionException, AMPIOException, AMPException
DeviceMetaInfo
. This info is unlikely to change frequently. All
of the returned data will be treated as read-only.
device
- the DataPower device to query.
DeviceMetaInfo
,
PingResponse
void reboot(DeviceContext device) throws InvalidCredentialsException, DeviceExecutionException, AMPIOException, AMPException
Shutdown -> Reboot System
command in the System Control
menu of the WebGUI.
device
- the device to rebootrestartDomain(DeviceContext, String)
java.lang.String[] getDomainList(DeviceContext device) throws InvalidCredentialsException, DeviceExecutionException, AMPIOException, AMPException
device
- the DataPower device to query.
byte[] getDomain(DeviceContext device, java.lang.String domainName) throws NotExistException, InvalidCredentialsException, DeviceExecutionException, AMPIOException, AMPException
Note that this does not include any items from the cert:
,
sharedcert:
, or pubcert:
filestores. Items
in those filestores will not be obtained using this method, as those
filestores are considered unexportable via AMP, WebGUI, and CLI. It will
be the responsbility of the user to manually copy items in those
filestores to each device device from their own external store.
device
- the DataPower device from which to export the domaindomainName
- the domain on the device to export
setDomain
.
Note that this blob probably (depending upon the implementation)
is a zip file in the same format as if you had performed a
"Create backup of one or more application domains" from the
WebGUI, and you could also use this content on a "Compare
Configuration" in the WebGUI as a "Backup ZIP Bundle".
Additionally, this content may be Base64 encoded (again,
depending on the implementation).setDomain(DeviceContext, String, byte[], DeploymentPolicy)
void setDomain(DeviceContext device, java.lang.String domainName, byte[] domainImage, DeploymentPolicy policy) throws InvalidCredentialsException, DeviceExecutionException, AMPIOException, AMPException, DeletedException
getDomain(DeviceContext, String)
. In DataPower terms, this
is a Restore instead of an Import, as we want all the referenced files,
not only the configuration objects. This can also be used to install
domains on a device different from where it was originally retrieved.
This method should delete any domain of the same name that already exists
on the device, load this domain into the running configuration, start all
the services that are in this domain, mark the domain as runnable
(op-state up), and persist it to the device's non-volatile storage (save
config).
If a domain was backed up from a device that has a different firmware version that the device it is being restored/installed to, it is assumed that the target device will handle any changes to the domain backup image that may be necessary for it to work properly on the target device.
If the domain is being installed to a different deviceType than it was retrieved from (i.e., XS40), it is assumed that loading the domain to a higher function device (i.e., XI50) will work appropriately. Installing the domain on a lower function device (i.e., XA35) may result in domain services that do not behave as desired. Because of this, the caller also needs to keep track of the deviceType that this domain was exported from.
device
- the DataPower device to which the domain is restored or
installeddomainName
- the name of the domain being loadeddomainImage
- an opaque blob that represents the domain. This is the same
blob that was obtained from
getDomain(DeviceContext, String)
, see the javadoc
for that method for more information about this blob.policy
- a deployment policy to be used when setting the domaingetDomain(DeviceContext, String)
,
deleteDomain(DeviceContext, String)
void deleteDomain(DeviceContext device, java.lang.String domainName) throws NotExistException, InvalidCredentialsException, DeviceExecutionException, AMPIOException, AMPException
device
- the DataPower device from which to delete the named domaindomainName
- the domain on that device to delete. The
default
domain cannot be deleted.setDomain(DeviceContext, String, byte[], DeploymentPolicy)
DomainStatus getDomainStatus(DeviceContext device, java.lang.String domainName) throws NotExistException, InvalidCredentialsException, DeviceExecutionException, AMPIOException, AMPException
Notification
.
device
- the DataPower device on which the domain residesdomainName
- the domain to get the status of
Notification
,
startDomain(DeviceContext, String)
,
stopDomain(DeviceContext, String)
void startDomain(DeviceContext device, java.lang.String domainName) throws NotExistException, InvalidCredentialsException, DeviceExecutionException, AMPIOException, AMPException
device
- the device in which the domain residesdomainName
- the name of the domain to startstopDomain(DeviceContext, String)
,
getDomainStatus(DeviceContext, String)
void stopDomain(DeviceContext device, java.lang.String domainName) throws NotExistException, InvalidCredentialsException, DeviceExecutionException, AMPIOException, AMPException
device
- the device in which the domain residesdomainName
- the name of the domain to stopstartDomain(DeviceContext, String)
,
getDomainStatus(DeviceContext, String)
void restartDomain(DeviceContext device, java.lang.String domainName) throws NotExistException, InvalidCredentialsException, DeviceExecutionException, AMPIOException, AMPException
device
- the device in which the domain residesdomainName
- the name of the domain to restartreboot(DeviceContext)
@Deprecated void setFirmware(DeviceContext device, byte[] firmwareImage) throws InvalidCredentialsException, DeviceExecutionException, AMPIOException, AMPException
If a change in the firmware causes either an existing configuration element to no longer be valid, or a missing configuration element to be required, it is assumed that the target device will handle any changes to the configuration element that may be necessary for it to work properly.
A single SOAP method on the device will be used by both this method and
setFirmware(DeviceContext, InputStream)
. This method will
return after the firmware has been installed and a reboot is scheduled.
device
- the device to load the firmware ontofirmwareImage
- an opaque blob firmware binary image as retrieved
from the DataPower web site or from distributable mediasetFirmware(DeviceContext, InputStream)
@Deprecated void setFirmware(DeviceContext device, java.io.InputStream inputStream) throws InvalidCredentialsException, DeviceExecutionException, AMPIOException, AMPException
setFirmware(DeviceContext, byte[])
, but allows for the
large boot image to be specified in in a stream instead of in-memory byte
array. The image can be 20MB or larger, so for performance purposes you
may not want it in a byte array.
A single SOAP method on the device will be used by both this method and
setFirmware(DeviceContext, byte[])
.
device
- the device to load the firmware ontoinputStream
- an inputStream to an opaque blob firmware binary image
as retrieved from the DataPower web site or from distributable
media. It is expected that this inputStream references content
that is already base64-encoded. This is a special case not present
on the other AMP commands. The reason for this is that firmware is
such a large object 15-30MB that doing a base64 encode to prepare
it for transmission each time it is transmitted to a device is a
memory-intensive operation that we need to avoid. If it was
unencoded, XMLBeans would create multiple copies of this large
blob, which may blow up the heap size and cause out-of-memory
errors. So to tune for this situation, the firmware blob is stored
in the repository already encoded in base64 format, and thus does
not need to be encoded for transmission to devices.setFirmware(DeviceContext, byte[])
java.lang.String[] getKeyFilenames(DeviceContext device, java.lang.String domainName) throws InvalidCredentialsException, DeviceExecutionException, AMPIOException, AMPException
cert:
, sharedcert:
, and
pubcert:
filestores. Those device filestores are
considered unexportable. This means that items in these filestores will
not be included in a domain backup, they need to be installed separately
when installing the backup image. This method will enable the application
to determine which keys are needed when installing the backup image.
Those needed keys could be pulled from an external repository, or the
administrator could be prompted to manually supply these key files. This
does not export the keys from the device, it only provides their names.
This is a nice-to-have, not a requirement.
device
- the DataPower device which has the specified domaindomainName
- the domain to check for key filenames
cert:///mycert.pem
. These filename should be
usable in the
setFile(DeviceContext, String, String, byte[])
method
and should include the name of the filestore.setFile(DeviceContext, String, String, byte[])
void setFile(DeviceContext device, java.lang.String domainName, java.lang.String filenameOnDevice, byte[] contents) throws NotExistException, InvalidCredentialsException, DeviceExecutionException, AMPIOException, AMPException
getKeyFilenames(DeviceContext, String)
. But
it could be used to install any file to any of the device filestores.
device
- the DataPower device which has the specified domaindomainName
- the domain in which to install the filefilenameOnDevice
- the name of the file in the format used by the
device, i.e., cert:///mycert.pem
contents
- the raw file contents (i.e., no Base64 encoding)getKeyFilenames(DeviceContext, String)
boolean isDomainDifferent(java.lang.String domainName, byte[] configImage1, byte[] configImage2, DeviceContext device) throws InvalidCredentialsException, DeviceExecutionException, AMPIOException, AMPException
getDomain(DeviceContext, String)
, and see if they are
equivalent. Because this application does not have any knowledge of the
device configuration object model (it is opaque), the diff is performed
on the device.
See getDomainDifferences(String, byte[], byte[], DeviceContext)
for an alternate way to visually display the blob differences.
domainName
- the name of the domain specified in configImage1configImage1
- an opaque blob obtained from getDomain()configImage2
- an opaque blob obtained from getDomain() If this parameter is
null, then the device should use its own persisted domain as
the second input to the comparison. If this parameter is not
null, then the comparison can be performed on any device, it
does not require that the device already contain the domain,
or that the device firmware match the firmware used when the
domain was retrieved.device
- a device on which to execute the comparison
getDomainDifferences(String, byte[], byte[], DeviceContext)
java.net.URL getDomainDifferences(java.lang.String domainName, byte[] configImage1, byte[] configImage2, DeviceContext device) throws InvalidCredentialsException, DeviceExecutionException, AMPIOException, AMPException
getDomainViaBackup
, and return
a URL where the differences can be viewed. Because the application does
not have any knowledge of the device configuration object model (it is
opaque), the diff is performed on the device.
Because the blob parameters are basically a ZIP backup (see
getDomain(DeviceContext, String)
, you could also use the WebGUI
(Compare Configuration - Backup ZIP Bundle) with these blobs as an
alternate way to display the differences.
domainName
- the name of the domain specified in configImage1configImage1
- an opaque blob obtained from getDomain()configImage2
- an opaque blob obtained from getDomain(). If this parameter is
null, then the device should use its own persisted domain as
the second input to the comparison. If this parameter is not
null, then the comparison can be performed on any device, it
does not require that the device already contain the domain,
or that the device firmware match the firmware used when the
domain was retrieved.device
- a device on which to execute the difference fetch. If
configImage2
is not null, then the domain image
does not need to exist on the device.
isDomainDifferent(String, byte[], byte[], DeviceContext)
ErrorReport getErrorReport(DeviceContext device) throws InvalidCredentialsException, DeviceExecutionException, AMPIOException, AMPException
device
- a device on which to retrieve the error report
java.lang.String getSAMLToken(DeviceContext device, java.lang.String domainName) throws InvalidCredentialsException, DeviceExecutionException, AMPIOException, AMPException
device
- the deviceContext of the device on which to retrieve the
SAML token fromdomainName
- the domainName to be forwarded to
java.util.Hashtable backupDevice(DeviceContext device, java.lang.String cryptoCertificateName, byte[] cryptoImage, java.lang.String secureBackupDestination, boolean includeISCSI, boolean includeRaid) throws AMPIOException, InvalidCredentialsException, AMPException
device
- the deviceContext of the device to perform a backup oncryptoCertificateName
- the cyrpto certificate object namecryptoImage
- the content of the certificate used to encrypt the backupsecureBackupDestination
- the location where the backed up files will be stored
void restoreDevice(DeviceContext device, java.lang.String cryptoCredentialName, boolean validate, java.net.URI secureBackupSource, java.util.Hashtable<java.lang.String,byte[]> backupFilesTable) throws AMPIOException, InvalidCredentialsException, AMPException
device
- the deviceContext of the device to perform the restorecryptoCredentialName
- the object name of the Crypto Identification Credentials used to decrypt the backupsecureBackupSource
- location of the backup files. This may be local: temporary: or ftpbackupFilesTable
- a Hashtable with the file names(keys) and contents (values) of the backup file, if the were
saved on a file system and have to embedded in the restore requestvoid quiesceDomain(DeviceContext device, java.lang.String domain, int timeout) throws AMPIOException, InvalidCredentialsException, AMPException
device
- the deviceContext of the device containing the domain to quiescedomain
- the name of the domain to quiescetimeout
- the amount of time in seconds to wait for the quiesce to complete.
Once the timeout is reached, existing connections may be terminated.void unquiesceDomain(DeviceContext device, java.lang.String domain) throws AMPIOException, InvalidCredentialsException, AMPException
device
- the deviceContext of the device containing the domain to unquiescedomain
- the name of the domain to unquiescevoid quiesceDevice(DeviceContext device, int timeout) throws AMPIOException, InvalidCredentialsException, AMPException
device
- the deviceContext of the device to quiescetimeout
- the amount of time in seconds to wait for the quiesce to complete.
Once the timeout is reached, existing connections may be terminated.void unquiesceDevice(DeviceContext device) throws AMPIOException, InvalidCredentialsException, AMPException
device
- the deviceContext of the device to unquiesceRuntimeService[] getServiceListFromDomain(DeviceContext device, java.lang.String domainName) throws DeviceExecutionException, AMPIOException, AMPException
device
- the DataPower device to query.domainName
- the domain on that device to get the service List
InterDependentServiceCollection getInterDependentServices(DeviceContext device, java.lang.String domainName, java.lang.String fileDomainName, java.lang.String fileNameOnDevice, ConfigObject[] objects) throws NotExistException, InvalidCredentialsException, DeviceExecutionException, AMPIOException, AMPException
device
- the DataPower device to query.domainName
- the domain on that device to get the inter dependent servicesfileDomainName
- the domain on that device to get the export/backup packagefileNameOnDevice
- the name of export/backup package in the format used by the
device, i.e., temporary:///package.zip
objectArray
- the objects context array
getInterDependentServices(DeviceContext, String, byte[], ConfigObject[])
InterDependentServiceCollection getInterDependentServices(DeviceContext device, java.lang.String domainName, byte[] packageImage, ConfigObject[] objectArray) throws NotExistException, InvalidCredentialsException, DeviceExecutionException, AMPIOException, AMPException
device
- the DataPower device to get the interDependentServicesdomainName
- the domain on that device to get the inter dependent servicespackageImage
- an opaque blob that represents the of export/backup package,
It is expected that this packageImage content is already base64-encoded.
getInterDependentServices(DeviceContext, String, String, String, ConfigObject[])
ConfigService[] getServiceListFromExport(DeviceContext device, java.lang.String fileDomainName, java.lang.String fileNameOnDevice) throws NotExistException, InvalidCredentialsException, DeviceExecutionException, AMPIOException, AMPException
device
- the DataPower device to get Service List from export/backup packagefileDomainName
- the domain in which the export/backup package isfileNameOnDevice
- the name of export/backup package in the format used by the
device, i.e., temporary:///package.zip
getServiceListFromExport(DeviceContext, byte[])
ConfigService[] getServiceListFromExport(DeviceContext device, byte[] packageImage) throws NotExistException, InvalidCredentialsException, DeviceExecutionException, AMPIOException, AMPException
device
- the DataPower device to get service list from export/backup packagepackageImage
- an opaque blob represents the export/backup package, It is expected
that this packageImage content is already base64-encoded.
getServiceListFromExport(DeviceContext, String, String)
ReferencedObjectCollection getReferencedObjects(DeviceContext device, java.lang.String domainName, java.lang.String objectName, java.lang.String objectClassName) throws NotExistException, InvalidCredentialsException, DeviceExecutionException, AMPIOException, AMPException
device
- the DataPower device to get referenced objectsdomainName
- the domain in where the object to get the referencedobjectName
- the name of objectobjectClassName
- the class name of the object
DeleteObjectResult[] deleteService(DeviceContext device, java.lang.String domainName, java.lang.String objectName, java.lang.String objectClassName, ConfigObject[] excludeObjects, boolean deleteReferencedFiles) throws NotExistException, InvalidCredentialsException, DeviceExecutionException, AMPIOException, AMPException
device
- the DataPower device to delete servicedomainName
- the domain in which the service to be deletedobjectName
- name of the service to be deletedobjectClassName
- class name of the service to be deltedexcludeObjects
- Object array to be deleted exclusivelydeleteReferencedFiles
- a boolean value if delete the referenced files
void quiesceService(DeviceContext device, java.lang.String domain, ConfigObject[] objects, int timeout) throws InvalidCredentialsException, DeviceExecutionException, AMPIOException, AMPException
device
- the DataPower device to quiesce the servicedomainName
- the name of domain in which the services to be quiescedobjects
- the service object to be quiescedtimeout
- the amount of time in seconds to wait for the quiesce to complete. Once the timeout is reached, existing connections may be terminated.void unquiesceService(DeviceContext device, java.lang.String domainName, ConfigObject[] objects) throws InvalidCredentialsException, DeviceExecutionException, AMPIOException, AMPException
device
- the DataPower device to unquiesce the servicedomainName
- the name of domain in which the services to be unquiescedobjects
- the service objects to be unquiescedvoid startService(DeviceContext device, java.lang.String domainName, ConfigObject[] objects) throws InvalidCredentialsException, DeviceExecutionException, AMPIOException, AMPException
device
- the DataPower device to start the servicesdomainName
- the name of domain in which services to be startedobjects
- the service objects to be startedvoid stopService(DeviceContext device, java.lang.String domainName, ConfigObject[] objects) throws InvalidCredentialsException, DeviceExecutionException, AMPIOException, AMPException
device
- the DataPower device to start the servicedomainName
- the name of domain in which services to be stopedobjects
- the service objects to be stopedvoid setDomainByService(DeviceContext device, java.lang.String domainName, ConfigObject[] objects, byte[] domainImage, DeploymentPolicy policy, boolean importAllFiles) throws InvalidCredentialsException, DeviceExecutionException, AMPIOException, AMPException, DeletedException
device
- the DataPower device to which the domain is restored or installed.domainName
- the name of the domain being loadedobjects
- services want to be setdomainImage
- an opaque blob that represents the domain. This is the same
blob that was obtained from getDomain(DeviceContext, String)
, see the javadoc
for that method for more information about this blob.policy
- a deployment policy to be used when setting the domainimportAllFiles
- a boolean value if import all files in the export/backup packagequiesceService(DeviceContext, String, ConfigObject[], int)
void setDomainByService(DeviceContext device, java.lang.String domainName, ConfigObject[] objects, java.lang.String fileDomainName, java.lang.String fileNameOnDevice, DeploymentPolicy policy, boolean importAllFiles) throws InvalidCredentialsException, DeviceExecutionException, AMPIOException, AMPException, DeletedException
device
- the DataPower device to which the domain is restored or installed.domainName
- the name of the domain to be setobjects
- services want to be setfileDomainName
- the domain in which to get the filefilenameOnDevice
- the name of the file in the format used by the
device, i.e., temporary:///package.zip
*policy
- a deployment policy to be used when setting the domainimportAllFiles
- a boolean value if import all files in the export/backup packagevoid setFirmware(DeviceContext device, byte[] firmwareImage, boolean acceptLicense) throws InvalidCredentialsException, DeviceExecutionException, AMPIOException, AMPException
If a change in the firmware causes either an existing configuration element to no longer be valid, or a missing configuration element to be required, it is assumed that the target device will handle any changes to the configuration element that may be necessary for it to work properly.
A single SOAP method on the device will be used by both this method and
setFirmware(DeviceContext, InputStream)
. This method will
return after the firmware has been installed and a reboot is scheduled.
device
- the device to load the firmware ontofirmwareImage
- an opaque blob firmware binary image as retrieved
from the DataPower web site or from distributable mediaacceptLicense
- a boolean value if accept license, must be ture to continue
the firmware setting.setFirmware(DeviceContext, InputStream)
void setFirmware(DeviceContext device, java.io.InputStream inputStream, boolean acceptLicense) throws InvalidCredentialsException, DeviceExecutionException, AMPIOException, AMPException
setFirmware(DeviceContext, byte[], boolean)
, but allows for the
large boot image to be specified in in a stream instead of in-memory byte
array. The image can be 20MB or larger, so for performance purposes you
may not want it in a byte array.
A single SOAP method on the device will be used by both this method and
setFirmware(DeviceContext, byte[], boolean)
.
device
- the device to load the firmware ontoinputStream
- an inputStream to an opaque blob firmware binary image
as retrieved from the DataPower web site or from distributable
media. It is expected that this inputStream references content
that is already base64-encoded. This is a special case not present
on the other AMP commands. The reason for this is that firmware is
such a large object 15-30MB that doing a base64 encode to prepare
it for transmission each time it is transmitted to a device is a
memory-intensive operation that we need to avoid. If it was
unencoded, XMLBeans would create multiple copies of this large
blob, which may blow up the heap size and cause out-of-memory
errors. So to tune for this situation, the firmware blob is stored
in the repository already encoded in base64 format, and thus does
not need to be encoded for transmission to devices.acceptLicense
- a boolean value if accept license, must be ture to continue
the firmware setting.setFirmware(DeviceContext, byte[])
void deleteFile(DeviceContext device, java.lang.String domainName, java.lang.String fileNameOnDevice) throws InvalidCredentialsException, DeviceExecutionException, AMPIOException, AMPException
device
- the DataPower device which has the specified domaindomainName
- the domain in which to delete the filefilenameOnDevice
- the name of the file in the format used by the
device, i.e., temporary:///package.zip
getKeyFilenames(DeviceContext, String)
,
setFile(DeviceContext, String, String, byte[])
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |