|
|||||||||||
PREV NEXT | FRAMES NO FRAMES |
clientAPI
and amp
packages.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.ServiceConfiguration.getAvailableServices(Device)
.Domain.deployConfiguration()
.
Configuration.KEY_AMP_CONNECT_TIMEOUT
Configuration.KEY_CAPTURE_VERSION_BLOB
Configuration.KEY_COLLECT_DAEMON_PROGRESSES
Configuration.KEY_COLLECT_DOMAIN_SYNCH_PROGRESSES
Configuration.KEY_COMMANDS_IMPL
Configuration.KEY_COMMANDS_SOMA_IMPL
Configuration.KEY_COMMANDS_V2_IMPL
Configuration.KEY_COMMANDS_V3_IMPL
Configuration.KEY_COMMANDS_XC10_IMPL
Configuration.KEY_DEVICE_LOG_PORT
Configuration.KEY_DOMAIN_QUIESCE_TIMEOUT
Configuration.KEY_DOMAIN_QUIESCE_TIMEOUT
Configuration.KEY_DOMAIN_SYNCHRONIZATION_INTERVAL
units are in milliseconds.
Configuration.KEY_DOMAIN_SYNCHRONIZATION_RETRY_MAX
.
Configuration.KEY_DOMAIN_SYNCHRONIZATION_THREAD_POOL_SIZE
.
Configuration.KEY_HEARTBEAT_DISABLE
Configuration.KEY_HEARTBEAT_INTERVAL
Configuration.KEY_HEARTBEAT_THREAD_POOL_SIZE
Configuration.KEY_HTTP_LISTENER_IP_INTERFACE
Configuration.KEY_HTTP_LISTENER_IP_PORT
Configuration.KEY_HTTP_LISTENER_IP_ADDRESS
Configuration.KEY_HTTP_LISTENER_SOCKET_TIMEOUT
Configuration.KEY_MESSAGE_PREFIX
Configuration.KEY_NOTIFICATION_CATCHER_IMPL
Configuration.KEY_NOTIFICATION_CATCHER_IP_ADDRESS
Configuration.KEY_NOTIFICATION_CATCHER_IP_INTERFACE
Configuration.KEY_NOTIFICATION_CATCHER_IP_PORT
Configuration.KEY_NOTIFICATION_CATCHER_NO_SSL
Configuration.KEY_REPOSITORY_IMPL
Configuration.KEY_SIGNAL_CONNECT_TIMEOUT
Configuration.KEY_SIGNAL_DELAY_TIME
Configuration.KEY_SIGNAL_RESPONSE_TIMEOUT
Configuration.KEY_SIGNAL_SOAP_ACTION
Configuration.KEY_SIGNAL_URL
Configuration.KEY_SOAP_HELPER_IMPL
Configuration.KEY_SOAP_HELPER_SOMA_IMPL
Configuration.KEY_SOAP_HELPER_V2_IMPL
Configuration.KEY_SOAP_HELPER_V3_IMPL
Configuration.KEY_TASK_QUEUE_SIZE
Configuration.KEY_TRUSTSTORE_FILENAME
Configuration.KEY_TRUSTSTORE_PASSWORD
Manager.getAllDevices()
and
Manager.getDmiLogger()
Commands.deleteService(DeviceContext, String, String, String, ConfigObject[], boolean)
.Domain.setSourceConfiguration(URLSource)
and Domain.setDeploymentPolicy(URLSource, String, String)
Domain
during deployment.Commands.getDeviceMetaInfo(DeviceContext)
.Commands.getDomainStatus(DeviceContext, String)
.this
is equivalent to that
.
Commands
interface.
SOMACommands
interface.
StoredDeploymentPolicy
that contains this version.
StoredDomain
resides.
DeviceMetaInfo
.
StoredDomain
that contains this StoredDeploymentPolicy
.
StoredDomain
that contains this version.
getDomainViaBackup
, and return
a URL where the differences can be viewed.
FirmwareVersion.getVersionedObject()
, but casts the return value to
a Firmare
class.
Commands.getDeviceMetaInfo(DeviceContext)
.
ManagedSet
membership.
ModelType
from the String returned from
Commands.getDeviceMetaInfo(DeviceContext)
.
StoredDevice
as the unique identifier of this object.
StoredDomain
.
Commands.getDomainStatus(DeviceContext, String)
.
StoredDeploymentPolicy
.
StoredDeploymentPolicyVersion
.
StoredDeploymentPolicyVersion
object.
StoredDeploymentPolicyVersion
.
StoredDeploymentPolicy
as the unique identifier
of this object.
StoredDomain
combined with the Device
primaryKey as the the unique identifier for this object
StoredDomain
combined with the version number of this StoredDomainVersion
.
Commands.getDomainStatus(DeviceContext, String)
.
SOAPHelper
interface.
SOAPHelper
interface.
Domain.setSourceConfiguration(URLSource)
StoredDevice
.
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
.
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.
Commands.getInterDependentServices(DeviceContext, String, byte[], ConfigObject[])
,
Commands.getInterDependentServices(DeviceContext, String, String, String, ConfigObject[])
.Commands#getInterDependentServices(DeviceContext, String, byte[], ConfigObject[]
in general.
DeviceContext
parameter were not accepted by the device.Commands.getDomain(DeviceContext, String)
, and see if they are
equivalent.
this
this
is considered more serious (worse) than
that
.
DomainVersion
or DeploymentPolicyVersion
is
created, serialize it to the local filesystem.
Commands
interface.
SOMACommands
interface.
Commands
interface.
Commands
interface.
Commands
interface.
DeviceLogger
to listen
on.
Commands
interface.
NotificationCatcher
interface.
Repository
interfaces.
SOAPHelper
interface.
SOAPHelper
interface.
SOAPHelper
interface.
SOAPHelper
interface.
Configuration.KEY_TRUSTSTORE_FILENAME
Manager.OPTION_TRUSTSTORE_PASSWORD
Configuration.DEFAULT_TRUSTSTORE_PASSWORD
synchronized
) or non-blocking (fail-fast).MacroProgressContainer
is a container for multiple
ProgressContainers.ManagementStatus
.ManagerStatus
.OperationStatus
.Manager.getInstance(Map)
, use this as the option
name when designating the number of milliseconds to monitor each AMP connect
request to avoid a hang condition.
Manager.getInstance(Map)
, use this as the option
name when designating a Boolean object that indicates if you would like
the heartbeat daemon to put ProgressContainers in a queue to be collected
by the caller.
Manager.getInstance(Map)
, use this as the option
name when designating a Boolean object that indicates if you would like
the domain synchronization to put ProgressContainers in a queue to be collected
by the caller.
Manager.getInstance(Map)
, use this as the option
name when designating the name of the class that implements the
Commands
interface for AMPv1.
Manager.getInstance(Map)
, use this as the option
name when designating the name of the class that implements the
Commands
interface for SOMA.
Manager.getInstance(Map)
, use this as the option
name when designating the name of the class that implements the
Commands
interface for AMPv2.
Manager.getInstance(Map)
, use this as the option
name when designating the name of the class that implements the
Commands
interface for AMPv3.
Manager.getInstance(Map)
, use this as the option
name when designating the name of the class that implements the
Commands
interface for AMPv2.
Manager.getInstance(Map)
, use this as the option
name when designating a reference to an object that implements the
Credential
interface and contains the values that will pass
authentication and authorization tests to permit the current user to use
the Manager.
Manager.getInstance(Map)
, use this as the option
name when designating a Boolean object that indicates if you would like
the DomainVersion and DeploymentPolicyVersion blobs to be captured to disk
in the root directory but outside of the repository.
Manager.getInstance(Map)
, use this as the option
name when designating a Boolean object that indicates if you would like
the heartbeat activity to not occur, meaning that heartbeating is
disabled.
Manager.getInstance(Map)
, use this as the option
name when designating the port for device logs.
Manager.getInstance(Map)
, use this as the option
name when designating the number of milliseconds in the period that a
DomainSynchronization task should wait before probing a device again.
Manager.getInstance(Map)
, use this as the option
name when designating the number of times to retry a failed domain synchronization task.
Manager.getInstance(Map)
, use this as the option
name when designating the number of threads that should be in the pool
for DomainSynchronization Tasks to run on.
Manager.getInstance(Map)
, use this as the option
name when designating the number of milliseconds in the period that a
HeartbeatTask should wait before probing a device again.
Manager.getInstance(Map)
, use this as the option
name when designating the number of threads that should be in the pool
for HeartbeatTasks to run on.
Manager.getInstance(Map)
, use this as the option
name when designating the IP address that the HTTP Listener can be
reached at by the device for retrieving files.
Manager.getInstance(Map)
, use this as the option
name when designating the name of the interface that the HTTP Listener can be
reached at by the device for retrieving files.
Manager.getInstance(Map)
, use this as the option
name when designating the IP port number that the HTTP Listener
should listen on for file requests from devices.
Manager.getInstance(Map)
, use this as the option
name when designating the IP port number that the HTTP Listener
should listen on for file requests from devices.
Manager.getInstance(Map)
, use this as the option
name when designating prefix for all messages
*
Manager.getInstance(Map)
, use this as the option
name when designating the name of the class that implements the
NotificationCatcher
interface.
Manager.getInstance(Map)
, use this as the option
name when designating the IP address that the NotificationCatcher can be
reached at by the device for the sending of events.
Manager.getInstance(Map)
, use this as the option
name when designating the name of the interface that the NotificationCatcher can be
reached at by the device for the sending of events.
Manager.getInstance(Map)
, use this as the option
name when designating if the NotificationCatcher should be listening
with a non-SSL server socket.
Manager.getInstance(Map)
, use this as the option
name when designating the IP port number that the NotificationCatcher
should listen on for events from devices.
Manager.getInstance(Map)
, use this as the option
name when designating the name of the class that implements the
Repository
interface.
Manager.getInstance(Map)
, and if you want a
third-party SOAP service to be signaled (receive a message) just before
and immediately after a change (firmware or domain) is
deployed to a device, this would specify the connect timeout of the
third-party SOAP service.
Manager.getInstance(Map)
, and if you want a
third-party SOAP service to be signaled (receive a message) just before
and immediately after a change (firmware or domain) is
deployed to a device, this would specify the sleep time after posting to
the third-party SOAP service before continuing on to deploy the change.
Manager.getInstance(Map)
, and if you want a
third-party SOAP service to be signaled (receive a message) just before
and immediately after a change (firmware or domain) is
deployed to a device, this would specify the timeout of waiting for a
response from the third-party SOAP service.
Manager.getInstance(Map)
, and if you want a
third-party SOAP service to be signaled (receive a message) just before
and immediately after a change (firmware or domain) is
deployed to a device, this would specify the value for the SOAPAction
header of the third-party SOAP service.
Manager.getInstance(Map)
, and if you want a
third-party SOAP service to be signaled (receive a message) just before
and immediately after a change (firmware or domain) is
deployed to a device, this would specify the URL of the third-party SOAP
service.
Manager.getInstance(Map)
, use this as the option
name when designating the name of the class that implements the
SOAPHelper
interface for AMPv1.
Manager.getInstance(Map)
, use this as the option
name when designating the name of the class that implements the
SOAPHelper
interface for AMPv2.
Manager.getInstance(Map)
, use this as the option
name when designating the name of the class that implements the
SOAPHelper
interface for AMPv2.
Manager.getInstance(Map)
, use this as the option
name when designating the name of the class that implements the
SOAPHelper
interface for AMPv2.
Manager.getInstance(Map)
, use this as the option
name when designating an Integer object that indicates how big you would
like the background task queue to be.
Manager.getInstance(Map)
, use this as an option
to specify the filename of the key store for the manager to use in it's truststore.
Manager.getInstance(Map)
, use this as an option
to specify the password for the key store specified in Configuration.KEY_TRUSTSTORE_FILENAME
Commands.pingDevice(DeviceContext, String)
.Shutdown -> Reboot System
command in the System Control
menu of the WebGUI.
Commands.getReferencedObjects(DeviceContext, String , String , String )
Domain.getServices()
or ServiceDeployment.getInterDependentServices()
.Manager.save(boolean)
calls an implementation of this interface to save the data in the repository.
Manager.save(boolean)
, use this value to indicate that
the new values held by this process should overwrite whatever may have
been changed by another vehicle.
Manager.save(boolean)
, use this value to indicate that if
the persistence has forked (a change in data was made by another vehicle
after it was loaded here), that the method should focus on data
consistency and fail the save operation.
Commands.getDomain(DeviceContext, String)
.
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.
URLSource
which will be deployed on the device
StoredDeploymentPolicyVersion
object which can be used along
with the configuration source, domain name and policy object name during domain configuration
deployment.
StoredDeploymentPolicyVersion
object which can be used along
with the configuration source, domain name and policy object name during domain configuration
deployment.
null
parameters are passed to
setDeploymentPolicy(null, null, null)
in Domain
Device.setSourceFirmwareVersion(FirmwareVersion)
, this
method accepts a firmware "level" (e.g., "3.8.0.1") instead of a specific
FirmwareVersion object.
Version.getUserComment()
.
StoredVersion.getUserComment()
.
Domain
that represents
a domain on a DataPower device.DeploymentPolicy
that must be managed and persisted when
domain configuration is deployed to a DataPower device.DeploymentPolicy
that is used in deploying a managed domain configuration.DeploymentPolicyVersion
.Device
.Domain
.Firmware
that must be maintained and
persisted for a firmware that can
be deployed to a device.FirmwareVersion
.ManagedSet
including its managed device members.Device
and Domain
including its tagged device and domain members.callback
when a configuration change or related action
happens on the specified device.
DomainVersion
is not deployable because it does not match the specified
DeploymentPolicyVersion
.Commands.subscribeToDevice(DeviceContext, String, StringCollection, URL)
.
Versionable
.Version
s.
|
|||||||||||
PREV NEXT | FRAMES NO FRAMES |