|
|||||||||||
PREV NEXT | FRAMES NO FRAMES |
Packages that use DeviceContext | |
---|---|
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. |
com.ibm.datapower.wamt.soma |
Uses of DeviceContext in com.ibm.datapower.wamt.amp |
---|
Methods in com.ibm.datapower.wamt.amp with parameters of type DeviceContext | |
---|---|
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. |
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. |
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. |
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. |
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 |
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 DeviceContext in com.ibm.datapower.wamt.clientAPI |
---|
Methods in com.ibm.datapower.wamt.clientAPI that return DeviceContext | |
---|---|
DeviceContext |
Device.getDeviceContext()
Returns the DeviceContext for this device, necessary for AMP calls. |
Uses of DeviceContext in com.ibm.datapower.wamt.soma |
---|
Methods in com.ibm.datapower.wamt.soma with parameters of type DeviceContext | |
---|---|
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) |
java.util.Map<java.lang.String,java.util.List<Status>> |
SOMACommands.getAllStatus(DeviceContext device,
java.lang.String domainName)
Get all SOMA status supported by device |
java.util.List<Status> |
SOMACommands.getStatus(DeviceContext device,
java.lang.String domainName,
java.lang.String OpName)
Get SOMA status with operation name supported by device |
|
|||||||||||
PREV NEXT | FRAMES NO FRAMES |