All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.netscape.certsrv.authentication.FlatFileAuth

com.netscape.certsrv.authentication.FlatFileAuth

public class FlatFileAuth
implements IAuthManager

Variable Index

 o entries
Hashtable of entries from Auth File.
 o FFAUTH
 o mAppendDN
 o mAuthAttrs
 o mConfig
configuration store
 o mConfigParams
 o mDeferOnFailure
 o mFileLastRead
 o mFilename
 o mImplName
name of the authentication manager plugin
 o mKeyAttributes
 o mLogger
system logger
 o mName
name of this authentication manager instance
 o PROP_APPENDDN
 o PROP_AUTHATTRS
 o PROP_DEFERONFAILURE
 o PROP_FILENAME
 o PROP_KEYATTRIBUTES

Constructor Index

 o FlatFileAuth()

Method Index

 o authenticate(IAuthCredentials)
Authenticate the request
 o getConfigParams()
Returns a list of configuration parameters, so the console can prompt the user when configuring.
 o getConfigStore()
Returns the configuration store used by this authentication manager
 o getImplName()
 o getName()
 o getPropertyB(String, boolean)
Get the named property, If the property is not set, use b as the default, and create a new value for the property in the config file.
 o getPropertyS(String, String)
Get the named property If the property is not set, use s as the default, and create a new value for the property in the config file.
 o getRequiredCreds()
Return a list of HTTP parameters which will be taken from the request posting and placed into the AuthCredentials block Note that this method will not be called until after the init() method is called
 o init(String, String, IConfigStore)
 o readFile(File, String[])
Read a file with the following format:

 param1: valuea
 param2: valueb
 -blank-line-
 param1: valuec
 param2: valued
 
 o shutdown()
 o unionOfStrings(String[][])
Return a string array which is the union of all the string arrays passed in.

Variables

 o PROP_FILENAME
 protected static final String PROP_FILENAME
 o PROP_KEYATTRIBUTES
 protected static final String PROP_KEYATTRIBUTES
 o PROP_AUTHATTRS
 protected static final String PROP_AUTHATTRS
 o PROP_APPENDDN
 protected static final String PROP_APPENDDN
 o PROP_DEFERONFAILURE
 protected static final String PROP_DEFERONFAILURE
 o mFilename
 protected String mFilename
 o mFileLastRead
 protected long mFileLastRead
 o mKeyAttributes
 protected String mKeyAttributes
 o mAuthAttrs
 protected String mAuthAttrs
 o mAppendDN
 protected String mAppendDN
 o mDeferOnFailure
 protected boolean mDeferOnFailure
 o mConfigParams
 protected static String mConfigParams[]
 o mName
 protected String mName
name of this authentication manager instance

 o FFAUTH
 protected String FFAUTH
 o mImplName
 protected String mImplName
name of the authentication manager plugin

 o mConfig
 protected IConfigStore mConfig
configuration store

 o mLogger
 protected Logger mLogger
system logger

 o entries
 protected Hashtable entries
Hashtable of entries from Auth File. Hash index is the concatenation of the attributes from matchAttributes property

Constructors

 o FlatFileAuth
 public FlatFileAuth()

Methods

 o getPropertyS
 protected String getPropertyS(String propertyName,
                               String s) throws EBaseException
Get the named property If the property is not set, use s as the default, and create a new value for the property in the config file.

Parameters:
propertyName - Property name
s - The default value of the property
 o getPropertyB
 protected boolean getPropertyB(String propertyName,
                                boolean b) throws EBaseException
Get the named property, If the property is not set, use b as the default, and create a new value for the property in the config file.

Parameters:
propertyName - Property name
b - The default value of the property
 o init
 public void init(String name,
                  String implName,
                  IConfigStore config) throws EBaseException
 o unionOfStrings
 public String[] unionOfStrings(String stringArrays[][])
Return a string array which is the union of all the string arrays passed in. The strings are treated as case sensitive

 o readFile
 protected Hashtable readFile(File f,
                              String keys[]) throws IOException
Read a file with the following format:

 param1: valuea
 param2: valueb
 -blank-line-
 param1: valuec
 param2: valued
 

Parameters:
fileName - The file's full pathname
keys - The parameters to concat together to form the hash key
Returns:
a hashtable of hashtables.
 o authenticate
 public AuthToken authenticate(IAuthCredentials authCred) throws EMissingCredential, EInvalidCredentials, EBaseException
Authenticate the request

 o getRequiredCreds
 public String[] getRequiredCreds()
Return a list of HTTP parameters which will be taken from the request posting and placed into the AuthCredentials block Note that this method will not be called until after the init() method is called

 o getConfigParams
 public String[] getConfigParams()
Returns a list of configuration parameters, so the console can prompt the user when configuring.

 o getConfigStore
 public IConfigStore getConfigStore()
Returns the configuration store used by this authentication manager

 o shutdown
 public void shutdown()
 o getName
 public String getName()
 o getImplName
 public String getImplName()

All Packages  Class Hierarchy  This Package  Previous  Next  Index