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