diff options
Diffstat (limited to 'src/main/java/com/gitblit/manager')
10 files changed, 139 insertions, 2 deletions
diff --git a/src/main/java/com/gitblit/manager/IAuthenticationManager.java b/src/main/java/com/gitblit/manager/IAuthenticationManager.java index 33546d90..2665b439 100644 --- a/src/main/java/com/gitblit/manager/IAuthenticationManager.java +++ b/src/main/java/com/gitblit/manager/IAuthenticationManager.java @@ -31,6 +31,7 @@ public interface IAuthenticationManager extends IManager { * * @param httpRequest * @return a user object or null + * @since 1.4.0 */ UserModel authenticate(HttpServletRequest httpRequest); @@ -40,6 +41,7 @@ public interface IAuthenticationManager extends IManager { * @param username * @param key * @return a user object or null +* * @since 1.5.0 */ UserModel authenticate(String username, SshKey key); @@ -52,6 +54,7 @@ public interface IAuthenticationManager extends IManager { * @param httpRequest * @param requiresCertificate * @return a user object or null + * @since 1.4.0 */ UserModel authenticate(HttpServletRequest httpRequest, boolean requiresCertificate); @@ -62,6 +65,7 @@ public interface IAuthenticationManager extends IManager { * @param username * @param password * @return a user object or null + * @since 1.4.0 */ UserModel authenticate(String username, char[] password); @@ -70,6 +74,7 @@ public interface IAuthenticationManager extends IManager { * * @param request * @return the Gitblit cookie for the request or null if not found + * @since 1.4.0 */ String getCookie(HttpServletRequest request); @@ -78,6 +83,7 @@ public interface IAuthenticationManager extends IManager { * * @param response * @param user + * @since 1.4.0 */ void setCookie(HttpServletResponse response, UserModel user); @@ -85,6 +91,7 @@ public interface IAuthenticationManager extends IManager { * Logout a user. * * @param user + * @since 1.4.0 */ void logout(HttpServletResponse response, UserModel user); @@ -92,7 +99,7 @@ public interface IAuthenticationManager extends IManager { * Does the user service support changes to credentials? * * @return true or false - * @since 1.0.0 + * @since 1.4.0 */ boolean supportsCredentialChanges(UserModel user); @@ -101,6 +108,7 @@ public interface IAuthenticationManager extends IManager { * * @param user * @return true if the user service supports display name changes + * @since 1.4.0 */ boolean supportsDisplayNameChanges(UserModel user); @@ -109,6 +117,7 @@ public interface IAuthenticationManager extends IManager { * * @param user * @return true if the user service supports email address changes + * @since 1.4.0 */ boolean supportsEmailAddressChanges(UserModel user); @@ -117,6 +126,7 @@ public interface IAuthenticationManager extends IManager { * * @param user * @return true if the user service supports team membership changes + * @since 1.4.0 */ boolean supportsTeamMembershipChanges(UserModel user); @@ -125,6 +135,7 @@ public interface IAuthenticationManager extends IManager { * * @param user * @return true if the team memberships can be changed + * @since 1.4.0 */ boolean supportsTeamMembershipChanges(TeamModel team); diff --git a/src/main/java/com/gitblit/manager/IFederationManager.java b/src/main/java/com/gitblit/manager/IFederationManager.java index d5880c00..df271749 100644 --- a/src/main/java/com/gitblit/manager/IFederationManager.java +++ b/src/main/java/com/gitblit/manager/IFederationManager.java @@ -36,6 +36,7 @@ public interface IFederationManager extends IManager { * Gitblit is running on a cloud service and may return an adjusted path. * * @return the proposals folder path + * @since 1.4.0 */ File getProposalsFolder(); @@ -45,6 +46,7 @@ public interface IFederationManager extends IManager { * Returns the federation user account. * * @return the federation user account + * @since 1.4.0 */ UserModel getFederationUser(); @@ -53,6 +55,7 @@ public interface IFederationManager extends IManager { * * @param httpRequest * @return the federation user, if authenticated + * @since 1.4.0 */ UserModel authenticate(HttpServletRequest httpRequest); @@ -61,6 +64,7 @@ public interface IFederationManager extends IManager { * try to pull. * * @return list of registered gitblit instances + * @since 1.4.0 */ List<FederationModel> getFederationRegistrations(); @@ -70,6 +74,7 @@ public interface IFederationManager extends IManager { * @param name * the name of the registration * @return a federation registration + * @since 1.4.0 */ FederationModel getFederationRegistration(String url, String name); @@ -77,6 +82,7 @@ public interface IFederationManager extends IManager { * Returns the list of federation sets. * * @return list of federation sets + * @since 1.4.0 */ List<FederationSet> getFederationSets(String gitblitUrl); @@ -84,6 +90,7 @@ public interface IFederationManager extends IManager { * Returns the list of possible federation tokens for this Gitblit instance. * * @return list of federation tokens + * @since 1.4.0 */ List<String> getFederationTokens(); @@ -92,6 +99,7 @@ public interface IFederationManager extends IManager { * * @param type * @return a federation token + * @since 1.4.0 */ String getFederationToken(FederationToken type); @@ -100,6 +108,7 @@ public interface IFederationManager extends IManager { * * @param value * @return a federation token + * @since 1.4.0 */ String getFederationToken(String value); @@ -110,6 +119,7 @@ public interface IFederationManager extends IManager { * @param req * @param token * @return true if the request can be executed + * @since 1.4.0 */ boolean validateFederationRequest(FederationRequest req, String token); @@ -121,6 +131,7 @@ public interface IFederationManager extends IManager { * @param registration * the registration from the pulling Gitblit instance * @return true if acknowledged + * @since 1.4.0 */ boolean acknowledgeFederationStatus(String identification, FederationModel registration); @@ -128,6 +139,7 @@ public interface IFederationManager extends IManager { * Returns the list of registration results. * * @return the list of registration results + * @since 1.4.0 */ List<FederationModel> getFederationResultRegistrations(); @@ -141,6 +153,7 @@ public interface IFederationManager extends IManager { * the url of your gitblit instance to send an email to * administrators * @return true if the proposal was submitted + * @since 1.4.0 */ boolean submitFederationProposal(FederationProposal proposal, String gitblitUrl); @@ -148,6 +161,7 @@ public interface IFederationManager extends IManager { * Returns the list of pending federation proposals * * @return list of federation proposals + * @since 1.4.0 */ List<FederationProposal> getPendingFederationProposals(); @@ -159,6 +173,7 @@ public interface IFederationManager extends IManager { * @param token * the federation token * @return a map of <cloneurl, RepositoryModel> + * @since 1.4.0 */ Map<String, RepositoryModel> getRepositories(String gitblitUrl, String token); @@ -169,6 +184,7 @@ public interface IFederationManager extends IManager { * the url of this Gitblit instance * @param token * @return a potential proposal + * @since 1.4.0 */ FederationProposal createFederationProposal(String gitblitUrl, String token); @@ -177,6 +193,7 @@ public interface IFederationManager extends IManager { * * @param token * @return the specified proposal or null + * @since 1.4.0 */ FederationProposal getPendingFederationProposal(String token); @@ -186,6 +203,7 @@ public interface IFederationManager extends IManager { * @param a * proposal * @return true if the proposal was deleted + * @since 1.4.0 */ boolean deletePendingFederationProposal(FederationProposal proposal); diff --git a/src/main/java/com/gitblit/manager/IGitblit.java b/src/main/java/com/gitblit/manager/IGitblit.java index f3202c01..50ec8b1f 100644 --- a/src/main/java/com/gitblit/manager/IGitblit.java +++ b/src/main/java/com/gitblit/manager/IGitblit.java @@ -46,6 +46,7 @@ public interface IGitblit extends IManager, * @param user * @param repository * @return a list of repository urls + * @since 1.4.0 */ List<RepositoryUrl> getRepositoryUrls(HttpServletRequest request, UserModel user, RepositoryModel repository); @@ -55,6 +56,7 @@ public interface IGitblit extends IManager, * @param user * @param isCreate * @throws GitBlitException + * @since 1.4.0 */ void addUser(UserModel user) throws GitBlitException; @@ -65,6 +67,7 @@ public interface IGitblit extends IManager, * @param username * @param user * @throws GitBlitException + * @since 1.4.0 */ void reviseUser(String username, UserModel user) throws GitBlitException; @@ -73,6 +76,7 @@ public interface IGitblit extends IManager, * * @param team * @param isCreate + * @since 1.4.0 */ void addTeam(TeamModel team) throws GitBlitException; @@ -81,6 +85,7 @@ public interface IGitblit extends IManager, * * @param teamname * @param team + * @since 1.4.0 */ void reviseTeam(String teamname, TeamModel team) throws GitBlitException; @@ -93,6 +98,7 @@ public interface IGitblit extends IManager, * @param user * @return the repository model of the fork, if successful * @throws GitBlitException + * @since 1.4.0 */ RepositoryModel fork(RepositoryModel repository, UserModel user) throws GitBlitException; @@ -101,6 +107,7 @@ public interface IGitblit extends IManager, * repository url panel; * * @return a collection of client applications + * @since 1.4.0 */ Collection<GitClientApplication> getClientApplications(); @@ -108,6 +115,7 @@ public interface IGitblit extends IManager, * Returns the ticket service. * * @return a ticket service + * @since 1.4.0 */ ITicketService getTicketService(); @@ -115,6 +123,7 @@ public interface IGitblit extends IManager, * Returns the SSH public key manager. * * @return the SSH public key manager + * @since 1.5.0 */ IPublicKeyManager getPublicKeyManager(); diff --git a/src/main/java/com/gitblit/manager/IManager.java b/src/main/java/com/gitblit/manager/IManager.java index 115831b9..44df5cdf 100644 --- a/src/main/java/com/gitblit/manager/IManager.java +++ b/src/main/java/com/gitblit/manager/IManager.java @@ -17,8 +17,20 @@ package com.gitblit.manager; public interface IManager { + /** + * Start the manager. + * + * @return the manager + * @since 1.4.0 + */ IManager start(); + /** + * Stop the manager. + * + * @return the manager + * @since 1.4.0 + */ IManager stop(); } diff --git a/src/main/java/com/gitblit/manager/INotificationManager.java b/src/main/java/com/gitblit/manager/INotificationManager.java index 6bee2f8e..231cf43a 100644 --- a/src/main/java/com/gitblit/manager/INotificationManager.java +++ b/src/main/java/com/gitblit/manager/INotificationManager.java @@ -26,6 +26,7 @@ public interface INotificationManager extends IManager { * * @param subject * @param message + * @since 1.4.0 */ void sendMailToAdministrators(String subject, String message); @@ -35,6 +36,7 @@ public interface INotificationManager extends IManager { * @param subject * @param message * @param toAddresses + * @since 1.4.0 */ void sendMail(String subject, String message, Collection<String> toAddresses); @@ -44,6 +46,7 @@ public interface INotificationManager extends IManager { * @param subject * @param message * @param toAddresses + * @since 1.4.0 */ void sendHtmlMail(String subject, String message, Collection<String> toAddresses); @@ -52,6 +55,7 @@ public interface INotificationManager extends IManager { * * @param mailing * @return the mail message object + * @since 1.4.0 */ void send(Mailing mailing); diff --git a/src/main/java/com/gitblit/manager/IPluginManager.java b/src/main/java/com/gitblit/manager/IPluginManager.java index 528bbed4..d8fe0f85 100644 --- a/src/main/java/com/gitblit/manager/IPluginManager.java +++ b/src/main/java/com/gitblit/manager/IPluginManager.java @@ -32,16 +32,19 @@ public interface IPluginManager extends IManager { * Returns the system version. * * @return the system version + * @since 1.5.0 */ Version getSystemVersion(); /** * Starts all plugins. + * @since 1.5.0 */ void startPlugins(); /** * Stops all plugins. + * @since 1.5.0 */ void stopPlugins(); @@ -50,6 +53,7 @@ public interface IPluginManager extends IManager { * * @param pluginId * @return the state of the plugin + * @since 1.5.0 */ PluginState startPlugin(String pluginId); @@ -58,6 +62,7 @@ public interface IPluginManager extends IManager { * * @param pluginId * @return the state of the plugin + * @since 1.5.0 */ PluginState stopPlugin(String pluginId); @@ -66,6 +71,7 @@ public interface IPluginManager extends IManager { * * @param type * @return a list of extensions the plugin provides + * @since 1.5.0 */ List<Class<?>> getExtensionClasses(String pluginId); @@ -74,6 +80,7 @@ public interface IPluginManager extends IManager { * * @param type * @return a list of extension instances + * @since 1.5.0 */ <T> List<T> getExtensions(Class<T> type); @@ -81,6 +88,7 @@ public interface IPluginManager extends IManager { * Returns the list of all resolved plugins. * * @return a list of resolved plugins + * @since 1.5.0 */ List<PluginWrapper> getPlugins(); @@ -89,6 +97,7 @@ public interface IPluginManager extends IManager { * * @param pluginId * @return the plugin wrapper + * @since 1.5.0 */ PluginWrapper getPlugin(String pluginId); @@ -97,6 +106,7 @@ public interface IPluginManager extends IManager { * * @param clazz extension point class to retrieve extension for * @return PluginWrapper that loaded the given class + * @since 1.5.0 */ PluginWrapper whichPlugin(Class<?> clazz); @@ -105,6 +115,7 @@ public interface IPluginManager extends IManager { * * @param pluginId * @return true if successful + * @since 1.5.0 */ boolean disablePlugin(String pluginId); @@ -113,6 +124,7 @@ public interface IPluginManager extends IManager { * * @param pluginId * @return true if successful + * @since 1.5.0 */ boolean enablePlugin(String pluginId); @@ -121,6 +133,7 @@ public interface IPluginManager extends IManager { * * @param pluginId * @return true if successful + * @since 1.5.0 */ boolean uninstallPlugin(String pluginId); @@ -128,6 +141,7 @@ public interface IPluginManager extends IManager { * Refresh the plugin registry. * * @param verifyChecksum + * @since 1.5.0 */ boolean refreshRegistry(boolean verifyChecksum); @@ -136,6 +150,7 @@ public interface IPluginManager extends IManager { * * @param url * @param verifyChecksum + * @since 1.5.0 */ boolean installPlugin(String url, boolean verifyChecksum) throws IOException; @@ -147,6 +162,7 @@ public interface IPluginManager extends IManager { * @param verifyChecksum * @return true if the upgrade has been successful * @throws IOException + * @since 1.5.0 */ boolean upgradePlugin(String pluginId, String url, boolean verifyChecksum) throws IOException; @@ -154,6 +170,7 @@ public interface IPluginManager extends IManager { * The list of all registered plugins. * * @return a list of registered plugins + * @since 1.5.0 */ List<PluginRegistration> getRegisteredPlugins(); @@ -162,6 +179,7 @@ public interface IPluginManager extends IManager { * * @param state * @return the list of plugins that match the install state + * @since 1.5.0 */ List<PluginRegistration> getRegisteredPlugins(InstallState state); @@ -170,6 +188,7 @@ public interface IPluginManager extends IManager { * * @param idOrName * @return a plugin registration or null + * @since 1.5.0 */ PluginRegistration lookupPlugin(String idOrName); @@ -179,6 +198,7 @@ public interface IPluginManager extends IManager { * @param idOrName * @param version (use null for the current version) * @return the identified plugin version or null + * @since 1.5.0 */ PluginRelease lookupRelease(String idOrName, String version); } diff --git a/src/main/java/com/gitblit/manager/IProjectManager.java b/src/main/java/com/gitblit/manager/IProjectManager.java index c5b490e5..730eec7e 100644 --- a/src/main/java/com/gitblit/manager/IProjectManager.java +++ b/src/main/java/com/gitblit/manager/IProjectManager.java @@ -29,6 +29,7 @@ public interface IProjectManager extends IManager { * @param user * @param includeUsers * @return list of projects that are accessible to the user + * @since 1.4.0 */ List<ProjectModel> getProjectModels(UserModel user, boolean includeUsers); @@ -38,6 +39,7 @@ public interface IProjectManager extends IManager { * @param name * @param user * @return a project model, or null if it does not exist + * @since 1.4.0 */ ProjectModel getProjectModel(String name, UserModel user); @@ -46,6 +48,7 @@ public interface IProjectManager extends IManager { * * @param name a project name * @return a project model or null if the project does not exist + * @since 1.4.0 */ ProjectModel getProjectModel(String name); @@ -57,6 +60,7 @@ public interface IProjectManager extends IManager { * @param repositoryModels * @param includeUsers * @return a list of project models + * @since 1.4.0 */ List<ProjectModel> getProjectModels(List<RepositoryModel> repositoryModels, boolean includeUsers); diff --git a/src/main/java/com/gitblit/manager/IRepositoryManager.java b/src/main/java/com/gitblit/manager/IRepositoryManager.java index 23c61cb4..fd5fc14b 100644 --- a/src/main/java/com/gitblit/manager/IRepositoryManager.java +++ b/src/main/java/com/gitblit/manager/IRepositoryManager.java @@ -37,6 +37,7 @@ public interface IRepositoryManager extends IManager { * Gitblit is running on a cloud service and may return an adjusted path. * * @return the repositories folder path + * @since 1.4.0 */ File getRepositoriesFolder(); @@ -45,6 +46,7 @@ public interface IRepositoryManager extends IManager { * Gitblit is running on a cloud service and may return an adjusted path. * * @return the Groovy hook scripts folder path + * @since 1.4.0 */ File getHooksFolder(); @@ -53,6 +55,7 @@ public interface IRepositoryManager extends IManager { * Gitblit is running on a cloud service and may return an adjusted path. * * @return the Groovy grapes folder path + * @since 1.4.0 */ File getGrapesFolder(); @@ -60,6 +63,7 @@ public interface IRepositoryManager extends IManager { * Returns the most recent change date of any repository served by Gitblit. * * @return a date + * @since 1.4.0 */ Date getLastActivityDate(); @@ -69,6 +73,7 @@ public interface IRepositoryManager extends IManager { * * @param user * @return the effective list of permissions for the user + * @since 1.4.0 */ List<RegistrantAccessPermission> getUserAccessPermissions(UserModel user); @@ -79,6 +84,7 @@ public interface IRepositoryManager extends IManager { * * @param repository * @return a list of RegistrantAccessPermissions + * @since 1.4.0 */ List<RegistrantAccessPermission> getUserAccessPermissions(RepositoryModel repository); @@ -88,6 +94,7 @@ public interface IRepositoryManager extends IManager { * @param repository * @param permissions * @return true if the user models have been updated + * @since 1.4.0 */ boolean setUserAccessPermissions(RepositoryModel repository, Collection<RegistrantAccessPermission> permissions); @@ -98,6 +105,7 @@ public interface IRepositoryManager extends IManager { * @see IUserService.getUsernamesForRepositoryRole(String) * @param repository * @return list of all usernames that have an access permission for the repository + * @since 1.4.0 */ List<String> getRepositoryUsers(RepositoryModel repository); @@ -108,6 +116,7 @@ public interface IRepositoryManager extends IManager { * * @param repository * @return a list of RegistrantAccessPermissions + * @since 1.4.0 */ List<RegistrantAccessPermission> getTeamAccessPermissions(RepositoryModel repository); @@ -117,6 +126,7 @@ public interface IRepositoryManager extends IManager { * @param repository * @param permissions * @return true if the team models have been updated + * @since 1.4.0 */ boolean setTeamAccessPermissions(RepositoryModel repository, Collection<RegistrantAccessPermission> permissions); @@ -127,6 +137,7 @@ public interface IRepositoryManager extends IManager { * @see IUserService.getTeamnamesForRepositoryRole(String) * @param repository * @return list of all teamnames with explicit access permissions to the repository + * @since 1.4.0 */ List<String> getRepositoryTeams(RepositoryModel repository); @@ -135,12 +146,15 @@ public interface IRepositoryManager extends IManager { * configured to cache the repository list. * * @param model + * @since 1.4.0 */ void addToCachedRepositoryList(RepositoryModel model); /** * Resets the repository list cache. * + * @since 1.4.0 + * */ void resetRepositoryListCache(); @@ -149,6 +163,7 @@ public interface IRepositoryManager extends IManager { * does not consider user access permissions. * * @return list of all repositories + * @since 1.4.0 */ List<String> getRepositoryList(); @@ -157,6 +172,7 @@ public interface IRepositoryManager extends IManager { * * @param repositoryName * @return repository or null + * @since 1.4.0 */ Repository getRepository(String repositoryName); @@ -166,6 +182,7 @@ public interface IRepositoryManager extends IManager { * @param repositoryName * @param logError * @return repository or null + * @since 1.4.0 */ Repository getRepository(String repositoryName, boolean logError); @@ -174,6 +191,7 @@ public interface IRepositoryManager extends IManager { * * @param user * @return list of repository models accessible to user + * @since 1.4.0 */ List<RepositoryModel> getRepositoryModels(UserModel user); @@ -184,6 +202,7 @@ public interface IRepositoryManager extends IManager { * @param user * @param repositoryName * @return repository model or null + * @since 1.4.0 */ RepositoryModel getRepositoryModel(UserModel user, String repositoryName); @@ -193,6 +212,7 @@ public interface IRepositoryManager extends IManager { * * @param repositoryName * @return repository model or null + * @since 1.4.0 */ RepositoryModel getRepositoryModel(String repositoryName); @@ -201,6 +221,7 @@ public interface IRepositoryManager extends IManager { * * @param repository * @return the star count + * @since 1.4.0 */ long getStarCount(RepositoryModel repository); @@ -209,6 +230,7 @@ public interface IRepositoryManager extends IManager { * * @param n * @return true if the repository exists + * @since 1.4.0 */ boolean hasRepository(String repositoryName); @@ -218,6 +240,7 @@ public interface IRepositoryManager extends IManager { * @param n * @param caseInsensitive * @return true if the repository exists + * @since 1.4.0 */ boolean hasRepository(String repositoryName, boolean caseSensitiveCheck); @@ -228,6 +251,7 @@ public interface IRepositoryManager extends IManager { * @param username * @param origin * @return true the if the user has a fork + * @since 1.4.0 */ boolean hasFork(String username, String origin); @@ -238,6 +262,7 @@ public interface IRepositoryManager extends IManager { * @param username * @param origin * @return the name of the user's fork, null otherwise + * @since 1.4.0 */ String getFork(String username, String origin); @@ -247,6 +272,7 @@ public interface IRepositoryManager extends IManager { * * @param repository * @return a ForkModel + * @since 1.4.0 */ ForkModel getForkNetwork(String repository); @@ -258,6 +284,7 @@ public interface IRepositoryManager extends IManager { * * @param model * @return size in bytes of the repository + * @since 1.4.0 */ long updateLastChangeFields(Repository r, RepositoryModel model); @@ -270,6 +297,7 @@ public interface IRepositoryManager extends IManager { * @param model * @param repository * @return a new array list of metrics + * @since 1.4.0 */ List<Metric> getRepositoryDefaultMetrics(RepositoryModel model, Repository repository); @@ -286,6 +314,7 @@ public interface IRepositoryManager extends IManager { * @param repository * @param isCreate * @throws GitBlitException + * @since 1.4.0 */ void updateRepositoryModel(String repositoryName, RepositoryModel repository, boolean isCreate) throws GitBlitException; @@ -297,6 +326,7 @@ public interface IRepositoryManager extends IManager { * the Git repository * @param repository * the Gitblit repository model + * @since 1.4.0 */ void updateConfiguration(Repository r, RepositoryModel repository); @@ -306,6 +336,7 @@ public interface IRepositoryManager extends IManager { * * @param model * @return true if successful + * @since 1.4.0 */ boolean deleteRepositoryModel(RepositoryModel model); @@ -315,6 +346,7 @@ public interface IRepositoryManager extends IManager { * * @param repositoryName * @return true if successful + * @since 1.4.0 */ boolean deleteRepository(String repositoryName); @@ -323,6 +355,7 @@ public interface IRepositoryManager extends IManager { * .groovy extension * * @return list of available hook scripts + * @since 1.4.0 */ List<String> getAllScripts(); @@ -333,6 +366,7 @@ public interface IRepositoryManager extends IManager { * @param repository * if null only the globally specified scripts are returned * @return a list of scripts + * @since 1.4.0 */ List<String> getPreReceiveScriptsInherited(RepositoryModel repository); @@ -344,6 +378,7 @@ public interface IRepositoryManager extends IManager { * @param repository * optional parameter * @return list of available hook scripts + * @since 1.4.0 */ List<String> getPreReceiveScriptsUnused(RepositoryModel repository); @@ -354,6 +389,7 @@ public interface IRepositoryManager extends IManager { * @param repository * if null only the globally specified scripts are returned * @return a list of scripts + * @since 1.4.0 */ List<String> getPostReceiveScriptsInherited(RepositoryModel repository); @@ -365,6 +401,7 @@ public interface IRepositoryManager extends IManager { * @param repository * optional parameter * @return list of available hook scripts + * @since 1.4.0 */ List<String> getPostReceiveScriptsUnused(RepositoryModel repository); @@ -375,13 +412,15 @@ public interface IRepositoryManager extends IManager { * @param page * @param pageSize * @param repositories - * @return + * @return a list of search results + * @since 1.4.0 */ List<SearchResult> search(String query, int page, int pageSize, List<String> repositories); /** * * @return true if we are running the gc executor + * @since 1.4.0 */ boolean isCollectingGarbage(); @@ -390,18 +429,21 @@ public interface IRepositoryManager extends IManager { * * @param repositoryName * @return true if actively collecting garbage + * @since 1.4.0 */ boolean isCollectingGarbage(String repositoryName); /** * Ensures that all cached repositories are completely closed and their resources * are properly released. + * @since 1.4.0 */ void closeAll(); /** * Ensures that a cached repository is completely closed and it's resources * are properly released. + * @since 1.4.0 */ void close(String repository); @@ -410,6 +452,7 @@ public interface IRepositoryManager extends IManager { * * @param repository * @return true if the repository is idle + * @since 1.4.0 */ boolean isIdle(Repository repository); }
\ No newline at end of file diff --git a/src/main/java/com/gitblit/manager/IRuntimeManager.java b/src/main/java/com/gitblit/manager/IRuntimeManager.java index 94ce3800..acd3a576 100644 --- a/src/main/java/com/gitblit/manager/IRuntimeManager.java +++ b/src/main/java/com/gitblit/manager/IRuntimeManager.java @@ -34,6 +34,7 @@ public interface IRuntimeManager extends IManager { * Returns the preferred timezone for the Gitblit instance. * * @return a timezone + * @since 1.4.0 */ TimeZone getTimezone(); @@ -42,6 +43,7 @@ public interface IRuntimeManager extends IManager { * or if it is merely a repository viewer. * * @return true if Gitblit is serving repositories + * @since 1.4.0 */ boolean isServingRepositories(); @@ -49,6 +51,7 @@ public interface IRuntimeManager extends IManager { * Determine if this Gitblit instance is running in debug mode * * @return true if Gitblit is running in debug mode + * @since 1.4.0 */ boolean isDebugMode(); @@ -56,15 +59,23 @@ public interface IRuntimeManager extends IManager { * Returns the boot date of the Gitblit server. * * @return the boot date of Gitblit + * @since 1.4.0 */ Date getBootDate(); + /** + * Returns the server status. + * + * @return the server status + * @since 1.4.0 + */ ServerStatus getStatus(); /** * Returns the descriptions/comments of the Gitblit config settings. * * @return SettingsModel + * @since 1.4.0 */ ServerSettings getSettingsModel(); @@ -72,6 +83,7 @@ public interface IRuntimeManager extends IManager { * Returns the file object for the specified configuration key. * * @return the file + * @since 1.4.0 */ File getFileOrFolder(String key, String defaultFileOrFolder); @@ -83,6 +95,7 @@ public interface IRuntimeManager extends IManager { * access based on environment or some other indicator. * * @return the file + * @since 1.4.0 */ File getFileOrFolder(String fileOrFolder); @@ -90,6 +103,7 @@ public interface IRuntimeManager extends IManager { * Returns the runtime settings. * * @return settings + * @since 1.4.0 */ IStoredSettings getSettings(); @@ -98,6 +112,7 @@ public interface IRuntimeManager extends IManager { * * @param settings * @return true if the update succeeded + * @since 1.4.0 */ boolean updateSettings(Map<String, String> updatedSettings); }
\ No newline at end of file diff --git a/src/main/java/com/gitblit/manager/IUserManager.java b/src/main/java/com/gitblit/manager/IUserManager.java index 945d6a85..b7ea9c46 100644 --- a/src/main/java/com/gitblit/manager/IUserManager.java +++ b/src/main/java/com/gitblit/manager/IUserManager.java @@ -24,6 +24,7 @@ public interface IUserManager extends IManager, IUserService { * * @param username * @return true if the specified username represents an internal account + * @since 1.4.0 */ boolean isInternalAccount(String username); |