Release 2.x‎ > ‎Install - Reference‎ > ‎Config Ref Guide‎ > ‎Security‎ > ‎Authenticators‎ > ‎

Authenticator

Defines a specific Authenticator that implements the AuthenticatorIF interface

Syntax


<Authenticator id="..." level="...">
   <Properties>
      <Property name="authenticator.classname"   value="..."/>
      <Property name="authenticator.context"     value="..."/>
      <Property name="authenticator.description" value="..."/>
   </Properties>
</Authenticator>


Arguments


NameRequiredDescriptionExample
idYesA unique identifier for the Authenticatorid="IdPass-Embedded"
levelYesWhat "level" does the Authenticator support
  • ANON
  • USER
  • SYSTEM 
level="USER"

Properties


NameRequiredDescriptionExample
authenticator.classnameYesThe full pathname of the Java class that implements the AuthenticatorIF interface value="org.openptk.authenticate.IdPassAuthenticator"
authenticator.contextMaybeIf the Authenticator is designed to leverage a Context, for the authentication process, then this property is required.  It is the id of a configured Context value="Embedded-JDBC"
authenticator.descriptionNoA descriptive name for the Authenticatorvalue="My Authenticator"

Example


<Authenticator id="Employees-IdPass-Embed" level="USER">
   <Properties>
      <Property name="authenticator.classname"   value="org.openptk.authenticate.IdPassServiceAuthenticator"/>
      <Property name="authenticator.context"     value="Employees-Embed-JDBC"/>
      <Property name="authenticator.description" value="ID and Password verified with Embedded database"/>
   </Properties>
</Authenticator>

XML Sub-Elements