org.hardtokenmgmt.uds.sql
Class BaseCustomUserDataSource

java.lang.Object
  extended by org.hardtokenmgmt.uds.sql.BaseCustomUserDataSource
All Implemented Interfaces:
org.ejbca.core.model.ra.userdatasource.ICustomUserDataSource
Direct Known Subclasses:
SQLUserDataSource

public abstract class BaseCustomUserDataSource
extends java.lang.Object
implements org.ejbca.core.model.ra.userdatasource.ICustomUserDataSource

A abstract base implementation of a custom User Data Source containing in common help methods.

Version:
$Id$
Author:
Philip Vendil 16 jul 2009

Field Summary
static java.lang.String ADDOMAIN
          AD domain name used to append to UPN, everything after @
static java.lang.String ADDSNTODN
          Add uid data in SN field in DN
static java.lang.String ADDUIDTODN
          Add uid data in UID field in DN
static java.lang.String BASEDN
          Base DN appended to constructed DN.
static java.lang.String DEFAULTCAID
          ID of default CA to use.
static java.lang.String DEFAULTCANAME
          Name of default CA Name to use, used instead of id
static java.lang.String DEFAULTCERTIFICATEPROFILEID
          ID of default certificate profile
static java.lang.String DEFAULTCERTIFICATEPROFILENAME
          Name of default certificate profile, used instead of id
static java.lang.String DEFAULTENDENTITYPROFILEID
          ID of default end entity profile
static java.lang.String DEFAULTENDENTITYPROFILENAME
          Name of default end entity profile, used instead of id
protected  java.util.Properties props
           
 
Constructor Summary
BaseCustomUserDataSource()
           
 
Method Summary
protected  boolean getBooleanSetting(java.lang.String setting)
           
protected  int getCaId()
           
protected  int getCertProfileId()
           
protected  int getEndEntityProfileId()
           
protected  int getIntSetting(java.lang.String setting)
           
protected  org.ejbca.core.ejb.ServiceLocator getLocator()
          return the environment entries locator
protected  java.lang.String getSetting(java.lang.String setting)
           
protected  org.ejbca.core.model.ra.userdatasource.UserDataSourceVO getUserDataSourceVO(java.lang.String uid, java.lang.String fullName, java.lang.String mail)
           
 void init(java.util.Properties properties)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.ejbca.core.model.ra.userdatasource.ICustomUserDataSource
fetch, removeUserData, testConnection
 

Field Detail

ADDOMAIN

public static final java.lang.String ADDOMAIN
AD domain name used to append to UPN, everything after @

See Also:
Constant Field Values

ADDUIDTODN

public static final java.lang.String ADDUIDTODN
Add uid data in UID field in DN

See Also:
Constant Field Values

ADDSNTODN

public static final java.lang.String ADDSNTODN
Add uid data in SN field in DN

See Also:
Constant Field Values

BASEDN

public static final java.lang.String BASEDN
Base DN appended to constructed DN.

See Also:
Constant Field Values

DEFAULTCAID

public static final java.lang.String DEFAULTCAID
ID of default CA to use.

See Also:
Constant Field Values

DEFAULTENDENTITYPROFILEID

public static final java.lang.String DEFAULTENDENTITYPROFILEID
ID of default end entity profile

See Also:
Constant Field Values

DEFAULTCERTIFICATEPROFILEID

public static final java.lang.String DEFAULTCERTIFICATEPROFILEID
ID of default certificate profile

See Also:
Constant Field Values

DEFAULTCANAME

public static final java.lang.String DEFAULTCANAME
Name of default CA Name to use, used instead of id

See Also:
Constant Field Values

DEFAULTENDENTITYPROFILENAME

public static final java.lang.String DEFAULTENDENTITYPROFILENAME
Name of default end entity profile, used instead of id

See Also:
Constant Field Values

DEFAULTCERTIFICATEPROFILENAME

public static final java.lang.String DEFAULTCERTIFICATEPROFILENAME
Name of default certificate profile, used instead of id

See Also:
Constant Field Values

props

protected java.util.Properties props
Constructor Detail

BaseCustomUserDataSource

public BaseCustomUserDataSource()
Method Detail

init

public void init(java.util.Properties properties)
Specified by:
init in interface org.ejbca.core.model.ra.userdatasource.ICustomUserDataSource
See Also:
ICustomUserDataSource.init(java.util.Properties)

getUserDataSourceVO

protected org.ejbca.core.model.ra.userdatasource.UserDataSourceVO getUserDataSourceVO(java.lang.String uid,
                                                                                      java.lang.String fullName,
                                                                                      java.lang.String mail)
                                                                               throws org.ejbca.core.model.ra.userdatasource.UserDataSourceException
Throws:
org.ejbca.core.model.ra.userdatasource.UserDataSourceException

getCertProfileId

protected int getCertProfileId()
                        throws org.ejbca.core.model.ra.userdatasource.UserDataSourceException
Throws:
org.ejbca.core.model.ra.userdatasource.UserDataSourceException

getEndEntityProfileId

protected int getEndEntityProfileId()
                             throws org.ejbca.core.model.ra.userdatasource.UserDataSourceException
Throws:
org.ejbca.core.model.ra.userdatasource.UserDataSourceException

getCaId

protected int getCaId()
               throws org.ejbca.core.model.ra.userdatasource.UserDataSourceException
Throws:
org.ejbca.core.model.ra.userdatasource.UserDataSourceException

getSetting

protected java.lang.String getSetting(java.lang.String setting)
                               throws org.ejbca.core.model.ra.userdatasource.UserDataSourceException
Throws:
org.ejbca.core.model.ra.userdatasource.UserDataSourceException

getIntSetting

protected int getIntSetting(java.lang.String setting)
                     throws org.ejbca.core.model.ra.userdatasource.UserDataSourceException
Throws:
org.ejbca.core.model.ra.userdatasource.UserDataSourceException

getBooleanSetting

protected boolean getBooleanSetting(java.lang.String setting)
                             throws org.ejbca.core.model.ra.userdatasource.UserDataSourceException
Throws:
org.ejbca.core.model.ra.userdatasource.UserDataSourceException

getLocator

protected org.ejbca.core.ejb.ServiceLocator getLocator()
return the environment entries locator

Returns:
return the environment entries locator