Package io.camunda.optimize.service.report

Class ReportService

java.lang.Object

io.camunda.optimize.service.report.ReportService

All Implemented Interfaces:

CollectionReferencingService

@Component
public class ReportService
extends Object
implements CollectionReferencingService

Constructor Summary

Constructors

Constructor	Description
ReportService(ReportWriter reportWriter, ReportReader reportReader, ReportAuthorizationService reportAuthorizationService, ReportRelationService reportRelationService, AuthorizedCollectionService collectionService, AbstractIdentityService identityService, DefinitionService defintionService)

Method Summary

Modifier and Type	Method	Description
IdResponseDto	copyAndMoveReport(String reportId, String userId, String collectionId, String newReportName)
IdResponseDto	copyAndMoveReport(String reportId, String userId, String collectionId, String newReportName, Map<String,String> existingReportCopies, boolean keepSubReportNames)	Note: The existingReportCopies Map might get modified in the context of this method, thus you should not call this method from a context where this map is being modified already.
IdResponseDto	copyReport(String reportId, String userId, String newReportName)
IdResponseDto	createNewCombinedProcessReport(String userId, CombinedReportDefinitionRequestDto combinedReportDefinitionDto)
IdResponseDto	createNewSingleDecisionReport(String userId, SingleDecisionReportDefinitionRequestDto definitionDto)
IdResponseDto	createNewSingleProcessReport(String userId, SingleProcessReportDefinitionRequestDto definitionDto)
void	deleteAllReportsForProcessDefinitionKey(String processDefinitionKey)
void	deleteManagementOrInstantPreviewReport(String reportId)
void	deleteReport(String reportId)
void	deleteReportAsUser(String userId, String reportId, boolean force)
void	ensureCompliesWithCollectionScope(String userId, String collectionId, String reportId)
void	ensureCompliesWithCollectionScope(List<ReportDataDefinitionDto> definitions, DefinitionType definitionType, CollectionDefinitionDto collection)
Set<String>	filterAuthorizedReportIds(String userId, Set<String> reportIds)
List<AuthorizedReportDefinitionResponseDto>	findAndFilterPrivateReports(String userId)
List<AuthorizedReportDefinitionResponseDto>	findAndFilterReports(String userId, String collectionId)
List<ReportDefinitionDto>	getAllAuthorizedReportsForIds(String userId, List<String> reportIds)
List<IdResponseDto>	getAllReportIdsInCollection(String collectionId)
List<ReportDefinitionDto>	getAllReportsForIds(List<String> reportIds)
List<ReportDefinitionDto>	getAllReportsForProcessDefinitionKeyOmitXml(String processDefinitionKey)
List<SingleProcessReportDefinitionRequestDto>	getAllSingleProcessReportsForIdsOmitXml(List<String> reportIds)
Set<ConflictedItemDto>	getConflictedItemsForCollectionDelete(CollectionDefinitionDto definition)
Set<ConflictedItemDto>	getConflictedItemsFromReportDefinition(String userId, String reportId)
ReportDefinitionDto<ReportDataDto>	getReportDefinition(String reportId)
AuthorizedReportDefinitionResponseDto	getReportDefinition(String reportId, String userId)
ConflictResponseDto	getReportDeleteConflictingItems(String userId, String reportId)
void	handleCollectionDeleted(CollectionDefinitionDto definition)
boolean	isReportAllowedForCollectionScope(SingleReportDefinitionDto<?> report, CollectionDefinitionDto collection)
void	updateCombinedProcessReport(String userId, String combinedReportId, CombinedReportDefinitionRequestDto updatedReport)
void	updateDefinitionXmlOfProcessReports(String definitionKey, String definitionXml)
Optional<String>	updateReportDefinitionXmlIfRequiredAndReturn(ReportDefinitionDto reportDefinition)
void	updateSingleDecisionReport(String reportId, SingleDecisionReportDefinitionRequestDto updatedReport, String userId, boolean force)
void	updateSingleProcessReport(String reportId, SingleProcessReportDefinitionRequestDto updatedReport, String userId, boolean force)
void	validateReportDescription(String reportDescription)

Methods inherited from class java.lang.Object

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

Constructor Details

ReportService

public ReportService(ReportWriter reportWriter,
 ReportReader reportReader,
 ReportAuthorizationService reportAuthorizationService,
 ReportRelationService reportRelationService,
 AuthorizedCollectionService collectionService,
 AbstractIdentityService identityService,
 DefinitionService defintionService)

Method Details

getConflictedItemsForCollectionDelete

public Set<ConflictedItemDto> getConflictedItemsForCollectionDelete(CollectionDefinitionDto definition)

Specified by:

getConflictedItemsForCollectionDelete in interface CollectionReferencingService

handleCollectionDeleted

public void handleCollectionDeleted(CollectionDefinitionDto definition)

Specified by:

handleCollectionDeleted in interface CollectionReferencingService

createNewSingleDecisionReport

public IdResponseDto createNewSingleDecisionReport(String userId,
 SingleDecisionReportDefinitionRequestDto definitionDto)

createNewSingleProcessReport

public IdResponseDto createNewSingleProcessReport(String userId,
 SingleProcessReportDefinitionRequestDto definitionDto)

createNewCombinedProcessReport

public IdResponseDto createNewCombinedProcessReport(String userId,
 CombinedReportDefinitionRequestDto combinedReportDefinitionDto)

getReportDeleteConflictingItems

public ConflictResponseDto getReportDeleteConflictingItems(String userId,
 String reportId)

copyReport

public IdResponseDto copyReport(String reportId,
 String userId,
 String newReportName)

copyAndMoveReport

public IdResponseDto copyAndMoveReport(String reportId,
 String userId,
 String collectionId,
 String newReportName)

getAllReportIdsInCollection

public List<IdResponseDto> getAllReportIdsInCollection(String collectionId)

getAllAuthorizedReportsForIds

public List<ReportDefinitionDto> getAllAuthorizedReportsForIds(String userId,
 List<String> reportIds)

getAllReportsForIds

public List<ReportDefinitionDto> getAllReportsForIds(List<String> reportIds)

copyAndMoveReport

public IdResponseDto copyAndMoveReport(String reportId,
 String userId,
 String collectionId,
 String newReportName,
 Map<String,String> existingReportCopies,
 boolean keepSubReportNames)

Note: The existingReportCopies Map might get modified in the context of this method, thus you should not call this method from a context where this map is being modified already. E.g. Don't call it inside a Map.computeIfAbsent(K, java.util.function.Function<? super K, ? extends V>) block on that same map instance.

getReportDefinition

public ReportDefinitionDto<ReportDataDto> getReportDefinition(String reportId)

getReportDefinition

public AuthorizedReportDefinitionResponseDto getReportDefinition(String reportId,
 String userId)

findAndFilterPrivateReports

public List<AuthorizedReportDefinitionResponseDto> findAndFilterPrivateReports(String userId)

deleteAllReportsForProcessDefinitionKey

public void deleteAllReportsForProcessDefinitionKey(String processDefinitionKey)

getAllReportsForProcessDefinitionKeyOmitXml

public List<ReportDefinitionDto> getAllReportsForProcessDefinitionKeyOmitXml(String processDefinitionKey)

getAllSingleProcessReportsForIdsOmitXml

public List<SingleProcessReportDefinitionRequestDto> getAllSingleProcessReportsForIdsOmitXml(List<String> reportIds)

findAndFilterReports

public List<AuthorizedReportDefinitionResponseDto> findAndFilterReports(String userId,
 String collectionId)

updateCombinedProcessReport

public void updateCombinedProcessReport(String userId,
 String combinedReportId,
 CombinedReportDefinitionRequestDto updatedReport)

updateSingleProcessReport

public void updateSingleProcessReport(String reportId,
 SingleProcessReportDefinitionRequestDto updatedReport,
 String userId,
 boolean force)

updateDefinitionXmlOfProcessReports

public void updateDefinitionXmlOfProcessReports(String definitionKey,
 String definitionXml)

updateSingleDecisionReport

public void updateSingleDecisionReport(String reportId,
 SingleDecisionReportDefinitionRequestDto updatedReport,
 String userId,
 boolean force)

deleteReport

public void deleteReport(String reportId)

deleteManagementOrInstantPreviewReport

public void deleteManagementOrInstantPreviewReport(String reportId)

deleteReportAsUser

public void deleteReportAsUser(String userId,
 String reportId,
 boolean force)

getConflictedItemsFromReportDefinition

public Set<ConflictedItemDto> getConflictedItemsFromReportDefinition(String userId,
 String reportId)

validateReportDescription

public void validateReportDescription(String reportDescription)

updateReportDefinitionXmlIfRequiredAndReturn

public Optional<String> updateReportDefinitionXmlIfRequiredAndReturn(ReportDefinitionDto reportDefinition)

ensureCompliesWithCollectionScope

public void ensureCompliesWithCollectionScope(String userId,
 String collectionId,
 String reportId)

ensureCompliesWithCollectionScope

public void ensureCompliesWithCollectionScope(List<ReportDataDefinitionDto> definitions,
 DefinitionType definitionType,
 CollectionDefinitionDto collection)

isReportAllowedForCollectionScope

public boolean isReportAllowedForCollectionScope(SingleReportDefinitionDto<?> report,
 CollectionDefinitionDto collection)

filterAuthorizedReportIds

public Set<String> filterAuthorizedReportIds(String userId,
 Set<String> reportIds)