This is the cl-fluidinfo Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 15:12:46 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
cl-fluidinfoLibrary to access the Fluidinfo database / storage and search platform
BSD 2-clause license - http://www.opensource.org/licenses/BSD-2-Clause
0.1
cl-fluiddb (system).
fluidinfo-defpackage.lisp (file).
cl-fluiddbLibrary to access the Fluidinfo database / storage and search platform
BSD 2-clause license - http://www.opensource.org/licenses/BSD-2-Clause
0.1
cl-json (system).
drakma (system).
flexi-streams (system).
bordeaux-threads (system).
split-sequence (system).
defpackage.lisp (file).
fluiddb.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-fluidinfo/cl-fluidinfo.asdcl-fluiddb/cl-fluiddb.asdcl-fluidinfo/fluidinfo-defpackage.lispcl-fluiddb/defpackage.lispcl-fluiddb/fluiddb.lispcl-fluiddb/cl-fluiddb.asdcl-fluiddb (system).
*cl-fluiddb-version* (special variable).
cl-fluidinfo/fluidinfo-defpackage.lispcl-fluidinfo (system).
cl-fluiddb/fluiddb.lispdefpackage.lisp (file).
cl-fluiddb (system).
*call-timeout* (special variable).
*credentials* (special variable).
*proxy-credentials* (special variable).
*proxy-server* (special variable).
*use-https* (special variable).
*user-agent* (special variable).
change-namespace (function).
change-tag (function).
create-namespace (function).
create-object (function).
create-tag (function).
delete-namespace (function).
delete-object-about-tag-value (function).
delete-object-tag-value (function).
delete-objects-tag-values (function).
delete-tag (function).
encode-json (method).
error-body (reader method).
(setf error-body) (writer method).
error-class (reader method).
(setf error-class) (writer method).
get-namespace (function).
get-namespace-permissions (function).
get-object (function).
get-object-about (function).
get-object-about-tag-value (function).
get-object-tag-value (function).
get-policy (function).
get-tag (function).
get-tag-permissions (function).
get-tag-value-permissions (function).
get-user (function).
object-about-tag-has-value-p (function).
object-tag-has-value-p (function).
query-objects (function).
query-objects-tag-values (function).
request-id (reader method).
(setf request-id) (writer method).
set-namespace-permissions (function).
set-object-about-tag-value (function).
set-object-tag-value (function).
set-objects-tag-values (function).
set-policy (function).
set-tag-permissions (function).
set-tag-value-permissions (function).
status-code (reader method).
(setf status-code) (writer method).
status-message (reader method).
(setf status-message) (writer method).
url-format-namespace-or-tag (generic function).
with-credentials (macro).
*connection* (special variable).
*server-url* (special variable).
*using-sandbox* (special variable).
call-error (condition).
copy-json-alist (function).
do-send-request (function).
json-alist (structure).
json-alist-p (function).
json-alist-values (reader).
(setf json-alist-values) (writer).
make-json-alist (function).
make-permission-object (function).
send-request (function).
throw-call-error (function).
to-boolean (function).
to-string (function).
url-encode (function).
Packages are listed by definition order.
cl-fluiddbcommon-lisp.
*call-timeout* (special variable).
*credentials* (special variable).
*proxy-credentials* (special variable).
*proxy-server* (special variable).
*use-https* (special variable).
*user-agent* (special variable).
change-namespace (function).
change-tag (function).
create-namespace (function).
create-object (function).
create-tag (function).
delete-namespace (function).
delete-object-about-tag-value (function).
delete-object-tag-value (function).
delete-objects-tag-values (function).
delete-tag (function).
error-body (generic reader).
(setf error-body) (generic writer).
error-class (generic reader).
(setf error-class) (generic writer).
get-namespace (function).
get-namespace-permissions (function).
get-object (function).
get-object-about (function).
get-object-about-tag-value (function).
get-object-tag-value (function).
get-policy (function).
get-tag (function).
get-tag-permissions (function).
get-tag-value-permissions (function).
get-user (function).
object-about-tag-has-value-p (function).
object-tag-has-value-p (function).
query-objects (function).
query-objects-tag-values (function).
request-id (generic reader).
(setf request-id) (generic writer).
set-namespace-permissions (function).
set-object-about-tag-value (function).
set-object-tag-value (function).
set-objects-tag-values (function).
set-policy (function).
set-tag-permissions (function).
set-tag-value-permissions (function).
status-code (generic reader).
(setf status-code) (generic writer).
status-message (generic reader).
(setf status-message) (generic writer).
url-format-namespace-or-tag (generic function).
with-credentials (macro).
*connection* (special variable).
*server-url* (special variable).
*using-sandbox* (special variable).
call-error (condition).
copy-json-alist (function).
do-send-request (function).
json-alist (structure).
json-alist-p (function).
json-alist-values (reader).
(setf json-alist-values) (writer).
make-json-alist (function).
make-permission-object (function).
send-request (function).
throw-call-error (function).
to-boolean (function).
to-string (function).
url-encode (function).
cl-fluiddb-asdasdf/interface.
common-lisp.
*cl-fluiddb-version* (special variable).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Timeout (in seconds) to use for any call to the FluidDB server.
If a timeout happens, a bordeaux-threads:timeout condition will be raised.
A value of nil means not to use any timeout.
User credentidals to be used for a request.
Should be either nil (anonymous access) or a list of two strings (username password)
Credentials to be used to authenticate against the proxy configured via *proxy-server*
Information about the proxy server to use for requests.
Should be either nil (direct access), a string (the server to use),
or a list of two values (server port)
Flag whether to use HTTPS or just HTTP
The string to be used as your user agent when making request.
This might allow FluidInfo to better monitor what app is using their service
Perform body with the passed fluiddb credentials in place
Change the description of the given namespace
Change the description of the given tag
Create a new sub-namespace within the passed namespace
Create a new object (anonymous if no about is specified)
Create a new tag withing the given namespace
Delete the given namespace
Delete the specified tag value on the object with the given about tag
Delete the specified tag value on the object with the given id
Perform a query and delete the specified tag values on the matching objects
Delete the given tag
Retrieve information about the given namespace
Retrieve the permission information for the given namespace and action. Action can be one of create, update, delete, list, control.
Retrieve an object by its id
Retrieve an object by its about tag
Retrieve the object’s tag value for the object with the given about tag
Retrieve the object’s tag value for the object with the given id
Retrieve the user’s default policy for the given category and action.
Possible values for categorie/actions are:
- namespaces: create, update, delete, and list.
- tags: update and delete.
- tag-values: create, read, and delete.
Retrieve information about the given tag
Retrieve the permission information for the given tag and action. Action can be one of update, delete, control.
Retrieve the permission information for the given tag value and action. Action can be one of create, read, delete, control.
Retrieve information about the user with the given name
Check if the object with the given about tag has the specified tag value set. Returns nil or the mime type of the value.
Check if the object with the given id has the specified tag value set. Returns nil or the mime type of the value.
Perform a query for all object matching
Perform a query and retrieve all objects matching plus the specified tag values on them
Set the permission information for the given namespace and action. Action can be one of create, update, delete, list, control. Policy can be either open or closed.
Set the specified tag value on the object with the given about tag. Content is either presumed to be pre-formatted (if content-type is given) or will be JSON encoded and passed a fluiddb primitive type.
Set the specified tag value on the object with the given id.
Content is either presumed to be pre-formatted (if content-type is given)
or will be JSON encoded and passed as a fluiddb primitive type.
Perform a query and set the specified tag values on the matching objects
Set the user’s default policy for the given category and action.
Possible values for categorie/actions are:
- namespaces: create, update, delete, and list.
- tags: update and delete.
- tag-values: create, read, and delete.
Policy can be either open or closed.
Set the permission information for the given tag and action.
Action can be one of update, delete, control.
Policy can be either open or closed.
Set the permission information for the given tag value and action.
Action can be one of create, read, delete, control.
Policy can be either open or closed.
call-error)) ¶call-error)) ¶call-error)) ¶call-error)) ¶call-error)) ¶call-error)) ¶call-error)) ¶call-error)) ¶call-error)) ¶call-error)) ¶Helper function to convert some object into a (url-escaped) string ready to be used as part of the path in the request URL
json-alist) &optional stream) ¶json.
A string denoting the current version of this package. Used for diagnostic output.
A store for any existing connection to the server that can be re-used
Base URL (without the http:// or https:// protocol bit) for the server to call
Lower-level routine to send a request to FluidDB.
Set accept to the content-type you want ("*/*" if you don’t know).
This does not interpret the results and just returns the HTTP response. It may still throw errors on network problems, timeouts etc.
Return a JSON encoded string representing the passed permission. Policy should be either open or closed.
Send a request to FluidDB.
Set accept to the content-type you want ("*/*" if you don’t know).
We inspect the return data and convert it to a lisp data structure if it is json
Convert a lisp value to something the JSON encode will convert to true or false
Do sensible conversion to a string
URL encode a string so it’s safe to include in an URL
error.
:status-code
:status-message
:error-class
:request-id
:error-body
| Jump to: | (
C D E F G J M O Q R S T U W |
|---|
| Jump to: | (
C D E F G J M O Q R S T U W |
|---|
| Jump to: | *
E R S V |
|---|
| Jump to: | *
E R S V |
|---|
| Jump to: | C D F J P S |
|---|
| Jump to: | C D F J P S |
|---|