com.netscape.certsrv.publish

Interface IPublisherProcessor

All Superinterfaces:

ISubsystem

All Known Subinterfaces:

IXcertPublisherProcessor

public interface IPublisherProcessor
extends ISubsystem

Controls the publishing process from the top level. Maintains a collection of Publishers , Mappers, and Publish Rules.

Version:

$Revision$ $Date$

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROP_CERT_ENABLE
static java.lang.String	PROP_CERTS
static java.lang.String	PROP_CLASS
static java.lang.String	PROP_CRL_ENABLE
static java.lang.String	PROP_ENABLE
static java.lang.String	PROP_IMPL
static java.lang.String	PROP_INSTANCE
static java.lang.String	PROP_LDAP
static java.lang.String	PROP_LDAP_PUBLISH_SUBSTORE
static java.lang.String	PROP_LOCAL_CA
static java.lang.String	PROP_LOCAL_CRL
static java.lang.String	PROP_MAPPER
static java.lang.String	PROP_PLUGIN
static java.lang.String	PROP_PREDICATE
static java.lang.String	PROP_PUBLISH_SUBSTORE
static java.lang.String	PROP_PUBLISHER
static java.lang.String	PROP_QUEUE_PUBLISH_SUBSTORE
static java.lang.String	PROP_TYPE
static java.lang.String	PROP_XCERT

Method Summary

Modifier and Type	Method and Description
ILdapMapper	getActiveMapperInstance(java.lang.String insName) Returns ILdapMapper instance that is currently active.
ILdapPublisher	getActivePublisherInstance(java.lang.String insName) Returns ILdapPublisher instance that is currently active.
ISubsystem	getAuthority() Return Authority for which this Processor operates.
ILdapConnModule	getLdapConnModule() Returns LdapConnModule belonging to this Processor.
java.util.Vector<java.lang.String>	getMapperDefaultParams(java.lang.String implName) Returns mapper initial default parameters.
ILdapMapper	getMapperInstance(java.lang.String insName) Returns ILdapMapper instance based on name of MapperProxy.
java.util.Vector<java.lang.String>	getMapperInstanceParams(java.lang.String insName) Returns mapper current instance parameters.
java.util.Hashtable<java.lang.String,MapperProxy>	getMapperInsts() Returns Hashtable of rule mapper instances.
java.util.Hashtable<java.lang.String,MapperPlugin>	getMapperPlugins() Returns Hashtable of mapper plugins.
java.util.Vector<java.lang.String>	getPublisherDefaultParams(java.lang.String implName) Returns publisher initial default parameters.
ILdapPublisher	getPublisherInstance(java.lang.String insName) Returns ILdapPublisher instance.
java.util.Vector<java.lang.String>	getPublisherInstanceParams(java.lang.String insName) Returns Vector of PublisherIntance's current instance parameters.
java.util.Hashtable<java.lang.String,PublisherProxy>	getPublisherInsts() Returns Hashtable of rule publisher instances.
java.util.Hashtable<java.lang.String,PublisherPlugin>	getPublisherPlugins() Returns Hashtable of publisher plugins.
java.util.Vector<java.lang.String>	getRuleDefaultParams(java.lang.String implName) Returns Vector of RulePlugin's initial default parameters.
java.util.Vector<java.lang.String>	getRuleInstanceParams(java.lang.String implName) Returns Vector of RulePlugin's current instance parameters.
java.util.Hashtable<java.lang.String,ILdapRule>	getRuleInsts() Returns Hashtable of rule instances.
java.util.Hashtable<java.lang.String,RulePlugin>	getRulePlugins() Returns Hashtable of rule plugins.
java.util.Enumeration<ILdapRule>	getRules(java.lang.String publishingType) Returns list of rules based on publishing type.
java.util.Enumeration<ILdapRule>	getRules(java.lang.String publishingType, IRequest req) Returns list of rules based on publishing type and publishing request.
boolean	isCertPublishingEnabled() Return true if Certificate Publishing is enabled.
boolean	isCRLPublishingEnabled() Return true if CRL publishing is enabled,
boolean	isMapperInstanceEnable(java.lang.String insName) Returns true if MapperInstance is enabled.
boolean	isPublisherInstanceEnable(java.lang.String insName) Returns true publisher instance is currently enabled.
boolean	ldapEnabled() Return true if Ldap is enabled.
void	log(int level, java.lang.String msg) Perform logging function for this Processor.
void	publishCACert(java.security.cert.X509Certificate cert) Publish ca cert, UpdateDir.java, jobs, request listeners
void	publishCert(java.security.cert.X509Certificate cert, IRequest req) Publishs regular user certificate based on the criteria set in the request.
void	publishCRL(java.lang.String dn, java.security.cert.X509CRL crl) publishes a crl by mapping the issuer name in the crl to an entry and publishing it there.
void	publishCRL(netscape.security.x509.X509CRLImpl crl, java.lang.String crlIssuingPointId) publishes a crl by mapping the issuer name in the crl to an entry and publishing it there.
void	setLdapConnModule(ILdapConnModule m) Sets the LdapConnModule belonging to this Processor.
void	setPublishedFlag(java.math.BigInteger serialNo, boolean published) Set published flag - true when published, false when unpublished.
void	unpublishCACert(java.security.cert.X509Certificate cert) This function is never called.
void	unpublishCert(java.security.cert.X509Certificate cert, IRequest req) Unpublish user certificate.

Methods inherited from interface com.netscape.certsrv.base.ISubsystem

getConfigStore, getId, init, setId, shutdown, startup

Field Detail

PROP_PUBLISH_SUBSTORE

static final java.lang.String PROP_PUBLISH_SUBSTORE

See Also:

Constant Field Values

PROP_LDAP_PUBLISH_SUBSTORE

static final java.lang.String PROP_LDAP_PUBLISH_SUBSTORE

See Also:

Constant Field Values

PROP_QUEUE_PUBLISH_SUBSTORE

static final java.lang.String PROP_QUEUE_PUBLISH_SUBSTORE

See Also:

Constant Field Values

PROP_LOCAL_CA

static final java.lang.String PROP_LOCAL_CA

See Also:

Constant Field Values

PROP_LOCAL_CRL

static final java.lang.String PROP_LOCAL_CRL

See Also:

Constant Field Values

PROP_CERTS

static final java.lang.String PROP_CERTS

See Also:

Constant Field Values

PROP_XCERT

static final java.lang.String PROP_XCERT

See Also:

Constant Field Values

PROP_CLASS

static final java.lang.String PROP_CLASS

See Also:

Constant Field Values

PROP_IMPL

static final java.lang.String PROP_IMPL

See Also:

Constant Field Values

PROP_PLUGIN

static final java.lang.String PROP_PLUGIN

See Also:

Constant Field Values

PROP_INSTANCE

static final java.lang.String PROP_INSTANCE

See Also:

Constant Field Values

PROP_PREDICATE

static final java.lang.String PROP_PREDICATE

See Also:

Constant Field Values

PROP_ENABLE

static final java.lang.String PROP_ENABLE

See Also:

Constant Field Values

PROP_CERT_ENABLE

static final java.lang.String PROP_CERT_ENABLE

See Also:

Constant Field Values

PROP_CRL_ENABLE

static final java.lang.String PROP_CRL_ENABLE

See Also:

Constant Field Values

PROP_LDAP

static final java.lang.String PROP_LDAP

See Also:

Constant Field Values

PROP_MAPPER

static final java.lang.String PROP_MAPPER

See Also:

Constant Field Values

PROP_PUBLISHER

static final java.lang.String PROP_PUBLISHER

See Also:

Constant Field Values

PROP_TYPE

static final java.lang.String PROP_TYPE

See Also:

Constant Field Values

Method Detail

getRulePlugins

java.util.Hashtable<java.lang.String,RulePlugin> getRulePlugins()

Returns Hashtable of rule plugins.

getRuleInsts

java.util.Hashtable<java.lang.String,ILdapRule> getRuleInsts()

Returns Hashtable of rule instances.

getMapperPlugins

java.util.Hashtable<java.lang.String,MapperPlugin> getMapperPlugins()

Returns Hashtable of mapper plugins.

getPublisherPlugins

java.util.Hashtable<java.lang.String,PublisherPlugin> getPublisherPlugins()

Returns Hashtable of publisher plugins.

getMapperInsts

java.util.Hashtable<java.lang.String,MapperProxy> getMapperInsts()

Returns Hashtable of rule mapper instances.

getPublisherInsts

java.util.Hashtable<java.lang.String,PublisherProxy> getPublisherInsts()

Returns Hashtable of rule publisher instances.

getRules

java.util.Enumeration<ILdapRule> getRules(java.lang.String publishingType)

Returns list of rules based on publishing type.

Parameters:

publishingType - Type for which to retrieve rule list.

getRules

java.util.Enumeration<ILdapRule> getRules(java.lang.String publishingType,
                                          IRequest req)

Returns list of rules based on publishing type and publishing request.

Parameters:

publishingType - Type for which to retrieve rule list.

req - Corresponding publish request.

getMapperDefaultParams

java.util.Vector<java.lang.String> getMapperDefaultParams(java.lang.String implName)
                                                   throws ELdapException

Returns mapper initial default parameters.

Parameters:

implName - name of MapperPlugin.

Throws:

ELdapException

getMapperInstanceParams

java.util.Vector<java.lang.String> getMapperInstanceParams(java.lang.String insName)
                                                    throws ELdapException

Returns mapper current instance parameters.

Parameters:

insName - name of MapperProxy.

Throws:

ELdapException - failed due to Ldap error.

getPublisherDefaultParams

java.util.Vector<java.lang.String> getPublisherDefaultParams(java.lang.String implName)
                                                      throws ELdapException

Returns publisher initial default parameters.

Parameters:

implName - name of PublisherPlugin.

Throws:

ELdapException - failed due to Ldap error.

isMapperInstanceEnable

boolean isMapperInstanceEnable(java.lang.String insName)

Returns true if MapperInstance is enabled.

Parameters:

insName - name of MapperProxy.

Returns:

true if enabled. false if disabled.

getActiveMapperInstance

ILdapMapper getActiveMapperInstance(java.lang.String insName)

Returns ILdapMapper instance that is currently active.

Parameters:

insName - name of MapperProxy.

Returns:

instance of ILdapMapper.

getMapperInstance

ILdapMapper getMapperInstance(java.lang.String insName)

Returns ILdapMapper instance based on name of MapperProxy.

Parameters:

insName - name of MapperProxy.

Returns:

instance of ILdapMapper.

isPublisherInstanceEnable

boolean isPublisherInstanceEnable(java.lang.String insName)

Returns true publisher instance is currently enabled.

Parameters:

insName - name of PublisherProxy.

Returns:

true if enabled.

getActivePublisherInstance

ILdapPublisher getActivePublisherInstance(java.lang.String insName)

Returns ILdapPublisher instance that is currently active.

Parameters:

insName - name of PublisherProxy.

Returns:

instance of ILdapPublisher.

getPublisherInstance

ILdapPublisher getPublisherInstance(java.lang.String insName)

Returns ILdapPublisher instance.

Parameters:

insName - name of PublisherProxy.

Returns:

instance of ILdapPublisher.

getPublisherInstanceParams

java.util.Vector<java.lang.String> getPublisherInstanceParams(java.lang.String insName)
                                                       throws ELdapException

Returns Vector of PublisherIntance's current instance parameters.

Parameters:

insName - name of PublisherProxy.

Returns:

Vector of current instance parameters.

Throws:

ELdapException

getRuleDefaultParams

java.util.Vector<java.lang.String> getRuleDefaultParams(java.lang.String implName)
                                                 throws ELdapException

Returns Vector of RulePlugin's initial default parameters.

Parameters:

implName - name of RulePlugin.

Returns:

Vector of initial default parameters.

Throws:

ELdapException - failed due to Ldap error.

getRuleInstanceParams

java.util.Vector<java.lang.String> getRuleInstanceParams(java.lang.String implName)
                                                  throws ELdapException

Returns Vector of RulePlugin's current instance parameters.

Parameters:

implName - name of RulePlugin.

Returns:

Vector of current instance parameters.

Throws:

ELdapException - failed due to Ldap error.

setPublishedFlag

void setPublishedFlag(java.math.BigInteger serialNo,
                      boolean published)

Set published flag - true when published, false when unpublished. Not exist means not published.

Parameters:

serialNo - serial number of publishable object.

published - true for published, false for not.

publishCACert

void publishCACert(java.security.cert.X509Certificate cert)
            throws ELdapException

Publish ca cert, UpdateDir.java, jobs, request listeners

Parameters:

cert - X509 certificate to be published.

Throws:

ELdapException - publish failed due to Ldap error.

ELdapException

unpublishCACert

void unpublishCACert(java.security.cert.X509Certificate cert)
              throws ELdapException

This function is never called. CMS does not unpublish CA certificate.

Throws:

ELdapException

publishCert

void publishCert(java.security.cert.X509Certificate cert,
                 IRequest req)
          throws ELdapException

Publishs regular user certificate based on the criteria set in the request.

Parameters:

cert - X509 certificate to be published.

req - request which provides the criteria

Throws:

ELdapException - publish failed due to Ldap error.

ELdapException

unpublishCert

void unpublishCert(java.security.cert.X509Certificate cert,
                   IRequest req)
            throws ELdapException

Unpublish user certificate. This is used by UnpublishExpiredJob.

Parameters:

cert - X509 certificate to be unpublished.

req - request which provides the criteria

Throws:

ELdapException - unpublish failed due to Ldap error.

ELdapException

publishCRL

void publishCRL(netscape.security.x509.X509CRLImpl crl,
                java.lang.String crlIssuingPointId)
         throws ELdapException

publishes a crl by mapping the issuer name in the crl to an entry and publishing it there. entry must be a certificate authority. Note that this is used by cmsgateway/cert/UpdateDir.java

Parameters:

crl - Certificate Revocation List

crlIssuingPointId - name of the issuing point.

Throws:

ELdapException - publish failed due to Ldap error.

ELdapException

publishCRL

void publishCRL(java.lang.String dn,
                java.security.cert.X509CRL crl)
         throws ELdapException

publishes a crl by mapping the issuer name in the crl to an entry and publishing it there. entry must be a certificate authority.

Parameters:

dn - Distinguished name to publish.

crl - Certificate Revocation List

Throws:

ELdapException - publish failed due to Ldap error.

ELdapException

ldapEnabled

boolean ldapEnabled()

Return true if Ldap is enabled.

Returns:

true if Ldap is enabled,otherwise false.

isCertPublishingEnabled

boolean isCertPublishingEnabled()

Return true if Certificate Publishing is enabled.

Returns:

true if enabled, false otherwise

isCRLPublishingEnabled

boolean isCRLPublishingEnabled()

Return true if CRL publishing is enabled,

Returns:

true if enabled, false otherwise.

getAuthority

ISubsystem getAuthority()

Return Authority for which this Processor operates.

Returns:

Authority.

log

void log(int level,
         java.lang.String msg)

Perform logging function for this Processor.

Parameters:

level - Log level to be used for this message

msg - Message to be logged.

getLdapConnModule

ILdapConnModule getLdapConnModule()

Returns LdapConnModule belonging to this Processor.

Returns:

LdapConnModule.

setLdapConnModule

void setLdapConnModule(ILdapConnModule m)

Sets the LdapConnModule belonging to this Processor.

Parameters:

m - ILdapConnModule.