de.innovationgate.wgpublisher.design.db

Class DBDesignProvider

java.lang.Object

de.innovationgate.webgate.api.WGConfigurableTypeDesignProvider

de.innovationgate.wgpublisher.design.db.DBDesignProvider

All Implemented Interfaces:

de.innovationgate.webgate.api.WGDatabaseEventListener, de.innovationgate.webgate.api.WGDesignChangeListener, de.innovationgate.webgate.api.WGDesignProvider, WGADesignProvider, WGACoreEventListener, WGACoreListener, java.util.EventListener

Direct Known Subclasses:

PluginDesignProvider

public class DBDesignProvider
extends de.innovationgate.webgate.api.WGConfigurableTypeDesignProvider
implements WGADesignProvider, de.innovationgate.webgate.api.WGDatabaseEventListener, de.innovationgate.webgate.api.WGDesignChangeListener, WGACoreEventListener

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	OPTION_CROSSLOGINMODE

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

OPTION_DESIGNVARIANTS

Constructor Summary

Constructors

Constructor and Description
DBDesignProvider(de.innovationgate.wga.config.DesignReference ref, WGACore core, de.innovationgate.webgate.api.WGDatabase slaveDB, java.lang.String dbkey, 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()
void	contentStoreConnected(WGACoreEvent event) Called after a content store has been connected
void	contentStoreDisconnected(WGACoreEvent event) Called after a content store has been disconnected
de.innovationgate.webgate.api.WGDocumentCore	createDesignDocument(int type, java.lang.String name, java.lang.String mediaKey)
void	databaseUpdate(de.innovationgate.webgate.api.WGDatabaseEvent event)
void	designChanged(de.innovationgate.webgate.api.WGDesignChangeEvent event)
int	designHashCode()
void	dispose()
de.innovationgate.webgate.api.WGDatabase	getConsumerDatabase() Returns the database that consumes the designs of this provider
de.innovationgate.webgate.api.WGDatabase	getDesignDB()
java.lang.String	getDesignDBKey()
de.innovationgate.webgate.api.WGDocumentCore	getDesignObject(int type, java.lang.String name, java.lang.String mediaKey)
java.util.List<de.innovationgate.webgate.api.WGDocumentCore>	getDesignObjects(int type)
de.innovationgate.wga.config.DesignReference	getDesignReference()
java.lang.String	getFileEncoding()
java.lang.String	getName()
de.innovationgate.webgate.api.WGDatabase	getSlaveDB()
boolean	isLookupVariants() Returns if the provider is configured to lookup design variants
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()
boolean	isTemporary()
void	openSession(de.innovationgate.webgate.api.WGSessionContext context)
void	removeDesignChangeListener(de.innovationgate.webgate.api.WGDesignChangeListener changeListener)
void	shutdownPostDisconnect(WGACoreEvent event) Called on WGA shutdown after databases haved been disconnected
void	shutdownPreDisconnect(WGACoreEvent event) Called on WGA shutdown before databases are disconnected
void	startupPostConnect(WGACoreEvent event) Called on WGA startup after databases have been connected
void	startupPreConnect(WGACoreEvent event) Called on WGA startup before databases are connected
de.innovationgate.webgate.api.WGDocumentCore	wrapVariantCore(de.innovationgate.webgate.api.WGDocumentCore core)

Methods inherited from class de.innovationgate.webgate.api.WGConfigurableTypeDesignProvider

providesType

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

providesType

Field Detail

OPTION_CROSSLOGINMODE

public static final java.lang.String OPTION_CROSSLOGINMODE

See Also:

Constant Field Values

Constructor Detail

DBDesignProvider

public DBDesignProvider(de.innovationgate.wga.config.DesignReference ref,
                WGACore core,
                de.innovationgate.webgate.api.WGDatabase slaveDB,
                java.lang.String dbkey,
                java.util.Map<java.lang.String,java.lang.String> options)

Method Detail

getDesignObjects

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

Specified by:

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

Specified by:

getDesignObjects in class de.innovationgate.webgate.api.WGConfigurableTypeDesignProvider

getDesignObject

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

Specified by:

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

Specified by:

getDesignObject in class de.innovationgate.webgate.api.WGConfigurableTypeDesignProvider

getName

public java.lang.String getName()

Specified by:

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

Specified by:

getName in class de.innovationgate.webgate.api.WGConfigurableTypeDesignProvider

createDesignDocument

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

Specified by:

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

Specified by:

createDesignDocument in class de.innovationgate.webgate.api.WGConfigurableTypeDesignProvider

Throws:

de.innovationgate.webgate.api.WGCreationException

getDesignDBKey

public java.lang.String getDesignDBKey()

Returns:

Returns the designDBKey.

databaseUpdate

public void databaseUpdate(de.innovationgate.webgate.api.WGDatabaseEvent event)

Specified by:

databaseUpdate in interface de.innovationgate.webgate.api.WGDatabaseEventListener

isTemporary

public boolean isTemporary()

Specified by:

isTemporary in interface de.innovationgate.webgate.api.WGDatabaseEventListener

addDesignChangeListener

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

Specified by:

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

Specified by:

addDesignChangeListener in class de.innovationgate.webgate.api.WGConfigurableTypeDesignProvider

removeDesignChangeListener

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

Specified by:

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

Specified by:

removeDesignChangeListener in class de.innovationgate.webgate.api.WGConfigurableTypeDesignProvider

designChanged

public void designChanged(de.innovationgate.webgate.api.WGDesignChangeEvent event)

Specified by:

designChanged in interface de.innovationgate.webgate.api.WGDesignChangeListener

dispose

public void dispose()

Specified by:

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

Specified by:

dispose in class de.innovationgate.webgate.api.WGConfigurableTypeDesignProvider

contentStoreConnected

public void contentStoreConnected(WGACoreEvent event)

Description copied from interface: WGACoreEventListener

Called after a content store has been connected

Specified by:

contentStoreConnected in interface WGACoreEventListener

contentStoreDisconnected

public void contentStoreDisconnected(WGACoreEvent event)

Description copied from interface: WGACoreEventListener

Called after a content store has been disconnected

Specified by:

contentStoreDisconnected in interface WGACoreEventListener

getDesignDB

public de.innovationgate.webgate.api.WGDatabase getDesignDB()
                                                     throws de.innovationgate.webgate.api.WGAPIException

Throws:

de.innovationgate.webgate.api.WGAPIException

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

getSlaveDB

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

shutdownPostDisconnect

public void shutdownPostDisconnect(WGACoreEvent event)

Description copied from interface: WGACoreEventListener

Called on WGA shutdown after databases haved been disconnected

Specified by:

shutdownPostDisconnect in interface WGACoreEventListener

shutdownPreDisconnect

public void shutdownPreDisconnect(WGACoreEvent event)

Description copied from interface: WGACoreEventListener

Called on WGA shutdown before databases are disconnected

Specified by:

shutdownPreDisconnect in interface WGACoreEventListener

startupPostConnect

public void startupPostConnect(WGACoreEvent event)

Description copied from interface: WGACoreEventListener

Called on WGA startup after databases have been connected

Specified by:

startupPostConnect in interface WGACoreEventListener

startupPreConnect

public void startupPreConnect(WGACoreEvent event)

Description copied from interface: WGACoreEventListener

Called on WGA startup before databases are connected

Specified by:

startupPreConnect in interface WGACoreEventListener

isProviderCore

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

Specified by:

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

Specified by:

isProviderCore in class de.innovationgate.webgate.api.WGConfigurableTypeDesignProvider

isNotifying

public boolean isNotifying()

Specified by:

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

Specified by:

isNotifying in class de.innovationgate.webgate.api.WGConfigurableTypeDesignProvider

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

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

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

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

getDesignReference

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

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