de.innovationgate.wgpublisher.design.fs

Class FileSystemDesignProvider

java.lang.Object

de.innovationgate.wgpublisher.design.fs.FileSystemDesignManager

de.innovationgate.wgpublisher.design.fs.FileSystemDesignProvider

All Implemented Interfaces:

de.innovationgate.webgate.api.WGDatabaseConnectListener, de.innovationgate.webgate.api.WGDesignProvider, WGADesignProvider, ManagedDBAttribute, java.util.EventListener

public class FileSystemDesignProvider
extends FileSystemDesignManager
implements WGADesignProvider

Nested Class Summary

Nested classes/interfaces inherited from class de.innovationgate.wgpublisher.design.fs.FileSystemDesignManager

FileSystemDesignManager.DesignInformation, FileSystemDesignManager.FileSystemResources, FileSystemDesignManager.ModuleFile

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	OPTION_NO_BACKGROUND_CHANGES
static java.lang.String	OPTION_SYNC

Fields inherited from class de.innovationgate.wgpublisher.design.fs.FileSystemDesignManager

_designTypes, DIRECTORY_DIVIDER, LOGGER_DESIGNSYNC, MODE_DIRECT, MODE_FULL, MODE_VIRTUAL, OPTION_DESIGNKEY, SYNCSTATUS_MODULE

Fields inherited from interface de.innovationgate.wgpublisher.design.WGADesignProvider

OPTION_DESIGNVARIANTS

Constructor Summary

Constructors

Constructor and Description
FileSystemDesignProvider(de.innovationgate.wga.config.DesignReference ref, WGACore core, de.innovationgate.webgate.api.WGDatabase db, java.lang.String path, java.util.Map<java.lang.String,java.lang.String> options)

Method Summary

Methods

Modifier and Type	Method and Description
void	addDesignChangeListener(de.innovationgate.webgate.api.WGDesignChangeListener changeListener)
void	clearCache() Clears all design caches
void	closeSession()
de.innovationgate.webgate.api.WGDocumentCore	createDesignDocument(int type, java.lang.String name, java.lang.String mediaKey)
static void	createDowngradeFiles(FileSystemDesignProvider originalDesignProvider, OverlayData data, org.apache.commons.vfs2.FileObject targetFolder, java.lang.String targetEncoding, org.apache.log4j.Logger log)
void	createDowngradeFiles(PluginDesignProvider originalDesignProvider, OverlayData data)
int	designHashCode()
static OverlayStatus	determineOverlayStatus(FileSystemDesignProvider sourceDesignProvider, de.innovationgate.wga.common.beans.csconfig.v1.PluginID baseId, org.apache.commons.vfs2.FileObject targetDirectory, java.lang.String targetEncoding, org.apache.log4j.Logger log, DesignFileValidator validator)
OverlayStatus	determineOverlayStatus(PluginDesignProvider originalDesignProvider)
void	dispose()
de.innovationgate.webgate.api.WGDatabase	getConsumerDatabase() Returns the database that consumes the designs of this provider
de.innovationgate.webgate.api.WGDocumentCore	getDesignObject(int type, java.lang.String name, java.lang.String strMediaKey)
java.util.List<de.innovationgate.webgate.api.WGDocumentCore>	getDesignObjects(int type)
de.innovationgate.wga.config.DesignReference	getDesignReference()
java.lang.String	getName()
boolean	isLookupVariants() Returns if the provider is configured to lookup design variants
boolean	isNoBackgroundChanges()
boolean	isNotifying()
boolean	isProviderCore(de.innovationgate.webgate.api.WGDocumentCore core)
boolean	isReady() A design provider may notify via this method if the design backend is currently ready
boolean	isSynchronizeAccess()
void	openSession(de.innovationgate.webgate.api.WGSessionContext context)
boolean	providesType(int type)
void	removeDesignChangeListener(de.innovationgate.webgate.api.WGDesignChangeListener changeListener)
static boolean	upgradeOverlay(FileSystemDesignProvider originalDesignProvider, de.innovationgate.wga.common.beans.csconfig.v1.PluginID baseId, OverlayStatus status, org.apache.commons.vfs2.FileObject targetFolder, java.lang.String targetEncoding, org.apache.log4j.Logger log, DesignFileValidator validator)
boolean	upgradeOverlay(PluginDesignProvider originalDesignProvider, OverlayStatus status)
de.innovationgate.webgate.api.WGDocumentCore	wrapVariantCore(de.innovationgate.webgate.api.WGDocumentCore core)

Methods inherited from class de.innovationgate.wgpublisher.design.fs.FileSystemDesignManager

close, databaseConnected, databaseConnectionError, determineDesignEncoding, getBaseFolder, getDB, getDesignInformation, getDesignPath, getFileEncoding, getFileStandardSuffix, getJavaClassesPath, getLog, getSyncedDoctypes, getSyncInfo, getTmlFolder, getWGACore, isDirectAccessDefault, isEditable, isValidDesignFile, isValidDesignFile

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.innovationgate.webgate.api.WGDesignProvider

getFileEncoding

Field Detail

OPTION_NO_BACKGROUND_CHANGES

public static final java.lang.String OPTION_NO_BACKGROUND_CHANGES

See Also:

Constant Field Values

OPTION_SYNC

public static final java.lang.String OPTION_SYNC

See Also:

Constant Field Values

Constructor Detail

FileSystemDesignProvider

public FileSystemDesignProvider(de.innovationgate.wga.config.DesignReference ref,
                        WGACore core,
                        de.innovationgate.webgate.api.WGDatabase db,
                        java.lang.String path,
                        java.util.Map<java.lang.String,java.lang.String> options)
                         throws WGDesignSyncException,
                                java.io.IOException,
                                de.innovationgate.webgate.api.WGAPIException,
                                java.lang.InstantiationException,
                                java.lang.IllegalAccessException,
                                de.innovationgate.wga.common.beans.csconfig.v1.InvalidCSConfigVersionException

Throws:

WGDesignSyncException

java.io.IOException

de.innovationgate.webgate.api.WGAPIException

java.lang.InstantiationException

java.lang.IllegalAccessException

de.innovationgate.wga.common.beans.csconfig.v1.InvalidCSConfigVersionException

Method Detail

providesType

public boolean providesType(int type)

Specified by:

providesType in interface de.innovationgate.webgate.api.WGDesignProvider

addDesignChangeListener

public void addDesignChangeListener(de.innovationgate.webgate.api.WGDesignChangeListener changeListener)

Specified by:

addDesignChangeListener in interface de.innovationgate.webgate.api.WGDesignProvider

createDesignDocument

public de.innovationgate.webgate.api.WGDocumentCore createDesignDocument(int type,
                                                                java.lang.String name,
                                                                java.lang.String mediaKey)
                                                                  throws de.innovationgate.webgate.api.WGAuthorisationException,
                                                                         de.innovationgate.webgate.api.WGCreationException

Specified by:

createDesignDocument in interface de.innovationgate.webgate.api.WGDesignProvider

Throws:

de.innovationgate.webgate.api.WGAuthorisationException

de.innovationgate.webgate.api.WGCreationException

dispose

public void dispose()

Specified by:

dispose in interface de.innovationgate.webgate.api.WGDesignProvider

getDesignObject

public de.innovationgate.webgate.api.WGDocumentCore getDesignObject(int type,
                                                           java.lang.String name,
                                                           java.lang.String strMediaKey)
                                                             throws de.innovationgate.webgate.api.WGBackendException

Specified by:

getDesignObject in interface de.innovationgate.webgate.api.WGDesignProvider

Throws:

de.innovationgate.webgate.api.WGBackendException

clearCache

public void clearCache()
                throws de.innovationgate.webgate.api.WGException

Description copied from interface: WGADesignProvider

Clears all design caches

Specified by:

clearCache in interface WGADesignProvider

Throws:

de.innovationgate.webgate.api.WGException

wrapVariantCore

public de.innovationgate.webgate.api.WGDocumentCore wrapVariantCore(de.innovationgate.webgate.api.WGDocumentCore core)
                                                             throws de.innovationgate.webgate.api.WGAPIException

Throws:

de.innovationgate.webgate.api.WGAPIException

getDesignObjects

public java.util.List<de.innovationgate.webgate.api.WGDocumentCore> getDesignObjects(int type)
                                                                              throws de.innovationgate.webgate.api.WGBackendException

Specified by:

getDesignObjects in interface de.innovationgate.webgate.api.WGDesignProvider

Throws:

de.innovationgate.webgate.api.WGBackendException

getName

public java.lang.String getName()

Specified by:

getName in interface de.innovationgate.webgate.api.WGDesignProvider

isNotifying

public boolean isNotifying()

Specified by:

isNotifying in interface de.innovationgate.webgate.api.WGDesignProvider

isProviderCore

public boolean isProviderCore(de.innovationgate.webgate.api.WGDocumentCore core)

Specified by:

isProviderCore in interface de.innovationgate.webgate.api.WGDesignProvider

removeDesignChangeListener

public void removeDesignChangeListener(de.innovationgate.webgate.api.WGDesignChangeListener changeListener)

Specified by:

removeDesignChangeListener in interface de.innovationgate.webgate.api.WGDesignProvider

getConsumerDatabase

public de.innovationgate.webgate.api.WGDatabase getConsumerDatabase()

Description copied from interface: WGADesignProvider

Returns the database that consumes the designs of this provider

Specified by:

getConsumerDatabase in interface WGADesignProvider

isLookupVariants

public boolean isLookupVariants()

Description copied from interface: WGADesignProvider

Returns if the provider is configured to lookup design variants

Specified by:

isLookupVariants in interface WGADesignProvider

closeSession

public void closeSession()

Specified by:

closeSession in interface de.innovationgate.webgate.api.WGDesignProvider

openSession

public void openSession(de.innovationgate.webgate.api.WGSessionContext context)

Specified by:

openSession in interface de.innovationgate.webgate.api.WGDesignProvider

designHashCode

public int designHashCode()

Specified by:

designHashCode in interface de.innovationgate.webgate.api.WGDesignProvider

Overrides:

designHashCode in class FileSystemDesignManager

getDesignReference

public de.innovationgate.wga.config.DesignReference getDesignReference()

determineOverlayStatus

public static OverlayStatus determineOverlayStatus(FileSystemDesignProvider sourceDesignProvider,
                                   de.innovationgate.wga.common.beans.csconfig.v1.PluginID baseId,
                                   org.apache.commons.vfs2.FileObject targetDirectory,
                                   java.lang.String targetEncoding,
                                   org.apache.log4j.Logger log,
                                   DesignFileValidator validator)
                                            throws java.lang.Exception

Throws:

java.lang.Exception

determineOverlayStatus

public OverlayStatus determineOverlayStatus(PluginDesignProvider originalDesignProvider)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

createDowngradeFiles

public static void createDowngradeFiles(FileSystemDesignProvider originalDesignProvider,
                        OverlayData data,
                        org.apache.commons.vfs2.FileObject targetFolder,
                        java.lang.String targetEncoding,
                        org.apache.log4j.Logger log)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

upgradeOverlay

public static boolean upgradeOverlay(FileSystemDesignProvider originalDesignProvider,
                     de.innovationgate.wga.common.beans.csconfig.v1.PluginID baseId,
                     OverlayStatus status,
                     org.apache.commons.vfs2.FileObject targetFolder,
                     java.lang.String targetEncoding,
                     org.apache.log4j.Logger log,
                     DesignFileValidator validator)
                              throws java.lang.Exception

Throws:

java.lang.Exception

upgradeOverlay

public boolean upgradeOverlay(PluginDesignProvider originalDesignProvider,
                     OverlayStatus status)
                       throws java.lang.Exception

Throws:

java.lang.Exception

createDowngradeFiles

public void createDowngradeFiles(PluginDesignProvider originalDesignProvider,
                        OverlayData data)
                          throws java.lang.Exception

Throws:

java.lang.Exception

isReady

public boolean isReady()

Description copied from interface: WGADesignProvider

A design provider may notify via this method if the design backend is currently ready

Specified by:

isReady in interface WGADesignProvider

isSynchronizeAccess

public boolean isSynchronizeAccess()

Specified by:

isSynchronizeAccess in interface de.innovationgate.webgate.api.WGDesignProvider

isNoBackgroundChanges

public boolean isNoBackgroundChanges()