Package com.netscape.cms.publish.mappers
Class LdapCertSubjMap
- java.lang.Object
-
- com.netscape.cms.publish.mappers.LdapCertSubjMap
-
- All Implemented Interfaces:
IExtendedPluginInfo,ILdapMapper,ILdapPlugin
public class LdapCertSubjMap extends java.lang.Object implements ILdapMapper, IExtendedPluginInfo
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
Fields Modifier and Type Field Description static java.lang.StringLDAP_CERTSUBJNAME_ATTRstatic org.slf4j.Loggerloggerprotected java.lang.StringmCertSubjNameAttrprotected IConfigStoremConfigprotected java.lang.StringmSearchBaseprotected booleanmUseAllEntries-
Fields inherited from interface com.netscape.certsrv.base.IExtendedPluginInfo
HELP_TEXT, HELP_TOKEN
-
-
Constructor Summary
Constructors Constructor Description LdapCertSubjMap()LdapCertSubjMap(java.lang.String searchBase)constructs a certificate subject name mapper with search base.LdapCertSubjMap(java.lang.String searchBase, java.lang.String certSubjNameAttr, java.lang.String certAttr)Constructor using non-ES cert map attribute name.LdapCertSubjMap(java.lang.String searchBase, java.lang.String certSubjNameAttr, java.lang.String certAttr, boolean useAllEntries)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.StringgetCertSubjNameAttr()return certificate subject attributeIConfigStoregetConfigStore()Return config store.java.util.Vector<java.lang.String>getDefaultParams()Returns the initial default parameters.java.lang.StringgetDescription()Returns the description of this mapper.java.lang.String[]getExtendedPluginInfo(java.util.Locale locale)This method returns an array of strings.java.lang.StringgetImplName()Returns implementation name.java.util.Vector<java.lang.String>getInstanceParams()Returns the current instance parameters.java.lang.StringgetSearchBase()return search basevoidinit(IConfigStore config)Initialize from config store.java.lang.Stringmap(netscape.ldap.LDAPConnection conn, IRequest req, java.lang.Object obj)maps a certificate to a LDAP entry.java.lang.Stringmap(netscape.ldap.LDAPConnection conn, java.lang.Object obj)Finds the entry for the certificate by looking for the cert subject name in the subject name attribute.java.util.Vector<java.lang.String>mapAll(netscape.ldap.LDAPConnection conn, IRequest req, java.lang.Object obj)java.util.Vector<java.lang.String>mapAll(netscape.ldap.LDAPConnection conn, java.lang.Object obj)booleanuseAllEntries()
-
-
-
Field Detail
-
logger
public static org.slf4j.Logger logger
-
LDAP_CERTSUBJNAME_ATTR
public static final java.lang.String LDAP_CERTSUBJNAME_ATTR
- See Also:
- Constant Field Values
-
mSearchBase
protected java.lang.String mSearchBase
-
mCertSubjNameAttr
protected java.lang.String mCertSubjNameAttr
-
mUseAllEntries
protected boolean mUseAllEntries
-
mConfig
protected IConfigStore mConfig
-
-
Constructor Detail
-
LdapCertSubjMap
public LdapCertSubjMap()
-
LdapCertSubjMap
public LdapCertSubjMap(java.lang.String searchBase)
constructs a certificate subject name mapper with search base.- Parameters:
searchBase- the dn to start searching for the certificate subject name.
-
LdapCertSubjMap
public LdapCertSubjMap(java.lang.String searchBase, java.lang.String certSubjNameAttr, java.lang.String certAttr)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
public LdapCertSubjMap(java.lang.String searchBase, java.lang.String certSubjNameAttr, java.lang.String certAttr, boolean useAllEntries)
-
-
Method Detail
-
getImplName
public java.lang.String getImplName()
Description copied from interface:ILdapMapperReturns implementation name.- Specified by:
getImplNamein interfaceILdapMapper
-
getDescription
public java.lang.String getDescription()
Description copied from interface:ILdapMapperReturns the description of this mapper.- Specified by:
getDescriptionin interfaceILdapMapper
-
getDefaultParams
public java.util.Vector<java.lang.String> getDefaultParams()
Description copied from interface:ILdapMapperReturns the initial default parameters.- Specified by:
getDefaultParamsin interfaceILdapMapper
-
getExtendedPluginInfo
public java.lang.String[] getExtendedPluginInfo(java.util.Locale locale)
Description copied from interface:IExtendedPluginInfoThis 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; [,required]; ;... 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:
getExtendedPluginInfoin interfaceIExtendedPluginInfo
-
getInstanceParams
public java.util.Vector<java.lang.String> getInstanceParams()
Description copied from interface:ILdapMapperReturns the current instance parameters.- Specified by:
getInstanceParamsin interfaceILdapMapper
-
getConfigStore
public IConfigStore getConfigStore()
Description copied from interface:ILdapPluginReturn config store.- Specified by:
getConfigStorein interfaceILdapPlugin
-
init
public void init(IConfigStore config) throws EBaseException
Description copied from interface:ILdapPluginInitialize from config store.- Specified by:
initin interfaceILdapPlugin- Parameters:
config- the configuration store to initialize from.- Throws:
ELdapException- initialization failed due to Ldap error.EBaseException- initialization failed.
-
map
public java.lang.String map(netscape.ldap.LDAPConnection conn, java.lang.Object obj) throws ELdapExceptionFinds the entry for the certificate by looking for the cert subject name in the subject name attribute.- Specified by:
mapin interfaceILdapMapper- Parameters:
conn- - the LDAP connection.obj- - the X509Certificate.- Returns:
- dn indicates whether a mapping was successful
- Throws:
ELdapException- Map operation failed.
-
map
public java.lang.String map(netscape.ldap.LDAPConnection conn, IRequest req, java.lang.Object obj) throws ELdapExceptionDescription copied from interface:ILdapMappermaps a certificate to a LDAP entry. returns dn of the mapped LDAP entry.- Specified by:
mapin 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
public java.util.Vector<java.lang.String> mapAll(netscape.ldap.LDAPConnection conn, java.lang.Object obj) throws ELdapException- Throws:
ELdapException
-
mapAll
public java.util.Vector<java.lang.String> mapAll(netscape.ldap.LDAPConnection conn, IRequest req, java.lang.Object obj) throws ELdapException- Throws:
ELdapException
-
getSearchBase
public java.lang.String getSearchBase()
return search base
-
getCertSubjNameAttr
public java.lang.String getCertSubjNameAttr()
return certificate subject attribute
-
useAllEntries
public boolean useAllEntries()
-
-