com.netscape.cms.publish.publishers
Class LdapCrlPublisher

java.lang.Object
  com.netscape.cms.publish.publishers.LdapCrlPublisher

All Implemented Interfaces:

IExtendedPluginInfo, ILdapPlugin, ILdapPublisher

public class LdapCrlPublisher
extends java.lang.Object
implements ILdapPublisher, IExtendedPluginInfo

For publishing master or global CRL. Publishes (replaces) the CRL in the CA's LDAP entry.

Version:

$Revision: 1688 $, $Date: 2011-01-04 17:23:23 -0800 (Tue, 04 Jan 2011) $

Field Summary

static java.lang.String	LDAP_ARL_ATTR
static java.lang.String	LDAP_CACERT_ATTR
static java.lang.String	LDAP_CRL_ATTR
static java.lang.String	LDAP_CRL_OBJECTCLASS
protected IConfigStore	mConfig
protected java.lang.String	mCrlAttr
protected java.lang.String	mCrlObjectClass
protected java.lang.String	mObjAdded
protected java.lang.String	mObjDeleted

Fields inherited from interface com.netscape.certsrv.publish.ILdapPublisher

PROP_ENABLE, PROP_IMPLNAME, PROP_PREDICATE

Fields inherited from interface com.netscape.certsrv.base.IExtendedPluginInfo

HELP_TEXT, HELP_TOKEN

Constructor Summary

LdapCrlPublisher()
constructs ldap crl publisher with default values

LdapCrlPublisher(java.lang.String crlAttr, java.lang.String crlObjectClass)

Method Summary

IConfigStore	getConfigStore() Return config store.
java.lang.String	getCRLObjectclass() Gets the CA object class to convert to.
java.util.Vector	getDefaultParams() Returns the initial default parameters.
java.lang.String	getDescription() Returns the description of the publisher.
java.lang.String[]	getExtendedPluginInfo(java.util.Locale locale) This method returns an array of strings.
java.lang.String	getImplName() Returns the implementation name.
java.util.Vector	getInstanceParams() Returns the current instance parameters.
void	init(IConfigStore config) Initialize from config store.
void	publish(netscape.ldap.LDAPConnection conn, java.lang.String dn, java.lang.Object crlObj) Replaces the CRL in the certificateRevocationList attribute.
void	unpublish(netscape.ldap.LDAPConnection conn, java.lang.String dn, java.lang.Object crlObj) There shouldn't be a need to call this.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

mConfig

protected IConfigStore mConfig

LDAP_CACERT_ATTR

public static final java.lang.String LDAP_CACERT_ATTR

See Also:

Constant Field Values

LDAP_ARL_ATTR

public static final java.lang.String LDAP_ARL_ATTR

See Also:

Constant Field Values

LDAP_CRL_ATTR

public static final java.lang.String LDAP_CRL_ATTR

See Also:

Constant Field Values

LDAP_CRL_OBJECTCLASS

public static final java.lang.String LDAP_CRL_OBJECTCLASS

See Also:

Constant Field Values

mCrlAttr

protected java.lang.String mCrlAttr

mCrlObjectClass

protected java.lang.String mCrlObjectClass

mObjAdded

protected java.lang.String mObjAdded

mObjDeleted

protected java.lang.String mObjDeleted

Constructor Detail

LdapCrlPublisher

public LdapCrlPublisher()

constructs ldap crl publisher with default values

LdapCrlPublisher

public LdapCrlPublisher(java.lang.String crlAttr,
                        java.lang.String crlObjectClass)

Method Detail

getImplName

public java.lang.String getImplName()

Description copied from interface: ILdapPublisher

Returns the implementation name.

Specified by:

getImplName in interface ILdapPublisher

getDescription

public java.lang.String getDescription()

Description copied from interface: ILdapPublisher

Returns the description of the publisher.

Specified by:

getDescription in interface ILdapPublisher

getExtendedPluginInfo

public java.lang.String[] getExtendedPluginInfo(java.util.Locale locale)

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 ;[,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:

getExtendedPluginInfo in interface IExtendedPluginInfo

getInstanceParams

public java.util.Vector getInstanceParams()

Description copied from interface: ILdapPublisher

Returns the current instance parameters.

Specified by:

getInstanceParams in interface ILdapPublisher

getDefaultParams

public java.util.Vector getDefaultParams()

Description copied from interface: ILdapPublisher

Returns the initial default parameters.

Specified by:

getDefaultParams in interface ILdapPublisher

getConfigStore

public IConfigStore getConfigStore()

Description copied from interface: ILdapPlugin

Return config store.

Specified by:

getConfigStore in interface ILdapPlugin

init

public void init(IConfigStore config)
          throws EBaseException

Description copied from interface: ILdapPlugin

Initialize from config store.

Specified by:

init in interface ILdapPlugin

Parameters:

config - the configuration store to initialize from.

Throws:

ELdapException - initialization failed due to Ldap error.

EBaseException - initialization failed.

getCRLObjectclass

public java.lang.String getCRLObjectclass()

Gets the CA object class to convert to.

publish

public void publish(netscape.ldap.LDAPConnection conn,
                    java.lang.String dn,
                    java.lang.Object crlObj)
             throws ELdapException

Replaces the CRL in the certificateRevocationList attribute. CRL's are published as a DER encoded blob.

Specified by:

publish in interface ILdapPublisher

Parameters:

conn - a Ldap connection (null for non-LDAP publishing)

dn - dn of the ldap entry to publish cert (null for non-LDAP publishing)

crlObj - object to publish (java.security.cert.X509Certificate or, java.security.cert.X509CRL)

Throws:

ELdapException - publish failed.

unpublish

public void unpublish(netscape.ldap.LDAPConnection conn,
                      java.lang.String dn,
                      java.lang.Object crlObj)
               throws ELdapException

There shouldn't be a need to call this. CRLs are always replaced but this is implemented anyway in case there is ever a reason to remove a global CRL.

Specified by:

unpublish in interface ILdapPublisher

Parameters:

conn - the Ldap connection (null for non-LDAP publishing)

dn - dn of the ldap entry to unpublish cert (null for non-LDAP publishing)

crlObj - object to unpublish (java.security.cert.X509Certificate)

Throws:

ELdapException - unpublish failed.