The lichat-ldap Reference Manual

This is the lichat-ldap Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 16:53:37 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

The main system appears first, followed by any subsystem dependency.


2.1 lichat-ldap

LDAP backend for the Lichat server profiles.

Maintainer

Yukari Hafner <>

Author

Yukari Hafner <>

Home Page

https://github.com/Shirakumo/lichat-ldap

License

zlib

Version

1.0.0

Dependencies
  • lichat-serverlib (system).
  • trivial-ldap (system).
  • documentation-utils (system).
Source

lichat-ldap.asd.

Child Components

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


3.1 Lisp


3.1.1 lichat-ldap/lichat-ldap.asd

Source

lichat-ldap.asd.

Parent Component

lichat-ldap (system).

ASDF Systems

lichat-ldap.


3.1.2 lichat-ldap/package.lisp

Source

lichat-ldap.asd.

Parent Component

lichat-ldap (system).

Packages

lichat-ldap.


3.1.3 lichat-ldap/ldap.lisp

Dependency

package.lisp (file).

Source

lichat-ldap.asd.

Parent Component

lichat-ldap (system).

Public Interface
Internals

3.1.4 lichat-ldap/documentation.lisp

Dependency

ldap.lisp (file).

Source

lichat-ldap.asd.

Parent Component

lichat-ldap (system).


4 Packages

Packages are listed by definition order.


4.1 lichat-ldap

Source

package.lisp.

Nickname

org.shirakumo.lichat.ldap

Use List

common-lisp.

Public Interface
Internals

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


5.1 Public Interface


5.1.1 Generic functions

Generic Reader: bind-dn (object)
Package

lichat-ldap.

Methods
Reader Method: bind-dn ((profile profile))

automatically generated reader method

Source

ldap.lisp.

Target Slot

bind-dn.

Reader Method: bind-dn ((server server))

automatically generated reader method

Source

ldap.lisp.

Target Slot

bind-dn.

Generic Writer: (setf bind-dn) (object)
Package

lichat-ldap.

Methods
Writer Method: (setf bind-dn) ((server server))

automatically generated writer method

Source

ldap.lisp.

Target Slot

bind-dn.

Generic Reader: bind-pw (object)
Package

lichat-ldap.

Methods
Reader Method: bind-pw ((server server))

automatically generated reader method

Source

ldap.lisp.

Target Slot

bind-pw.

Generic Writer: (setf bind-pw) (object)
Package

lichat-ldap.

Methods
Writer Method: (setf bind-pw) ((server server))

automatically generated writer method

Source

ldap.lisp.

Target Slot

bind-pw.

Generic Reader: error-message (condition)
Package

lichat-ldap.

Methods
Reader Method: error-message ((condition bind-error))
Source

ldap.lisp.

Target Slot

error-message.

Generic Reader: error-type (condition)
Package

lichat-ldap.

Methods
Reader Method: error-type ((condition bind-error))
Source

ldap.lisp.

Target Slot

error-type.

Generic Reader: ldap-host (object)
Package

lichat-ldap.

Methods
Reader Method: ldap-host ((server server))

automatically generated reader method

Source

ldap.lisp.

Target Slot

ldap-host.

Generic Writer: (setf ldap-host) (object)
Package

lichat-ldap.

Methods
Writer Method: (setf ldap-host) ((server server))

automatically generated writer method

Source

ldap.lisp.

Target Slot

ldap-host.

Generic Reader: ldap-port (object)
Package

lichat-ldap.

Methods
Reader Method: ldap-port ((server server))

automatically generated reader method

Source

ldap.lisp.

Target Slot

ldap-port.

Generic Writer: (setf ldap-port) (object)
Package

lichat-ldap.

Methods
Writer Method: (setf ldap-port) ((server server))

automatically generated writer method

Source

ldap.lisp.

Target Slot

ldap-port.

Generic Reader: ldap-ssl (object)
Package

lichat-ldap.

Methods
Reader Method: ldap-ssl ((server server))

automatically generated reader method

Source

ldap.lisp.

Target Slot

ldap-ssl.

Generic Writer: (setf ldap-ssl) (object)
Package

lichat-ldap.

Methods
Writer Method: (setf ldap-ssl) ((server server))

automatically generated writer method

Source

ldap.lisp.

Target Slot

ldap-ssl.

Generic Reader: profile-attr (object)
Package

lichat-ldap.

Methods
Reader Method: profile-attr ((server server))

automatically generated reader method

Source

ldap.lisp.

Target Slot

profile-attr.

Generic Writer: (setf profile-attr) (object)
Package

lichat-ldap.

Methods
Writer Method: (setf profile-attr) ((server server))

automatically generated writer method

Source

ldap.lisp.

Target Slot

profile-attr.

Generic Reader: profile-base (object)
Package

lichat-ldap.

Methods
Reader Method: profile-base ((server server))

automatically generated reader method

Source

ldap.lisp.

Target Slot

profile-base.

Generic Writer: (setf profile-base) (object)
Package

lichat-ldap.

Methods
Writer Method: (setf profile-base) ((server server))

automatically generated writer method

Source

ldap.lisp.

Target Slot

profile-base.

Generic Reader: profile-query (object)
Package

lichat-ldap.

Methods
Reader Method: profile-query ((server server))

automatically generated reader method

Source

ldap.lisp.

Target Slot

profile-query.

Generic Writer: (setf profile-query) (object)
Package

lichat-ldap.

Methods
Writer Method: (setf profile-query) ((server server))

automatically generated writer method

Source

ldap.lisp.

Target Slot

profile-query.

Generic Reader: server (object)
Package

lichat-ldap.

Methods
Reader Method: server ((profile profile))

automatically generated reader method

Source

ldap.lisp.

Target Slot

server.


5.1.2 Standalone methods

Method: find-profile ((name string) (server server))
Package

lichat-serverlib.

Source

ldap.lisp.

Method: list-profiles ((server server))
Package

lichat-serverlib.

Source

ldap.lisp.

Method: make-profile ((server server) &key)
Package

lichat-serverlib.

Source

ldap.lisp.

Method: (setf password) ((profile profile))
Package

lichat-serverlib.

Source

ldap.lisp.

Method: password-valid-p ((profile profile) password)
Package

lichat-serverlib.

Source

ldap.lisp.

Method: print-object ((bind-error bind-error) stream)
Source

ldap.lisp.

Method: remove-profile (name (server server))
Package

lichat-serverlib.

Source

ldap.lisp.


5.1.3 Conditions

Condition: bind-error
Package

lichat-ldap.

Source

ldap.lisp.

Direct superclasses

error.

Direct methods
Direct slots
Slot: error-type
Initargs

:error-type

Readers

error-type.

Writers

This slot is read-only.

Slot: error-message
Initargs

:error-message

Readers

error-message.

Writers

This slot is read-only.


5.1.4 Classes

Class: profile
Package

lichat-ldap.

Source

ldap.lisp.

Direct superclasses

profile.

Direct methods
Direct Default Initargs
InitargValue
:timeoutnil
Direct slots
Slot: server
Initargs

:server

Readers

server.

Writers

This slot is read-only.

Slot: bind-dn
Initargs

:bind-dn

Readers

bind-dn.

Writers

This slot is read-only.

Class: server
Package

lichat-ldap.

Source

ldap.lisp.

Direct superclasses

server.

Direct methods
Direct Default Initargs
InitargValue
:ldap-hostlocalhost
:ldap-port389
:ldap-sslnil
:bind-dnnil
:bind-pwnil
:profile-basenil
:profile-query(quote (= cn name))
:profile-attrcn
Direct slots
Slot: ldap-host
Initargs

:ldap-host

Readers

ldap-host.

Writers

(setf ldap-host).

Slot: ldap-port
Initargs

:ldap-port

Readers

ldap-port.

Writers

(setf ldap-port).

Slot: ldap-ssl
Initargs

:ldap-ssl

Readers

ldap-ssl.

Writers

(setf ldap-ssl).

Slot: bind-dn
Initargs

:bind-dn

Readers

bind-dn.

Writers

(setf bind-dn).

Slot: bind-pw
Initargs

:bind-pw

Readers

bind-pw.

Writers

(setf bind-pw).

Slot: profile-base
Initargs

:profile-base

Readers

profile-base.

Writers

(setf profile-base).

Slot: profile-query
Initargs

:profile-query

Readers

profile-query.

Writers

(setf profile-query).

Slot: profile-attr
Initargs

:profile-attr

Readers

profile-attr.

Writers

(setf profile-attr).


5.2 Internals


5.2.1 Macros

Macro: with-ldap ((ldap object &key host port sslflag user pass) &body body)
Package

lichat-ldap.

Source

ldap.lisp.


5.2.2 Ordinary functions

Function: replace-username (query name)
Package

lichat-ldap.

Source

ldap.lisp.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
B   E   F   G   L   M   P   R   S   W  
Index Entry  Section

(
(setf bind-dn): Public generic functions
(setf bind-dn): Public generic functions
(setf bind-pw): Public generic functions
(setf bind-pw): Public generic functions
(setf ldap-host): Public generic functions
(setf ldap-host): Public generic functions
(setf ldap-port): Public generic functions
(setf ldap-port): Public generic functions
(setf ldap-ssl): Public generic functions
(setf ldap-ssl): Public generic functions
(setf password): Public standalone methods
(setf profile-attr): Public generic functions
(setf profile-attr): Public generic functions
(setf profile-base): Public generic functions
(setf profile-base): Public generic functions
(setf profile-query): Public generic functions
(setf profile-query): Public generic functions

B
bind-dn: Public generic functions
bind-dn: Public generic functions
bind-dn: Public generic functions
bind-pw: Public generic functions
bind-pw: Public generic functions

E
error-message: Public generic functions
error-message: Public generic functions
error-type: Public generic functions
error-type: Public generic functions

F
find-profile: Public standalone methods
Function, replace-username: Private ordinary functions

G
Generic Function, (setf bind-dn): Public generic functions
Generic Function, (setf bind-pw): Public generic functions
Generic Function, (setf ldap-host): Public generic functions
Generic Function, (setf ldap-port): Public generic functions
Generic Function, (setf ldap-ssl): Public generic functions
Generic Function, (setf profile-attr): Public generic functions
Generic Function, (setf profile-base): Public generic functions
Generic Function, (setf profile-query): Public generic functions
Generic Function, bind-dn: Public generic functions
Generic Function, bind-pw: Public generic functions
Generic Function, error-message: Public generic functions
Generic Function, error-type: Public generic functions
Generic Function, ldap-host: Public generic functions
Generic Function, ldap-port: Public generic functions
Generic Function, ldap-ssl: Public generic functions
Generic Function, profile-attr: Public generic functions
Generic Function, profile-base: Public generic functions
Generic Function, profile-query: Public generic functions
Generic Function, server: Public generic functions

L
ldap-host: Public generic functions
ldap-host: Public generic functions
ldap-port: Public generic functions
ldap-port: Public generic functions
ldap-ssl: Public generic functions
ldap-ssl: Public generic functions
list-profiles: Public standalone methods

M
Macro, with-ldap: Private macros
make-profile: Public standalone methods
Method, (setf bind-dn): Public generic functions
Method, (setf bind-pw): Public generic functions
Method, (setf ldap-host): Public generic functions
Method, (setf ldap-port): Public generic functions
Method, (setf ldap-ssl): Public generic functions
Method, (setf password): Public standalone methods
Method, (setf profile-attr): Public generic functions
Method, (setf profile-base): Public generic functions
Method, (setf profile-query): Public generic functions
Method, bind-dn: Public generic functions
Method, bind-dn: Public generic functions
Method, bind-pw: Public generic functions
Method, error-message: Public generic functions
Method, error-type: Public generic functions
Method, find-profile: Public standalone methods
Method, ldap-host: Public generic functions
Method, ldap-port: Public generic functions
Method, ldap-ssl: Public generic functions
Method, list-profiles: Public standalone methods
Method, make-profile: Public standalone methods
Method, password-valid-p: Public standalone methods
Method, print-object: Public standalone methods
Method, profile-attr: Public generic functions
Method, profile-base: Public generic functions
Method, profile-query: Public generic functions
Method, remove-profile: Public standalone methods
Method, server: Public generic functions

P
password-valid-p: Public standalone methods
print-object: Public standalone methods
profile-attr: Public generic functions
profile-attr: Public generic functions
profile-base: Public generic functions
profile-base: Public generic functions
profile-query: Public generic functions
profile-query: Public generic functions

R
remove-profile: Public standalone methods
replace-username: Private ordinary functions

S
server: Public generic functions
server: Public generic functions

W
with-ldap: Private macros