fedora.server.management
Class BasicPIDGenerator

java.lang.Object
  fedora.server.Parameterized
      fedora.server.Pluggable
          fedora.server.Module
              fedora.server.management.BasicPIDGenerator

All Implemented Interfaces:

Constants, PIDGenerator

public class BasicPIDGenerator
extends Module
implements PIDGenerator

A wrapper around the DBPIDGenerator class that casts it as a Module.

Version:

$Id: BasicPIDGenerator.java 5999 2007-04-05 17:23:10Z cwilper $

Author:

cwilper@cs.cornell.edu

Nested Class Summary

Nested classes/interfaces inherited from interface fedora.common.Constants

Constants.FedoraHome

Field Summary

Fields inherited from interface fedora.common.Constants

ACCESS, ACTION, API, AUDIT, AUDIT1_0, BATCH_MODIFY, BATCH_MODIFY1_1, BDEF, BE_SECURITY, BE_SECURITY1_0, BINDING_SPEC, BMECH, DATASTREAM, DC, DISSEMINATOR, DS_COMPOSITE_MODEL, DS_COMPOSITE_MODEL1_0, ENVIRONMENT, FCFG, FEDORA, FEDORA_HOME, FOXML, FOXML1_0, FOXML1_1, HTTP_REQUEST, MANAGEMENT, METHOD_MAP, METS, METS_EXT, METS_EXT1_0, METS_EXT1_1, MODEL, MULGARA, OAI_DC, OAI_DC2_0, OAI_FRIENDS, OAI_FRIENDS2_0, OAI_IDENTIFIER, OAI_IDENTIFIER2_0, OAI_PMH, OAI_PMH2_0, OAI_PROV, OAI_PROV2_0, OBJ_DATASTREAMS1_0, OBJ_HISTORY1_0, OBJ_ITEMS1_0, OBJ_METHODS1_0, OBJ_PROFILE1_0, OBJECT, OLD_XLINK, PID_LIST1_0, RDF, RDF_XSD, RECOVERY, RELS_EXT, REPO_DESC1_0, RESOURCE, SERVICE_PROFILE, SOAP, SOAP_ENC, SUBJECT, TYPES, VIEW, WSDL, WSDL_HTTP, WSDL_MIME, XLINK, XML_XSD, XMLNS, XSI

Constructor Summary

BasicPIDGenerator(java.util.Map moduleParameters, Server server, java.lang.String role)
Constructs a BasicPIDGenerator.

Method Summary

PID	generatePID(java.lang.String namespaceID) Generate a new pid that is guaranteed to be unique, within the given namespace.
PID	getLastPID() Get the last pid that was generated.
void	initModule() Initializes the Module based on configuration parameters.
void	neverGeneratePID(java.lang.String pid) Cause the given PID to never be generated by the PID generator.
void	postInitModule() Get a reference to the ConnectionPoolManager so we can give the instance constructor a ConnectionPool later in initializeIfNeeded().

Methods inherited from class fedora.server.Module

getRole, getServer, shutdownModule

Methods inherited from class fedora.server.Pluggable

getHelp, getOptionalParameters, getParameterHelp, getRequiredModuleRoles, getRequiredParameters

Methods inherited from class fedora.server.Parameterized

getParameter, getParameter, getParameters, parameterNames, setParameter, setParameters

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicPIDGenerator

public BasicPIDGenerator(java.util.Map moduleParameters,
                         Server server,
                         java.lang.String role)
                  throws ModuleInitializationException

Constructs a BasicPIDGenerator.

Parameters:

moduleParameters - A pre-loaded Map of name-value pairs comprising the intended configuration of this Module.

server - The Server instance.

role - The role this module fulfills, a java class name.

Throws:

ModuleInitializationException - If initilization values are invalid or initialization fails for some other reason.

Method Detail

initModule

public void initModule()

Description copied from class: Module

Initializes the Module based on configuration parameters.

Overrides:

initModule in class Module

postInitModule

public void postInitModule()
                    throws ModuleInitializationException

Get a reference to the ConnectionPoolManager so we can give the instance constructor a ConnectionPool later in initializeIfNeeded().

Overrides:

postInitModule in class Module

Throws:

ModuleInitializationException - If initialization values are invalid or initialization fails for some other reason.

generatePID

public PID generatePID(java.lang.String namespaceID)
                throws java.io.IOException

Description copied from interface: PIDGenerator

Generate a new pid that is guaranteed to be unique, within the given namespace.

Specified by:

generatePID in interface PIDGenerator

Returns:

the PID

Throws:

java.io.IOException

getLastPID

public PID getLastPID()
               throws java.io.IOException

Description copied from interface: PIDGenerator

Get the last pid that was generated.

Specified by:

getLastPID in interface PIDGenerator

Returns:

the last PID that was generated

Throws:

java.io.IOException

neverGeneratePID

public void neverGeneratePID(java.lang.String pid)
                      throws java.io.IOException

Description copied from interface: PIDGenerator

Cause the given PID to never be generated by the PID generator.

Specified by:

neverGeneratePID in interface PIDGenerator

Throws:

java.io.IOException