From c51db7be8f6f48ddebff5053915be68f77e3fc94 Mon Sep 17 00:00:00 2001 From: James Moger <james.moger@gitblit.com> Date: Fri, 23 May 2014 09:20:25 -0400 Subject: [PATCH] Merged #85 "Tag server-side merges when incremental push tags are enabled" --- src/site/plugins_extensions.mkd | 156 ++++++++++++++++++++++++++++++++++++++++++++++++++- 1 files changed, 151 insertions(+), 5 deletions(-) diff --git a/src/site/plugins_extensions.mkd b/src/site/plugins_extensions.mkd index 6e0e52e..99b6400 100644 --- a/src/site/plugins_extensions.mkd +++ b/src/site/plugins_extensions.mkd @@ -19,6 +19,7 @@ import com.gitblit.manager.IFederationManager; import com.gitblit.manager.IPluginManager; import com.gitblit.manager.IGitblit; +import ro.fortsoft.pf4j.Version; public class ExamplePlugin extends GitblitPlugin { @@ -33,6 +34,53 @@ IFederationManager federation = GitblitContext.getManager(IFederationManager.class); IPluginManager plugins = GitblitContext.getManager(IPluginManager.class); IGitblit gitblit = GitblitContext.getManager(IGitblit.class); + } + + @Override + public void stop() { + } + + @Override + public void onInstall() { + } + + @Override + public void onUpgrade(Version oldVersion) { + } + + @Override + public void onUninstall() { + } +} + +/** + * You can also create Webapp plugins that register pages. + */ +public class ExampleWicketPlugin extends GitblitWicketPlugin { + @Override + public void start() { + } + + @Override + public void stop() { + } + + @Override + public void onInstall() { + } + + @Override + public void onUpgrade(Version oldVersion) { + } + + @Override + public void onUninstall() { + } + + @Override + protected void init(GitblitWicketApp app) { + app.mount("/logo", LogoPage.class); + app.mount("/hello", HelloWorldPage.class); } } ``` @@ -58,14 +106,14 @@ public class MyDispatcher extends DispatchCommand { @Override - protected void setup(UserModel user) { + protected void setup() { // commands in this dispatcher - register(user, CommandA.class); - register(user, CommandB.class); + register(CommandA.class); + register(CommandB.class); // nested dispatchers - register(user, SubDispatcher1.class); - register(user, SubDispatcher2.class); + register(SubDispatcher1.class); + register(SubDispatcher2.class); } @CommandMetaData(name = "commanda", aliases = { "ca" }, description = "description of command a") @@ -168,3 +216,101 @@ } ``` +### Request Filter + +*SINCE 1.6.0* + +You can provide your own custom request filter by subclassing the *HttpRequestFilter* class. + +```java +import com.gitblit.extensions.HttpRequestFilter; +import ro.fortsoft.pf4j.Extension; + +@Extension +public class MyRequestFilter extends HttpRequestFilter { + + @Override + public void doFilter(ServletRequest request, ServletResponse response, + FilterChain chain) throws IOException, ServletException { + } +} +``` + +### User Menu Items + +*SINCE 1.6.0* + +You can provide your own user menu items by subclassing the *UserMenuExtension* class. + +```java +import java.util.Arrays; +import java.util.List; +import ro.fortsoft.pf4j.Extension; +import com.gitblit.extensions.UserMenuExtension; +import com.gitblit.models.Menu.ExternalLinkMenuItem; +import com.gitblit.models.Menu.MenuItem; +import com.gitblit.models.UserModel; + +@Extension +public class MyUserMenuContributor extends UserMenuExtension { + + @Override + public List<MenuItem> getMenuItems(UserModel user) { + MenuItem item = new ExternalLinkMenuItem("Github", String.format("https://github.com/%s", user.username)); + return Arrays.asList(item); + } +} +``` + +### Navigation Links + +*SINCE 1.6.0* + +You can provide your own top-level navigation links by subclassing the *NavLinkExtension* class. + +```java +import java.util.Arrays; +import java.util.List; +import ro.fortsoft.pf4j.Extension; +import com.gitblit.extensions.NavLinkExtension; +import com.gitblit.models.UserModel; + +@Extension +public class MyNavLink extends NavLinkExtension { + + @Override + public List<NavLink> getNavLinks(UserModel user) { + NavLink link = new ExternalLinkMenuItem("Github", String.format("https://github.com/%s", user.username)); + return Arrays.asList(link); + } +} +``` + +### Lifecycle Listener + +*SINCE 1.6.0* + +You can provide a lifecycle listener to be notified when Gitblit has completely started and just before Gitblit is gracefully terminated. + +```java +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import ro.fortsoft.pf4j.Extension; +import com.gitblit.extensions.LifeCycleListener; + +@Extension +public class MyLifeCycleListener extends LifeCycleListener { + + final Logger log = LoggerFactory.getLogger(getClass()); + + @Override + public void onStartup() { + log.info("Gitblit is Ready!!"); + } + + @Override + public void onShutdown() { + log.info("Gitblit is Going Down!!"); + } +} +``` \ No newline at end of file -- Gitblit v1.9.1