|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The basic interface that all Listeners must implement.
All Listeners must also have an empty constructor to that the ListenerFactory can create it.
IssueEventListener
,
UserEventListener
Method Summary | |
String[] |
getAcceptedParams()
Get a list of the parameters for this listener. |
String |
getDescription()
A textual description of the listener. |
void |
init(Map params)
Initialise the listener. |
boolean |
isInternal()
Indicates whether administrators can delete this listener from within the web interface. |
boolean |
isUnique()
Whether this listener class should be unique. |
Method Detail |
public void init(Map params)
For custom listeners, the list of parameters is always empty.
public String[] getAcceptedParams()
public boolean isInternal()
Basically only Atlassian listeners should return true from this.
public boolean isUnique()
Having multiple mail listeners could be fine - if you wanted multiple mails sent out.
With other listeners, such as the cache listeners, it makes no sense to have multiple listeners of the one class.
public String getDescription()
A good description will describe what this listener does, and then explains the parameters required for configuring the listener.
If no description is appropriate, return null.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |