diff options
| -rw-r--r-- | docs/design-api | 67 |
1 files changed, 4 insertions, 63 deletions
diff --git a/docs/design-api b/docs/design-api index 7657b27..e51c677 100644 --- a/docs/design-api +++ b/docs/design-api @@ -9,9 +9,10 @@ Introduction object type (which amounts mostly to storage and retrieval), and the ACL implementation. - Also see the documentation for Wallet::Object and Wallet::ACL::Base, - which contain some additional information about creating new object - and ACL verifier implementations. + See the documentation for Wallet::Object::Base and Wallet::ACL::Base, + which contain additional information about creating new object and + ACL verifier implementations and the documentation for all generic + methods. Object API @@ -83,66 +84,6 @@ Object API Returns the error text from the last failed call. -ACL API - - new(ACL, DBH) - - Instantiate a new ACL object with the given ACL ID or name. Takes the - database handle to use for retrieving metadata. Returns a new ACL - object if the ACL was found or undef if it wasn't. - - create(NAME, DBH, PRINCIPAL, HOSTNAME [, DATETIME]) - - Similar to new() but instead creates a new ACL record in the database - with the given NAME (and with no lines). Returns the new object on - success and undef on failure. - - add(SCHEME, INSTANCE, PRINCIPAL, HOSTNAME [, DATETIME]) - - Add the given ACL line (given by SCHEME and INSTANCE) to this ACL. - Returns true on success and false on failure. On failure, the caller - should call error() to get the error message. - - remove(SCHEME, INSTANCE, PRINCIPAL, HOSTNAME [, DATETIME]) - - Remove the given ACL line (given by SCHEME and INSTANCE) from this - ACL. Returns true on success and false on failure. On failure, the - caller should call error() to get the error message. - - rename(NAME) - - Rename this ACL. This changes the name used for human convenience but - not the system-generated ACL ID that is used to reference this ACL. - Returns true on success and false on failure. On failure, the caller - should call error() to get the error message. - - destroy(PRINCIPAL, HOSTNAME [, DATETIME]) - - Destroys this ACL from the database. Note that this will fail due to - integrity constraint errors if the ACL is still referenced by any - object. Returns ture on success and false on failure. On failure, - the caller should call error() to get the error message. - - check(PRINCIPAL) - - Checks whether the given PRINCIPAL should be allowed access given ACL. - Returns 1 if access was granted, 0 if access is declined, and undef on - error. On error, the caller should call error() to get the error text - but generally should continue with checking other ACLs. Any errors - found by the individual ACL verifiers can be retrieved by calling - check_errors(). Errors from individual ACL verifiers will not result - in an error return from check(). - - check_errors() - - Return (as a list in array context and a string with newlines between - errors and at the end of the last error in scalar context) the errors, - if any, returned by ACL verifiers for the last check operation. - - error() - - Returns the error text of the last error. - ACL Verifier API new() |