Package com.netscape.cms.publish.mappers
Class LdapCertSubjMap
java.lang.Object
com.netscape.cms.publish.mappers.LdapCertSubjMap
- All Implemented Interfaces:
IExtendedPluginInfo
,ILdapMapper
,ILdapPlugin
Maps a X509 certificate to a LDAP entry by finding an LDAP entry
which has an attribute whose contents are equal to the cert subject name.
- Version:
- $Revision$, $Date$
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
static org.slf4j.Logger
protected String
protected ConfigStore
protected String
protected boolean
Fields inherited from interface com.netscape.certsrv.base.IExtendedPluginInfo
HELP_TEXT, HELP_TOKEN
-
Constructor Summary
ConstructorsConstructorDescriptionLdapCertSubjMap
(String searchBase) constructs a certificate subject name mapper with search base.LdapCertSubjMap
(String searchBase, String certSubjNameAttr, String certAttr) Constructor using non-ES cert map attribute name.LdapCertSubjMap
(String searchBase, String certSubjNameAttr, String certAttr, boolean useAllEntries) -
Method Summary
Modifier and TypeMethodDescriptionreturn certificate subject attributeReturn config store.Returns the initial default parameters.Returns the description of this mapper.String[]
This method returns an array of strings.Returns implementation name.Returns the current instance parameters.return search basevoid
init
(ConfigStore config) Initialize from config store.maps a certificate to a LDAP entry.Finds the entry for the certificate by looking for the cert subject name in the subject name attribute.boolean
-
Field Details
-
logger
public static org.slf4j.Logger logger -
LDAP_CERTSUBJNAME_ATTR
- See Also:
-
mSearchBase
-
mCertSubjNameAttr
-
mUseAllEntries
protected boolean mUseAllEntries -
mConfig
-
-
Constructor Details
-
LdapCertSubjMap
public LdapCertSubjMap() -
LdapCertSubjMap
constructs a certificate subject name mapper with search base.- Parameters:
searchBase
- the dn to start searching for the certificate subject name.
-
LdapCertSubjMap
Constructor using non-ES cert map attribute name.- Parameters:
searchBase
- entry to start search.certSubjNameAttr
- attribute for certificate subject names.certAttr
- attribute to find certificate.
-
LdapCertSubjMap
-
-
Method Details
-
getImplName
Description copied from interface:ILdapMapper
Returns implementation name.- Specified by:
getImplName
in interfaceILdapMapper
-
getDescription
Description copied from interface:ILdapMapper
Returns the description of this mapper.- Specified by:
getDescription
in interfaceILdapMapper
-
getDefaultParams
Description copied from interface:ILdapMapper
Returns the initial default parameters.- Specified by:
getDefaultParams
in interfaceILdapMapper
-
getExtendedPluginInfo
Description copied from interface:IExtendedPluginInfo
This method returns an array of strings. Each element of the array represents a configurable parameter, or some other meta-info (such as help-token) there is an entry indexed on that parameter name Where: type_info is either 'string', 'number', 'boolean', 'password' or 'choice(ch1,ch2,ch3,...)' If the marker 'required' is included after the type_info, the parameter will has some visually distinctive marking in the UI. 'description' is a short sentence describing the parameter 'choice' is rendered as a drop-down list. The first parameter in the list will be activated by default 'boolean' is rendered as a checkbox. The resulting parameter will be either 'true' or 'false' 'string' allows any characters 'number' allows only numbers 'password' is rendered as a password field (the characters are replaced with *'s when being types. This parameter is not passed through to the plugin. It is instead inserted directly into the password cache keyed on the instance name. The value of the parameter 'bindPWPrompt' (see example below) is set to the key. In addition to the configurable parameters, the following magic parameters may be defined: HELP_TOKEN;helptoken - a pointer to the online manual section for this plugin HELP_TEXT;helptext - a general help string describing the plugin For example: "username;string;The username you wish to login as" "bindPWPrompt;password;Enter password to bind as above user with" "algorithm;choice(RSA,DSA);Which algorithm do you want to use" "enable;boolean;Do you want to run this plugin" "port;number;Which port number do you want to use"- Specified by:
getExtendedPluginInfo
in interfaceIExtendedPluginInfo
-
getInstanceParams
Description copied from interface:ILdapMapper
Returns the current instance parameters.- Specified by:
getInstanceParams
in interfaceILdapMapper
-
getConfigStore
Description copied from interface:ILdapPlugin
Return config store.- Specified by:
getConfigStore
in interfaceILdapPlugin
-
init
Description copied from interface:ILdapPlugin
Initialize from config store.- Specified by:
init
in interfaceILdapPlugin
- Parameters:
config
- the configuration store to initialize from.- Throws:
ELdapException
- initialization failed due to Ldap error.EBaseException
- initialization failed.
-
map
Finds the entry for the certificate by looking for the cert subject name in the subject name attribute.- Specified by:
map
in interfaceILdapMapper
- Parameters:
conn
- - the LDAP connection.obj
- - the X509Certificate.- Returns:
- dn indicates whether a mapping was successful
- Throws:
ELdapException
- Map operation failed.
-
map
Description copied from interface:ILdapMapper
maps a certificate to a LDAP entry. returns dn of the mapped LDAP entry.- Specified by:
map
in interfaceILdapMapper
- Parameters:
conn
- the LDAP connectionreq
- the request to mapobj
- the object to map- Returns:
- dn indicates whether a mapping was successful
- Throws:
ELdapException
- Map operation failed.
-
mapAll
- Throws:
ELdapException
-
mapAll
public Vector<String> mapAll(netscape.ldap.LDAPConnection conn, Request req, Object obj) throws ELdapException - Throws:
ELdapException
-
getSearchBase
return search base -
getCertSubjNameAttr
return certificate subject attribute -
useAllEntries
public boolean useAllEntries()
-