public class OverlayDesignProvider extends java.lang.Object implements WGADesignProvider
Modifier and Type | Class and Description |
---|---|
static class |
OverlayDesignProvider.ApplyOverlayDesignOccasion |
static class |
OverlayDesignProvider.ConflictProblem |
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 |
OPTION_DESIGNVARIANTS
Constructor and Description |
---|
OverlayDesignProvider(WGACore core,
de.innovationgate.webgate.api.WGDatabase consumer,
WGADesignProvider overlayProvider,
PluginDesignProvider originalProvider,
java.lang.String initialBaseVersionStr) |
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() |
public static final java.lang.String OVERLAY_FOLDER
public static final java.lang.String OVERLAY_PREFIX
public static final java.lang.String OVERLAY_DATA_FILE
public OverlayDesignProvider(WGACore core, de.innovationgate.webgate.api.WGDatabase consumer, WGADesignProvider overlayProvider, PluginDesignProvider originalProvider, java.lang.String initialBaseVersionStr) throws java.lang.Exception
java.lang.Exception
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
de.innovationgate.webgate.api.WGException
public de.innovationgate.webgate.api.WGDatabase getConsumerDatabase()
WGADesignProvider
getConsumerDatabase
in interface WGADesignProvider
public boolean isLookupVariants()
WGADesignProvider
isLookupVariants
in interface WGADesignProvider
public void addDesignChangeListener(de.innovationgate.webgate.api.WGDesignChangeListener changeListener)
addDesignChangeListener
in interface de.innovationgate.webgate.api.WGDesignProvider
public void closeSession() throws de.innovationgate.webgate.api.WGBackendException
closeSession
in interface de.innovationgate.webgate.api.WGDesignProvider
de.innovationgate.webgate.api.WGBackendException
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
createDesignDocument
in interface de.innovationgate.webgate.api.WGDesignProvider
de.innovationgate.webgate.api.WGAuthorisationException
de.innovationgate.webgate.api.WGCreationException
public int designHashCode()
designHashCode
in interface de.innovationgate.webgate.api.WGDesignProvider
public void dispose()
dispose
in interface de.innovationgate.webgate.api.WGDesignProvider
public de.innovationgate.webgate.api.WGDocumentCore getDesignObject(int type, java.lang.String name, java.lang.String strMediaKey) throws de.innovationgate.webgate.api.WGAPIException
getDesignObject
in interface de.innovationgate.webgate.api.WGDesignProvider
de.innovationgate.webgate.api.WGAPIException
public de.innovationgate.webgate.api.WGDesignProvider getDesignProvider(int type, java.lang.String name, java.lang.String strMediaKey)
public java.util.List getDesignObjects(int type) throws de.innovationgate.webgate.api.WGAPIException
getDesignObjects
in interface de.innovationgate.webgate.api.WGDesignProvider
de.innovationgate.webgate.api.WGAPIException
public java.lang.String getName()
getName
in interface de.innovationgate.webgate.api.WGDesignProvider
public boolean isNotifying()
isNotifying
in interface de.innovationgate.webgate.api.WGDesignProvider
public boolean isProviderCore(de.innovationgate.webgate.api.WGDocumentCore core)
isProviderCore
in interface de.innovationgate.webgate.api.WGDesignProvider
public void openSession(de.innovationgate.webgate.api.WGSessionContext context) throws de.innovationgate.webgate.api.WGBackendException
openSession
in interface de.innovationgate.webgate.api.WGDesignProvider
de.innovationgate.webgate.api.WGBackendException
public boolean providesType(int type)
providesType
in interface de.innovationgate.webgate.api.WGDesignProvider
public void removeDesignChangeListener(de.innovationgate.webgate.api.WGDesignChangeListener changeListener)
removeDesignChangeListener
in interface de.innovationgate.webgate.api.WGDesignProvider
public WGADesignProvider getOverlay()
public PluginDesignProvider getOriginal()
public boolean isReady()
WGADesignProvider
isReady
in interface WGADesignProvider
public boolean isSynchronizeAccess()
isSynchronizeAccess
in interface de.innovationgate.webgate.api.WGDesignProvider
public boolean isUpgradeable() throws WGADesignConfigurationException, org.apache.commons.vfs2.FileSystemException, WGDesignSyncException
WGADesignConfigurationException
org.apache.commons.vfs2.FileSystemException
WGDesignSyncException
public boolean isOverlayWriteable() throws WGADesignConfigurationException, org.apache.commons.vfs2.FileSystemException, WGDesignSyncException
WGADesignConfigurationException
org.apache.commons.vfs2.FileSystemException
WGDesignSyncException
public OverlayStatus getStatus()
public void upgradeOverlay() throws java.lang.Exception
java.lang.Exception
public void createOverlayDowngradeFiles() throws java.lang.Exception
java.lang.Exception
public de.innovationgate.wga.common.beans.csconfig.v1.Version getInitialBaseVersion()
public void clearCache() throws de.innovationgate.webgate.api.WGException
WGADesignProvider
clearCache
in interface WGADesignProvider
de.innovationgate.webgate.api.WGException
public java.lang.String getFileEncoding()
getFileEncoding
in interface de.innovationgate.webgate.api.WGDesignProvider