Differences

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

--- building_an_authentication_handler [2010/12/13 16:55] – created demiankatz
+++ building_an_authentication_handler [2014/09/15 13:51] – demiankatz
@@ Line 1: / Line 1: @@
 ====== Building an Authentication Handler ======
+// This page refers to VuFind 1.x architecture. For VuFind 2.x notes, see [[vufind2:authentication_handlers|the VuFind 2.x docs]]. //
 VuFind contains a class-based mechanism for authenticating users.
@@ Line 10: / Line 12: @@
 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 =====
@@ Line 15: / Line 18: @@
   * 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.
+  * 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 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.
+  * 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.