com.riadalabs.jira.plugins.insight.channel.external.api.facade.impl

Class ImportSourceConfigurationFacadeImpl

java.lang.Object

com.riadalabs.jira.plugins.insight.channel.external.api.facade.impl.ImportSourceConfigurationFacadeImpl

All Implemented Interfaces:

ImportSourceConfigurationFacade

public class ImportSourceConfigurationFacadeImpl
extends Object
implements ImportSourceConfigurationFacade

Constructor Summary

Constructors

Constructor and Description
ImportSourceConfigurationFacadeImpl(com.riadalabs.jira.plugins.insight.services.core.ImportSourceConfigurationService importSourceConfigurationService, com.riadalabs.jira.plugins.insight.services.imports.common.DefaultImportService defaultImportService, com.riadalabs.jira.plugins.insight.services.util.ErrorMessageTranslator errorMessageTranslator)

Method Summary

Modifier and Type	Method and Description
ImportSource	createPredefinedConfiguration(Integer importSourceId, ObjectTypeBean optionalParent) Create the template configuration as specified by the component.
void	createPredefinedStructure(Integer importSourceId, ObjectTypeBean optionalParent) Creates a predefined structure based on the import component used.
void	deleteImportSource(Integer importSourceId) Deletes an Import Source
void	deleteImportSourceOT(Integer importSourceOT) Deletes an Import Source OT
void	deleteImportSourceOTAttr(Integer importSourceOTAttr) Deletes an Import Source OTA
List<ImportSource>	findImportSourcesByModule(String moduleKey) Finds import sources for a specific import module type (each integration module specifies it's own type with a module key e.g.
List<ImportSource>	findImportSourcesBySchema(Integer objectSchemaId) Finds all import source configurations by the given object schema id.
List<ImportSource>	findImportSourcesForObjectTypeId(Integer objectTypeId) Finds all the import sources where the specified object type id is used in any object type mapping configuration.
ImportSource	loadImportSource(Integer importSourceId) Loads the ImportSource from the database and validates it if it is ready to be synchronised.
ImportSourceOT	loadImportSourceOT(Integer importSourceOTId) Load a specific import source OT configuration item.
ImportSourceOTAttr	loadImportSourceOTAttr(Integer importSourceOTAttrId) Load a specific import source OT Attr configuration item.
ImportSource	loadImportSourceWithMaskedPasswords(Integer importSourceId) Loads the ImportSource from the database and validate if it is ready to be synchronised.
List<String>	passwordFieldNamesInModuleConfig(Integer importSourceId) Retrieves a list of all the keys (the json names) in the ImportSource.getJsonConfiguration() that represents a password field for the given import source.
Progress	startImportSource(int importSourceId) Start an import given the id of the configuration.
Progress	startImportSourceForSpecificOTs(int importSourceId, List<Integer> importSourceOTIds) Start an import given the id of the configuration but only import a specific number of object types.
ImportSource	storeImportSource(ImportSource importSource) Store the entire import source together with all attached ImportSourceOTs and ImportSourceOTAs.
ImportSourceOT	storeImportSourceOT(ImportSourceOT importSourceOT) Store a single import source OT configuration item together with all ImportSourceOTAs.
ImportSourceOTAttr	storeImportSourceOTAttr(ImportSourceOTAttr importSourceOTAttr) Store a single import source OTAttr configuration item together with all ImportSourceOTAs.

Methods inherited from class java.lang.Object

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

Constructor Detail

ImportSourceConfigurationFacadeImpl

public ImportSourceConfigurationFacadeImpl(com.riadalabs.jira.plugins.insight.services.core.ImportSourceConfigurationService importSourceConfigurationService,
                                           com.riadalabs.jira.plugins.insight.services.imports.common.DefaultImportService defaultImportService,
                                           com.riadalabs.jira.plugins.insight.services.util.ErrorMessageTranslator errorMessageTranslator)

Method Detail

findImportSourcesBySchema

public List<ImportSource> findImportSourcesBySchema(Integer objectSchemaId)
                                             throws InsightException

Description copied from interface: ImportSourceConfigurationFacade

Finds all import source configurations by the given object schema id.

Specified by:

findImportSourcesBySchema in interface ImportSourceConfigurationFacade

Returns:

The import sources in the list will have all passwords masked see ImportSourceConfigurationFacade.loadImportSource(Integer)

Throws:

InsightException

findImportSourcesForObjectTypeId

public List<ImportSource> findImportSourcesForObjectTypeId(Integer objectTypeId)
                                                    throws InsightException

Description copied from interface: ImportSourceConfigurationFacade

Finds all the import sources where the specified object type id is used in any object type mapping configuration.

Specified by:

findImportSourcesForObjectTypeId in interface ImportSourceConfigurationFacade

Returns:

A list of import source configurations where each import source contains a ImportSourceOT configuration with the ObjectTypeBean specified by the argument. The import sources in the list will have all passwords masked see ImportSourceConfigurationFacade.loadImportSource(Integer)

Throws:

InsightException

findImportSourcesByModule

public List<ImportSource> findImportSourcesByModule(String moduleKey)
                                             throws InsightException

Description copied from interface: ImportSourceConfigurationFacade

Finds import sources for a specific import module type (each integration module specifies it's own type with a module key e.g. AWS integration specifies insight-aws-import as the module key)

Specified by:

findImportSourcesByModule in interface ImportSourceConfigurationFacade

Returns:

The import sources in the list will have all passwords masked see ImportSourceConfigurationFacade.loadImportSource(Integer)

Throws:

InsightException

loadImportSource

public ImportSource loadImportSource(Integer importSourceId)
                              throws InsightException

Description copied from interface: ImportSourceConfigurationFacade

Loads the ImportSource from the database and validates it if it is ready to be synchronised. If the ImportSource is invalid this method will throw a ValidationInsightException rather than returning an Invalid import source. Note that the validation state of the import source will be persisted to the database. I.e. a call to this function will update the stored import source with the current validation status

Specified by:

loadImportSource in interface ImportSourceConfigurationFacade

Returns:

an import source that can be used to run an import with all validations passed. The resulting import source will have all password fields in the ImportSource.getJsonConfiguration() removed. In other words all password fields (both name and value in the json config) will be missing. To get the password fields (names and masked values) use the ImportSourceConfigurationFacade.loadImportSourceWithMaskedPasswords(Integer) instead.

Throws:

InsightException - / ValidationInsightException if the ImportSource is not valid.

passwordFieldNamesInModuleConfig

public List<String> passwordFieldNamesInModuleConfig(Integer importSourceId)
                                              throws InsightException

Description copied from interface: ImportSourceConfigurationFacade

Retrieves a list of all the keys (the json names) in the ImportSource.getJsonConfiguration() that represents a password field for the given import source. The password fields are masked in the fetched import source as described in ImportSourceConfigurationFacade.loadImportSourceWithMaskedPasswords(Integer)

Specified by:

passwordFieldNamesInModuleConfig in interface ImportSourceConfigurationFacade

Throws:

InsightException

loadImportSourceWithMaskedPasswords

public ImportSource loadImportSourceWithMaskedPasswords(Integer importSourceId)
                                                 throws InsightException

Description copied from interface: ImportSourceConfigurationFacade

Loads the ImportSource from the database and validate if it is ready to be synchronised. If the ImportSource is invalid this method will throw a ValidationInsightException rather than returning an Invalid import source. Note that the validation state of the import source will be persisted to the database. I.e. a call to this function will update the stored import source with the current validation status

Specified by:

loadImportSourceWithMaskedPasswords in interface ImportSourceConfigurationFacade

Returns:

an import source that can be used to run an import with all validations passed. The resulting import source will have all password fields in the ImportSource.getJsonConfiguration() masked. In other words doing a call like storeImportSource(loadImportSourceWithMaskedPasswords(1)) will overwrite the stored passwords in the database with masked values leading to an invalid configuration

Throws:

InsightException

loadImportSourceOT

public ImportSourceOT loadImportSourceOT(Integer importSourceOTId)
                                  throws InsightException

Description copied from interface: ImportSourceConfigurationFacade

Load a specific import source OT configuration item.

Specified by:

loadImportSourceOT in interface ImportSourceConfigurationFacade

Throws:

InsightException

loadImportSourceOTAttr

public ImportSourceOTAttr loadImportSourceOTAttr(Integer importSourceOTAttrId)
                                          throws InsightException

Description copied from interface: ImportSourceConfigurationFacade

Load a specific import source OT Attr configuration item.

Specified by:

loadImportSourceOTAttr in interface ImportSourceConfigurationFacade

Throws:

InsightException

storeImportSource

public ImportSource storeImportSource(ImportSource importSource)
                               throws InsightException

Description copied from interface: ImportSourceConfigurationFacade

Store the entire import source together with all attached ImportSourceOTs and ImportSourceOTAs. If id is left as null new ones will be created

Specified by:

storeImportSource in interface ImportSourceConfigurationFacade

Parameters:

importSource - the import source that will be persisted. If the ImportSource.getId() != null an existing import source will be updated. When an import source is sent to be updated and the ImportSource.getJsonConfiguration() do not have any of the configured password fields present (i.e the json name of the password field is not present at all) the already saved password from the database will be used. In other words in all cases when the passwords are not to be updated the passwords should not be present at all in the ImportSource.getJsonConfiguration()

Returns:

The import source will have all passwords masked see ImportSourceConfigurationFacade.loadImportSource(Integer)

Throws:

InsightException

storeImportSourceOT

public ImportSourceOT storeImportSourceOT(ImportSourceOT importSourceOT)
                                   throws InsightException

Description copied from interface: ImportSourceConfigurationFacade

Store a single import source OT configuration item together with all ImportSourceOTAs. If id is left as null a new one will be created

Specified by:

storeImportSourceOT in interface ImportSourceConfigurationFacade

Throws:

InsightException

storeImportSourceOTAttr

public ImportSourceOTAttr storeImportSourceOTAttr(ImportSourceOTAttr importSourceOTAttr)
                                           throws InsightException

Description copied from interface: ImportSourceConfigurationFacade

Store a single import source OTAttr configuration item together with all ImportSourceOTAs. If id is left as null a new one will be created

Specified by:

storeImportSourceOTAttr in interface ImportSourceConfigurationFacade

Throws:

InsightException

deleteImportSource

public void deleteImportSource(Integer importSourceId)
                        throws InsightException

Description copied from interface: ImportSourceConfigurationFacade

Deletes an Import Source

Specified by:

deleteImportSource in interface ImportSourceConfigurationFacade

Throws:

InsightException

deleteImportSourceOT

public void deleteImportSourceOT(Integer importSourceOT)
                          throws InsightException

Description copied from interface: ImportSourceConfigurationFacade

Deletes an Import Source OT

Specified by:

deleteImportSourceOT in interface ImportSourceConfigurationFacade

Throws:

InsightException

deleteImportSourceOTAttr

public void deleteImportSourceOTAttr(Integer importSourceOTAttr)
                              throws InsightException

Description copied from interface: ImportSourceConfigurationFacade

Deletes an Import Source OTA

Specified by:

deleteImportSourceOTAttr in interface ImportSourceConfigurationFacade

Throws:

InsightException

createPredefinedStructure

public void createPredefinedStructure(Integer importSourceId,
                                      ObjectTypeBean optionalParent)
                               throws InsightException

Description copied from interface: ImportSourceConfigurationFacade

Creates a predefined structure based on the import component used. If the import component does not support a predefined structure an insight exception will be thrown

Specified by:

createPredefinedStructure in interface ImportSourceConfigurationFacade

optionalParent - if this structure should be inserted under a specific parent. If left as null the object type tree will be created on the top level

Throws:

InsightException

createPredefinedConfiguration

public ImportSource createPredefinedConfiguration(Integer importSourceId,
                                                  ObjectTypeBean optionalParent)
                                           throws InsightException

Description copied from interface: ImportSourceConfigurationFacade

Create the template configuration as specified by the component. If something is invalid in the configuration template or an object type is not mappable that one will be ignored. TODO the result of this operation should respond if a configuration was created

Specified by:

createPredefinedConfiguration in interface ImportSourceConfigurationFacade

optionalParent - if this structure should be inserted under a specific parent. If left as null the object type tree will be created on the top level

Returns:

The import source will have all passwords masked see ImportSourceConfigurationFacade.loadImportSource(Integer)

Throws:

InsightException

startImportSource

public Progress startImportSource(int importSourceId)
                           throws InsightException

Description copied from interface: ImportSourceConfigurationFacade

Start an import given the id of the configuration. The returned Progress can be used to determine when the import is done.

Specified by:

startImportSource in interface ImportSourceConfigurationFacade

Throws:

InsightException

startImportSourceForSpecificOTs

public Progress startImportSourceForSpecificOTs(int importSourceId,
                                                List<Integer> importSourceOTIds)
                                         throws InsightException

Description copied from interface: ImportSourceConfigurationFacade

Start an import given the id of the configuration but only import a specific number of object types. Note that the import source ot ids are the ids of the configuration item ant not the id of the object type

Specified by:

startImportSourceForSpecificOTs in interface ImportSourceConfigurationFacade

Throws:

InsightException