com.businessobjects.sdk.biar
Class BIARFactory

java.lang.Object
  com.businessobjects.sdk.biar.BIARFactory

public class BIARFactory
extends java.lang.Object

This class is used to provide concrete instances of the interfaces used with the BIAR APIs.

Terminology

The following terms are easier to remember if you memorize that they are relative to the CMS.

• Import - Import objects into a CMS.
• Export - Export objects from a CMS.

Method Summary

ICommitOptions	createCommitOptions()
IExportOptions	createExportOptions() Creates an IExportOptions instance containing the default values for a typical export.
IImportOptions	createImportOptions() Creates an IImportOptions instance containing the default values for a typical import.
ILiveToLivePipe	createLiveToLivePipe(IEnterpriseSession srcSession, IEnterpriseSession destSession, IExportOptions srcOpts, IImportOptions destOpts) Begin a transfer between two live systems.
IObjectManager	createOM(IEnterpriseSession entSession) Creates an IObjectManager instance for the specified enterprise session.
IObjectManager	createOM(IEnterpriseSession entSession, boolean encrypt)
IObjectManager	createOM(IEnterpriseSession entSession, boolean encrypt, boolean disposeFilesWithOM) Creates an IObjectManager instance for the specified enterprise session.
static BIARFactory	getFactory() Returns a reference to the singleton BIARFactory instance.

Methods inherited from class java.lang.Object

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

Method Detail

getFactory

public static BIARFactory getFactory()

Returns a reference to the singleton BIARFactory instance.

Returns:

the BIARFactory instance.

createLiveToLivePipe

public ILiveToLivePipe createLiveToLivePipe(IEnterpriseSession srcSession,
                                            IEnterpriseSession destSession,
                                            IExportOptions srcOpts,
                                            IImportOptions destOpts)
                                     throws BIARException

Begin a transfer between two live systems. This is equivalent to creating a new IObjectManager and calling IObjectManager.liveImport(IEnterpriseSession, IExportOptions, IImportOptions).

Parameters:

srcSession - a valid session obtained from the live source system.

destSession - a valid session obtained from the live destination system.

srcOpts - a set of options to control the parameters of export.

destOpts - a set of options to control the parameters of import.

Throws:

BIARException - if this operation fails.

createOM

public IObjectManager createOM(IEnterpriseSession entSession)
                        throws OMException

Creates an IObjectManager instance for the specified enterprise session.

Parameters:

entSession - a valid enterprise session

Returns:

A new IObjectManager instance.

Throws:

OMException - if construction fails.

createOM

public IObjectManager createOM(IEnterpriseSession entSession,
                               boolean encrypt)
                        throws OMException

Parameters:

encrypt - If true, OM's contents will be encrypted.

Returns:

A new IObjectManager instance.

Throws:

OMException - if construction fails.

createOM

public IObjectManager createOM(IEnterpriseSession entSession,
                               boolean encrypt,
                               boolean disposeFilesWithOM)
                        throws OMException

Creates an IObjectManager instance for the specified enterprise session.

Parameters:

entSession - a valid enterprise session

encrypt - If true, OM's contents will be encrypted.

disposeFilesWithOM - If true, any temporary files extracted from BIAR Archives, or Live to Live transfer will be cleaned up when the OM is disposed. Otherwise the temporary files are cleaned up when the JVM closes. If this parameter is true and the OM is disposed, any InfoObjects kept in memory from the OM could be left in an invalid state since their files could be removed. It's important to finish any operations on your InfoObjects before disposing the OM.

Returns:

A new IObjectManager instance.

Throws:

OMException - if construction fails.

createExportOptions

public IExportOptions createExportOptions()

Creates an IExportOptions instance containing the default values for a typical export.

Returns:

A new IExportOptions instance.

See Also:

IObjectManager.exportToArchive(java.lang.String, com.businessobjects.sdk.biar.IExportOptions)

createImportOptions

public IImportOptions createImportOptions()

Creates an IImportOptions instance containing the default values for a typical import.

Returns:

A new IImportOptions instance.

See Also:

IObjectManager.importArchive(java.lang.String, com.businessobjects.sdk.biar.IImportOptions)

createCommitOptions

public ICommitOptions createCommitOptions()