Dell PowerConnect W Clearpass 100 Software XMLRPC Interface TechNote - Page 6

API Symmetry, Access Control, Parameter Names, Parameter Validation, Field Customization

Page 6 highlights

amigopod XMLRPC Interface Version 0.9 XMLRPC and HTML presentation methods are supplied, which adapt the underlying basic presentation to appropriate conventions suitable for a machine-to-machine or human-to-machine interaction. The application layer provides the page templates, business logic, and the concrete features making up visitor management applications, such as Guest Manager or Hotspot Manager. These applications are built using the services provided by the lower layers. API Symmetry Because amigopod VMA applications are built using the framework supplied by the presentation layer, there is a direct symmetry between application features provided to operators using a web browser (HTML presentation), and application features provided to external applications using the XMLRPC presentation. In particular, the following items are shared between HTML and XMLRPC presentations: Access control Parameter names Parameter validation rules Customized fields and their rules Access Control Page privileges are applied to XMLRPC authenticated sessions in the same way as the HTML user interface. However, XMLRPC access also requires the XMLRPC API privilege to be granted. Parameter Names The parameter names passed to the XMLRPC interface are the same as the field names in the HTML user interface. Parameter Validation Each field of the forms in the HTML user interface is subject to validation according to the rules defined for that field. The same rules also apply to XMLRPC parameters. If a required field is missing, or an invalid value for a field is supplied, an error is generated by the presentation layer and returned to the XMLRPC client. Field Customization Some forms in the HTML user interface are customizable. New fields may be defined (for example, stored with a guest account) and used as part of the form in the presentation layer. Policy-based processing of fields includes form validation, data conversion and input formatting, and user interface metadata (for example, the list of valid options for a multiple-choice "dropdown" control). CONFIDENTIAL 6

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21

amigopod XMLRPC Interface
Version 0.9
CONFIDENTIAL
6
XMLRPC and HTML presentation methods are supplied, which adapt the
underlying basic presentation to appropriate conventions suitable for a
machine-to-machine or human-to-machine interaction.
The application layer provides the page templates, business logic, and the
concrete features making up visitor management applications, such as Guest
Manager or Hotspot Manager.
These applications are built using the services
provided by the lower layers.
API Symmetry
Because amigopod VMA applications are built using the framework supplied
by the presentation layer, there is a direct symmetry between application
features provided to operators using a web browser (HTML presentation), and
application features provided to external applications using the XMLRPC
presentation.
In particular, the following items are shared between HTML and XMLRPC
presentations:
°
Access control
°
Parameter names
°
Parameter validation rules
°
Customized fields and their rules
Access Control
Page privileges are applied to XMLRPC authenticated sessions in the same
way as the HTML user interface.
However, XMLRPC access also requires
the XMLRPC API privilege to be granted.
Parameter Names
The parameter names passed to the XMLRPC interface are the same as the
field names in the HTML user interface.
Parameter Validation
Each field of the forms in the HTML user interface is subject to validation
according to the rules defined for that field.
The same rules also apply to
XMLRPC parameters.
If a required field is missing, or an invalid value for a field is supplied, an error
is generated by the presentation layer and returned to the XMLRPC client.
Field Customization
Some forms in the HTML user interface are customizable. New fields may be
defined (for example, stored with a guest account) and used as part of the
form in the presentation layer.
Policy-based processing of fields includes
form validation, data conversion and input formatting, and user interface
metadata (for example, the list of valid options for a multiple-choice
“dropdown” control).