docs/sections/logging.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3
   4 Logging
   5 =======
   6
   7 .. note::
   8    * This section is used to describe the informational or diagnostic messages emitted from
   9      a software component and the methods or collecting them.
  10
  11    * This section is typically: provided for a platform-component and sdk; and
  12      referenced in developer and user guides
  13
  14    * This note must be removed after content has been added.
  15
  16
  17 Where to Access Information
  18 ---------------------------
  19 AAF uses log4j framework to generate logs and all the logs are stored in a persistent volume.
  20
  21 Error / Warning Messages
  22 ------------------------
  23 Following are the error codes
  24
  25 | Create a Permission - Expected=201, Explicit=403, 404, 406, 409
  26 | Set Description for Permission - Expected=200, Explicit=404, 406
  27 | Delete a Permission Expected=200, Explicit=404, 406
  28 | Update a Permission - Expected=200, Explicit==04, 406, 409
  29 | Get Permissions by Type - Expected=200, Explicit=404, 406
  30 | Get Permissions by Key - Expected=200, Explicit=404, 406
  31 | Get PermsByNS - Expected=200, Explicit==404, 406
  32 | Get Permissions by Role - Expected=200, Explicit=404, 406
  33 | Get Permissions by User, Query AAF Perms - Expected=200, Explicit=404, 406
  34 | Get Permissions by User - Expected=200, Explicit=404, 406
  35 | Create Role - Expected=201, Explicit=403, 404, 406, 409
  36 | Set Description for role= - Expected=200, Explicit=404, 406
  37 | Delete Role - Expected=200, Explicit==404, 406
  38 | Delete Permission from Role - Expected=200, Explicit=404, 406
  39 | Add Permission to Role - Expected=201, Explicit=403, 404, 406, 409
  40 | Set a Permission's Roles - Expected=201, Explicit=403, 404, 406, 409
  41 | GetRolesByFullName - Expected=200, Explicit=404, 406
  42 | GetRolesByNameOnly - Expected=200, Explicit=404, 406
  43 | GetRolesByNS - Expected=200, Explicit=404, 406
  44 | GetRolesByPerm - Expected=200, Explicit=404, 406
  45 | GetRolesByUser - Expected=200, Explicit=404, 406
  46 | Request User Role Access - Expected=201, Explicit=403, 404, 406, 409
  47 | Get if User is In Role - Expected=200, Explicit=403, 404, 406
  48 | Delete User Role - Expected=200, Explicit=403, 404, 406
  49 | Update Users for a role - Expected=200, Explicit=403, 404, 406
  50 | Update Roles for a user - Expected=200, Explicit=403, 404, 406
  51 | Get UserRoles by Role - Expected=200, Explicit=404, 406
  52 | Get UserRoles by User - Expected=200, Explicit=404, 406
  53 | Create a Namespace - Expected=201, Explicit=403, 404, 406, 409
  54 | Set a Description for a Namespace - Expected=200, Explicit=403, 404, 406
  55 | Delete a Namespace - Expected=200, Explicit=403, 404, 424
  56 | Add an Admin to a Namespace - Expected=201, Explicit=403, 404, 406, 409
  57 | Remove an Admin from a Namespace - Expected=200, Explicit=403, 404
  58 | Delete an Attribute from a Namespace - Expected=200, Explicit=403, 404
  59 | Add an Attribute from a Namespace - Expected=201, Explicit=403, 404, 406, 409
  60 | update an Attribute from a Namespace - Expected=200, Explicit=403, 404
  61 | Add a Responsible Identity to a Namespace - Expected=201, Explicit=403, 404, 406, 409
  62 | Remove a Responsible Identity from Namespace - Expected=200, Explicit=403, 404
  63 | get Ns Key List From Attribute - Expected=200, Explicit=403, 404
  64 | Return Information about Namespaces - Expected=200, Explicit=404, 406
  65 | Return Child Namespaces - Expected=200, Explicit=403, 404
  66 | Get Users By Permission - Expected=200, Explicit=404, 406
  67 | Get Users By Role - Expected=200, Explicit=403, 404, 406
  68 | Is given BasicAuth valid? - Expected=200, Explicit=403
  69 | Is given Credential valid? - Expected=200, Explicit=403
  70