EventBroker (Gerrit Review Plugin API Documentation)

java.lang.Object
- com.google.gerrit.common.EventBroker

All Implemented Interfaces:

EventDispatcher
```
public class EventBroker
extends Object
implements EventDispatcher
```
Distributes Events to listeners if they are allowed to see them

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class EventBroker.Module

Nested Classes
Modifier and Type	Class and Description
`static class`	`EventBroker.Module`

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.google.inject.Provider<com.google.gerrit.reviewdb.server.ReviewDb>`	`dbProvider`
`protected com.google.gerrit.extensions.registration.DynamicSet<UserScopedEventListener>`	`listeners` Listeners to receive changes as they happen (limited by visibility of user).
`protected ChangeNotes.Factory`	`notesFactory`
`protected ProjectCache`	`projectCache`
`protected com.google.gerrit.extensions.registration.DynamicSet<EventListener>`	`unrestrictedListeners` Listeners to receive all changes as they happen.

Constructor Summary

Constructors
Constructor and Description
`EventBroker(com.google.gerrit.extensions.registration.DynamicSet<UserScopedEventListener> listeners, com.google.gerrit.extensions.registration.DynamicSet<EventListener> unrestrictedListeners, ProjectCache projectCache, ChangeNotes.Factory notesFactory, com.google.inject.Provider<com.google.gerrit.reviewdb.server.ReviewDb> dbProvider)`

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`fireEvent(com.google.gerrit.reviewdb.client.Branch.NameKey branchName, RefEvent event)`
`protected void`	`fireEvent(com.google.gerrit.reviewdb.client.Change change, ChangeEvent event)`
`protected void`	`fireEvent(Event event)`
`protected void`	`fireEvent(com.google.gerrit.reviewdb.client.Project.NameKey project, ProjectEvent event)`
`protected void`	`fireEventForUnrestrictedListeners(Event event)`
`protected boolean`	`isVisibleTo(com.google.gerrit.reviewdb.client.Branch.NameKey branchName, CurrentUser user)`
`protected boolean`	`isVisibleTo(com.google.gerrit.reviewdb.client.Change change, CurrentUser user)`
`protected boolean`	`isVisibleTo(Event event, CurrentUser user)`
`protected boolean`	`isVisibleTo(com.google.gerrit.reviewdb.client.Project.NameKey project, CurrentUser user)`
`void`	`postEvent(com.google.gerrit.reviewdb.client.Branch.NameKey branchName, RefEvent event)` Post a stream event that is related to a branch
`void`	`postEvent(com.google.gerrit.reviewdb.client.Change change, ChangeEvent event)` Post a stream event that is related to a change
`void`	`postEvent(Event event)` Post a stream event generically.
`void`	`postEvent(com.google.gerrit.reviewdb.client.Project.NameKey projectName, ProjectEvent event)` Post a stream event that is related to a project.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

listeners

protected final com.google.gerrit.extensions.registration.DynamicSet<UserScopedEventListener> listeners

Listeners to receive changes as they happen (limited by visibility of user).

unrestrictedListeners

protected final com.google.gerrit.extensions.registration.DynamicSet<EventListener> unrestrictedListeners

Listeners to receive all changes as they happen.

projectCache

protected final ProjectCache projectCache

notesFactory

protected final ChangeNotes.Factory notesFactory

dbProvider

protected final com.google.inject.Provider<com.google.gerrit.reviewdb.server.ReviewDb> dbProvider

Constructor Detail

EventBroker

@Inject
public EventBroker(com.google.gerrit.extensions.registration.DynamicSet<UserScopedEventListener> listeners,
                  com.google.gerrit.extensions.registration.DynamicSet<EventListener> unrestrictedListeners,
                  ProjectCache projectCache,
                  ChangeNotes.Factory notesFactory,
                  com.google.inject.Provider<com.google.gerrit.reviewdb.server.ReviewDb> dbProvider)

Method Detail

postEvent
```
public void postEvent(com.google.gerrit.reviewdb.client.Change change,
             ChangeEvent event)
               throws com.google.gwtorm.server.OrmException
```
Description copied from interface: EventDispatcher

Post a stream event that is related to a change

Specified by:

postEvent in interface EventDispatcher

Parameters:
change - The change that the event is related to
event - The event to post

Throws:

com.google.gwtorm.server.OrmException - on failure to post the event due to DB error

postEvent
```
public void postEvent(com.google.gerrit.reviewdb.client.Branch.NameKey branchName,
             RefEvent event)
```
Description copied from interface: EventDispatcher

Post a stream event that is related to a branch

Specified by:

postEvent in interface EventDispatcher

Parameters:
branchName - The branch that the event is related to
event - The event to post

postEvent
```
public void postEvent(com.google.gerrit.reviewdb.client.Project.NameKey projectName,
             ProjectEvent event)
```
Description copied from interface: EventDispatcher

Post a stream event that is related to a project.

Specified by:

postEvent in interface EventDispatcher

Parameters:
projectName - The project that the event is related to.
event - The event to post.

postEvent
```
public void postEvent(Event event)
               throws com.google.gwtorm.server.OrmException
```
Description copied from interface: EventDispatcher

Post a stream event generically.
If you are creating a RefEvent or ChangeEvent from scratch, it is more efficient to use the specific postEvent methods for those use cases.

Specified by:

postEvent in interface EventDispatcher

Parameters:
event - The event to post.

Throws:

com.google.gwtorm.server.OrmException - on failure to post the event due to DB error

fireEventForUnrestrictedListeners

protected void fireEventForUnrestrictedListeners(Event event)

fireEvent

protected void fireEvent(com.google.gerrit.reviewdb.client.Change change,
             ChangeEvent event)
                  throws com.google.gwtorm.server.OrmException

Throws:: com.google.gwtorm.server.OrmException

fireEvent

protected void fireEvent(com.google.gerrit.reviewdb.client.Project.NameKey project,
             ProjectEvent event)

fireEvent

protected void fireEvent(com.google.gerrit.reviewdb.client.Branch.NameKey branchName,
             RefEvent event)

fireEvent

protected void fireEvent(Event event)
                  throws com.google.gwtorm.server.OrmException

Throws:: com.google.gwtorm.server.OrmException

isVisibleTo

protected boolean isVisibleTo(com.google.gerrit.reviewdb.client.Project.NameKey project,
                  CurrentUser user)

isVisibleTo

protected boolean isVisibleTo(com.google.gerrit.reviewdb.client.Change change,
                  CurrentUser user)
                       throws com.google.gwtorm.server.OrmException

Throws:: com.google.gwtorm.server.OrmException

isVisibleTo

protected boolean isVisibleTo(com.google.gerrit.reviewdb.client.Branch.NameKey branchName,
                  CurrentUser user)

isVisibleTo

protected boolean isVisibleTo(Event event,
                  CurrentUser user)
                       throws com.google.gwtorm.server.OrmException

Throws:: com.google.gwtorm.server.OrmException

Class EventBroker

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

listeners

unrestrictedListeners

projectCache

notesFactory

dbProvider

Constructor Detail

EventBroker

Method Detail

postEvent

postEvent

postEvent

postEvent

fireEventForUnrestrictedListeners

fireEvent

fireEvent

fireEvent

fireEvent

isVisibleTo

isVisibleTo

isVisibleTo

isVisibleTo