Class MongoDBBackendMetaData
java.lang.Object
com.kingsrook.qqq.backend.core.model.metadata.QBackendMetaData
com.kingsrook.qqq.backend.module.mongodb.model.metadata.MongoDBBackendMetaData
- All Implemented Interfaces:
MetaDataProducerOutput,QMetaDataObject,TopLevelMetaDataInterface,Serializable
Meta-data to provide details of a MongoDB backend (e.g., connection params)
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidRegister BackendFieldFunctionAdapterInterface classes to be used in this backend for known FieldFunctionTypes.voidenrich()Called by the QInstanceEnricher - to do backend-type-specific enrichments.Getter for authSourceDatabaseGetter for databaseNamegetFieldFunctionAdapter(FieldFunctionTypeIdentifier fieldFunctionTypeIdentifier) Get an instance of a MongoDBFieldFunctionAdapterInterface for a specific FieldFunctionType.getHost()Getter for hostGetter for passwordgetPort()Getter for portbooleanGetter for transactionsSupportedGetter for urlSuffixGetter for usernameprotected voidregisterBackendFieldFunctionAdapter(FieldFunctionTypeIdentifier fieldFunctionTypeIdentifier, Class<? extends MongoDBFieldFunctionAdapterInterface> adapterClass) Register a BackendFieldFunctionAdapterInterface class to be used in this backend for a specific FieldFunctionType.voidsetAuthSourceDatabase(String authSourceDatabase) Setter for authSourceDatabasevoidsetDatabaseName(String databaseName) Setter for databaseNamevoidSetter for hostvoidsetPassword(String password) Setter for passwordvoidSetter for portvoidsetTransactionsSupported(boolean transactionsSupported) Setter for transactionsSupportedvoidsetUrlSuffix(String urlSuffix) Setter for urlSuffixvoidsetUsername(String username) Setter for usernamewithAuthSourceDatabase(String authSourceDatabase) Fluent setter for authSourceDatabasewithDatabaseName(String databaseName) Fluent setter for databaseNameFluent Setter for hostFluent setter, override to help fluent flowswithPassword(String password) Fluent Setter for passwordFluent Setter for portwithTransactionsSupported(boolean transactionsSupported) Fluent setter for transactionsSupportedwithUrlSuffix(String urlSuffix) Fluent setter for urlSuffixwithUsername(String username) Fluent Setter for usernameMethods inherited from class com.kingsrook.qqq.backend.core.model.metadata.QBackendMetaData
addSelfToInstance, getBackendType, getBackendVariantsConfig, getDisabledCapabilities, getEnabledCapabilities, getName, getUsesVariants, performValidation, requiresPrimaryKeyOnTables, setBackendType, setBackendType, setBackendVariantsConfig, setDisabledCapabilities, setEnabledCapabilities, setName, setUsesVariants, setVariantOptionsTableApiKeyField, setVariantOptionsTableClientIdField, setVariantOptionsTableClientSecretField, setVariantOptionsTableIdField, setVariantOptionsTableName, setVariantOptionsTableNameField, setVariantOptionsTablePasswordField, setVariantOptionsTableTypeField, setVariantOptionsTableTypeValue, setVariantOptionsTableUsernameField, withBackendType, withBackendVariantsConfig, withCapabilities, withCapabilities, withCapability, withDisabledCapabilities, withEnabledCapabilities, withoutCapabilities, withoutCapabilities, withoutCapability, withUsesVariants, withVariantOptionsTableApiKeyField, withVariantOptionsTableClientIdField, withVariantOptionsTableClientSecretField, withVariantOptionsTableIdField, withVariantOptionsTableName, withVariantOptionsTableNameField, withVariantOptionsTablePasswordField, withVariantOptionsTableTypeField, withVariantOptionsTableTypeValue, withVariantOptionsTableUsernameField
-
Constructor Details
-
MongoDBBackendMetaData
public MongoDBBackendMetaData()Default Constructor.
-
-
Method Details
-
withName
Fluent setter, override to help fluent flows- Overrides:
withNamein classQBackendMetaData
-
getHost
Getter for host -
setHost
Setter for host -
withHost
Fluent Setter for host -
getPort
Getter for port -
setPort
Setter for port -
withPort
Fluent Setter for port -
getUsername
Getter for username -
setUsername
Setter for username -
withUsername
Fluent Setter for username -
getPassword
Getter for password -
setPassword
Setter for password -
withPassword
Fluent Setter for password -
enrich
public void enrich()Called by the QInstanceEnricher - to do backend-type-specific enrichments. Original use case is: reading secrets into fields (e.g., passwords).- Overrides:
enrichin classQBackendMetaData
-
doRegisterFieldFunctionAdapters
public void doRegisterFieldFunctionAdapters()Register BackendFieldFunctionAdapterInterface classes to be used in this backend for known FieldFunctionTypes. If a subclass needs different adapters, it can override this method, should call super to register the base functions first, then register its own override implementations via registerBackendFieldFunctionAdapter. -
registerBackendFieldFunctionAdapter
protected void registerBackendFieldFunctionAdapter(FieldFunctionTypeIdentifier fieldFunctionTypeIdentifier, Class<? extends MongoDBFieldFunctionAdapterInterface> adapterClass) Register a BackendFieldFunctionAdapterInterface class to be used in this backend for a specific FieldFunctionType. -
getFieldFunctionAdapter
public MongoDBFieldFunctionAdapterInterface getFieldFunctionAdapter(FieldFunctionTypeIdentifier fieldFunctionTypeIdentifier) Get an instance of a MongoDBFieldFunctionAdapterInterface for a specific FieldFunctionType. -
getUrlSuffix
Getter for urlSuffix -
setUrlSuffix
Setter for urlSuffix -
withUrlSuffix
Fluent setter for urlSuffix -
getDatabaseName
Getter for databaseName -
setDatabaseName
Setter for databaseName -
withDatabaseName
Fluent setter for databaseName -
getTransactionsSupported
public boolean getTransactionsSupported()Getter for transactionsSupported -
setTransactionsSupported
public void setTransactionsSupported(boolean transactionsSupported) Setter for transactionsSupported -
withTransactionsSupported
Fluent setter for transactionsSupported -
getAuthSourceDatabase
Getter for authSourceDatabase -
setAuthSourceDatabase
Setter for authSourceDatabase -
withAuthSourceDatabase
Fluent setter for authSourceDatabase
-