de.innovationgate.wgpublisher.design

Class OverlayDesignProvider

java.lang.Object

de.innovationgate.wgpublisher.design.OverlayDesignProvider

All Implemented Interfaces:

de.innovationgate.webgate.api.WGDesignProvider, WGADesignProvider

public class OverlayDesignProvider
extends java.lang.Object
implements WGADesignProvider

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OverlayDesignProvider.ApplyOverlayDesignOccasion
static class	OverlayDesignProvider.ConflictProblem

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	OVERLAY_DATA_FILE
static java.lang.String	OVERLAY_FOLDER
static java.lang.String	OVERLAY_PREFIX

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

OPTION_DESIGNVARIANTS

Constructor Summary

Constructors

Constructor and Description
OverlayDesignProvider(WGACore core, de.innovationgate.webgate.api.WGDatabase consumer, WGADesignProvider overlayProvider, PluginDesignProvider originalProvider, java.lang.String initialBaseVersionStr)

Method Summary

Methods

Modifier and Type	Method and Description
void	addDesignChangeListener(de.innovationgate.webgate.api.WGDesignChangeListener changeListener)
static void	applyOverlayDesign(WGACore core, de.innovationgate.webgate.api.WGDatabase db, WGADesign originalDesign, java.util.Map<java.lang.String,java.lang.String> originalOptions, WGADesign overlayDesign, java.util.Map<java.lang.String,java.lang.String> overlayOptions)
void	clearCache() Clears all design caches
void	closeSession()
de.innovationgate.webgate.api.WGDocumentCore	createDesignDocument(int type, java.lang.String name, java.lang.String mediaKey)
void	createOverlayDowngradeFiles()
int	designHashCode()
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	getDesignObjects(int type)
de.innovationgate.webgate.api.WGDesignProvider	getDesignProvider(int type, java.lang.String name, java.lang.String strMediaKey)
java.lang.String	getFileEncoding()
de.innovationgate.wga.common.beans.csconfig.v1.Version	getInitialBaseVersion()
java.lang.String	getName()
PluginDesignProvider	getOriginal()
WGADesignProvider	getOverlay()
OverlayStatus	getStatus()
boolean	isLookupVariants() Returns if the provider is configured to lookup design variants
boolean	isNotifying()
boolean	isOverlayWriteable()
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()
boolean	isUpgradeable()
void	openSession(de.innovationgate.webgate.api.WGSessionContext context)
boolean	providesType(int type)
void	removeDesignChangeListener(de.innovationgate.webgate.api.WGDesignChangeListener changeListener)
void	upgradeOverlay()

Methods inherited from class java.lang.Object

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

Field Detail

OVERLAY_FOLDER

public static final java.lang.String OVERLAY_FOLDER

See Also:

Constant Field Values

OVERLAY_PREFIX

public static final java.lang.String OVERLAY_PREFIX

See Also:

Constant Field Values

OVERLAY_DATA_FILE

public static final java.lang.String OVERLAY_DATA_FILE

See Also:

Constant Field Values

Constructor Detail

OverlayDesignProvider

public OverlayDesignProvider(WGACore core,
                     de.innovationgate.webgate.api.WGDatabase consumer,
                     WGADesignProvider overlayProvider,
                     PluginDesignProvider originalProvider,
                     java.lang.String initialBaseVersionStr)
                      throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

applyOverlayDesign

public static final void applyOverlayDesign(WGACore core,
                      de.innovationgate.webgate.api.WGDatabase db,
                      WGADesign originalDesign,
                      java.util.Map<java.lang.String,java.lang.String> originalOptions,
                      WGADesign overlayDesign,
                      java.util.Map<java.lang.String,java.lang.String> overlayOptions)
                                     throws de.innovationgate.webgate.api.WGException

Throws:

de.innovationgate.webgate.api.WGException

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

addDesignChangeListener

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

Specified by:

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

closeSession

public void closeSession()
                  throws de.innovationgate.webgate.api.WGBackendException

Specified by:

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

Throws:

de.innovationgate.webgate.api.WGBackendException

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

designHashCode

public int designHashCode()

Specified by:

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

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.WGAPIException

Specified by:

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

Throws:

de.innovationgate.webgate.api.WGAPIException

getDesignProvider

public de.innovationgate.webgate.api.WGDesignProvider getDesignProvider(int type,
                                                               java.lang.String name,
                                                               java.lang.String strMediaKey)

getDesignObjects

public java.util.List getDesignObjects(int type)
                                throws de.innovationgate.webgate.api.WGAPIException

Specified by:

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

Throws:

de.innovationgate.webgate.api.WGAPIException

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

openSession

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

Specified by:

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

Throws:

de.innovationgate.webgate.api.WGBackendException

providesType

public boolean providesType(int type)

Specified by:

providesType 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

getOverlay

public WGADesignProvider getOverlay()

getOriginal

public PluginDesignProvider getOriginal()

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

isUpgradeable

public boolean isUpgradeable()
                      throws WGADesignConfigurationException,
                             org.apache.commons.vfs2.FileSystemException,
                             WGDesignSyncException

Throws:

WGADesignConfigurationException

org.apache.commons.vfs2.FileSystemException

WGDesignSyncException

isOverlayWriteable

public boolean isOverlayWriteable()
                           throws WGADesignConfigurationException,
                                  org.apache.commons.vfs2.FileSystemException,
                                  WGDesignSyncException

Throws:

WGADesignConfigurationException

org.apache.commons.vfs2.FileSystemException

WGDesignSyncException

getStatus

public OverlayStatus getStatus()

upgradeOverlay

public void upgradeOverlay()
                    throws java.lang.Exception

Throws:

java.lang.Exception

createOverlayDowngradeFiles

public void createOverlayDowngradeFiles()
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getInitialBaseVersion

public de.innovationgate.wga.common.beans.csconfig.v1.Version getInitialBaseVersion()

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

getFileEncoding

public java.lang.String getFileEncoding()

Specified by:

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