Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

TMF-1946: create a tempo events example plugin (#2) #3

Merged
merged 1 commit into from
Apr 12, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 52 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
BuildInfo.java


# Idea #
########
# Do not commit IntelliJ files
*.iml
*.iws
*.ipr
.idea/
target/
resources/build/
.jar


# Packages #
############
# it's better to unpack these files and commit the raw source
# git has its own built in compression methods
*.7z
*.dmg
*.gz
*.iso
*.jar
*.rar
*.tar
*.zip

# Logs and databases #
######################
*.log
#*.sql
*.sqlite

# OS generated files #
######################
.DS_Store
.DS_Store?
._*
.Spotlight-V100
.Trashes
Icon?
ehthumbs.db
Thumbs.db

# Cloud #
#########
dockertag
build/dist
tempo-cloud-migration/build/dist
classpath-list
.git-history
62 changes: 62 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
# JIRA Plugin for showcasing how to listen to Tempo Events

# Listening to events

[Writing JIRA event listeners with the atlassian-event library](https://developer.atlassian.com/server/jira/platform/writing-jira-event-listeners-with-the-atlassian-event-library)

# Root event class

All public Tempo events implements this :

com.tempoplugin.platform.api.event.Event

Although this is helpful for discovering Tempo events, we do recommend that you listen to other
fine-grained events (see the list below).

Most of the Tempo events have base classes that you can listen without the distinction of the nature
of the event. For example, listening to `AccountEvent`, you will receive events like
`AccountChangedEvent`, `AccountCreatedEvent`, `AccountDeletedEvent`, etc.

Keep in mind that if for example you listen to `AccountEvent` __and__ `AccountChangedEvent`, both
listening methods will be called.

# List of Tempo events

Class [hierarchy](doc/tempo-events.png) of the event classes.

## Tempo Accounts

### Acount
![Account](doc/tempo-events-account.svg)

### Category
![Category](doc/tempo-events-category.svg)

### Customer
![Customer](doc/tempo-events-customer.svg)

## Tempo Budgets

### Folio
![Folio](doc/tempo-events-folio.svg)

### Portfolio
![Portfolio](doc/tempo-events-portfolio.svg)

### Expenditure
![Expenditure](doc/tempo-events-expenditure.svg)

## Tempo Planner

### Allocation
![Allocation](doc/tempo-events-allocation.svg)

## Tempo Teams

### Team
![Team](doc/tempo-events-team.svg)

## Tempo Timesheets

### Approval
![Approval](doc/tempo-events-timesheet-approval.svg)
69 changes: 69 additions & 0 deletions doc/tempo-events-account.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
69 changes: 69 additions & 0 deletions doc/tempo-events-allocation.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
69 changes: 69 additions & 0 deletions doc/tempo-events-category.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
69 changes: 69 additions & 0 deletions doc/tempo-events-customer.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading