Class Overview
Provides a PostReceiveHook
implementation.
Usage example:
<post-receive-hook key="myPostReceiveHook"
name="Show some example"
class="com.mycompany.example.plugin.myhook.MyPostReceiveHook">
<description>A post-receive hook example that thanks the user for pushing</description>
</post-receive-hook>
The (optional) weight
attribute defines the order in which PostReceiveHook
implementations
will be executed. Lower weights are executed earlier and the default weight is 1000. The module key (of the form
plugin.key:module.key
) will be used as a secondary sort factor to ensure a deterministic order for a given
set of modules. The weight
attribute was added in 3.8 and will be ignored in older versions of Stash.
Adding a weight will not necessarily lead to a stable and predictable execution order, as the overall order depends
on the weight attribute values and module keys of other post-receive hooks that may be added or removed over time.
Summary
[Expand]
Inherited Fields |
From class
com.atlassian.plugin.descriptors.AbstractModuleDescriptor
protected
String |
key |
|
protected
Class<T> |
moduleClass |
|
protected
String |
moduleClassName |
|
protected
final
ModuleFactory |
moduleFactory |
|
protected
String |
name |
|
protected
Plugin |
plugin |
|
protected
Resources |
resources |
|
protected
boolean |
singleton |
|
|
From interface
com.atlassian.stash.util.Weighted
|
[Expand]
Inherited Methods |
From class
com.atlassian.stash.hook.BaseScmHookModuleDescriptor
|
From class
com.atlassian.stash.scm.BaseWeightedModuleDescriptor
|
From class
com.atlassian.plugin.descriptors.AbstractModuleDescriptor
final
void
|
assertModuleClassImplements(Class<T> arg0)
|
final
void
|
checkPermissions()
|
void
|
destroy()
|
@Deprecated
void
|
destroy(Plugin arg0)
|
void
|
disabled()
|
void
|
enabled()
|
boolean
|
equals(Object arg0)
|
String
|
getCompleteKey()
|
String
|
getDescription()
|
String
|
getDescriptionKey()
|
String
|
getI18nNameKey()
|
String
|
getKey()
|
Float
|
getMinJavaVersion()
|
abstract
T
|
getModule()
|
Class<T>
|
getModuleClass()
|
String
|
getModuleClassName()
|
String
|
getName()
|
Map<String, String>
|
getParams()
|
Plugin
|
getPlugin()
|
String
|
getPluginKey()
|
Set<String>
|
getRequiredPermissions()
|
ResourceDescriptor
|
getResourceDescriptor(String arg0, String arg1)
|
List<ResourceDescriptor>
|
getResourceDescriptors()
|
List<ResourceDescriptor>
|
getResourceDescriptors(String arg0)
|
ResourceLocation
|
getResourceLocation(String arg0, String arg1)
|
int
|
hashCode()
|
void
|
init(Plugin arg0, Element arg1)
|
boolean
|
isEnabledByDefault()
|
@Deprecated
boolean
|
isSingleton()
|
@Deprecated
boolean
|
isSingletonByDefault()
|
boolean
|
isSystemModule()
|
void
|
loadClass(Plugin arg0, String arg1)
|
@Deprecated
void
|
loadClass(Plugin arg0, Element arg1)
|
void
|
provideValidationRules(ValidationPattern arg0)
|
boolean
|
satisfiesMinJavaVersion()
|
void
|
setPlugin(Plugin arg0)
|
String
|
toString()
|
|
From class
java.lang.Object
Object
|
clone()
|
boolean
|
equals(Object arg0)
|
void
|
finalize()
|
final
Class<?>
|
getClass()
|
int
|
hashCode()
|
final
void
|
notify()
|
final
void
|
notifyAll()
|
String
|
toString()
|
final
void
|
wait()
|
final
void
|
wait(long arg0, int arg1)
|
final
void
|
wait(long arg0)
|
|
From interface
com.atlassian.plugin.ModuleDescriptor
void
|
destroy()
|
void
|
destroy(Plugin arg0)
|
boolean
|
equals(Object arg0)
|
String
|
getCompleteKey()
|
String
|
getDescription()
|
String
|
getDescriptionKey()
|
String
|
getI18nNameKey()
|
String
|
getKey()
|
Float
|
getMinJavaVersion()
|
T
|
getModule()
|
Class<T>
|
getModuleClass()
|
String
|
getName()
|
Map<String, String>
|
getParams()
|
Plugin
|
getPlugin()
|
String
|
getPluginKey()
|
int
|
hashCode()
|
void
|
init(Plugin arg0, Element arg1)
|
boolean
|
isEnabledByDefault()
|
boolean
|
isSystemModule()
|
boolean
|
satisfiesMinJavaVersion()
|
|
From interface
com.atlassian.plugin.Resourced
ResourceDescriptor
|
getResourceDescriptor(String arg0, String arg1)
|
@Deprecated
List<ResourceDescriptor>
|
getResourceDescriptors(String arg0)
|
List<ResourceDescriptor>
|
getResourceDescriptors()
|
ResourceLocation
|
getResourceLocation(String arg0, String arg1)
|
|
From interface
com.atlassian.plugin.StateAware
void
|
disabled()
|
void
|
enabled()
|
|
From interface
com.atlassian.stash.util.Weighted
|
From interface
java.lang.Comparable
|
Fields
public
static
final
String
XML_ELEMENT_NAME
Public Constructors
public
PostReceiveHookModuleDescriptor
(ModuleFactory moduleFactory)