com.sssw.cm.factory
Class EboFactory

java.lang.Object
 |
 +--com.sssw.cm.factory.EboFactory

All Implemented Interfaces:

Serializable

public class EboFactory

extends Object

implements Serializable

This is the factory class for the Content Management system. It basically acts as the gateway into the CMS by letting the API users obtain instances of Content Manager objects as well as CM elements.

See Also:

Serialized Form

Constructor Summary

EboFactory()

Method Summary

static void	flushRepositories() Discards any existing instantiated Content Managers.
static EbiAddDocumentParams	getAddDocParams() Creates a parameter holder object for adding a new Document.
static EbiContentManager	getContentManagerByRepID(String repositoryID) Gets a Content Manager for the specified repository ID.
static EbiContentManager	getContentManagerByRepName(String repositoryName) Given the name of a repository, gets the corresponding Content Manager.
static EbiDataFetcher	getDataFetcher(String repository, boolean byID) Gets the Data Fetcher object for the specified CM repository.
static EbiContentManager	getDefaultContentManager() Gets the Default Content Manager.
static EbiDirEntryXmlDataOptions	getDirEntryXmlDataOptions() Instantiates a new directory entry XML data options object.
static EbiDocumentXmlDataOptions	getDocumentXmlDataOptions() Instantiates a new document XML data options object.
static EbiCmElement	getElement(String elementType) Gets a content management element object, given the element's type.
static EbiElementOverwrite	getElementOverwrite() Instantiates a new element overwrite specifier object.
static EbiExporter	getExporter(String repositoryID) Creates a CM Data Exporter object.
static EbiImporter	getImporter(String repositoryID) Creates a CM Data Importer object.
static EbiQuery	getQuery() Gets a Query object for Document queries executed via the Search Service.
static EbiQueryEngine	getQueryEngine() Gets a CM Query Engine object.
static Iterator	getRepositoryIDs() Returns an iterator of the Repository IDs for the instantiated Content Managers.
static EbiContentManager	getSystemContentManager() Gets the system Content Manager
static EbiTaskManager	getTaskManager(EbiContext context, String repositoryID) Gets the Task Manager for a specific Repository.
static EbiTaskManager	getTaskManager(String repositoryID) Deprecated. EboFactory.getTaskManager(EbiContext, String)
static EbiXmlDataOptions	getXmlDataOptions() Instantiates a new XML data options object.

Methods inherited from class java.lang.Object

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

Constructor Detail

EboFactory

public EboFactory()

Method Detail

getRepositoryIDs

public static Iterator getRepositoryIDs()

Returns an iterator of the Repository IDs for the instantiated Content Managers.

Returns:

Iterator of repository IDs (Strings)

flushRepositories

public static void flushRepositories()

Discards any existing instantiated Content Managers.

getDefaultContentManager

public static EbiContentManager getDefaultContentManager()
                                                  throws EboFactoryException,
                                                         EboUnrecoverableSystemException

Gets the Default Content Manager.

Returns:

the Default Content Manager

Throws:

EboFactoryException - if unable to instantiate the object

EboUnrecoverableSystemException - on an unrecoverable system exception

getSystemContentManager

public static EbiContentManager getSystemContentManager()
                                                 throws EboFactoryException,
                                                        EboUnrecoverableSystemException

Gets the system Content Manager

Returns:

the system Content Manager

Throws:

EboFactoryException - if unable to instantiate the object

EboUnrecoverableSystemException - on an unrecoverable system exception

getContentManagerByRepID

public static EbiContentManager getContentManagerByRepID(String repositoryID)
                                                  throws EboFactoryException,
                                                         EboUnrecoverableSystemException

Gets a Content Manager for the specified repository ID.

Parameters:

repositoryID - the ID of the repository for which to get the Content Manager; if the repositoryID is null or empty, the default Content Manager is returned

Returns:

the Content Manager for the given repository ID, or null if the supplied repository ID does not map to a valid existing repository

Throws:

EboFactoryException - if unable to instantiate the object

EboUnrecoverableSystemException - on an unrecoverable system exception

getContentManagerByRepName

public static EbiContentManager getContentManagerByRepName(String repositoryName)
                                                    throws EboFactoryException,
                                                           EboUnrecoverableSystemException

Given the name of a repository, gets the corresponding Content Manager.

Parameters:

repositoryName - the name of the Repository

Returns:

the Content Manager, or null if the repository name is invalid

Throws:

EboFactoryException - if unable to instantiate the object

EboUnrecoverableSystemException - on an unrecoverable system exception

getElement

public static EbiCmElement getElement(String elementType)
                               throws EboFactoryException

Gets a content management element object, given the element's type.

Parameters:

elementType - the element type

Returns:

the content management element object

Throws:

EboFactoryException - if fails to instantiate the object

getQuery

public static EbiQuery getQuery()
                         throws EboFactoryException

Gets a Query object for Document queries executed via the Search Service.

Returns:

a Query object

Throws:

EboFactoryException - if fails to instantiate the object

getQueryEngine

public static EbiQueryEngine getQueryEngine()
                                     throws EboFactoryException

Gets a CM Query Engine object.

Returns:

a CM Query Engine object

Throws:

EboFactoryException - if fails to instantiate the object

getDataFetcher

public static EbiDataFetcher getDataFetcher(String repository,
                                            boolean byID)
                                     throws EboFactoryException

Gets the Data Fetcher object for the specified CM repository.

Parameters:

repository - the name or the ID of the CM repository

byID - if true, then repository is the ID, otherwise the name of the CM repository

Returns:

a CM Data Fetcher object

Throws:

EboFactoryException - if fails to instantiate the object

getAddDocParams

public static EbiAddDocumentParams getAddDocParams()
                                            throws EboFactoryException

Creates a parameter holder object for adding a new Document.

Returns:

EbiAddDocumentParams

Throws:

EboFactoryException - if fails to instantiate the object

getImporter

public static EbiImporter getImporter(String repositoryID)
                               throws EboFactoryException

Creates a CM Data Importer object.

Parameters:

repositoryID - the ID of the target repository

Returns:

EbiImporter

Throws:

EboFactoryException - on a factory exception

getExporter

public static EbiExporter getExporter(String repositoryID)
                               throws EboFactoryException

Creates a CM Data Exporter object.

Parameters:

repositoryID - the ID of the target repository

Returns:

EbiExporter

Throws:

EboFactoryException - on a factory exception

getTaskManager

public static EbiTaskManager getTaskManager(String repositoryID)
                                     throws EboFactoryException,
                                            EboUnrecoverableSystemException

Deprecated. EboFactory.getTaskManager(EbiContext, String)

Gets the Task Manager for a specific Repository.

Parameters:

repositoryID - the Repository ID

Returns:

the Task Manager

Throws:

EboFactoryException - if fails to instantiate the object

EboUnrecoverableSystemException - on an unrecoverable system exception

getTaskManager

public static EbiTaskManager getTaskManager(EbiContext context,
                                            String repositoryID)
                                     throws EboFactoryException,
                                            EboUnrecoverableSystemException

Gets the Task Manager for a specific Repository.

Parameters:

context - context

repositoryID - the Repository ID

Returns:

the Task Manager

Throws:

EboFactoryException - if fails to instantiate the object

EboUnrecoverableSystemException - on an unrecoverable system

getElementOverwrite

public static EbiElementOverwrite getElementOverwrite()
                                               throws EboFactoryException

Instantiates a new element overwrite specifier object.

Returns:

a new element overwrite specifier object

Throws:

EboFactoryException - if unable to instantiate the object

getXmlDataOptions

public static EbiXmlDataOptions getXmlDataOptions()
                                           throws EboFactoryException

Instantiates a new XML data options object.

Returns:

a new XML data options object

Throws:

EboFactoryException - if unable to instantiate the object

getDirEntryXmlDataOptions

public static EbiDirEntryXmlDataOptions getDirEntryXmlDataOptions()
                                                           throws EboFactoryException

Instantiates a new directory entry XML data options object.

Returns:

a new directory entry XML data options object

Throws:

EboFactoryException - if unable to instantiate the object

getDocumentXmlDataOptions

public static EbiDocumentXmlDataOptions getDocumentXmlDataOptions()
                                                           throws EboFactoryException

Instantiates a new document XML data options object.

Returns:

a new document XML data options object

Throws:

EboFactoryException - if unable to instantiate the object