You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by sm...@apache.org on 2022/07/25 17:18:40 UTC
[directory-site] branch master updated: Change the descriptions
This is an automated email from the ASF dual-hosted git repository.
smckinney pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/directory-site.git
The following commit(s) were added to refs/heads/master by this push:
new 1ec2da45 Change the descriptions
1ec2da45 is described below
commit 1ec2da451a0c6466311c82886c19509aed41cdaf
Author: Shawn McKinney <sm...@symas.com>
AuthorDate: Mon Jul 25 12:18:33 2022 -0500
Change the descriptions
---
source/fortress/exception-handling.md | 55 ++++++++++++++++++-----------------
1 file changed, 28 insertions(+), 27 deletions(-)
diff --git a/source/fortress/exception-handling.md b/source/fortress/exception-handling.md
index 81b22559..eb706824 100644
--- a/source/fortress/exception-handling.md
+++ b/source/fortress/exception-handling.md
@@ -4,10 +4,10 @@ title: Exception Handing
# Fortress Exception Handling
-Fortress communicates errors to the user through checked exceptions. At the highest level, is the [SecurityException](https://directory.apache.org/fortress/gen-docs/latest/apidocs/org/apache/directory/fortress/core/SecurityException.html)
+Fortress communicates errors to the caller via checked exceptions. At the highest level is the [SecurityException](https://directory.apache.org/fortress/gen-docs/latest/apidocs/org/apache/directory/fortress/core/SecurityException.html).
-The SecurityException is declared to be thrown by all APIs within Fortress Manager interfaces.
-The original exception thrown may be of this type or one of its extensions
+It is declared to be thrown by all APIs within the Fortress Manager interfaces.
+The original exception thrown may be of this type or one of its extensions:
* [AuthorizationException](https://directory.apache.org/fortress/gen-docs/latest/apidocs/org/apache/directory/fortress/core/AuthorizationException.html) in the event user fails administrative permission check.
* [CfgException](https://directory.apache.org/fortress/gen-docs/latest/apidocs/org/apache/directory/fortress/core/CfgException.html) in the event the runtime cfg system fails.
* [CreateException](https://directory.apache.org/fortress/gen-docs/latest/apidocs/org/apache/directory/fortress/core/CreateException.html) in the event DAO cannot create entity.
@@ -18,9 +18,10 @@ The original exception thrown may be of this type or one of its extensions
* [UpdateException](https://directory.apache.org/fortress/gen-docs/latest/apidocs/org/apache/directory/fortress/core/UpdateException.html) in the event DAO cannot update entity.
* [ValidationException](https://directory.apache.org/fortress/gen-docs/latest/apidocs/org/apache/directory/fortress/core/ValidationException.html) in the event entity validation fails.
-For certain methods like AccessMgr.createSession, or AccessMgr.authenticate, the caller may need to differentiate by one of the above subclasses, e.g. PasswordException, to facilitate password expiring condition or allow user to retry authentication after entering it incorrectly. If specific exception processing is not the aim, or if differentiating conditions by SecurityException#errorId is acceptable, callers are allowed to catch (or throw) as type SecurityException.
+For some methods, e.g. AccessMgr.createSession, AccessMgr.authenticate, the caller may need to differentiate by one of the above subclasses, e.g. PasswordException, to facilitate password expiring condition or allow user to retry authentication after entering it incorrectly.
+If specific exception processing is not required and differentiating conditions by SecurityException#errorId is acceptable, callers are allowed to catch (or throw) as type SecurityException.
-All exceptions generated by Fortress will be set with error code BaseException.getErrorId() indicating fault condition which is set via its constructor. The error codes are declared in [GlobalErrIds](https://directory.apache.org/fortress/gen-docs/latest/apidocs/org/apache/directory/fortress/core/GlobalErrIds.html) and are also listed below:
+All exceptions generated by Fortress will be set as an error code. These codes are declared in [GlobalErrIds](https://directory.apache.org/fortress/gen-docs/latest/apidocs/org/apache/directory/fortress/core/GlobalErrIds.html) and are also listed below:
| Error Code | Tag name | Meaning |
|------------|-----------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|
@@ -29,19 +30,19 @@ All exceptions generated by Fortress will be set with error code BaseException.g
| 104 | FT_MGR_INST_EXCEPTION | The reflection API could not create the Manager instance due to instantiation exception. |
| 105 | FT_MGR_ILLEGAL_ACCESS | The reflection API could not create the Manager instance due to illegal access exception. |
| 106 | FT_MGR_CLASS_NAME_NULL | The Manager impl class name was not found in the cfg. |
-| 107 | FT_CONFIG_NOT_FOUND | The remote cfg instance could not be found on the ldap server. |
+| 107 | FT_CONFIG_NOT_FOUND | The remote cfg instance could not be found on the server. |
| 108 | FT_CONFIG_NAME_NULL | The cfg node name was not found in cfg file. |
| 109 | FT_CONFIG_NAME_INVLD | The name specified for config instance is too long. |
| 110 | FT_CONFIG_PROPS_NULL | The config API was called with an empty properties list. |
| 111 | FT_CONFIG_NULL | The cfg object is required but was passed in null. |
-| 120 | FT_CONFIG_CREATE_FAILED | The config node could not be created on ldap server. |
-| 121 | FT_CONFIG_UPDATE_FAILED | The config node could not be updated on ldap server. |
-| 122 | FT_CONFIG_DELETE_FAILED | The config node could not be removed from ldap. |
-| 123 | FT_CONFIG_DELETE_PROPS_FAILED | The config parameters could not be removed from ldap. |
-| 124 | FT_CONFIG_READ_FAILED | The config node could not be read from ldap. |
+| 120 | FT_CONFIG_CREATE_FAILED | The config node could not be created on server. |
+| 121 | FT_CONFIG_UPDATE_FAILED | The config node could not be updated on server. |
+| 122 | FT_CONFIG_DELETE_FAILED | The config node could not be removed from server. |
+| 123 | FT_CONFIG_DELETE_PROPS_FAILED | The config parameters could not be removed from server. |
+| 124 | FT_CONFIG_READ_FAILED | The config node could not be read from server. |
| 125 | FT_CONFIG_ALREADY_EXISTS | The config node could not be created because it already exists. |
-| 126 | FT_CONFIG_BOOTSTRAP_FAILED | The config node could not be read from ldap. |
-| 127 | FT_CONFIG_INITIALIZE_FAILED | The config node could not be read from ldap. |
+| 126 | FT_CONFIG_BOOTSTRAP_FAILED | The config node could not be read from server. |
+| 127 | FT_CONFIG_INITIALIZE_FAILED | The config node could not be read from server. |
| 128 | FT_RESOURCE_NOT_FOUND | The resource could not be located on the runtime classloader path. |
| 129 | FT_CACHE_NOT_CONFIGURED | The cache is not configured. |
| 130 | FT_CACHE_GET_ERR | The cache get operation failed. |
@@ -51,21 +52,21 @@ All exceptions generated by Fortress will be set with error code BaseException.g
| 134 | FT_NULL_CACHE | The cache is null. |
| 135 | FT_APACHE_LDAP_POOL_INIT_FAILED | Could not initialize Apache LDAP Connection Pool. |
| 136 | FT_CONFIG_JSSE_TRUSTSTORE_NULL | Cannot load JSSE TrustStore because the full-qualified input file name is null. |
-| 1000 | USER_SEARCH_FAILED | The User node could not be searched in ldap. |
-| 1001 | USER_READ_FAILED | The User node could not be read from ldap. |
-| 1002 | USER_ADD_FAILED | The User node could not be added to ldap. |
-| 1003 | USER_UPDATE_FAILED | The User node could not be updated in ldap. |
-| 1004 | USER_DELETE_FAILED | The User node could not be deleted from ldap. |
-| 1005 | USER_NOT_FOUND | The User node was not found in ldap. |
+| 1000 | USER_SEARCH_FAILED | The User node could not be searched on server. |
+| 1001 | USER_READ_FAILED | The User node could not be read from server. |
+| 1002 | USER_ADD_FAILED | The User node could not be added to server. |
+| 1003 | USER_UPDATE_FAILED | The User node could not be updated on server. |
+| 1004 | USER_DELETE_FAILED | The User node could not be deleted from server. |
+| 1005 | USER_NOT_FOUND | The User node was not found on server. |
| 1006 | USER_ID_NULL | The supplied userId was null and is required for this operation. |
-| 1007 | USER_ID_DUPLICATE | The User could not be added because it already exists in ldap. |
+| 1007 | USER_ID_DUPLICATE | The User could not be added because it already exists. |
| 1008 | USER_NULL | The operation failed because the supplied User entity is null and is required. |
| 1009 | USER_PW_NULL | The operation failed because the supplied User's password is required but was found to be null. |
| 1010 | USER_PW_INVLD_LEN | The operation failed because the supplied User password is too long. Ensure the length does not exceed Ensure the length does not exceed GlobalIds#PASSWORD_LEN. |
| 1011 | USER_PLCY_VIOLATION | The operation failed because of policy violation due to being designated a 'system' user. |
-| 1012 | USER_PW_PLCY_DEL_FAILED | The PW Policy node could not be removed from ldap. |
+| 1012 | USER_PW_PLCY_DEL_FAILED | The PW Policy node could not be removed from server. |
| 1013 | USER_PW_INVLD | The supplied User password was invalid. |
-| 1014 | USER_PW_CHK_FAILED | The User password check failed in ldap. |
+| 1014 | USER_PW_CHK_FAILED | The User password check failed on server. |
| 1015 | USER_PW_RESET | The User's password is in reset state which requires change. |
| 1016 | USER_PW_LOCKED | Authentication failed because User's password has been locked on the server. |
| 1017 | USER_PW_EXPIRED | Authentication failed because User's password is expired on the server. |
@@ -89,7 +90,7 @@ All exceptions generated by Fortress will be set with error code BaseException.g
| 1035 | USER_OU_INVALID | The User ou name supplied for User was not found on server. |
| 1036 | SESS_CTXT_NULL | The required User Session was not supplied and is required. Used by fortress realm. |
| 1037 | USER_BIND_FAILED | The User bind operation failed on server. |
-| 1038 | USER_ADD_FAILED_ALREADY_EXISTS | The User node could not be added to ldap. |
+| 1038 | USER_ADD_FAILED_ALREADY_EXISTS | The User node could not be added to server. |
| 1039 | USER_ADMIN_CANNOT_ADD | The Admin is not authorized to add the User. |
| 1040 | USER_ADMIN_CANNOT_CHANGE | The Admin is not authorized to edit the User. |
| 1041 | USER_OU_NULL | The User ou name was not supplied and is required. |
@@ -124,7 +125,7 @@ All exceptions generated by Fortress will be set with error code BaseException.g
| 3004 | PERM_UPDATE_FAILED | The supplied Permission could not be updated on server. |
| 3005 | PERM_DELETE_FAILED | The supplied Permission could not be removed from server. |
| 3006 | PERM_OP_NOT_FOUND | The supplied Permission operation could not be found on server. |
-| 3007 | PERM_OBJ_NOT_FOUND | The supplied Permission object could not be found on ldap server. |
+| 3007 | PERM_OBJ_NOT_FOUND | The supplied Permission object could not be found on server. |
| 3008 | PERM_NULL | The supplied Permission entity is required but was passed as null. |
| 3009 | PERM_OPERATION_NULL | The supplied Permission operation is required but was passed as null. |
| 3010 | PERM_OBJECT_NULL | The supplied Permission object is required but was passed as null. |
@@ -262,7 +263,7 @@ All exceptions generated by Fortress will be set with error code BaseException.g
| 8018 | ORG_NULL_USER | The supplied User OU is required and cannot be null. |
| 8019 | ORG_TYPE_NULL_USER | The supplied User OU type is required and cannot be null. |
| 8020 | ORG_DEL_FAILED_USER | The supplied User OU entry could not be removed from the server. |
-| 8021 | ORG_REMOVE_PARENT_FAILED_USER | The supplied Perm OU entity parent attribute could not be updated due to ldap error. |
+| 8021 | ORG_REMOVE_PARENT_FAILED_USER | The supplied Perm OU entity parent attribute could not be updated due to error on server. |
| 8061 | ORG_READ_FAILED_PERM | The supplied Perm OU entity could not be read due to error on server. |
| 8062 | ORG_ADD_FAILED_PERM | The supplied Perm OU entity could not be added due to error on server. |
| 8063 | ORG_UPDATE_FAILED_PERM | The supplied Perm OU entity could not be updated due to error on server. |
@@ -305,7 +306,7 @@ All exceptions generated by Fortress will be set with error code BaseException.g
| 9025 | ARLE_DEASSIGN_FAILED | The User Admin Role deassignment failed. |
| 9026 | ARLE_OCCUPANT_SEARCH_FAILED | AdminRole occupant search failed. |
| 9027 | ARLE_REMOVE_OCCUPANT_FAILED | The operation to remove User as occupant to AdminRoles failed. |
-| 9028 | ARLE_REMOVE_PARENT_FAILED | The supplied Administrative Role parent attribute could not be removed on ldap server. |
+| 9028 | ARLE_REMOVE_PARENT_FAILED | The supplied Administrative Role parent attribute could not be removed on server. |
| 9029 | ARLE_END_RANGE_NULL | The supplied end range for Administrative Role is required and cannot be null. |
| 10001 | CONST_INVLD_TEXT | The constraint contains invalid text. |
| 10002 | CONST_INVLD_FIELD_LEN | The Constraint value failed length check. |
@@ -360,4 +361,4 @@ All exceptions generated by Fortress will be set with error code BaseException.g
| 10402 | RCON_NOT_FOUND | The RoleConstraint entity was not found. |
| 10501 | ENTITY_PROP_NOT_SUPPORTED | The entity does not support properties. |
| 10502 | ENTITY_PROPS_NOT_FOUND | The entity was not found. |
-| 10503 | ENTITY_PROPS_LOAD_FAILED | The entity was not found |
+| 10503 | ENTITY_PROPS_LOAD_FAILED | The entity was not found. |