About Features Downloads Getting Started Documentation Events Support GitHub

Site Tools


legacy:vufind_1.x_developer_manual:building_an_authentication_handler

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
legacy:vufind_1.x_developer_manual:building_an_authentication_handler [2015/12/09 19:53]
demiankatz ↷ Page moved from building_an_authentication_handler to legacy:vufind_1.x_developer_manual:building_an_authentication_handler
legacy:vufind_1.x_developer_manual:building_an_authentication_handler [2018/12/19 14:16] (current)
demiankatz
Line 1: Line 1:
 ====== Building an Authentication Handler ====== ====== Building an Authentication Handler ======
  
-// This page refers ​to VuFind 1.x architecture. For VuFind 2.x notes, see [[development:​plugins:​authentication_handlers|the VuFind 2.x docs]]. // +// This outdated ​page has been deleted ​to prevent confusion; for current documentation, see [[development:​plugins:​authentication_handlers|this page]]. To view old content ​for historical interest, see the "Old Revisions" ​list below. //
- +
-VuFind contains a class-based mechanism ​for authenticating users. +
- +
-===== Architecture ===== +
- +
-All of VuFind'​s authentication code can be found in the [[https://​vufind.svn.sourceforge.net/​svnroot/​vufind/​trunk/​web/​sys/​authn/​|web/​sys/​authn]] directory. +
- +
-All authentication handlers implement the Authentication interface found in [[https://​vufind.svn.sourceforge.net/​svnroot/​vufind/​trunk/​web/​sys/​authn/​Authentication.php|web/​sys/​authn/​Interface.php]]. +
- +
-Authentication handlers are instantiated by the AuthenticationFactory class found in [[https://​vufind.svn.sourceforge.net/​svnroot/​vufind/​trunk/​web/​sys/​authn/​AuthenticationFactory.php|web/​sys/​authn/​AuthenticationFactory.php]]. +
- +
- +
-===== Building an Authentication Handler ===== +
- +
-  * Create a new module in web/​sys/​authn for your new authentication method. +
-  * Write a class in this new file that implements the Authentication interface. +
-  * Modify the AuthenticationFactory class so that it knows how to construct your new class. ​ //Starting with VuFind 1.1, this will be unnecessary as long as you name your class according to this pattern: [config.ini value]Authentication;​ i.e. MyNewAuthentication will load automatically if you use "MyNew" ​as the value in config.ini.// +
- +
- +
-===== Notes ===== +
- +
-  * As of this writing, the web/​sys/​authn directory contains some utility code (configuration parsers, exception classes) that should probably be moved to a more generic location in the future. ​ If you add new support classes, please consider putting them somewhere more appropriate. +
- +
legacy/vufind_1.x_developer_manual/building_an_authentication_handler.txt · Last modified: 2018/12/19 14:16 by demiankatz