Package 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.

See:
          Description

Interface Summary
Commands A list of high-level commands that the DataPower device should support via SOAP invocation.
NotificationCatcher This is the interface through which the Manager will start and stop the NotificationCatcher.
SOAPHelper A list of high-level commands that a SOAPHelperImpl class should implement.
 

Class Summary
AMPConstants  
CommandFactory Gets an instance of an AMP Command implementation.
ConfigObject This class is used to represent the basis information of a object (service)
DeleteObjectResult This represents the data that would be returned from Commands.deleteService(DeviceContext, String, String, String, ConfigObject[], boolean).
DeviceContext This provides the information/context necessary to identify a particular DataPower device for communicating with it, and have the authentication or other data necessary to connect to it.
DeviceMetaInfo This represents the data that would be returned from Commands.getDeviceMetaInfo(DeviceContext).
DomainStatus A container to hold the multiple objects returned from Commands.getDomainStatus(DeviceContext, String).
ErrorReport An error report is an object generated on the DataPower appliance that reports the running config, logs, and other pertinent data that can be used in debugging.
InterDependentServiceCollection This represents the data that would be returned only from Commands.getInterDependentServices(DeviceContext, String, byte[], ConfigObject[]), Commands.getInterDependentServices(DeviceContext, String, String, String, ConfigObject[]).
Notification A POJO representation of an event from a DataPower device.
NotificationCatcherFactory Create an instance of a NotificationCatcher implementation using only the name.
PackageInfo Get the SCM information about all the classes in this package.
PingResponse This is the object that will be returned from Commands.pingDevice(DeviceContext, String).
ReferencedObjectCollection This class is used to represent the referenced object returned from the Commands.getReferencedObjects(DeviceContext, String , String , String )
SOAPHelperFactory Gets an instance of an AMP SOAPHelper implementation.
SubscriptionResponseCode Provides enumerated values and helper methods for the response from the device of the subscription request.
SubscriptionState Provides enumerated values and helper methods for the state of the subscription as reported by the device.
Utilities This class provides utilities which can be used for parsing information needed by the other classes in this package.
 

Exception Summary
AMPException The top-level class to identify exceptions that may occur while communicating with DataPower devices.
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.
DeviceExecutionException The device had an internal error while executing an AMP command.
InvalidCredentialsException The device userid and password supplied inside a DeviceContext parameter were not accepted by the device.
NotExistException The requested item does not exist in the device.
NotificationCatcherResourceException The NotificationCatcher encountered a problem while trying to acquire sufficient resources to start itself.
 

Package com.ibm.datapower.wamt.amp Description

The Appliance Management Protocol (AMP) provides an abstraction layer for message and command communication between the Manager and the DataPower devices. It provides a Java interface so that the caller does not need to know the format of the messages or the transport mechanism used to communicate with the device. Because this is a Java interface, a specific implementation of this interface needs to be provided for actual communication with DataPower devices.

WAMT provides default implementations for AMP in the com.ibm.datapower.wamt.amp.defaultProvider and com.ibm.datapower.wamt.amp.defaultV2Provider packages.

AMP may also be referred to as "HLM", which is an abbreviation for "High Level Management". HLM is meant to contrast with SOMA, which is a low-level management. HLM was the initial name for AMP, it may not have been changed in all places.

To start using AMP, refer to:



© Copyright IBM Corp. 2006, 2010 All Rights Reserved.