diff --git a/scm-annotation-processor/src/main/java/sonia/scm/annotation/ClassSetElement.java b/scm-annotation-processor/src/main/java/sonia/scm/annotation/ClassSetElement.java index ffa6d9f16d..fa2eab38ea 100644 --- a/scm-annotation-processor/src/main/java/sonia/scm/annotation/ClassSetElement.java +++ b/scm-annotation-processor/src/main/java/sonia/scm/annotation/ClassSetElement.java @@ -24,7 +24,6 @@ package sonia.scm.annotation; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Strings; import org.w3c.dom.Document; @@ -33,11 +32,7 @@ import org.w3c.dom.Element; import java.util.Map; import java.util.Map.Entry; -//~--- JDK imports ------------------------------------------------------------ -/** - * @author Sebastian Sdorra - */ public class ClassSetElement implements DescriptorElement { private static final String EL_CLASS = "class"; diff --git a/scm-annotation-processor/src/main/java/sonia/scm/annotation/DescriptorElement.java b/scm-annotation-processor/src/main/java/sonia/scm/annotation/DescriptorElement.java index 7407f3951f..aca4aeb41e 100644 --- a/scm-annotation-processor/src/main/java/sonia/scm/annotation/DescriptorElement.java +++ b/scm-annotation-processor/src/main/java/sonia/scm/annotation/DescriptorElement.java @@ -24,24 +24,14 @@ package sonia.scm.annotation; -//~--- non-JDK imports -------------------------------------------------------- import org.w3c.dom.Document; import org.w3c.dom.Element; -/** - * - * @author Sebastian Sdorra - */ + public interface DescriptorElement { - /** - * Method description - * - * - * @param doc - * @param root - */ + public void append(Document doc, Element root); } diff --git a/scm-annotation-processor/src/main/java/sonia/scm/annotation/ScmAnnotationProcessor.java b/scm-annotation-processor/src/main/java/sonia/scm/annotation/ScmAnnotationProcessor.java index 2bcc23e4ad..2d1c838b6e 100644 --- a/scm-annotation-processor/src/main/java/sonia/scm/annotation/ScmAnnotationProcessor.java +++ b/scm-annotation-processor/src/main/java/sonia/scm/annotation/ScmAnnotationProcessor.java @@ -81,9 +81,7 @@ import java.util.Set; import static javax.lang.model.util.ElementFilter.methodsIn; -/** - * @author Sebastian Sdorra - */ + @SupportedAnnotationTypes("*") @MetaInfServices(Processor.class) @SuppressWarnings({"Since16"}) diff --git a/scm-annotation-processor/src/main/java/sonia/scm/annotation/SubscriberElement.java b/scm-annotation-processor/src/main/java/sonia/scm/annotation/SubscriberElement.java index 89d7b7f194..32a55e9143 100644 --- a/scm-annotation-processor/src/main/java/sonia/scm/annotation/SubscriberElement.java +++ b/scm-annotation-processor/src/main/java/sonia/scm/annotation/SubscriberElement.java @@ -24,42 +24,30 @@ package sonia.scm.annotation; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Strings; import org.w3c.dom.Document; import org.w3c.dom.Element; -/** - * - * @author Sebastian Sdorra - */ + public class SubscriberElement implements DescriptorElement { - /** Field description */ private static final String EL_CLASS = "class"; - /** Field description */ private static final String EL_DESCRIPTION = "description"; - /** Field description */ private static final String EL_EVENT = "event"; - /** Field description */ private static final String EL_SUBSCRIBER = "subscriber"; - //~--- constructors --------------------------------------------------------- + private final String description; + + private final String eventType; + + private final String subscriberType; - /** - * Constructs ... - * - * - * @param subscriberType - * @param eventType - * @param description - */ public SubscriberElement(String subscriberType, String eventType, String description) { @@ -68,15 +56,8 @@ public class SubscriberElement implements DescriptorElement this.description = description; } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param doc - * @param root - */ + @Override public void append(Document doc, Element root) { @@ -102,14 +83,4 @@ public class SubscriberElement implements DescriptorElement root.appendChild(subscriberEl); } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private final String description; - - /** Field description */ - private final String eventType; - - /** Field description */ - private final String subscriberType; } diff --git a/scm-annotations/src/main/java/sonia/scm/Default.java b/scm-annotations/src/main/java/sonia/scm/Default.java index 04380bae27..7d8de9db6a 100644 --- a/scm-annotations/src/main/java/sonia/scm/Default.java +++ b/scm-annotations/src/main/java/sonia/scm/Default.java @@ -24,12 +24,9 @@ package sonia.scm; -//~--- non-JDK imports -------------------------------------------------------- import com.google.inject.BindingAnnotation; -//~--- JDK imports ------------------------------------------------------------ - import java.lang.annotation.Documented; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; @@ -40,7 +37,6 @@ import java.lang.annotation.Target; * The default annotation can be used to inject the default implementation of * service. The annotation is mainly used to inject the ServletContext. * - * @author Sebastian Sdorra * @since 2.0.0 */ @Documented diff --git a/scm-annotations/src/main/java/sonia/scm/Priority.java b/scm-annotations/src/main/java/sonia/scm/Priority.java index 28ba5f3711..0ba8275ac1 100644 --- a/scm-annotations/src/main/java/sonia/scm/Priority.java +++ b/scm-annotations/src/main/java/sonia/scm/Priority.java @@ -24,8 +24,6 @@ package sonia.scm; -//~--- JDK imports ------------------------------------------------------------ - import java.lang.annotation.Documented; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; @@ -34,7 +32,6 @@ import java.lang.annotation.Target; /** * - * @author Sebastian Sdorra * @since 2.0.0 */ @Documented diff --git a/scm-annotations/src/main/java/sonia/scm/api/v2/resources/Enrich.java b/scm-annotations/src/main/java/sonia/scm/api/v2/resources/Enrich.java index bbe4870dea..7fdc5fb6df 100644 --- a/scm-annotations/src/main/java/sonia/scm/api/v2/resources/Enrich.java +++ b/scm-annotations/src/main/java/sonia/scm/api/v2/resources/Enrich.java @@ -33,7 +33,6 @@ import java.lang.annotation.Target; /** * Annotation to specify the source of an enricher. * - * @author Sebastian Sdorra * @since 2.0.0 */ @Documented diff --git a/scm-annotations/src/main/java/sonia/scm/event/Event.java b/scm-annotations/src/main/java/sonia/scm/event/Event.java index 3a17a41dd2..7a222482dc 100644 --- a/scm-annotations/src/main/java/sonia/scm/event/Event.java +++ b/scm-annotations/src/main/java/sonia/scm/event/Event.java @@ -24,12 +24,9 @@ package sonia.scm.event; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.plugin.PluginAnnotation; -//~--- JDK imports ------------------------------------------------------------ - import java.lang.annotation.Documented; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; @@ -40,7 +37,6 @@ import java.lang.annotation.Target; * This annotation marks classes which are receivable over the event bus of * scm-manager. * - * @author Sebastian Sdorra * @since 1.33 */ @Documented diff --git a/scm-annotations/src/main/java/sonia/scm/filter/WebElement.java b/scm-annotations/src/main/java/sonia/scm/filter/WebElement.java index 734862958a..596fd64883 100644 --- a/scm-annotations/src/main/java/sonia/scm/filter/WebElement.java +++ b/scm-annotations/src/main/java/sonia/scm/filter/WebElement.java @@ -24,12 +24,9 @@ package sonia.scm.filter; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.plugin.PluginAnnotation; -//~--- JDK imports ------------------------------------------------------------ - import java.lang.annotation.Documented; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; @@ -40,7 +37,6 @@ import java.lang.annotation.Target; * Annotation to register servlets and filters. The annotation is automatically * picked up by the plugin registration processor of SCM-Manager. * - * @author Sebastian Sdorra * @since 2.0.0 */ @Documented @@ -69,14 +65,11 @@ public @interface WebElement * Returns {@code true} if the path patterns are specified as regex patterns. * Default is {@code false}. * - * @return {@code true} if the path patterns are specified as regex patterns */ public boolean regex() default false; /** * Returns an array of init params. - * - * @return array of init params */ public WebInitParam[] initParams() default {}; } diff --git a/scm-annotations/src/main/java/sonia/scm/filter/WebInitParam.java b/scm-annotations/src/main/java/sonia/scm/filter/WebInitParam.java index 4ba84cf8e6..d1d4409494 100644 --- a/scm-annotations/src/main/java/sonia/scm/filter/WebInitParam.java +++ b/scm-annotations/src/main/java/sonia/scm/filter/WebInitParam.java @@ -34,24 +34,13 @@ import java.lang.annotation.Target; * Init param for servlet of filter registration. This annotation can only be * used with {@link WebElement}. * - * @author Sebastian Sdorra */ @Documented @Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) public @interface WebInitParam { - /** - * Name of the init parameter. - * - * @return name of init parameter - */ public String name(); - /** - * Value of the init parameter. - * - * @return value of init parameter - */ public String value(); } diff --git a/scm-annotations/src/main/java/sonia/scm/i18n/I18n.java b/scm-annotations/src/main/java/sonia/scm/i18n/I18n.java index 72184e3ba8..2d1b7c2b93 100644 --- a/scm-annotations/src/main/java/sonia/scm/i18n/I18n.java +++ b/scm-annotations/src/main/java/sonia/scm/i18n/I18n.java @@ -24,8 +24,6 @@ package sonia.scm.i18n; -//~--- JDK imports ------------------------------------------------------------ - import java.lang.annotation.Documented; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; @@ -36,7 +34,6 @@ import java.lang.annotation.Target; * The I18n annotation is used by the I18nMessages class to define the * resource bundle key. * - * @author Sebastian Sdorra * @since 1.37 */ @Documented @@ -46,8 +43,6 @@ public @interface I18n { /** * Returns the key for the resource bundle. - * - * @return resource bundle key */ String value(); } diff --git a/scm-annotations/src/main/java/sonia/scm/plugin/Extension.java b/scm-annotations/src/main/java/sonia/scm/plugin/Extension.java index 7191780e69..0c604a03df 100644 --- a/scm-annotations/src/main/java/sonia/scm/plugin/Extension.java +++ b/scm-annotations/src/main/java/sonia/scm/plugin/Extension.java @@ -24,18 +24,13 @@ package sonia.scm.plugin; -//~--- JDK imports ------------------------------------------------------------ - import java.lang.annotation.Documented; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; -/** - * - * @author Sebastian Sdorra - */ + @Documented @Target({ ElementType.TYPE }) @PluginAnnotation("extension") diff --git a/scm-annotations/src/main/java/sonia/scm/plugin/ExtensionPoint.java b/scm-annotations/src/main/java/sonia/scm/plugin/ExtensionPoint.java index 64963668b6..1a66e8f211 100644 --- a/scm-annotations/src/main/java/sonia/scm/plugin/ExtensionPoint.java +++ b/scm-annotations/src/main/java/sonia/scm/plugin/ExtensionPoint.java @@ -30,10 +30,7 @@ import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; -/** - * - * @author Sebastian Sdorra - */ + @Documented @Target({ ElementType.TYPE }) @PluginAnnotation("extension-point") diff --git a/scm-annotations/src/main/java/sonia/scm/plugin/PluginAnnotation.java b/scm-annotations/src/main/java/sonia/scm/plugin/PluginAnnotation.java index 23c8cfe8e1..2a9aa6918e 100644 --- a/scm-annotations/src/main/java/sonia/scm/plugin/PluginAnnotation.java +++ b/scm-annotations/src/main/java/sonia/scm/plugin/PluginAnnotation.java @@ -24,8 +24,6 @@ package sonia.scm.plugin; -//~--- JDK imports ------------------------------------------------------------ - import java.lang.annotation.Documented; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; @@ -34,7 +32,6 @@ import java.lang.annotation.Target; /** * - * @author Sebastian Sdorra * @since 2.0.0 */ @Documented diff --git a/scm-annotations/src/main/java/sonia/scm/search/Indexed.java b/scm-annotations/src/main/java/sonia/scm/search/Indexed.java index d0bb77c220..7e1d74dffd 100644 --- a/scm-annotations/src/main/java/sonia/scm/search/Indexed.java +++ b/scm-annotations/src/main/java/sonia/scm/search/Indexed.java @@ -59,8 +59,6 @@ public @interface Indexed { /** * {@code true} if this field should be part of default query for this type of object. - * - * @return {@code true} if field is part of default query */ boolean defaultQuery() default false; @@ -76,7 +74,6 @@ public @interface Indexed { /** * {@code true} to search the field value for matches and returns fragments with those matches instead of the whole value. * - * @return {@code true} to return matched fragments */ boolean highlighted() default false; @@ -150,9 +147,6 @@ public @interface Indexed { } /** - * Returns {@code true} if the field is tokenized. - * - * @return {@code true} if tokenized * @see #TOKENIZED */ public boolean isTokenized() { @@ -160,19 +154,12 @@ public @interface Indexed { } /** - * Returns {@code true} if the field is searchable. - * - * @return {@code true} if searchable * @see #SEARCHABLE */ public boolean isSearchable() { return searchable; } - /** - * Returns {@code true} if the field is stored. - * @return {@code true} if stored - */ public boolean isStored() { return stored; } diff --git a/scm-core/src/main/java/sonia/scm/BackendException.java b/scm-core/src/main/java/sonia/scm/BackendException.java index 92955102ff..0635c1f570 100644 --- a/scm-core/src/main/java/sonia/scm/BackendException.java +++ b/scm-core/src/main/java/sonia/scm/BackendException.java @@ -28,55 +28,27 @@ package sonia.scm; * This type of exception is only thrown by scm-manager backend implementation, * such as the xml or jdbc backend. * - * @author Sebastian Sdorra * @since 1.14 */ public class BackendException extends RuntimeException { - - /** Field description */ private static final long serialVersionUID = -6885276113482167556L; - //~--- constructors --------------------------------------------------------- - - /** - * Constructs ... - * - */ public BackendException() { super(); } - /** - * Constructs ... - * - * - * @param message - */ public BackendException(String message) { super(message); } - /** - * Constructs ... - * - * - * @param cause - */ public BackendException(Throwable cause) { super(cause); } - /** - * Constructs ... - * - * - * @param message - * @param cause - */ public BackendException(String message, Throwable cause) { super(message, cause); diff --git a/scm-core/src/main/java/sonia/scm/BaseDirectory.java b/scm-core/src/main/java/sonia/scm/BaseDirectory.java index c461b94d29..f6872a1282 100644 --- a/scm-core/src/main/java/sonia/scm/BaseDirectory.java +++ b/scm-core/src/main/java/sonia/scm/BaseDirectory.java @@ -70,8 +70,6 @@ final class BaseDirectory { /** * Returns the determined base directory. - * - * @return base directory */ @SuppressWarnings("java:S5304") // it is safe to use environment in this case static Path get() { diff --git a/scm-core/src/main/java/sonia/scm/BasicContextProvider.java b/scm-core/src/main/java/sonia/scm/BasicContextProvider.java index 33d38d46dc..c82700c9a8 100644 --- a/scm-core/src/main/java/sonia/scm/BasicContextProvider.java +++ b/scm-core/src/main/java/sonia/scm/BasicContextProvider.java @@ -24,7 +24,6 @@ package sonia.scm; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.annotations.VisibleForTesting; import com.google.common.base.Strings; @@ -40,12 +39,9 @@ import java.nio.file.Path; import java.util.Properties; import java.util.UUID; -//~--- JDK imports ------------------------------------------------------------ - /** * The default implementation of {@link SCMContextProvider}. * - * @author Sebastian Sdorra */ @SuppressWarnings("java:S106") // we can not use logger until base directory is not determined public class BasicContextProvider implements SCMContextProvider @@ -67,10 +63,22 @@ public class BasicContextProvider implements SCMContextProvider /** Maven property for the version of the artifact */ public static final String MAVEN_PROPERTY_VERSION = "version"; - public static final String DEVELOPMENT_INSTANCE_ID = "00000000-0000-0000-0000-000000000000"; - //~--- constructors --------------------------------------------------------- + /** The base directory of the SCM-Manager */ + private File baseDirectory; + + /** stage of the current SCM-Manager instance */ + private Stage stage; + + /** startup exception */ + private Throwable startupError; + + /** the version of the SCM-Manager */ + private String version; + + /** the instance id of the SCM-Manager */ + private String instanceId; /** * Constructs a new {@link BasicContextProvider} object. @@ -101,9 +109,6 @@ public class BasicContextProvider implements SCMContextProvider this.stage = stage; } - //~--- methods -------------------------------------------------------------- - - @Override public Path resolve(Path path) { if (path.isAbsolute()) { @@ -113,29 +118,22 @@ public class BasicContextProvider implements SCMContextProvider return baseDirectory.toPath().resolve(path); } - //~--- get methods ---------------------------------------------------------- - /** - * {@inheritDoc} - */ + @Override public File getBaseDirectory() { return baseDirectory; } - /** - * {@inheritDoc} - */ + @Override public Stage getStage() { return stage; } - /** - * {@inheritDoc} - */ + @Override public Throwable getStartupError() { @@ -145,9 +143,6 @@ public class BasicContextProvider implements SCMContextProvider /** * Returns the version of the SCM-Manager. If the version is not set, the * {@link #VERSION_DEFAULT} is returned. - * - * - * @return the version of the SCM-Manager */ @Override public String getVersion() @@ -160,7 +155,6 @@ public class BasicContextProvider implements SCMContextProvider return instanceId; } - //~--- methods -------------------------------------------------------------- /** * Find the base directory of SCM-Manager. @@ -201,9 +195,6 @@ public class BasicContextProvider implements SCMContextProvider /** * Loads the version of the SCM-Manager from maven properties file. - * - * - * @return the version of the SCM-Manager */ private String loadVersion() { @@ -255,20 +246,5 @@ public class BasicContextProvider implements SCMContextProvider return uuid; } - //~--- fields --------------------------------------------------------------- - /** The base directory of the SCM-Manager */ - private File baseDirectory; - - /** stage of the current SCM-Manager instance */ - private Stage stage; - - /** startup exception */ - private Throwable startupError; - - /** the version of the SCM-Manager */ - private String version; - - /** the instance id of the SCM-Manager */ - private String instanceId; } diff --git a/scm-core/src/main/java/sonia/scm/BasicPropertiesAware.java b/scm-core/src/main/java/sonia/scm/BasicPropertiesAware.java index d554a2a52e..2920dfc65e 100644 --- a/scm-core/src/main/java/sonia/scm/BasicPropertiesAware.java +++ b/scm-core/src/main/java/sonia/scm/BasicPropertiesAware.java @@ -24,7 +24,6 @@ package sonia.scm; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Objects; import com.google.common.collect.Maps; @@ -36,26 +35,20 @@ import sonia.scm.xml.XmlMapStringAdapter; import java.io.Serializable; import java.util.Map; -//~--- JDK imports ------------------------------------------------------------ - /** * Default implementation of {@link PropertiesAware} interface. * - * @author Sebastian Sdorra */ @XmlAccessorType(XmlAccessType.FIELD) public class BasicPropertiesAware implements PropertiesAware, Serializable { - /** Field description */ private static final long serialVersionUID = -536608122577385802L; - //~--- methods -------------------------------------------------------------- + /** map to hold the properties */ + @XmlJavaTypeAdapter(XmlMapStringAdapter.class) + protected Map properties; - /** - * {@inheritDoc} - * - */ @Override public boolean equals(Object obj) { @@ -74,32 +67,22 @@ public class BasicPropertiesAware implements PropertiesAware, Serializable return Objects.equal(properties, other.properties); } - /** - * {@inheritDoc} - * - */ + @Override public int hashCode() { return Objects.hashCode(properties); } - /** - * {@inheritDoc} - * - */ + @Override public void removeProperty(String key) { getProperties().remove(key); } - //~--- get methods ---------------------------------------------------------- - /** - * {@inheritDoc} - * - */ + @Override public Map getProperties() { @@ -111,41 +94,26 @@ public class BasicPropertiesAware implements PropertiesAware, Serializable return properties; } - /** - * {@inheritDoc} - * - */ + @Override public String getProperty(String key) { return getProperties().get(key); } - //~--- set methods ---------------------------------------------------------- - /** - * {@inheritDoc} - * - */ + @Override public void setProperties(Map properties) { this.properties = properties; } - /** - * {@inheritDoc} - * - */ + @Override public void setProperty(String key, String value) { getProperties().put(key, value); } - //~--- fields --------------------------------------------------------------- - - /** map to hold the properties */ - @XmlJavaTypeAdapter(XmlMapStringAdapter.class) - protected Map properties; } diff --git a/scm-core/src/main/java/sonia/scm/ClientMessages.java b/scm-core/src/main/java/sonia/scm/ClientMessages.java index 742b706800..927805719b 100644 --- a/scm-core/src/main/java/sonia/scm/ClientMessages.java +++ b/scm-core/src/main/java/sonia/scm/ClientMessages.java @@ -24,22 +24,20 @@ package sonia.scm; -//~--- non-JDK imports -------------------------------------------------------- import jakarta.servlet.http.HttpServletRequest; import sonia.scm.i18n.I18nMessages; -//~--- JDK imports ------------------------------------------------------------ - /** * I18n messages which are send back to client. * - * @author Sebastian Sdorra * @since 1.37 */ public final class ClientMessages { + private String failedAuthentication; + private String notEnoughPrivileges; /** * Constructs a new instance of ClientMessages. This constructor should not be @@ -48,13 +46,9 @@ public final class ClientMessages */ public ClientMessages() {} - //~--- methods -------------------------------------------------------------- /** * Returns the localized string for a failed authentication. - * - * - * @return localized string */ public String failedAuthentication() { @@ -62,35 +56,21 @@ public final class ClientMessages } /** - * Returns the localized string for "not enough privileges. - * - * - * @return localized string + * Returns the localized string for not enough privileges. */ public String notEnoughPrivileges() { return notEnoughPrivileges; } - //~--- get methods ---------------------------------------------------------- /** * Returns an instance {@link ClientMessages}. * * @param request servlet request - * - * @return instance of client messages */ public static ClientMessages get(HttpServletRequest request) { return I18nMessages.get(ClientMessages.class, request); } - - //~--- fields --------------------------------------------------------------- - - /** failed authentication */ - private String failedAuthentication; - - /** not enough privileges */ - private String notEnoughPrivileges; } diff --git a/scm-core/src/main/java/sonia/scm/ConfigurationException.java b/scm-core/src/main/java/sonia/scm/ConfigurationException.java index 2ec58382ca..cf7985b4d2 100644 --- a/scm-core/src/main/java/sonia/scm/ConfigurationException.java +++ b/scm-core/src/main/java/sonia/scm/ConfigurationException.java @@ -27,54 +27,28 @@ package sonia.scm; /** * Exception for problems with the SCM-Manager configuration. * - * @author Sebastian Sdorra */ public class ConfigurationException extends RuntimeException { - /** Field description */ private static final long serialVersionUID = 3462977946341972841L; - //~--- constructors --------------------------------------------------------- - /** - * Constructs a {@link ConfigurationException} - * - */ public ConfigurationException() { super(); } - /** - * Constructs a {@link ConfigurationException} - * - * - * @param message - */ public ConfigurationException(String message) { super(message); } - /** - * Constructs a {@link ConfigurationException} - * - * - * @param cause - */ public ConfigurationException(Throwable cause) { super(cause); } - /** - * Constructs a {@link ConfigurationException} - * - * - * @param message - * @param cause - */ public ConfigurationException(String message, Throwable cause) { super(message, cause); diff --git a/scm-core/src/main/java/sonia/scm/CreationTimeAware.java b/scm-core/src/main/java/sonia/scm/CreationTimeAware.java index dd3dee0bcd..2a0a2d099e 100644 --- a/scm-core/src/main/java/sonia/scm/CreationTimeAware.java +++ b/scm-core/src/main/java/sonia/scm/CreationTimeAware.java @@ -27,16 +27,12 @@ package sonia.scm; /** * Base interface of all objects which have a creation time. * - * @author Sebastian Sdorra * @since 1.14 */ public interface CreationTimeAware { /** * Returns a timestamp of object creation. - * - * - * @return timestamp of object creation */ public Long getCreationTime(); } diff --git a/scm-core/src/main/java/sonia/scm/DecoratorFactory.java b/scm-core/src/main/java/sonia/scm/DecoratorFactory.java index d9fee9fd20..732dbbc373 100644 --- a/scm-core/src/main/java/sonia/scm/DecoratorFactory.java +++ b/scm-core/src/main/java/sonia/scm/DecoratorFactory.java @@ -27,7 +27,6 @@ package sonia.scm; /** * Factory for decorated objects. * - * @author Sebastian Sdorra * @since 1.23 * * @param @@ -35,13 +34,5 @@ package sonia.scm; public interface DecoratorFactory { - /** - * Create a decorator for the given object. - * - * - * @param object object to decorate - * - * @return decorated object - */ public T createDecorator(T object); } diff --git a/scm-core/src/main/java/sonia/scm/EagerSingleton.java b/scm-core/src/main/java/sonia/scm/EagerSingleton.java index 918026c25b..1589238f38 100644 --- a/scm-core/src/main/java/sonia/scm/EagerSingleton.java +++ b/scm-core/src/main/java/sonia/scm/EagerSingleton.java @@ -24,8 +24,6 @@ package sonia.scm; -//~--- JDK imports ------------------------------------------------------------ - import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; @@ -34,7 +32,6 @@ import java.lang.annotation.Target; /** * Eager singleton scope for injection. * - * @author Sebastian Sdorra * @since 1.23 */ @Target({ ElementType.TYPE, ElementType.METHOD }) diff --git a/scm-core/src/main/java/sonia/scm/ExceptionWithContext.java b/scm-core/src/main/java/sonia/scm/ExceptionWithContext.java index 16c0f0218c..35b3d30d2e 100644 --- a/scm-core/src/main/java/sonia/scm/ExceptionWithContext.java +++ b/scm-core/src/main/java/sonia/scm/ExceptionWithContext.java @@ -65,9 +65,8 @@ public abstract class ExceptionWithContext extends RuntimeException { /** * Returns an url which gives more information about the exception or an empty optional. - * The methods returns an empty optional by default and can be overwritten. + * The method returns an empty optional by default and can be overwritten. * - * @return information url or empty * @since 2.5.0 */ public Optional getUrl() { diff --git a/scm-core/src/main/java/sonia/scm/FeatureNotSupportedException.java b/scm-core/src/main/java/sonia/scm/FeatureNotSupportedException.java index 6b5f4503bc..181231a86e 100644 --- a/scm-core/src/main/java/sonia/scm/FeatureNotSupportedException.java +++ b/scm-core/src/main/java/sonia/scm/FeatureNotSupportedException.java @@ -28,7 +28,6 @@ import java.util.Collections; /** * - * @author Sebastian Sdorra * @version 1.6 */ @SuppressWarnings("squid:MaximumInheritanceDepth") // exceptions have a deep inheritance depth themselves; therefore we accept this here diff --git a/scm-core/src/main/java/sonia/scm/GenericDAO.java b/scm-core/src/main/java/sonia/scm/GenericDAO.java index a0cc204be5..bb56299969 100644 --- a/scm-core/src/main/java/sonia/scm/GenericDAO.java +++ b/scm-core/src/main/java/sonia/scm/GenericDAO.java @@ -21,18 +21,15 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ - -package sonia.scm; -//~--- JDK imports ------------------------------------------------------------ +package sonia.scm; import java.util.Collection; /** * Generic data access object. A DAO does not check the permission of the - * current user. A DAO should only used by a {@link Manager} class. + * current user. A DAO should only be used by a {@link Manager} class. * - * @author Sebastian Sdorra * @since 1.14 * * @param type of object @@ -44,7 +41,6 @@ public interface GenericDAO /** * Persists a new item. * - * * @param item item to persist */ public void add(T item); @@ -52,10 +48,7 @@ public interface GenericDAO /** * Returns true if the item already exists in the backend. * - * * @param item item to check - * - * @return true if the item already exists */ public boolean contains(T item); @@ -63,17 +56,13 @@ public interface GenericDAO * Returns true if the item with the specified id * already exists in the backend. * - * * @param id id of the item to check - * - * @return true if the item already exists */ public boolean contains(String id); /** * Updates an existing item. * - * * @param item item to update */ public void modify(T item); @@ -81,29 +70,20 @@ public interface GenericDAO /** * Removes the specified item from the backend. * - * * @param item item to remove */ public void delete(T item); - //~--- get methods ---------------------------------------------------------- /** * Returns the item by its id or returns null if no item with * the specified id exists in the backend. * - * - * @param id id of the item - * - * @return item with the specified id or null */ public T get(String id); /** * Returns all items stored in the backend. - * - * - * @return all items */ public Collection getAll(); diff --git a/scm-core/src/main/java/sonia/scm/Handler.java b/scm-core/src/main/java/sonia/scm/Handler.java index 0ae5c09e7f..0735e45b38 100644 --- a/scm-core/src/main/java/sonia/scm/Handler.java +++ b/scm-core/src/main/java/sonia/scm/Handler.java @@ -21,13 +21,12 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ - + package sonia.scm; /** * Base interface for all handler objects. * - * @author Sebastian Sdorra * * @param a typed object */ @@ -35,17 +34,11 @@ public interface Handler extends HandlerBase { /** * Returns the type object of the handler. - * - * - * @return type object of the handler */ Type getType(); /** * Returns true if the hanlder is configured. - * - * - * @return true if the hanlder is configured */ boolean isConfigured(); } diff --git a/scm-core/src/main/java/sonia/scm/HandlerBase.java b/scm-core/src/main/java/sonia/scm/HandlerBase.java index fa53568702..d64b5f3dcc 100644 --- a/scm-core/src/main/java/sonia/scm/HandlerBase.java +++ b/scm-core/src/main/java/sonia/scm/HandlerBase.java @@ -21,17 +21,14 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ - -package sonia.scm; -//~--- JDK imports ------------------------------------------------------------ +package sonia.scm; import java.io.Closeable; /** * The base class of all handlers. * - * @author Sebastian Sdorra * * @param type object of the handler */ @@ -41,24 +38,16 @@ public interface HandlerBase /** * Persists a new object. - * - * @return The persisted object. */ T create(T object); /** * Removes a persistent object. - * - * - * @param object to delete */ void delete(T object); /** * Modifies a persistent object. - * - * - * @param object to modify */ void modify(T object); } diff --git a/scm-core/src/main/java/sonia/scm/HandlerEventType.java b/scm-core/src/main/java/sonia/scm/HandlerEventType.java index af4c68eb88..3214028840 100644 --- a/scm-core/src/main/java/sonia/scm/HandlerEventType.java +++ b/scm-core/src/main/java/sonia/scm/HandlerEventType.java @@ -27,7 +27,6 @@ package sonia.scm; /** * Handler event type. * - * @author Sebastian Sdorra */ public enum HandlerEventType { @@ -38,12 +37,12 @@ public enum HandlerEventType CREATE(true), /** - * After a object is modified by a handler. + * After an object is modified by a handler. */ MODIFY(true), /** - * After a object is removed by a handler. + * After an object is removed by a handler. */ DELETE(true), @@ -54,35 +53,25 @@ public enum HandlerEventType BEFORE_CREATE(false), /** - * Before a object is modified by a handler. + * Before an object is modified by a handler. * @since 1.16 */ BEFORE_MODIFY(false), /** - * Before a object is removed by a handler. + * Before an object is removed by a handler. * @since 1.16 */ BEFORE_DELETE(false); - /** - * Constructs ... - * - * - * @param post - */ private HandlerEventType(boolean post) { this.post = post; } - //~--- get methods ---------------------------------------------------------- - /** * Returns true if the event is fired after the action is occurred. * - * - * @return true if the event is fired after the action is occurred * @since 1.21 */ public boolean isPost() @@ -93,8 +82,6 @@ public enum HandlerEventType /** * Returns true if the event is fired before the action is occurred. * - * - * @return true if the event is fired before the action is occurred * @since 1.21 */ public boolean isPre() @@ -102,8 +89,5 @@ public enum HandlerEventType return !post; } - //~--- fields --------------------------------------------------------------- - - /** Field description */ private final boolean post; } diff --git a/scm-core/src/main/java/sonia/scm/Initable.java b/scm-core/src/main/java/sonia/scm/Initable.java index a4cf0e1183..99119e04ec 100644 --- a/scm-core/src/main/java/sonia/scm/Initable.java +++ b/scm-core/src/main/java/sonia/scm/Initable.java @@ -27,7 +27,6 @@ package sonia.scm; /** * Base interface for all initable objects. * - * @author Sebastian Sdorra */ public interface Initable { diff --git a/scm-core/src/main/java/sonia/scm/LastModifiedAware.java b/scm-core/src/main/java/sonia/scm/LastModifiedAware.java index 1492f11dce..f17bc2065b 100644 --- a/scm-core/src/main/java/sonia/scm/LastModifiedAware.java +++ b/scm-core/src/main/java/sonia/scm/LastModifiedAware.java @@ -27,16 +27,12 @@ package sonia.scm; /** * Base interface of all objects which have a last modified date. * - * @author Sebastian Sdorra */ public interface LastModifiedAware { /** * Returns a timestamp of the last modified date. - * - * - * @return timestamp of the last modified date */ public Long getLastModified(); } diff --git a/scm-core/src/main/java/sonia/scm/Manager.java b/scm-core/src/main/java/sonia/scm/Manager.java index 20e531f7f4..66a24fbbd1 100644 --- a/scm-core/src/main/java/sonia/scm/Manager.java +++ b/scm-core/src/main/java/sonia/scm/Manager.java @@ -31,7 +31,6 @@ import java.util.function.Predicate; /** * Base interface for all manager classes. * - * @author Sebastian Sdorra * * @param type of the model object */ @@ -41,7 +40,7 @@ public interface Manager /** - * Reloads a object from store and overwrites all changes. + * Reloads an object from store and overwrites all changes. * * * @param object to refresh @@ -50,7 +49,6 @@ public interface Manager */ void refresh(T object); - //~--- get methods ---------------------------------------------------------- /** * Returns the object with the given id. @@ -64,9 +62,6 @@ public interface Manager /** * Returns a {@link java.util.Collection} of all objects in the store. - * - * - * @return all object in the store */ Collection getAll(); diff --git a/scm-core/src/main/java/sonia/scm/ManagerDecorator.java b/scm-core/src/main/java/sonia/scm/ManagerDecorator.java index 60f9d638b4..5f1b90cfd6 100644 --- a/scm-core/src/main/java/sonia/scm/ManagerDecorator.java +++ b/scm-core/src/main/java/sonia/scm/ManagerDecorator.java @@ -24,8 +24,6 @@ package sonia.scm; -//~--- JDK imports ------------------------------------------------------------ - import java.io.IOException; import java.util.Collection; import java.util.Comparator; @@ -34,19 +32,12 @@ import java.util.function.Predicate; /** * Basic decorator for manager classes. * - * @author Sebastian Sdorra * @since 1.23 * * @param model type */ public class ManagerDecorator implements Manager { - /** - * Constructs a new ManagerDecorator. - * - * - * @param decorated manager implementation - */ public ManagerDecorator(Manager decorated) { this.decorated = decorated; diff --git a/scm-core/src/main/java/sonia/scm/ModelObject.java b/scm-core/src/main/java/sonia/scm/ModelObject.java index 845b4e73b4..0d9e1e5f4a 100644 --- a/scm-core/src/main/java/sonia/scm/ModelObject.java +++ b/scm-core/src/main/java/sonia/scm/ModelObject.java @@ -24,14 +24,11 @@ package sonia.scm; -//~--- JDK imports ------------------------------------------------------------ - import java.io.Serializable; /** * Base interface for all model objects. * - * @author Sebastian Sdorra */ public interface ModelObject extends TypedObject, LastModifiedAware, Cloneable, Validateable, @@ -40,9 +37,6 @@ public interface ModelObject /** * Returns the unique id of the model object - * - * - * @return unique id */ String getId(); diff --git a/scm-core/src/main/java/sonia/scm/ModificationHandlerEvent.java b/scm-core/src/main/java/sonia/scm/ModificationHandlerEvent.java index b674b81a68..7c2ed4bd9f 100644 --- a/scm-core/src/main/java/sonia/scm/ModificationHandlerEvent.java +++ b/scm-core/src/main/java/sonia/scm/ModificationHandlerEvent.java @@ -21,7 +21,7 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ - + package sonia.scm; import sonia.scm.event.HandlerEvent; @@ -30,16 +30,13 @@ import sonia.scm.event.HandlerEvent; * Extension to the {@link ModificationHandlerEvent}. * * @param type of changed item - * - * @author Sebastian Sdorra + * * @since 1.48 */ public interface ModificationHandlerEvent extends HandlerEvent { /** * Returns item, before it was modified. - * - * @return item before modification */ public T getItemBeforeModification(); } diff --git a/scm-core/src/main/java/sonia/scm/PasswordAware.java b/scm-core/src/main/java/sonia/scm/PasswordAware.java index 074d67de8a..35a38dd842 100644 --- a/scm-core/src/main/java/sonia/scm/PasswordAware.java +++ b/scm-core/src/main/java/sonia/scm/PasswordAware.java @@ -27,7 +27,6 @@ package sonia.scm; /** * Interface for objects using a password. * - * @author Sebastian Sdorra * @since 1.13 */ public interface PasswordAware @@ -35,19 +34,12 @@ public interface PasswordAware /** * Returns the encrypted password. - * - * - * @return encrypted password */ public String getPassword(); - //~--- set methods ---------------------------------------------------------- /** * Sets the encrypted password - * - * - * @param password encrypted password */ public void setPassword(String password); } diff --git a/scm-core/src/main/java/sonia/scm/Platform.java b/scm-core/src/main/java/sonia/scm/Platform.java index e2cb14ca0e..4575968cdf 100644 --- a/scm-core/src/main/java/sonia/scm/Platform.java +++ b/scm-core/src/main/java/sonia/scm/Platform.java @@ -21,32 +21,35 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ - + package sonia.scm; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.util.Util; -//~--- JDK imports ------------------------------------------------------------ - import java.util.Locale; /** * Represents the platform on which the SCM manager running. * - * @author Sebastian Sdorra */ public class Platform { + private String arch; + + private String name; + + private PlatformType type; + + private boolean x64; /** * Constructs a {@link Platform} object * * - * @param osName - name of the operation system + * @param osName - name of the operating system * @param archModel - name of the host architecture model - * @param osArch - name of the operation system architecture + * @param osArch - name of the operating system architecture */ public Platform(String osName, String archModel, String osArch) { @@ -67,13 +70,9 @@ public class Platform type = PlatformType.createPlatformType(osName); } - //~--- methods -------------------------------------------------------------- /** - * Returns true if the operating system is a 32 bit operating system. - * - * - * @return true if the operating system is a 32 bit operating system + * Returns true if the operating system is a 32-bit operating system. */ public boolean is32Bit() { @@ -82,22 +81,15 @@ public class Platform /** * Returns true if the operating system is a 64 a bit operating system. - * - * - * @return true if the operating system is a 64 a bit operating system */ public boolean is64Bit() { return x64; } - //~--- get methods ---------------------------------------------------------- /** * Returns the architecture of the platform. - * - * - * @return the architecture of the platform */ public String getArch() { @@ -106,9 +98,6 @@ public class Platform /** * Returns the name of the platform. - * - * - * @return name of the platform */ public String getName() { @@ -117,9 +106,6 @@ public class Platform /** * Returns the type of the platform. - * - * - * @return type of the platform */ public PlatformType getType() { @@ -128,9 +114,6 @@ public class Platform /** * Returns true if the operating system is a FreeBSD. - * - * - * @return true if the operating system is a FreeBSD */ public boolean isFreeBSD() { @@ -139,9 +122,6 @@ public class Platform /** * Returns true if the operating system is a Linux. - * - * - * @return true if the operating system is a Linux */ public boolean isLinux() { @@ -150,9 +130,6 @@ public class Platform /** * Returns true if the operating system is a Mac OS. - * - * - * @return true if the operating system is a Mac OS */ public boolean isMac() { @@ -161,9 +138,6 @@ public class Platform /** * Returns true if the operating system is a OpenBSD. - * - * - * @return true if the operating system is a OpenBSD */ public boolean isOpenBSD() { @@ -172,9 +146,6 @@ public class Platform /** * Returns true if the operating system has posix support. - * - * - * @return true if the operating system has posix support */ public boolean isPosix() { @@ -183,9 +154,6 @@ public class Platform /** * Returns true if the operating system is a Solaris. - * - * - * @return true if the operating system is a Solaris */ public boolean isSolaris() { @@ -194,9 +162,6 @@ public class Platform /** * Returns true if the operating system is a Unix system. - * - * - * @return true if the operating system is a Unix system */ public boolean isUnix() { @@ -205,26 +170,10 @@ public class Platform /** * Returns true if the operating system is a Windows. - * - * - * @return true if the operating system is a Windows */ public boolean isWindows() { return PlatformType.WINDOWS == type; } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private String arch; - - /** Field description */ - private String name; - - /** Field description */ - private PlatformType type; - - /** Field description */ - private boolean x64; } diff --git a/scm-core/src/main/java/sonia/scm/PlatformType.java b/scm-core/src/main/java/sonia/scm/PlatformType.java index 29da3f8489..887fe8ae6e 100644 --- a/scm-core/src/main/java/sonia/scm/PlatformType.java +++ b/scm-core/src/main/java/sonia/scm/PlatformType.java @@ -29,7 +29,6 @@ import java.util.Locale; /** * Type of the SCM-Manager host platform. * - * @author Sebastian Sdorra */ public enum PlatformType { @@ -37,6 +36,12 @@ public enum PlatformType WINDOWS(false, false), SOLARIS(true, true), FREEBSD(true, true), OPENBSD(true, true); + /** has the platform support for posix */ + private boolean posix; + + /** is the platform a unix system */ + private boolean unix; + /** * Constructs {@link PlatformType} object. * @@ -50,15 +55,12 @@ public enum PlatformType this.posix = posix; } - //~--- methods -------------------------------------------------------------- /** * Returns {@link PlatformType} object for the given operating system name. * * * @param osName - name of the operating system - * - * @return {@link PlatformType} object for the given operating system name */ public static PlatformType createPlatformType(String osName) { @@ -94,7 +96,6 @@ public enum PlatformType return type; } - //~--- get methods ---------------------------------------------------------- /** * Returns true if the platform has support for posix. @@ -118,11 +119,4 @@ public enum PlatformType return unix; } - //~--- fields --------------------------------------------------------------- - - /** has the platform support for posix */ - private boolean posix; - - /** is the platform is a unix system */ - private boolean unix; } diff --git a/scm-core/src/main/java/sonia/scm/Priorities.java b/scm-core/src/main/java/sonia/scm/Priorities.java index cd45b2be82..86306db568 100644 --- a/scm-core/src/main/java/sonia/scm/Priorities.java +++ b/scm-core/src/main/java/sonia/scm/Priorities.java @@ -24,37 +24,26 @@ package sonia.scm; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.collect.Ordering; import com.google.common.primitives.Ints; -//~--- JDK imports ------------------------------------------------------------ - import java.util.List; /** * Priority constants and util methods to sort classes by {@link Priority} * annotation. * - * @author Sebastian Sdorra * @since 2.0.0 */ public final class Priorities { - /** default priority */ public static final int DEFAULT = 9999; - //~--- constructors --------------------------------------------------------- - /** - * Constructs ... - * - */ private Priorities() {} - //~--- methods -------------------------------------------------------------- /** * Returns a list sorted by priority. @@ -83,7 +72,6 @@ public final class Priorities } - //~--- get methods ---------------------------------------------------------- /** * Returns the priority of the given class. @@ -106,8 +94,6 @@ public final class Priorities return priority; } - //~--- inner classes -------------------------------------------------------- - /** * {@link Ordering} which orders classes by priority. * diff --git a/scm-core/src/main/java/sonia/scm/PropertiesAware.java b/scm-core/src/main/java/sonia/scm/PropertiesAware.java index 6bca751d53..e37e6a2f2a 100644 --- a/scm-core/src/main/java/sonia/scm/PropertiesAware.java +++ b/scm-core/src/main/java/sonia/scm/PropertiesAware.java @@ -24,45 +24,32 @@ package sonia.scm; -//~--- JDK imports ------------------------------------------------------------ - import java.util.Map; /** * Base interface of all objects which have properties. * * @since 1.6 - * @author Sebastian Sdorra */ public interface PropertiesAware { - /** - * Removes a existing property. - * - * @param key - the key of the property - */ public void removeProperty(String key); - //~--- get methods ---------------------------------------------------------- /** * Returns all properties. - * - * @return all properties */ public Map getProperties(); /** * Returns the property value for the given key - * or null if the key does not exists. + * or null if the key does not exist. * * @param key - the key of the property - * @return the value of the property */ public String getProperty(String key); - //~--- set methods ---------------------------------------------------------- /** * Sets all properties and overwrites existing ones. diff --git a/scm-core/src/main/java/sonia/scm/ReducedModelObject.java b/scm-core/src/main/java/sonia/scm/ReducedModelObject.java index 1d5eadb506..328c79b5b6 100644 --- a/scm-core/src/main/java/sonia/scm/ReducedModelObject.java +++ b/scm-core/src/main/java/sonia/scm/ReducedModelObject.java @@ -28,8 +28,6 @@ package sonia.scm; /** * This is a reduced form of a model object. * It can be used as search result to avoid returning the whole object properties. - * - * @author Mohamed Karray */ public interface ReducedModelObject { diff --git a/scm-core/src/main/java/sonia/scm/RootURL.java b/scm-core/src/main/java/sonia/scm/RootURL.java index 0187b51fb1..35ee2a47a0 100644 --- a/scm-core/src/main/java/sonia/scm/RootURL.java +++ b/scm-core/src/main/java/sonia/scm/RootURL.java @@ -28,7 +28,7 @@ import java.net.URL; /** * RootURL is able to return the root url of the SCM-Manager instance, - * regardless of the scope (web request, async hook, ssh command, etc). + * regardless of the scope (web request, async hook, ssh command, etc.). * * @since 2.3.1 */ @@ -43,8 +43,6 @@ public interface RootURL { /** * Returns the root url of the SCM-Manager instance as string. - * - * @return root url as string */ default String getAsString() { return get().toExternalForm(); diff --git a/scm-core/src/main/java/sonia/scm/SCMContext.java b/scm-core/src/main/java/sonia/scm/SCMContext.java index 569a3a2115..6249c50fcd 100644 --- a/scm-core/src/main/java/sonia/scm/SCMContext.java +++ b/scm-core/src/main/java/sonia/scm/SCMContext.java @@ -24,17 +24,15 @@ package sonia.scm; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.security.CipherUtil; import sonia.scm.user.User; import sonia.scm.util.ServiceUtil; /** - * The SCMContext searches a implementation of {@link SCMContextProvider} and + * The SCMContext searches an implementation of {@link SCMContextProvider} and * holds a singleton instance of this implementation. * - * @author Sebastian Sdorra */ public final class SCMContext { @@ -67,20 +65,13 @@ public final class SCMContext { */ private static SCMContextProvider provider = null; - //~--- constructors --------------------------------------------------------- - /** - * Constructs ... - */ private SCMContext() { } - //~--- get methods ---------------------------------------------------------- /** * Returns the singleton instance of {@link SCMContextProvider} - * - * @return singleton instance of {@link SCMContextProvider} */ public static SCMContextProvider getContext() { synchronized (SCMContext.class) { diff --git a/scm-core/src/main/java/sonia/scm/SCMContextProvider.java b/scm-core/src/main/java/sonia/scm/SCMContextProvider.java index 4c0b3a9268..80a40f9e87 100644 --- a/scm-core/src/main/java/sonia/scm/SCMContextProvider.java +++ b/scm-core/src/main/java/sonia/scm/SCMContextProvider.java @@ -24,8 +24,6 @@ package sonia.scm; -//~--- JDK imports ------------------------------------------------------------ - import sonia.scm.version.Version; import java.io.File; @@ -39,14 +37,10 @@ import static java.lang.String.format; * This class is a singleton which can be retrieved via injection * or with the static {@link SCMContext#getContext()} method. * - * @author Sebastian Sdorra */ public interface SCMContextProvider { /** * Returns the base directory of the SCM-Manager. - * - * - * @return base directory of the SCM-Manager */ File getBaseDirectory(); @@ -64,14 +58,12 @@ public interface SCMContextProvider { /** * Returns the current stage of SCM-Manager. * - * - * @return stage of SCM-Manager * @since 1.12 */ Stage getStage(); /** - * Returns a exception which is occurred on context startup. + * Returns an exception which is occurred on context startup. * The method returns null if the start was successful. * * @@ -82,18 +74,14 @@ public interface SCMContextProvider { /** * Returns the version of the SCM-Manager. - * - * - * @return version of the SCM-Manager */ String getVersion(); /** - * Returns the version of the SCM-Manager used in documentation urls (eg. version 2.17.0 and 2.17.1 will all result + * Returns the version of the SCM-Manager used in documentation urls (e.g. version 2.17.0 and 2.17.1 will all result * in 2.17.x). The default implementation works for versions with three parts (major version, minor version, - * and patch version, where the patch version will be replaces with an 'x'). + * and patch version, where the patch version will be replaced with an 'x'). * - * @return version of the SCM-Manager used in documentation urls * @since 2.17.0 */ default String getDocumentationVersion() { @@ -104,7 +92,6 @@ public interface SCMContextProvider { /** * Returns the instance id of the SCM-Manager used. * - * @return instance id of the SCM-Manager * @since 2.30.0 */ default String getInstanceId() { diff --git a/scm-core/src/main/java/sonia/scm/ScmConstraintViolationException.java b/scm-core/src/main/java/sonia/scm/ScmConstraintViolationException.java index 02e69c12d9..7d713d18af 100644 --- a/scm-core/src/main/java/sonia/scm/ScmConstraintViolationException.java +++ b/scm-core/src/main/java/sonia/scm/ScmConstraintViolationException.java @@ -67,7 +67,7 @@ public class ScmConstraintViolationException extends RuntimeException implements } /** - * An optional URL for more informations about this constraint violation. + * An optional URL for more information about this constraint violation. */ public String getUrl() { return furtherInformation; @@ -102,7 +102,7 @@ public class ScmConstraintViolationException extends RuntimeException implements * you can call this method multiple times. * @param message The message describing the violation. * @param pathElements The affected property denoted by the path to reach this property, - * eg. "someParameter", "complexProperty", "attribute" + * e.g. "someParameter", "complexProperty", "attribute" * @return this builder instance. */ public Builder violation(String message, String... pathElements) { @@ -121,7 +121,7 @@ public class ScmConstraintViolationException extends RuntimeException implements } /** - * When the given condition is true, a exception will be thrown. Otherwise this simply resets this + * When the given condition is true, an exception will be thrown. Otherwise, this simply resets this * builder and does nothing else. * @param condition The condition that indicates a violation of this constraint. * @return this builder instance. diff --git a/scm-core/src/main/java/sonia/scm/ServletContainer.java b/scm-core/src/main/java/sonia/scm/ServletContainer.java index 57a671f283..cdced841b2 100644 --- a/scm-core/src/main/java/sonia/scm/ServletContainer.java +++ b/scm-core/src/main/java/sonia/scm/ServletContainer.java @@ -25,9 +25,8 @@ package sonia.scm; /** - * Type of a servlet container. + * Type of servlet container. * - * @author Sebastian Sdorra */ public enum ServletContainer { diff --git a/scm-core/src/main/java/sonia/scm/ServletContainerDetector.java b/scm-core/src/main/java/sonia/scm/ServletContainerDetector.java index 6e45576faa..4d3249b1a3 100644 --- a/scm-core/src/main/java/sonia/scm/ServletContainerDetector.java +++ b/scm-core/src/main/java/sonia/scm/ServletContainerDetector.java @@ -21,10 +21,9 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ - + package sonia.scm; -//~--- non-JDK imports -------------------------------------------------------- import jakarta.servlet.RequestDispatcher; import jakarta.servlet.http.HttpServletRequest; @@ -36,16 +35,16 @@ import org.slf4j.LoggerFactory; * This class is inspired by * com.liferay.portal.kernel.util.ServerDetector of liferay. * - * @author Sebastian Sdorra */ public class ServletContainerDetector { + /** Servlet request for alternate detection method. */ + private HttpServletRequest request = null; /** Make usage of the logging framework. */ private static final Logger LOGGER = LoggerFactory.getLogger(ServletContainerDetector.class); - //~--- constructors --------------------------------------------------------- /** * Constructs a new ServletContainerDetector depending on the ServletRequest. @@ -56,13 +55,11 @@ public class ServletContainerDetector request = req; } - //~--- methods -------------------------------------------------------------- /** * Detects the ServletContainer. * * @param req The used Servlet instance. - * @return the detected ServletContainer. * @since 1.32 */ public static ServletContainer detect(final HttpServletRequest req) @@ -72,9 +69,6 @@ public class ServletContainerDetector /** * Detects the ServletContainer. - * - * - * @return the detected ServletContainer */ public ServletContainer detectContainer() { @@ -139,13 +133,11 @@ public class ServletContainerDetector return container; } - //~--- get methods ---------------------------------------------------------- /** * Returns true if the ServletContainer is a Eclipse Jetty. * * @since 1.32 - * @return true if the ServletContainer is a Eclipse Jetty */ public boolean isEclipseJetty() { @@ -161,9 +153,6 @@ public class ServletContainerDetector /** * Returns true if the ServletContainer is a Geronimo. - * - * - * @return true if the ServletContainer is a Geronimo */ public boolean isGeronimo() { @@ -172,9 +161,6 @@ public class ServletContainerDetector /** * Returns true if the ServletContainer is a Glassfish. - * - * - * @return true if the ServletContainer is a Glassfish */ public boolean isGlassfish() { @@ -185,9 +171,6 @@ public class ServletContainerDetector /** * Returns true if the ServletContainer is a JBoss. - * - * - * @return true if the ServletContainer is a JBos */ public boolean isJBoss() { @@ -196,9 +179,6 @@ public class ServletContainerDetector /** * Returns true if the ServletContainer is a JOnAS. - * - * - * @return true if the ServletContainer is a JOnAS */ public boolean isJOnAS() { @@ -214,9 +194,6 @@ public class ServletContainerDetector /** * Returns true if the ServletContainer is a Jetty. - * - * - * @return true if the ServletContainer is a Jetty */ public boolean isJetty() { @@ -225,9 +202,6 @@ public class ServletContainerDetector /** * Returns true if the ServletContainer is a OC4J. - * - * - * @return true if the ServletContainer is a OC4J */ public boolean isOC4J() { @@ -236,9 +210,6 @@ public class ServletContainerDetector /** * Returns true if the ServletContainer is a Resin. - * - * - * @return true if the ServletContainer is a Resin */ public boolean isResin() { @@ -247,9 +218,6 @@ public class ServletContainerDetector /** * Returns true if the ServletContainer is a SCM-Server. - * - * - * @return true if the ServletContainer is a SCM-Server */ public boolean isScmServer() { @@ -260,9 +228,6 @@ public class ServletContainerDetector /** * Returns true if the ServletContainer is a Tomcat. - * - * - * @return true if the ServletContainer is a Tomcat */ public boolean isTomcat() { @@ -278,9 +243,6 @@ public class ServletContainerDetector /** * Returns true if the ServletContainer is a WebLogic. - * - * - * @return true if the ServletContainer is a WebLogic */ public boolean isWebLogic() { @@ -289,24 +251,18 @@ public class ServletContainerDetector /** * Returns true if the ServletContainer is a WebSphere. - * - * - * @return true if the ServletContainer is a WebSpere */ public boolean isWebSphere() { return detect("/com/ibm/websphere/product/VersionInfo.class"); } - //~--- methods -------------------------------------------------------------- /** * Returns true if the given class exists in the system classpath. * * * @param clazz class name to search in classpath - * - * @return true if class exists in system classpath */ private boolean detect(final String clazz) { @@ -332,18 +288,16 @@ public class ServletContainerDetector } /** - * An alternate detection. The default servlet that must be implemented by each application, so we can get it's + * An alternate detection. The default servlet that must be implemented by each application, so we can get its * class name and compare against our suggestion. * * @since 1.32 * @param keyword Part of the class path that is needed at the implementation class. - * - * @return */ private boolean detectDefaultServlet(final String keyword) { - // Request the default servlet (its pretty safe to say it will always be there) + // Request the default servlet (It's pretty safe to say it will always be there) final RequestDispatcher dispatcher = request.getServletContext().getNamedDispatcher("default"); @@ -356,8 +310,4 @@ public class ServletContainerDetector return dispatcher.getClass().getName().contains(keyword); } - //~--- fields --------------------------------------------------------------- - - /** Servlet request for alternate detection method. */ - private HttpServletRequest request = null; } diff --git a/scm-core/src/main/java/sonia/scm/Stage.java b/scm-core/src/main/java/sonia/scm/Stage.java index eb4ab3dbec..1ec677dc88 100644 --- a/scm-core/src/main/java/sonia/scm/Stage.java +++ b/scm-core/src/main/java/sonia/scm/Stage.java @@ -21,7 +21,7 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ - + package sonia.scm; /** @@ -29,11 +29,9 @@ package sonia.scm; * SCM_Manager instance. The stage can be queried by calling * {@link SCMContextProvider#getStage()}. * - * @author Sebastian Sdorra * @since 1.12 */ -public enum Stage -{ +public enum Stage { /** * This value indicates SCM-Manager is right now in development. @@ -47,38 +45,24 @@ public enum Stage /** * This value indicates SCM-Manager is right now in development but specifically configured for testing. + * * @since 2.47.0 */ TESTING(com.google.inject.Stage.DEVELOPMENT); - /** - * Constructs a new Stage - * - * - * @param injectionStage injection stage - */ - private Stage(com.google.inject.Stage injectionStage) - { + private final com.google.inject.Stage injectionStage; + + private Stage(com.google.inject.Stage injectionStage) { this.injectionStage = injectionStage; } - //~--- get methods ---------------------------------------------------------- - /** * Returns the injection stage * - * - * @return injection stage - * * @since 2.0.0 */ - public com.google.inject.Stage getInjectionStage() - { + public com.google.inject.Stage getInjectionStage() { return injectionStage; } - //~--- fields --------------------------------------------------------------- - - /** injection stage */ - private final com.google.inject.Stage injectionStage; } diff --git a/scm-core/src/main/java/sonia/scm/TransformFilter.java b/scm-core/src/main/java/sonia/scm/TransformFilter.java index b22cb55c3c..456fa97e52 100644 --- a/scm-core/src/main/java/sonia/scm/TransformFilter.java +++ b/scm-core/src/main/java/sonia/scm/TransformFilter.java @@ -27,7 +27,6 @@ package sonia.scm; /** * Util class to transform multiple objects. * - * @author Sebastian Sdorra * * @param type of objects to transform * @param result type of the transformation @@ -43,7 +42,7 @@ public interface TransformFilter * * @param item * - * @return tranformed object + * @return transformed object */ R accept(T item); } diff --git a/scm-core/src/main/java/sonia/scm/Type.java b/scm-core/src/main/java/sonia/scm/Type.java index ac82688ba6..eea016035e 100644 --- a/scm-core/src/main/java/sonia/scm/Type.java +++ b/scm-core/src/main/java/sonia/scm/Type.java @@ -24,7 +24,6 @@ package sonia.scm; -//~--- non-JDK imports -------------------------------------------------------- import jakarta.xml.bind.annotation.XmlRootElement; import sonia.scm.util.AssertUtil; @@ -33,11 +32,15 @@ import sonia.scm.util.Util; /** * Base class for all objects which supports different types. * - * @author Sebastian Sdorra */ @XmlRootElement public class Type { + /** display name of the type */ + private String displayName; + + /** unique name of the type */ + private String name; /** * Constructs {@link Type} object. @@ -68,15 +71,12 @@ public class Type } } - //~--- methods -------------------------------------------------------------- /** - * Returns true if the given ovject is equals. + * Returns true if the given object is equals. * * * @param obj - * - * @return true if the given ovject is equals */ @Override public boolean equals(Object obj) @@ -112,9 +112,6 @@ public class Type /** * Returns the hash code of the object. - * - * - * @return hash code of the object */ @Override public int hashCode() @@ -131,12 +128,6 @@ public class Type return hash; } - /** - * Returns {@link String} representation of the type. - * - * - * @return {@link String} representation of the type - */ @Override public String toString() { @@ -147,13 +138,9 @@ public class Type return out.toString(); } - //~--- get methods ---------------------------------------------------------- /** * Returns the display name of the type. - * - * - * @return display name of the type */ public String getDisplayName() { @@ -162,16 +149,12 @@ public class Type /** * Returns the unique name of the type. - * - * - * @return unique name of the type */ public String getName() { return name; } - //~--- set methods ---------------------------------------------------------- /** * Setter for the display name of the type @@ -196,11 +179,4 @@ public class Type this.name = name; } - //~--- fields --------------------------------------------------------------- - - /** display name of the type */ - private String displayName; - - /** unique name of the type */ - private String name; } diff --git a/scm-core/src/main/java/sonia/scm/TypeManager.java b/scm-core/src/main/java/sonia/scm/TypeManager.java index 50250febe6..a09023f0b6 100644 --- a/scm-core/src/main/java/sonia/scm/TypeManager.java +++ b/scm-core/src/main/java/sonia/scm/TypeManager.java @@ -24,14 +24,11 @@ package sonia.scm; -//~--- JDK imports ------------------------------------------------------------ - import java.util.Collection; /** * Base interface for all type manager classes. * - * @author Sebastian Sdorra * * @param type of the model object * @param type of the handler @@ -44,16 +41,12 @@ public interface TypeManager> extend * null if no handler of that type is available. * * @param type name of the handler - * - * @return the handler for given type */ H getHandler(String type); /** * Returns a {@link java.util.Collection} of all * available and configured types. - * - * @return all available types */ Collection getTypes(); } diff --git a/scm-core/src/main/java/sonia/scm/TypedObject.java b/scm-core/src/main/java/sonia/scm/TypedObject.java index 0bc461d66e..c136b03352 100644 --- a/scm-core/src/main/java/sonia/scm/TypedObject.java +++ b/scm-core/src/main/java/sonia/scm/TypedObject.java @@ -21,22 +21,18 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ - + package sonia.scm; /** * Base interface for all objects of specific type. * - * @author Sebastian Sdorra */ public interface TypedObject { /** * Returns the type of the object. - * - * - * @return type of the object */ - public String getType(); + String getType(); } diff --git a/scm-core/src/main/java/sonia/scm/Validateable.java b/scm-core/src/main/java/sonia/scm/Validateable.java index 78150aed93..42cd91d083 100644 --- a/scm-core/src/main/java/sonia/scm/Validateable.java +++ b/scm-core/src/main/java/sonia/scm/Validateable.java @@ -27,16 +27,12 @@ package sonia.scm; /** * Base interface for all validateable objects. * - * @author Sebastian Sdorra */ public interface Validateable { /** * Returns true if the object is valid. - * - * - * @return true if the object is valid */ public boolean isValid(); } diff --git a/scm-core/src/main/java/sonia/scm/api/v2/resources/BranchLinkProvider.java b/scm-core/src/main/java/sonia/scm/api/v2/resources/BranchLinkProvider.java index 6f526ecabf..9be6f077a4 100644 --- a/scm-core/src/main/java/sonia/scm/api/v2/resources/BranchLinkProvider.java +++ b/scm-core/src/main/java/sonia/scm/api/v2/resources/BranchLinkProvider.java @@ -33,7 +33,6 @@ public interface BranchLinkProvider { * * @param namespaceAndName The namespace and name of the repository. * @param branch The name of the branch. - * @return Internal api link for the given branch. */ String get(NamespaceAndName namespaceAndName, String branch); } diff --git a/scm-core/src/main/java/sonia/scm/api/v2/resources/HalAppender.java b/scm-core/src/main/java/sonia/scm/api/v2/resources/HalAppender.java index 04ddf006fc..02068b32e7 100644 --- a/scm-core/src/main/java/sonia/scm/api/v2/resources/HalAppender.java +++ b/scm-core/src/main/java/sonia/scm/api/v2/resources/HalAppender.java @@ -21,7 +21,7 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ - + package sonia.scm.api.v2.resources; import de.otto.edison.hal.HalRepresentation; @@ -31,7 +31,6 @@ import java.util.List; /** * The {@link HalAppender} can be used within an {@link HalEnricher} to append hateoas links to a json response. * - * @author Sebastian Sdorra * @since 2.0.0 */ public interface HalAppender { diff --git a/scm-core/src/main/java/sonia/scm/api/v2/resources/HalEnricher.java b/scm-core/src/main/java/sonia/scm/api/v2/resources/HalEnricher.java index 4d06b18fbe..89724a2a17 100644 --- a/scm-core/src/main/java/sonia/scm/api/v2/resources/HalEnricher.java +++ b/scm-core/src/main/java/sonia/scm/api/v2/resources/HalEnricher.java @@ -33,7 +33,6 @@ import sonia.scm.plugin.ExtensionPoint; * * Warning: enrichers are always registered as singletons. * - * @author Sebastian Sdorra * @since 2.0.0 */ @ExtensionPoint diff --git a/scm-core/src/main/java/sonia/scm/api/v2/resources/HalEnricherContext.java b/scm-core/src/main/java/sonia/scm/api/v2/resources/HalEnricherContext.java index 5c08ac2fc5..67985f1796 100644 --- a/scm-core/src/main/java/sonia/scm/api/v2/resources/HalEnricherContext.java +++ b/scm-core/src/main/java/sonia/scm/api/v2/resources/HalEnricherContext.java @@ -34,7 +34,6 @@ import java.util.Optional; * Context object for the {@link HalEnricher}. The context holds the source object for the json and all related * objects, which can be useful for the enrichment. * - * @author Sebastian Sdorra * @since 2.0.0 */ public final class HalEnricherContext { @@ -49,8 +48,6 @@ public final class HalEnricherContext { * Creates a context with the given entries * * @param instances entries of the context - * - * @return context of given entries */ public static HalEnricherContext of(Object... instances) { ImmutableMap.Builder, Object> builder = ImmutableMap.builder(); @@ -62,7 +59,6 @@ public final class HalEnricherContext { /** * Return builder for {@link HalEnricherContext}. - * @return builder * @since 2.23.0 */ public static Builder builder() { @@ -125,7 +121,6 @@ public final class HalEnricherContext { /** * Returns the {@link HalEnricherContext}. - * @return context */ public HalEnricherContext build() { return new HalEnricherContext(mapBuilder.build()); diff --git a/scm-core/src/main/java/sonia/scm/api/v2/resources/HalEnricherRegistry.java b/scm-core/src/main/java/sonia/scm/api/v2/resources/HalEnricherRegistry.java index 1ce9a503d7..bcc8ec6655 100644 --- a/scm-core/src/main/java/sonia/scm/api/v2/resources/HalEnricherRegistry.java +++ b/scm-core/src/main/java/sonia/scm/api/v2/resources/HalEnricherRegistry.java @@ -32,7 +32,6 @@ import sonia.scm.plugin.Extension; /** * The {@link HalEnricherRegistry} is responsible for binding {@link HalEnricher} instances to their source types. * - * @author Sebastian Sdorra * @since 2.0.0 */ @Extension @@ -55,7 +54,6 @@ public final class HalEnricherRegistry { * Returns all registered {@link HalEnricher} for the given type. * * @param sourceType type of json mapping source - * @return all registered enrichers */ public Iterable allByType(Class sourceType) { return enrichers.get(sourceType); diff --git a/scm-core/src/main/java/sonia/scm/api/v2/resources/Index.java b/scm-core/src/main/java/sonia/scm/api/v2/resources/Index.java index 6c6197f77e..ee0bfaa225 100644 --- a/scm-core/src/main/java/sonia/scm/api/v2/resources/Index.java +++ b/scm-core/src/main/java/sonia/scm/api/v2/resources/Index.java @@ -27,7 +27,6 @@ package sonia.scm.api.v2.resources; /** * The {@link Index} object can be used to register a {@link HalEnricher} for the index resource. * - * @author Sebastian Sdorra * @since 2.0.0 */ public final class Index { diff --git a/scm-core/src/main/java/sonia/scm/api/v2/resources/Me.java b/scm-core/src/main/java/sonia/scm/api/v2/resources/Me.java index 046a42117a..be8ca71937 100644 --- a/scm-core/src/main/java/sonia/scm/api/v2/resources/Me.java +++ b/scm-core/src/main/java/sonia/scm/api/v2/resources/Me.java @@ -27,7 +27,6 @@ package sonia.scm.api.v2.resources; /** * The {@link Me} object can be used to register a {@link HalEnricher} for the me resource. * - * @author Sebastian Sdorra * @since 2.0.0 */ public final class Me { diff --git a/scm-core/src/main/java/sonia/scm/api/v2/resources/PersonDto.java b/scm-core/src/main/java/sonia/scm/api/v2/resources/PersonDto.java index 815150ecc5..b650210823 100644 --- a/scm-core/src/main/java/sonia/scm/api/v2/resources/PersonDto.java +++ b/scm-core/src/main/java/sonia/scm/api/v2/resources/PersonDto.java @@ -21,7 +21,7 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ - + package sonia.scm.api.v2.resources; import lombok.Getter; diff --git a/scm-core/src/main/java/sonia/scm/api/v2/resources/RepositoryLinkProvider.java b/scm-core/src/main/java/sonia/scm/api/v2/resources/RepositoryLinkProvider.java index e66a0c41ff..c423b21aae 100644 --- a/scm-core/src/main/java/sonia/scm/api/v2/resources/RepositoryLinkProvider.java +++ b/scm-core/src/main/java/sonia/scm/api/v2/resources/RepositoryLinkProvider.java @@ -32,7 +32,6 @@ public interface RepositoryLinkProvider { * Returns the internal api link for the given repository. * * @param namespaceAndName The namespace and name of the repository. - * @return Internal api link for the given repository. */ String get(NamespaceAndName namespaceAndName); } diff --git a/scm-core/src/main/java/sonia/scm/cache/Cache.java b/scm-core/src/main/java/sonia/scm/cache/Cache.java index b58c743e25..34db756412 100644 --- a/scm-core/src/main/java/sonia/scm/cache/Cache.java +++ b/scm-core/src/main/java/sonia/scm/cache/Cache.java @@ -24,7 +24,6 @@ package sonia.scm.cache; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Predicate; @@ -32,7 +31,6 @@ import com.google.common.base.Predicate; * The main interface for the cache. * Provides methods to add, access, and remove entries from a cache. * - * @author Sebastian Sdorra * * @param type of the keys for the cache * @param type of cached elements @@ -42,17 +40,13 @@ public interface Cache extends org.apache.shiro.cache.Cache { /** * Remove all elements from this cache. - * */ void clear(); /** * Returns true if this cache contains an element with the specified key. * - * * @param key key of the cached element - * - * @return true if this cache contains an element with the specified key */ boolean contains(K key); @@ -84,8 +78,6 @@ public interface Cache extends org.apache.shiro.cache.Cache { * @since 1.9 * * @param predicate predicate to match cache keys - * - * @return all previous cached values */ @SuppressWarnings("java:S4738") // we have to use guava predicate for compatibility Iterable removeAll(Predicate predicate); @@ -93,13 +85,10 @@ public interface Cache extends org.apache.shiro.cache.Cache { /** * Returns the number of entries in the cache. * - * @return number of entries in the cache - * * @since 2.0.0 */ int size(); - //~--- get methods ---------------------------------------------------------- /** * Returns the element with the specified key. @@ -116,8 +105,6 @@ public interface Cache extends org.apache.shiro.cache.Cache { * support statistics. The returned statistic is a snapshot of the current * performance. * - * @return performance statistics or null - * * @since 2.0.0 */ CacheStatistics getStatistics(); diff --git a/scm-core/src/main/java/sonia/scm/cache/CacheManager.java b/scm-core/src/main/java/sonia/scm/cache/CacheManager.java index 4cb4fa2b4a..2afc15fdf6 100644 --- a/scm-core/src/main/java/sonia/scm/cache/CacheManager.java +++ b/scm-core/src/main/java/sonia/scm/cache/CacheManager.java @@ -24,8 +24,6 @@ package sonia.scm.cache; -//~--- JDK imports ------------------------------------------------------------ - import java.io.Closeable; /** @@ -33,7 +31,6 @@ import java.io.Closeable; * and manages their creation. * This class is a singleton which can be retrieved via injection. * - * @author Sebastian Sdorra */ public interface CacheManager extends Closeable { diff --git a/scm-core/src/main/java/sonia/scm/cache/CacheStatistics.java b/scm-core/src/main/java/sonia/scm/cache/CacheStatistics.java index e7971afcae..edc796580c 100644 --- a/scm-core/src/main/java/sonia/scm/cache/CacheStatistics.java +++ b/scm-core/src/main/java/sonia/scm/cache/CacheStatistics.java @@ -31,11 +31,19 @@ import com.google.common.base.Objects; * Statistics about the performance of a {@link Cache}. * Instances of this class are immutable. * - * @author Sebastian Sdorra * @since 2.0.0 */ public final class CacheStatistics { + private final long hitCount; + + private final long missCount; + + /** + * name of cache + */ + private final String name; + /** * Constructs a new performance statistic for a {@link Cache}. * @@ -49,11 +57,8 @@ public final class CacheStatistics { this.missCount = missCount; } - //~--- methods -------------------------------------------------------------- - /** - * {@inheritDoc} - */ + @Override public boolean equals(Object obj) { if (obj == null) { @@ -71,17 +76,13 @@ public final class CacheStatistics { && Objects.equal(missCount, other.missCount); } - /** - * {@inheritDoc} - */ + @Override public int hashCode() { return Objects.hashCode(name, hitCount, missCount); } - /** - * {@inheritDoc} - */ + @Override public String toString() { //J- @@ -93,7 +94,6 @@ public final class CacheStatistics { //J+ } - //~--- get methods ---------------------------------------------------------- /** * Returns number of times requested elements were found in the cache. @@ -106,8 +106,6 @@ public final class CacheStatistics { /** * Returns the ratio of cache requests which were hits. - * - * @return ratio of cache hits */ public double getHitRate() { return ratio(hitCount); @@ -115,8 +113,6 @@ public final class CacheStatistics { /** * Returns number of times a requested element was not found in the cache. - * - * @return number of cache misses */ public long getMissCount() { return missCount; @@ -124,8 +120,6 @@ public final class CacheStatistics { /** * Returns the ratio of cache requests which were misses. - * - * @return ratio of cache misses */ public double getMissRate() { return ratio(missCount); @@ -133,8 +127,6 @@ public final class CacheStatistics { /** * Returns name of the cache. - * - * @return name of the cache */ public String getName() { return name; @@ -142,8 +134,6 @@ public final class CacheStatistics { /** * Returns the total number of requests, this includes hits and misses. - * - * @return numer of requests */ public long getRequestCount() { return hitCount + missCount; @@ -163,18 +153,5 @@ public final class CacheStatistics { : (double) counter / requestCount; } - /** - * hit count - */ - private final long hitCount; - /** - * miss count - */ - private final long missCount; - - /** - * name of cache - */ - private final String name; } diff --git a/scm-core/src/main/java/sonia/scm/cli/CliContext.java b/scm-core/src/main/java/sonia/scm/cli/CliContext.java index 3ffb746a83..e52cc831f9 100644 --- a/scm-core/src/main/java/sonia/scm/cli/CliContext.java +++ b/scm-core/src/main/java/sonia/scm/cli/CliContext.java @@ -61,13 +61,11 @@ public interface CliContext { /** * Returns the {@link Locale} of the client terminal. - * @return locale of the client terminal */ Locale getLocale(); /** * Returns the client. - * @return client */ Client getClient(); } diff --git a/scm-core/src/main/java/sonia/scm/cli/CliResourceBundle.java b/scm-core/src/main/java/sonia/scm/cli/CliResourceBundle.java index f7911bf10c..42abea1d5f 100644 --- a/scm-core/src/main/java/sonia/scm/cli/CliResourceBundle.java +++ b/scm-core/src/main/java/sonia/scm/cli/CliResourceBundle.java @@ -34,7 +34,7 @@ import java.lang.annotation.Target; * Defines a custom resource bundle for the CLI command * * We need to use this workaround instead the picocli way because we cannot ensure that the resource bundles can be found by the classloader. - * Currently there is no solution for picocli to chose which classloader should be used to load command-related resource bundle. + * Currently, there is no solution for picocli to chose which classloader should be used to load command-related resource bundle. * * @since 2.35.0 */ diff --git a/scm-core/src/main/java/sonia/scm/collect/CallableQueueCollector.java b/scm-core/src/main/java/sonia/scm/collect/CallableQueueCollector.java index 8adc492725..d5573a1d85 100644 --- a/scm-core/src/main/java/sonia/scm/collect/CallableQueueCollector.java +++ b/scm-core/src/main/java/sonia/scm/collect/CallableQueueCollector.java @@ -24,15 +24,12 @@ package sonia.scm.collect; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.collect.Lists; import org.slf4j.Logger; import org.slf4j.LoggerFactory; -//~--- JDK imports ------------------------------------------------------------ - import java.util.List; import java.util.concurrent.Callable; @@ -40,7 +37,6 @@ import java.util.concurrent.Callable; * A {@link Callable} which consumes all items from a {@link QueueIterator} and * returns a list with all items from the queue. * - * @author Sebastian Sdorra * * @since 1.29 * @@ -49,13 +45,9 @@ import java.util.concurrent.Callable; public class CallableQueueCollector implements Callable> { - /** - * the logger for CallableListComsumer - */ private static final Logger logger = LoggerFactory.getLogger(CallableQueueCollector.class); - //~--- constructors --------------------------------------------------------- /** * Constructs a new {@link CallableQueueCollector} from the given @@ -68,7 +60,6 @@ public class CallableQueueCollector implements Callable> this.queue = queue; } - //~--- methods -------------------------------------------------------------- /** * Creates a {@link List} from all items of the queue. diff --git a/scm-core/src/main/java/sonia/scm/collect/IterableQueue.java b/scm-core/src/main/java/sonia/scm/collect/IterableQueue.java index 991a80b63c..52a1877e97 100644 --- a/scm-core/src/main/java/sonia/scm/collect/IterableQueue.java +++ b/scm-core/src/main/java/sonia/scm/collect/IterableQueue.java @@ -21,10 +21,9 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ - + package sonia.scm.collect; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.collect.Iterators; import com.google.common.collect.Lists; @@ -32,37 +31,34 @@ import com.google.common.collect.Lists; import org.slf4j.Logger; import org.slf4j.LoggerFactory; -//~--- JDK imports ------------------------------------------------------------ - import java.util.Iterator; import java.util.List; /** - * A iterable queue. The queue can have multiple parallel consumer - * {@link Iterator}s, which can iterate over all items of the queue until the - * end of the queue is reached. The end of the queue if reached, if a producer + * An iterable queue. The queue can have multiple parallel consumer + * {@link Iterator}s, which can iterate over all items of the queue until the + * end of the queue is reached. The end of the queue if reached, if a producer * call the method {@link #endReached()} and the iterator has consumed all items - * of the backend list. Warning: The queue iterator blocks + * of the backend list. Warning: The queue iterator blocks * forever if the producer never call {@link #endReached()}. * - * @author Sebastian Sdorra * * @since 1.29 * @param type of the queued items */ public final class IterableQueue implements Iterable { + private boolean endReached = false; + + /** backend list of the queue */ + private List list; - /** - * the logger for IterableQueue - */ private static final Logger logger = LoggerFactory.getLogger(IterableQueue.class); - //~--- constructors --------------------------------------------------------- /** - * Constructs a new {@link IterableQueue} with the default implementation + * Constructs a new {@link IterableQueue} with the default implementation * of the backing list. * */ @@ -82,10 +78,9 @@ public final class IterableQueue implements Iterable this.list = list; } - //~--- methods -------------------------------------------------------------- /** - * Mark that the end of the queue is reached and notify all consuming + * Mark that the end of the queue is reached and notify all consuming * iterators. * * @throws IllegalStateException if the end of the queue if already reached @@ -102,11 +97,11 @@ public final class IterableQueue implements Iterable } /** - * Returns a new consuming iterator for the queue. The methods - * {@link Iterator#hasNext()} and {@link Iterator#next()} of the - * {@link Iterator} will block until the next item is pushed to the queue, if - * the queue is empty and the end is not reached. The - * {@link Iterator#remove()} method of the {@link Iterator} is not implemented + * Returns a new consuming iterator for the queue. The methods + * {@link Iterator#hasNext()} and {@link Iterator#next()} of the + * {@link Iterator} will block until the next item is pushed to the queue, if + * the queue is empty and the end is not reached. The + * {@link Iterator#remove()} method of the {@link Iterator} is not implemented * and will throw a {@link UnsupportedOperationException}. * * @@ -151,24 +146,15 @@ public final class IterableQueue implements Iterable /** * Returns the current size of the queue. - * - * - * @return current size */ int size() { return list.size(); } - //~--- get methods ---------------------------------------------------------- /** * Returns the item at the specified index in this queue. - * - * - * @param index index of the item in the queue - * - * @return item at the current index */ T get(int index) { @@ -177,20 +163,10 @@ public final class IterableQueue implements Iterable /** * Returns true if the end of the queue is reached. - * - * - * @return true if the end is reached */ boolean isEndReached() { return endReached; } - //~--- fields --------------------------------------------------------------- - - /** marker for the end of the queue */ - private boolean endReached = false; - - /** backend list of the queue */ - private List list; } diff --git a/scm-core/src/main/java/sonia/scm/collect/LimitedSortedSet.java b/scm-core/src/main/java/sonia/scm/collect/LimitedSortedSet.java index 14d9a52fb4..2721e7bd16 100644 --- a/scm-core/src/main/java/sonia/scm/collect/LimitedSortedSet.java +++ b/scm-core/src/main/java/sonia/scm/collect/LimitedSortedSet.java @@ -21,16 +21,13 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ - + package sonia.scm.collect; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.collect.ForwardingSortedSet; import com.google.common.collect.Sets; -//~--- JDK imports ------------------------------------------------------------ - import java.util.Collection; import java.util.Comparator; import java.util.SortedSet; @@ -40,13 +37,16 @@ import java.util.TreeSet; * A sorted set which is limited to a specified maximum size. If the maximum * size is reached the last element is removed from the set. * - * @author Sebastian Sdorra * * @param * @since 1.32 */ public class LimitedSortedSet extends ForwardingSortedSet { + private int maxSize; + + /** delegate set */ + private SortedSet sortedSet; /** * Constructs a new set with the specified maximum. @@ -74,11 +74,8 @@ public class LimitedSortedSet extends ForwardingSortedSet this.maxSize = maxSize; } - //~--- methods -------------------------------------------------------------- - /** - * {@inheritDoc} - */ + @Override public boolean add(E o) { @@ -89,9 +86,7 @@ public class LimitedSortedSet extends ForwardingSortedSet return added; } - /** - * {@inheritDoc} - */ + @Override public boolean addAll(Collection c) { @@ -116,7 +111,6 @@ public class LimitedSortedSet extends ForwardingSortedSet /** * Remove the last entries, if the maximum size is reached. - * */ private void cleanUp() { @@ -126,11 +120,4 @@ public class LimitedSortedSet extends ForwardingSortedSet } } - //~--- fields --------------------------------------------------------------- - - /** maximum size of the set */ - private int maxSize; - - /** delegate set */ - private SortedSet sortedSet; } diff --git a/scm-core/src/main/java/sonia/scm/collect/QueueIterator.java b/scm-core/src/main/java/sonia/scm/collect/QueueIterator.java index 57c36da740..e4e6b6ffd1 100644 --- a/scm-core/src/main/java/sonia/scm/collect/QueueIterator.java +++ b/scm-core/src/main/java/sonia/scm/collect/QueueIterator.java @@ -24,12 +24,9 @@ package sonia.scm.collect; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.collect.UnmodifiableIterator; -//~--- JDK imports ------------------------------------------------------------ - import java.util.NoSuchElementException; import java.util.concurrent.TimeUnit; @@ -38,13 +35,15 @@ import java.util.concurrent.TimeUnit; * only be created from the {@link IterableQueue} by calling the * {@link IterableQueue#iterator()}. * - * @author Sebastian Sdorra * * @since 1.29 * @param type of the queued items */ public final class QueueIterator extends UnmodifiableIterator { + private final IterableQueue queue; + + private int index = 0; /** * Constructs a new {@link QueueIterator} for the given {@link IterableQueue}. @@ -57,7 +56,6 @@ public final class QueueIterator extends UnmodifiableIterator this.queue = queue; } - //~--- methods -------------------------------------------------------------- /** * Returns the next item in the queue. This method will block until the next @@ -79,16 +77,11 @@ public final class QueueIterator extends UnmodifiableIterator return queue.get(index++); } - //~--- get methods ---------------------------------------------------------- /** - * Returns {@code true} {@code true} if the queue has more items. + * Returns {@code true} if the queue has more items. * This method will block until the next item is pushed to the queue, if the - * queue is empty and the end is not - * reached. - * - * - * @return {@code true} {@code true} if the queue has more items + * queue is empty and the end is not reached. */ @Override public boolean hasNext() @@ -118,11 +111,4 @@ public final class QueueIterator extends UnmodifiableIterator return result; } - //~--- fields --------------------------------------------------------------- - - /** queue for the iterator */ - private final IterableQueue queue; - - /** current index */ - private int index = 0; } diff --git a/scm-core/src/main/java/sonia/scm/config/ScmConfiguration.java b/scm-core/src/main/java/sonia/scm/config/ScmConfiguration.java index 1f946cb664..3cbdbbdc2c 100644 --- a/scm-core/src/main/java/sonia/scm/config/ScmConfiguration.java +++ b/scm-core/src/main/java/sonia/scm/config/ScmConfiguration.java @@ -50,7 +50,6 @@ import java.util.concurrent.TimeUnit; /** * The main configuration object for SCM-Manager. * - * @author Sebastian Sdorra */ @Singleton diff --git a/scm-core/src/main/java/sonia/scm/config/ScmConfigurationChangedEvent.java b/scm-core/src/main/java/sonia/scm/config/ScmConfigurationChangedEvent.java index 5f599bf6e8..f0be75708d 100644 --- a/scm-core/src/main/java/sonia/scm/config/ScmConfigurationChangedEvent.java +++ b/scm-core/src/main/java/sonia/scm/config/ScmConfigurationChangedEvent.java @@ -30,7 +30,6 @@ import sonia.scm.event.Event; * The {@link ScmConfigurationChangedEvent} is fired whenever the * {@link ScmConfiguration} changes. * - * @author Sebastian Sdorra * @since 1.34 */ @Event diff --git a/scm-core/src/main/java/sonia/scm/event/AbstractHandlerEvent.java b/scm-core/src/main/java/sonia/scm/event/AbstractHandlerEvent.java index 78ef3d3190..03b066b25f 100644 --- a/scm-core/src/main/java/sonia/scm/event/AbstractHandlerEvent.java +++ b/scm-core/src/main/java/sonia/scm/event/AbstractHandlerEvent.java @@ -21,10 +21,9 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ - + package sonia.scm.event; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.MoreObjects; import com.google.common.base.Objects; @@ -33,7 +32,6 @@ import sonia.scm.HandlerEventType; /** * Abstract base class for {@link HandlerEvent}. * - * @author Sebastian Sdorra * @since 2.0.0 * * @param @@ -41,26 +39,18 @@ import sonia.scm.HandlerEventType; public class AbstractHandlerEvent implements HandlerEvent { - /** - * Constructs ... - * - * - * @param eventType - * @param item - */ + private final HandlerEventType eventType; + + /** changed item */ + private final T item; + + private final T oldItem; + public AbstractHandlerEvent(HandlerEventType eventType, T item) { this(eventType, item, null); } - /** - * Constructs ... - * - * - * @param eventType - * @param item - * @param oldItem - */ public AbstractHandlerEvent(HandlerEventType eventType, T item, T oldItem) { this.eventType = eventType; @@ -68,16 +58,7 @@ public class AbstractHandlerEvent implements HandlerEvent this.oldItem = oldItem; } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param obj - * - * @return - */ @Override public boolean equals(Object obj) { @@ -98,24 +79,14 @@ public class AbstractHandlerEvent implements HandlerEvent && Objects.equal(oldItem, other.oldItem); } - /** - * Method description - * - * - * @return - */ + @Override public int hashCode() { return Objects.hashCode(eventType, item, oldItem); } - /** - * Method description - * - * - * @return - */ + @Override public String toString() { @@ -128,13 +99,9 @@ public class AbstractHandlerEvent implements HandlerEvent //J+ } - //~--- get methods ---------------------------------------------------------- /** * Returns the type of the event. - * - * - * @return type of the event */ @Override public HandlerEventType getEventType() @@ -144,9 +111,6 @@ public class AbstractHandlerEvent implements HandlerEvent /** * Returns changed item. - * - * - * @return changed item */ @Override public T getItem() @@ -155,7 +119,7 @@ public class AbstractHandlerEvent implements HandlerEvent } /** - * Returns old item or null. This method will always return null expect of + * Returns old item or null. This method will always return null expect of * modification events. * * @@ -167,14 +131,4 @@ public class AbstractHandlerEvent implements HandlerEvent return oldItem; } - //~--- fields --------------------------------------------------------------- - - /** event type */ - private final HandlerEventType eventType; - - /** changed item */ - private final T item; - - /** old item */ - private final T oldItem; } diff --git a/scm-core/src/main/java/sonia/scm/event/HandlerEvent.java b/scm-core/src/main/java/sonia/scm/event/HandlerEvent.java index 30fcf20605..4c3ce3b65e 100644 --- a/scm-core/src/main/java/sonia/scm/event/HandlerEvent.java +++ b/scm-core/src/main/java/sonia/scm/event/HandlerEvent.java @@ -24,14 +24,12 @@ package sonia.scm.event; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.HandlerEventType; /** * Base class for handler events. * - * @author Sebastian Sdorra * @since 1.23 * * @param @@ -39,19 +37,10 @@ import sonia.scm.HandlerEventType; public interface HandlerEvent { - /** - * Returns the type of the event, - * - * - * @return event type - */ public HandlerEventType getEventType(); /** * Returns the item which has changed. - * - * - * @return changed item */ public T getItem(); diff --git a/scm-core/src/main/java/sonia/scm/event/ScmEventBus.java b/scm-core/src/main/java/sonia/scm/event/ScmEventBus.java index 860ef43a46..b2755dfbc0 100644 --- a/scm-core/src/main/java/sonia/scm/event/ScmEventBus.java +++ b/scm-core/src/main/java/sonia/scm/event/ScmEventBus.java @@ -24,18 +24,12 @@ package sonia.scm.event; -//~--- non-JDK imports -------------------------------------------------------- import com.github.legman.EventBus; -import com.github.legman.Subscribe; - import org.slf4j.Logger; import org.slf4j.LoggerFactory; - import sonia.scm.util.ServiceUtil; -//~--- JDK imports ------------------------------------------------------------ - import java.util.ServiceLoader; /** @@ -43,30 +37,20 @@ import java.util.ServiceLoader; * themselves. The ScmEventBus searches its implementation with the * {@link ServiceLoader}. * - * @author Sebastian Sdorra * @apiviz.landmark * @see EventBus * @since 1.23 */ public abstract class ScmEventBus { - /** - * Field description - */ private static ScmEventBus instance; - /** - * the logger for ScmEventBus - */ private static final Logger logger = LoggerFactory.getLogger(ScmEventBus.class); - //~--- get methods ---------------------------------------------------------- /** * Returns the singleton instance of the ScmEventBus - * - * @return singleton instance */ public static ScmEventBus getInstance() { synchronized (ScmEventBus.class) { @@ -86,10 +70,9 @@ public abstract class ScmEventBus { return instance; } - //~--- methods -------------------------------------------------------------- /** - * Post a event through the event bus. All registered subscribers will be + * Post an event through the event bus. All registered subscribers will be * notified by the event bus. * * @param event event to send through the event bus @@ -97,17 +80,13 @@ public abstract class ScmEventBus { public abstract void post(Object event); /** - * Register all handler methods with the {@link Subscribe} annotation as + * Register all handler methods with the {@link com.github.legman.Subscribe} annotation as * subscriber for the event bus. - * - * @param subscriber subscriber object */ public abstract void register(Object subscriber); /** * Unregister the given subscriber object from the event bus. - * - * @param subscriber subscriber object to unregister */ public abstract void unregister(Object subscriber); } diff --git a/scm-core/src/main/java/sonia/scm/filter/Filters.java b/scm-core/src/main/java/sonia/scm/filter/Filters.java index 3c8b9b082e..f9e6dd534b 100644 --- a/scm-core/src/main/java/sonia/scm/filter/Filters.java +++ b/scm-core/src/main/java/sonia/scm/filter/Filters.java @@ -30,52 +30,34 @@ import static sonia.scm.api.v2.resources.ScmPathInfo.REST_API_PATH; * Useful constants for filter implementations. * * @since 2.0.0 - * @author Sebastian Sdorra */ public final class Filters { - /** Field description */ public static final String PATTERN_ALL = "/*"; - /** Field description */ public static final String PATTERN_DEBUG = "/debug.html"; - /** Field description */ public static final String PATTERN_RESTAPI = REST_API_PATH + "/*"; - /** authentication priority */ public static final int PRIORITY_AUTHENTICATION = 5000; - /** authorization priority */ public static final int PRIORITY_AUTHORIZATION = 6000; - /** base url priority */ public static final int PRIORITY_BASEURL = 1000; - /** post authentication priority */ public static final int PRIORITY_POST_AUTHENTICATION = 5500; - /** pre authorization priority */ public static final int PRIORITY_POST_AUTHORIZATION = 6500; - /** post base url priority */ public static final int PRIORITY_POST_BASEURL = 1500; - /** pre authentication priority */ public static final int PRIORITY_PRE_AUTHENTICATION = 4500; - /** pre authorization priority */ public static final int PRIORITY_PRE_AUTHORIZATION = 5500; - /** pre base url priority */ public static final int PRIORITY_PRE_BASEURL = 500; - //~--- constructors --------------------------------------------------------- - /** - * Constructs ... - * - */ private Filters() {} } diff --git a/scm-core/src/main/java/sonia/scm/filter/GZipFilterConfig.java b/scm-core/src/main/java/sonia/scm/filter/GZipFilterConfig.java index eaa51da4ca..08dbd1a4ff 100644 --- a/scm-core/src/main/java/sonia/scm/filter/GZipFilterConfig.java +++ b/scm-core/src/main/java/sonia/scm/filter/GZipFilterConfig.java @@ -27,25 +27,20 @@ package sonia.scm.filter; /** * Configuration for the {@link GZipResponseFilter}. * - * @author Sebastian Sdorra * @since 1.16 */ public class GZipFilterConfig { - + private boolean bufferResponse = true; /** * Returns true if the response should be buffered. - * - * - * @return true if the response should be buffered */ public boolean isBufferResponse() { return bufferResponse; } - //~--- set methods ---------------------------------------------------------- /** * Enables or disables response buffering. Default buffering is enabled. @@ -57,8 +52,4 @@ public class GZipFilterConfig this.bufferResponse = bufferResponse; } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private boolean bufferResponse = true; } diff --git a/scm-core/src/main/java/sonia/scm/filter/GZipResponseStream.java b/scm-core/src/main/java/sonia/scm/filter/GZipResponseStream.java index 5f33019c8a..37f92949af 100644 --- a/scm-core/src/main/java/sonia/scm/filter/GZipResponseStream.java +++ b/scm-core/src/main/java/sonia/scm/filter/GZipResponseStream.java @@ -24,7 +24,6 @@ package sonia.scm.filter; -//~--- non-JDK imports -------------------------------------------------------- import jakarta.servlet.ServletOutputStream; import jakarta.servlet.WriteListener; @@ -40,41 +39,31 @@ import java.util.zip.GZIPOutputStream; /** * Response stream for gzip encoding. * - * @author Sebastian Sdorra * @since 1.15 */ public class GZipResponseStream extends ServletOutputStream { - /** - * the logger for GZipResponseStream - */ + protected ByteArrayOutputStream baos = null; + + protected GZIPOutputStream gzipstream = null; + + protected boolean closed = false; + + protected ServletOutputStream output = null; + + protected HttpServletResponse response = null; + private static final Logger logger = LoggerFactory.getLogger(GZipResponseStream.class); - //~--- constructors --------------------------------------------------------- - /** - * Constructs ... - * - * - * @param response - * - * @throws IOException - */ public GZipResponseStream(HttpServletResponse response) throws IOException { this(response, null); } /** - * Constructs ... - * - * - * @param response - * @param config - * - * @throws IOException * @since 1.16 */ public GZipResponseStream(HttpServletResponse response, @@ -108,14 +97,7 @@ public class GZipResponseStream extends ServletOutputStream } } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @throws IOException - */ @Override public void close() throws IOException { @@ -147,12 +129,6 @@ public class GZipResponseStream extends ServletOutputStream closed = true; } - /** - * Method description - * - * - * @throws IOException - */ @Override public void flush() throws IOException { @@ -164,24 +140,12 @@ public class GZipResponseStream extends ServletOutputStream gzipstream.flush(); } - /** - * Method description - * - */ - public void reset() + public void reset() { // noop } - /** - * Method description - * - * - * @param b - * - * @throws IOException - */ @Override public void write(int b) throws IOException { @@ -193,30 +157,12 @@ public class GZipResponseStream extends ServletOutputStream gzipstream.write((byte) b); } - /** - * Method description - * - * - * @param b - * - * @throws IOException - */ @Override public void write(byte b[]) throws IOException { write(b, 0, b.length); } - /** - * Method description - * - * - * @param b - * @param off - * @param len - * - * @throws IOException - */ @Override public void write(byte b[], int off, int len) throws IOException { @@ -228,14 +174,7 @@ public class GZipResponseStream extends ServletOutputStream gzipstream.write(b, off, len); } - //~--- get methods ---------------------------------------------------------- - /** - * Returns true if the stream is closed. - * - * - * @return true if the stream is closed - */ public boolean isClosed() { return closed; @@ -255,20 +194,4 @@ public class GZipResponseStream extends ServletOutputStream } } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - protected ByteArrayOutputStream baos = null; - - /** Field description */ - protected GZIPOutputStream gzipstream = null; - - /** Field description */ - protected boolean closed = false; - - /** Field description */ - protected ServletOutputStream output = null; - - /** Field description */ - protected HttpServletResponse response = null; } diff --git a/scm-core/src/main/java/sonia/scm/filter/GZipResponseWrapper.java b/scm-core/src/main/java/sonia/scm/filter/GZipResponseWrapper.java index b6a39f1b70..5d4bbc8c3e 100644 --- a/scm-core/src/main/java/sonia/scm/filter/GZipResponseWrapper.java +++ b/scm-core/src/main/java/sonia/scm/filter/GZipResponseWrapper.java @@ -24,7 +24,6 @@ package sonia.scm.filter; -//~--- non-JDK imports -------------------------------------------------------- import jakarta.servlet.ServletOutputStream; import jakarta.servlet.http.HttpServletResponse; @@ -38,18 +37,19 @@ import java.io.PrintWriter; /** * Response wrapper for gzip encoding. * - * @author Sebastian Sdorra * @since 1.15 */ public class GZipResponseWrapper extends HttpServletResponseWrapper { + protected GZipFilterConfig config = null; + + protected HttpServletResponse origResponse = null; + + protected GZipResponseStream stream = null; + + /** response writer */ + protected PrintWriter writer = null; - /** - * Constructs a new GZipResponseWrapper - * - * - * @param response http response to wrap - */ public GZipResponseWrapper(HttpServletResponse response) { super(response); @@ -57,12 +57,7 @@ public class GZipResponseWrapper extends HttpServletResponseWrapper } /** - * Constructs ... - * - * - * @param response * @since 1.16 - * @param config */ public GZipResponseWrapper(HttpServletResponse response, GZipFilterConfig config) @@ -72,13 +67,8 @@ public class GZipResponseWrapper extends HttpServletResponseWrapper this.config = config; } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - */ - public void finishResponse() + public void finishResponse() { IOUtil.close(writer); @@ -88,12 +78,6 @@ public class GZipResponseWrapper extends HttpServletResponseWrapper } } - /** - * Method description - * - * - * @throws IOException - */ @Override public void flushBuffer() throws IOException { @@ -103,27 +87,11 @@ public class GZipResponseWrapper extends HttpServletResponseWrapper } } - //~--- get methods ---------------------------------------------------------- - - /** - * Method description - * - * - * @return - */ public GZipFilterConfig getConfig() { return config; } - /** - * Method description - * - * - * @return - * - * @throws IOException - */ @Override public ServletOutputStream getOutputStream() throws IOException { @@ -140,14 +108,6 @@ public class GZipResponseWrapper extends HttpServletResponseWrapper return stream; } - /** - * Method description - * - * - * @return - * - * @throws IOException - */ @Override public PrintWriter getWriter() throws IOException { @@ -168,43 +128,14 @@ public class GZipResponseWrapper extends HttpServletResponseWrapper return writer; } - //~--- set methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param length - */ @Override public void setContentLength(int length) {} - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @return - * - * @throws IOException - */ private GZipResponseStream createOutputStream() throws IOException { return new GZipResponseStream(origResponse, config); } - //~--- fields --------------------------------------------------------------- - - /** gzip filter config */ - protected GZipFilterConfig config = null; - - /** original http response */ - protected HttpServletResponse origResponse = null; - - /** gzip stream */ - protected GZipResponseStream stream = null; - - /** response writer */ - protected PrintWriter writer = null; } diff --git a/scm-core/src/main/java/sonia/scm/group/AbstractGroupManager.java b/scm-core/src/main/java/sonia/scm/group/AbstractGroupManager.java index b459f629c0..ceaa5cea2e 100644 --- a/scm-core/src/main/java/sonia/scm/group/AbstractGroupManager.java +++ b/scm-core/src/main/java/sonia/scm/group/AbstractGroupManager.java @@ -24,7 +24,6 @@ package sonia.scm.group; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.HandlerEventType; import sonia.scm.event.ScmEventBus; @@ -33,7 +32,6 @@ import sonia.scm.event.ScmEventBus; * Abstract base class for {@link GroupManager} implementations. This class * implements the listener methods of the {@link GroupManager} interface. * - * @author Sebastian Sdorra */ public abstract class AbstractGroupManager implements GroupManager { diff --git a/scm-core/src/main/java/sonia/scm/group/Group.java b/scm-core/src/main/java/sonia/scm/group/Group.java index 1f7b775245..c64ec4a0d5 100644 --- a/scm-core/src/main/java/sonia/scm/group/Group.java +++ b/scm-core/src/main/java/sonia/scm/group/Group.java @@ -24,7 +24,6 @@ package sonia.scm.group; -//~--- non-JDK imports -------------------------------------------------------- import com.github.sdorra.ssp.PermissionObject; import com.github.sdorra.ssp.StaticPermissions; @@ -48,14 +47,11 @@ import java.util.Arrays; import java.util.Collections; import java.util.List; -//~--- JDK imports ------------------------------------------------------------ - /** * Organizes users into a group for easier permissions management. *

* TODO for 2.0: Use a set instead of a list for members * - * @author Sebastian Sdorra */ @IndexedType(permission = "group:list") @StaticPermissions( @@ -69,51 +65,46 @@ import java.util.List; public class Group extends BasicPropertiesAware implements ModelObject, PermissionObject, ReducedModelObject, AuditLogEntity { - /** - * Field description - */ private static final long serialVersionUID = 1752369869345245872L; - //~--- constructors --------------------------------------------------------- + private boolean external = false; + + @Indexed + private Long creationDate; + + @Indexed(defaultQuery = true, highlighted = true) + private String description; + + @Indexed + private Long lastModified; + + private List members; + + @Indexed(defaultQuery = true, boost = 1.5f) + private String name; + + private String type; + + /** - * Constructs {@link Group} object. This constructor is required by JAXB. + * This constructor is required by JAXB. */ public Group() { } - /** - * Constructs {@link Group} object. - * - * @param type of the group - * @param name of the group - */ public Group(String type, String name) { this.type = type; this.name = name; this.members = Lists.newArrayList(); } - /** - * Constructs {@link Group} object. - * - * @param type of the group - * @param name of the group - * @param members of the groups - */ public Group(String type, String name, List members) { this.type = type; this.name = name; this.members = members; } - /** - * Constructs {@link Group} object. - * - * @param type of the group - * @param name of the group - * @param members of the groups - */ public Group(String type, String name, String... members) { this.type = type; this.name = name; @@ -124,30 +115,14 @@ public class Group extends BasicPropertiesAware } } - //~--- methods -------------------------------------------------------------- - - /** - * Add a new member to the group. - * - * @param member - The name of new group member - * @return true if the operation was successful - */ public boolean add(String member) { return getMembers().add(member); } - /** - * Remove all members of the group. - */ public void clear() { members.clear(); } - /** - * Returns a clone of the group. - * - * @return a clone of the group - */ @Override public Group clone() { Group group = null; @@ -174,12 +149,6 @@ public class Group extends BasicPropertiesAware group.setExternal(external); } - /** - * Returns true if this {@link Group} is the same as the obj argument. - * - * @param obj - the reference object with which to compare - * @return true if this {@link Group} is the same as the obj argument - */ @Override public boolean equals(Object obj) { if (obj == null) { @@ -204,8 +173,6 @@ public class Group extends BasicPropertiesAware /** * Returns a hash code value for this {@link Group}. - * - * @return a hash code value for this {@link Group} */ @Override public int hashCode() { @@ -213,21 +180,10 @@ public class Group extends BasicPropertiesAware lastModified, properties); } - /** - * Remove the given member from this group. - * - * @param member to remove from this group - * @return true if the operation was successful - */ public boolean remove(String member) { return members.remove(member); } - /** - * Returns a {@link String} that represents this group. - * - * @return a {@link String} that represents this group - */ @Override public String toString() { //J- @@ -244,22 +200,11 @@ public class Group extends BasicPropertiesAware //J+ } - //~--- get methods ---------------------------------------------------------- - /** - * Returns a timestamp of the creation date of this group. - * - * @return a timestamp of the creation date of this group - */ public Long getCreationDate() { return creationDate; } - /** - * Returns the description of this group. - * - * @return the description of this group - */ public String getDescription() { return description; } @@ -267,8 +212,6 @@ public class Group extends BasicPropertiesAware /** * Returns the unique name of this group. This method is an alias for the * {@link #getName()} method. - * - * @return the unique name of this group */ @Override public String getId() { @@ -280,21 +223,11 @@ public class Group extends BasicPropertiesAware return description; } - /** - * Returns a timestamp of the last modified date of this group. - * - * @return a timestamp of the last modified date of this group - */ @Override public Long getLastModified() { return lastModified; } - /** - * Returns a {@link java.util.List} of all members of this group. - * - * @return a {@link java.util.List} of all members of this group - */ public List getMembers() { if (external) { return Collections.emptyList(); @@ -307,8 +240,6 @@ public class Group extends BasicPropertiesAware /** * Returns the unique name of this group. - * - * @return the unique name of this group */ public String getName() { return name; @@ -316,149 +247,54 @@ public class Group extends BasicPropertiesAware /** * Returns the type of this group. The default type is xml. - * - * @return the type of this group */ @Override public String getType() { return type; } - /** - * Returns {@code true} if the members of the groups managed external of scm-manager. - * - * @return {@code true} if the group is an external group - */ public boolean isExternal() { return external; } - /** - * Returns true if the member is a member of this group. - * - * @param member - The name of the member - * @return true if the member is a member of this group - */ public boolean isMember(String member) { return (members != null) && members.contains(member); } - /** - * Returns true if the group is valid. - * - * @return true if the group is valid - */ @Override public boolean isValid() { return ValidationUtil.isNameValid(name) && Util.isNotEmpty(type); } - //~--- set methods ---------------------------------------------------------- - /** - * Sets the date the group was created. - * - * @param creationDate - date the group was last modified - */ public void setCreationDate(Long creationDate) { this.creationDate = creationDate; } - /** - * Sets the description of the group. - * - * @param description of the group - */ public void setDescription(String description) { this.description = description; } - /** - * Sets the date the group was last modified. - * - * @param lastModified - date the group was last modified - */ public void setLastModified(Long lastModified) { this.lastModified = lastModified; } - /** - * Sets the members of the group. - * - * @param members of the group - */ public void setMembers(List members) { this.members = members; } - /** - * Sets the name of the group. - * - * @param name of the group - */ public void setName(String name) { this.name = name; } - /** - * Sets the type of the group. - * - * @param type of the group - */ public void setType(String type) { this.type = type; } - /** - * {@code true} to mark the group as external. - * - * @param {@code true} for a external group - */ public void setExternal(boolean external) { this.external = external; } - //~--- fields --------------------------------------------------------------- - - /** - * external group - */ - private boolean external = false; - - /** - * timestamp of the creation date of this group - */ - @Indexed - private Long creationDate; - - /** - * description of this group - */ - @Indexed(defaultQuery = true, highlighted = true) - private String description; - - /** - * timestamp of the last modified date of this group - */ - @Indexed - private Long lastModified; - - /** - * members of this group - */ - private List members; - - /** - * name of this group - */ - @Indexed(defaultQuery = true, boost = 1.5f) - private String name; - - /** - * type of this group - */ - private String type; - /** * Get the entity name which is used for the audit log * @since 2.43.0 diff --git a/scm-core/src/main/java/sonia/scm/group/GroupDAO.java b/scm-core/src/main/java/sonia/scm/group/GroupDAO.java index 69da53e4fc..10173d1cf5 100644 --- a/scm-core/src/main/java/sonia/scm/group/GroupDAO.java +++ b/scm-core/src/main/java/sonia/scm/group/GroupDAO.java @@ -24,16 +24,14 @@ package sonia.scm.group; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.GenericDAO; /** - * Data access object for groups. This class should only used by the + * Data access object for groups. This class should only be used by the * {@link GroupManager}. Plugins and other classes should use the * {@link GroupManager} instead. * - * @author Sebastian Sdorra * @since 1.14 */ public interface GroupDAO extends GenericDAO {} diff --git a/scm-core/src/main/java/sonia/scm/group/GroupEvent.java b/scm-core/src/main/java/sonia/scm/group/GroupEvent.java index c8e04f6ecb..7097e6f4cb 100644 --- a/scm-core/src/main/java/sonia/scm/group/GroupEvent.java +++ b/scm-core/src/main/java/sonia/scm/group/GroupEvent.java @@ -24,7 +24,6 @@ package sonia.scm.group; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.HandlerEventType; @@ -34,33 +33,17 @@ import sonia.scm.event.Event; /** * The GroupEvent is fired if a group object changes. * - * @author Sebastian Sdorra * @since 1.23 */ @Event public class GroupEvent extends AbstractHandlerEvent { - /** - * Constructs a new group event. - * - * - * @param eventType type of the event - * @param group changed group - */ public GroupEvent(HandlerEventType eventType, Group group) { super(eventType, group); } - /** - * Constructs a new group event. - * - * - * @param eventType type of the event - * @param group changed group - * @param oldGroup old group - */ public GroupEvent(HandlerEventType eventType, Group group, Group oldGroup) { super(eventType, group, oldGroup); diff --git a/scm-core/src/main/java/sonia/scm/group/GroupManager.java b/scm-core/src/main/java/sonia/scm/group/GroupManager.java index c743a79c3c..76b58c08fa 100644 --- a/scm-core/src/main/java/sonia/scm/group/GroupManager.java +++ b/scm-core/src/main/java/sonia/scm/group/GroupManager.java @@ -24,7 +24,6 @@ package sonia.scm.group; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.Manager; import sonia.scm.search.Searchable; @@ -32,13 +31,10 @@ import sonia.scm.search.Searchable; import java.util.Collection; import java.util.Set; -//~--- JDK imports ------------------------------------------------------------ - /** * The central class for managing {@link Group}s. * This class is a singleton and is available via injection. * - * @author Sebastian Sdorra */ public interface GroupManager extends Manager, Searchable @@ -46,11 +42,6 @@ public interface GroupManager /** * Returns a {@link Collection} of all groups assigned to the given member. - * - * - * @param member - The name of the member - * - * @return all groups assigned to the given member */ Collection getGroupsForMember(String member); diff --git a/scm-core/src/main/java/sonia/scm/group/GroupManagerDecorator.java b/scm-core/src/main/java/sonia/scm/group/GroupManagerDecorator.java index 430f0348ca..e94b7dd603 100644 --- a/scm-core/src/main/java/sonia/scm/group/GroupManagerDecorator.java +++ b/scm-core/src/main/java/sonia/scm/group/GroupManagerDecorator.java @@ -24,7 +24,6 @@ package sonia.scm.group; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.ManagerDecorator; import sonia.scm.search.SearchRequest; @@ -32,54 +31,31 @@ import sonia.scm.search.SearchRequest; import java.util.Collection; import java.util.Set; -//~--- JDK imports ------------------------------------------------------------ - /** * Decorator for {@link GroupManager}. * - * @author Sebastian Sdorra * @since 1.23 */ public class GroupManagerDecorator extends ManagerDecorator implements GroupManager { - /** - * Constructs ... - * - * - * @param decorated - */ public GroupManagerDecorator(GroupManager decorated) { super(decorated); this.decorated = decorated; } - //~--- methods -------------------------------------------------------------- - /** - * {@inheritDoc} - * - * - * @param searchRequest - * - * @return - */ @Override public Collection search(SearchRequest searchRequest) { return decorated.search(searchRequest); } - //~--- get methods ---------------------------------------------------------- /** * Returns the decorated {@link GroupManager}. - * - * - * @return decorated {@link GroupManager} - * * @since 1.34 */ public GroupManager getDecorated() @@ -87,14 +63,6 @@ public class GroupManagerDecorator return decorated; } - /** - * {@inheritDoc} - * - * - * @param member - * - * @return - */ @Override public Collection getGroupsForMember(String member) { @@ -106,6 +74,5 @@ public class GroupManagerDecorator return decorated.getAllNames(); } - /** Field description */ private final GroupManager decorated; } diff --git a/scm-core/src/main/java/sonia/scm/group/GroupManagerDecoratorFactory.java b/scm-core/src/main/java/sonia/scm/group/GroupManagerDecoratorFactory.java index 0cfe6fe97b..1ab0459f95 100644 --- a/scm-core/src/main/java/sonia/scm/group/GroupManagerDecoratorFactory.java +++ b/scm-core/src/main/java/sonia/scm/group/GroupManagerDecoratorFactory.java @@ -24,7 +24,6 @@ package sonia.scm.group; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.DecoratorFactory; import sonia.scm.plugin.ExtensionPoint; @@ -32,7 +31,6 @@ import sonia.scm.plugin.ExtensionPoint; /** * Factory for group manager decorators. * - * @author Sebastian Sdorra * @since 1.23 */ @ExtensionPoint diff --git a/scm-core/src/main/java/sonia/scm/group/GroupModificationEvent.java b/scm-core/src/main/java/sonia/scm/group/GroupModificationEvent.java index 5b9d57909a..d28e37503b 100644 --- a/scm-core/src/main/java/sonia/scm/group/GroupModificationEvent.java +++ b/scm-core/src/main/java/sonia/scm/group/GroupModificationEvent.java @@ -30,7 +30,6 @@ import sonia.scm.ModificationHandlerEvent; /** * Event which is fired whenever a group is modified. * - * @author Sebastian Sdorra * @since 1.48 */ public class GroupModificationEvent extends GroupEvent implements ModificationHandlerEvent diff --git a/scm-core/src/main/java/sonia/scm/i18n/Bundle.java b/scm-core/src/main/java/sonia/scm/i18n/Bundle.java index 1bbb7a4687..e118d72b5b 100644 --- a/scm-core/src/main/java/sonia/scm/i18n/Bundle.java +++ b/scm-core/src/main/java/sonia/scm/i18n/Bundle.java @@ -21,16 +21,13 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ - + package sonia.scm.i18n; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.util.ClassLoaders; import sonia.scm.util.Util; -//~--- JDK imports ------------------------------------------------------------ - import java.text.MessageFormat; import java.util.Locale; @@ -41,23 +38,14 @@ import java.util.ResourceBundle; * This class is a wrapper for {@link ResourceBundle}, it applies some missing * format options missing in {@link ResourceBundle}. * - * @author Sebastian Sdorra * @since 1.15 */ public class Bundle { + private final ResourceBundle bundle; - /** Field description */ private static final String SEPARATOR = System.getProperty("line.separator"); - //~--- constructors --------------------------------------------------------- - - /** - * Constructs ... - * - * - * @param bundle - */ private Bundle(ResourceBundle bundle) { this.bundle = bundle; @@ -68,7 +56,6 @@ public class Bundle /** * Creates a new bundle instance * - * * @param path path to the properties file * * @return new bundle instance @@ -81,7 +68,6 @@ public class Bundle /** * Creates a new bundle instance * - * * @param path path to the properties file * @param locale locale for the properties file * @@ -95,7 +81,6 @@ public class Bundle /** * Creates a new bundle instance * - * * @param path path to the properties file * @param locale locale for the properties file * @param classLoader classLoader to load @@ -128,7 +113,7 @@ public class Bundle * @param key key in the properties file * @param args format arguments * - * @return formated message + * @return formatted message */ public String getLine(String key, Object... args) { @@ -142,7 +127,7 @@ public class Bundle * @param key key in the properties file * @param args format arguments * - * @return formated message + * @return formatted message */ public String getString(String key, Object... args) { @@ -164,7 +149,7 @@ public class Bundle * @param key key in the properties file * @param args format arguments * - * @return formated message or null + * @return formatted message or null * * @since 1.37 */ @@ -180,9 +165,4 @@ public class Bundle return msg; } - - //~--- fields --------------------------------------------------------------- - - /** resource bundle */ - private final ResourceBundle bundle; } diff --git a/scm-core/src/main/java/sonia/scm/i18n/I18nException.java b/scm-core/src/main/java/sonia/scm/i18n/I18nException.java index 96fe074116..404b609889 100644 --- a/scm-core/src/main/java/sonia/scm/i18n/I18nException.java +++ b/scm-core/src/main/java/sonia/scm/i18n/I18nException.java @@ -24,53 +24,22 @@ package sonia.scm.i18n; -/** - * - * @author Sebastian Sdorra - */ public class I18nException extends RuntimeException { - - /** Field description */ private static final long serialVersionUID = 1845326427312983227L; - //~--- constructors --------------------------------------------------------- - - /** - * Constructs ... - * - */ public I18nException() {} - /** - * Constructs ... - * - * - * @param message - */ public I18nException(String message) { super(message); } - /** - * Constructs ... - * - * - * @param cause - */ public I18nException(Throwable cause) { super(cause); } - /** - * Constructs ... - * - * - * @param message - * @param cause - */ public I18nException(String message, Throwable cause) { super(message, cause); diff --git a/scm-core/src/main/java/sonia/scm/i18n/I18nMessages.java b/scm-core/src/main/java/sonia/scm/i18n/I18nMessages.java index 9aa45ff898..77c72cc6b7 100644 --- a/scm-core/src/main/java/sonia/scm/i18n/I18nMessages.java +++ b/scm-core/src/main/java/sonia/scm/i18n/I18nMessages.java @@ -24,7 +24,6 @@ package sonia.scm.i18n; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Objects; import com.google.common.cache.Cache; @@ -35,8 +34,6 @@ import sonia.scm.util.ClassLoaders; import java.lang.reflect.Field; import java.util.Locale; -//~--- JDK imports ------------------------------------------------------------ - /** * The I18nMessages class instantiates a class and initializes all {@link String} * fields with values from a resource bundle. The resource bundle must have the @@ -45,25 +42,17 @@ import java.util.Locale; * {@link I18n} annotation which holds the key. I18nMessages injects also the * locale and the bundle if it founds a field with the corresponding type. * - * @author Sebastian Sdorra * @since 1.37 */ public final class I18nMessages { - /** Field description */ private static final Cache cache = CacheBuilder.newBuilder().build(); - //~--- constructors --------------------------------------------------------- - /** - * Constructs ... - * - */ private I18nMessages() {} - //~--- get methods ---------------------------------------------------------- /** * Same as {@link #get(java.lang.Class, java.util.Locale)}, with locale @@ -87,8 +76,6 @@ public final class I18nMessages * @param msgClass message class * @param request servlet request * @param type of message class - * - * @return */ public static T get(Class msgClass, HttpServletRequest request) { @@ -96,15 +83,13 @@ public final class I18nMessages } /** - * Returns a instance of the given message class with all message fields + * Returns an instance of the given message class with all message fields * initialized. * * * @param msgClass message class * @param locale locale * @param type of the message class - * - * @return instance of message class */ @SuppressWarnings("unchecked") public synchronized static T get(Class msgClass, Locale locale) @@ -121,18 +106,6 @@ public final class I18nMessages return instance; } - //~--- methods -------------------------------------------------------------- - - /** - * Method description - * - * - * @param msgClass - * @param locale - * @param - * - * @return - */ private static T createInstance(Class msgClass, Locale locale) { Bundle bundle = Bundle.getBundle(msgClass.getName(), locale, @@ -152,18 +125,6 @@ public final class I18nMessages return instance; } - /** - * Method description - * - * - * @param bundle - * @param locale - * @param msgClass - * @param instance - * - * @throws IllegalAccessException - * @throws IllegalArgumentException - */ private static void initializeInstance(Bundle bundle, Locale locale, Class msgClass, Object instance) throws IllegalArgumentException, IllegalAccessException @@ -202,41 +163,19 @@ public final class I18nMessages } } - //~--- inner classes -------------------------------------------------------- - /** - * Class description - * - * - * @version Enter version here..., 14/03/15 - * @author Enter your name here... - */ private static class CacheKey { + private final Locale locale; + + private final Class msgClass; - /** - * Constructs ... - * - * - * @param locale - * @param msgClass - */ public CacheKey(Locale locale, Class msgClass) { this.locale = locale; this.msgClass = msgClass; } - //~--- methods ------------------------------------------------------------ - - /** - * Method description - * - * - * @param obj - * - * @return - */ @Override public boolean equals(Object obj) { @@ -256,24 +195,11 @@ public final class I18nMessages && Objects.equal(msgClass, other.msgClass); } - /** - * Method description - * - * - * @return - */ @Override public int hashCode() { return Objects.hashCode(locale, msgClass); } - //~--- fields ------------------------------------------------------------- - - /** Field description */ - private final Locale locale; - - /** Field description */ - private final Class msgClass; } } diff --git a/scm-core/src/main/java/sonia/scm/io/AbstractReader.java b/scm-core/src/main/java/sonia/scm/io/AbstractReader.java index 0a7391fff2..c5f4a94d6f 100644 --- a/scm-core/src/main/java/sonia/scm/io/AbstractReader.java +++ b/scm-core/src/main/java/sonia/scm/io/AbstractReader.java @@ -24,79 +24,30 @@ package sonia.scm.io; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.util.IOUtil; -//~--- JDK imports ------------------------------------------------------------ - import java.io.ByteArrayInputStream; import java.io.File; import java.io.FileInputStream; import java.io.IOException; import java.io.InputStream; -/** - * - * @author Sebastian Sdorra - * - * @param - */ public abstract class AbstractReader { - /** - * Method description - * - * - * @param input - * - * @return - * - * @throws IOException - */ public abstract T read(InputStream input) throws IOException; - /** - * Method description - * - * - * @param data - * - * @return - * - * @throws IOException - */ public T read(byte[] data) throws IOException { return read(new ByteArrayInputStream(data)); } - /** - * Method description - * - * - * @param path - * - * @return - * - * @throws IOException - */ public T read(String path) throws IOException { return read(new File(path)); } - /** - * Method description - * - * - * @param file - * - * @return - * - * @throws IOException - */ public T read(File file) throws IOException { T result = null; diff --git a/scm-core/src/main/java/sonia/scm/io/AbstractResourceProcessor.java b/scm-core/src/main/java/sonia/scm/io/AbstractResourceProcessor.java index f364f38e97..3905bd488b 100644 --- a/scm-core/src/main/java/sonia/scm/io/AbstractResourceProcessor.java +++ b/scm-core/src/main/java/sonia/scm/io/AbstractResourceProcessor.java @@ -24,12 +24,9 @@ package sonia.scm.io; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.util.IOUtil; -//~--- JDK imports ------------------------------------------------------------ - import java.io.BufferedReader; import java.io.BufferedWriter; import java.io.File; @@ -46,64 +43,26 @@ import java.io.Writer; import java.util.HashMap; import java.util.Map; -/** - * - * @author Sebastian Sdorra - */ public abstract class AbstractResourceProcessor implements ResourceProcessor { + private Map variableMap = new HashMap<>(); - /** - * Method description - * - * - * @param variableMap - * @param reader - * @param writer - * - * @throws IOException - */ protected abstract void process(Map variableMap, BufferedReader reader, BufferedWriter writer) throws IOException; - /** - * Method description - * - * - * @param key - * @param value - */ @Override public void addVariable(String key, String value) { variableMap.put(key, value); } - /** - * Method description - * - * - * @param input - * @param output - * - * @throws IOException - */ @Override public void process(InputStream input, OutputStream output) throws IOException { process(new InputStreamReader(input), new OutputStreamWriter(output)); } - /** - * Method description - * - * - * @param input - * @param output - * - * @throws IOException - */ @Override public void process(File input, File output) throws IOException { @@ -123,15 +82,6 @@ public abstract class AbstractResourceProcessor implements ResourceProcessor } } - /** - * Method description - * - * - * @param reader - * @param writer - * - * @throws IOException - */ @Override public void process(Reader reader, Writer writer) throws IOException { @@ -159,20 +109,10 @@ public abstract class AbstractResourceProcessor implements ResourceProcessor process(variableMap, bufferedReader, bufferedWriter); } - /** - * Method description - * - * - * @param key - */ @Override public void removeVariable(String key) { variableMap.remove(key); } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private Map variableMap = new HashMap<>(); } diff --git a/scm-core/src/main/java/sonia/scm/io/AbstractUnArchiver.java b/scm-core/src/main/java/sonia/scm/io/AbstractUnArchiver.java index 8cd6305e03..7c0f109f31 100644 --- a/scm-core/src/main/java/sonia/scm/io/AbstractUnArchiver.java +++ b/scm-core/src/main/java/sonia/scm/io/AbstractUnArchiver.java @@ -24,7 +24,6 @@ package sonia.scm.io; -//~--- non-JDK imports -------------------------------------------------------- import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -33,8 +32,6 @@ import sonia.scm.util.ChecksumUtil; import sonia.scm.util.IOUtil; import sonia.scm.util.Util; -//~--- JDK imports ------------------------------------------------------------ - import java.io.File; import java.io.FileInputStream; import java.io.FileOutputStream; @@ -42,65 +39,28 @@ import java.io.IOException; import java.util.Properties; -/** - * - * @author Sebastian Sdorra - */ public abstract class AbstractUnArchiver implements UnArchiver { - /** Field description */ public static final String FILE_SOURCE_PROPERTIES = "scm-source.properties"; - /** Field description */ public static final String PROPERTY_CHECKSUM = "scm.unarchiver.checksum"; - /** Field description */ public static final String PROPERTY_SOURCEFILE = "scm.unarchiver.source"; - /** the logger for AbstractUnArchiver */ private static final Logger logger = LoggerFactory.getLogger(AbstractUnArchiver.class); - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param archive - * @param outputDirectory - * - * @throws IOException - */ protected abstract void extractArchive(File archive, File outputDirectory) throws IOException; - /** - * Method description - * - * - * @param archive - * @param outputDirectory - * - * @throws IOException - */ @Override public void extract(File archive, File outputDirectory) throws IOException { extract(archive, outputDirectory, false); } - /** - * Method description - * - * - * @param archive - * @param outputDirectory - * @param force - * - * @throws IOException - */ @Override public void extract(File archive, File outputDirectory, boolean force) throws IOException @@ -118,15 +78,6 @@ public abstract class AbstractUnArchiver implements UnArchiver } } - /** - * Method description - * - * - * @param archive - * @param outputDirectory - * - * @throws IOException - */ private void extractAndCreateProperties(File archive, File outputDirectory) throws IOException { @@ -137,15 +88,6 @@ public abstract class AbstractUnArchiver implements UnArchiver writeProperties(outputDirectory, checksum); } - /** - * Method description - * - * - * @param outputDirectory - * @param checksum - * - * @throws IOException - */ private void writeProperties(File outputDirectory, String checksum) throws IOException { @@ -170,16 +112,6 @@ public abstract class AbstractUnArchiver implements UnArchiver } } - //~--- get methods ---------------------------------------------------------- - - /** - * Method description - * - * - * @param sourcePropsFile - * - * @return - */ private String getChecksumProperty(File sourcePropsFile) { Properties properties = new Properties(); @@ -202,15 +134,6 @@ public abstract class AbstractUnArchiver implements UnArchiver return properties.getProperty(PROPERTY_CHECKSUM); } - /** - * Method description - * - * - * @param archive - * @param outputDirectory - * - * @return - */ private boolean isModified(File archive, File outputDirectory) { boolean modified = true; diff --git a/scm-core/src/main/java/sonia/scm/io/AbstractWriter.java b/scm-core/src/main/java/sonia/scm/io/AbstractWriter.java index c7938e338f..e9f066b12c 100644 --- a/scm-core/src/main/java/sonia/scm/io/AbstractWriter.java +++ b/scm-core/src/main/java/sonia/scm/io/AbstractWriter.java @@ -24,46 +24,18 @@ package sonia.scm.io; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.util.IOUtil; -//~--- JDK imports ------------------------------------------------------------ - import java.io.File; import java.io.FileOutputStream; import java.io.IOException; import java.io.OutputStream; -/** - * - * @author Sebastian Sdorra - * - * @param - */ public abstract class AbstractWriter { - - /** - * Method description - * - * - * @param object - * @param output - * - * @throws IOException - */ public abstract void write(T object, OutputStream output) throws IOException; - /** - * Method description - * - * - * @param object - * @param file - * - * @throws IOException - */ public void write(T object, File file) throws IOException { OutputStream output = null; @@ -79,15 +51,6 @@ public abstract class AbstractWriter } } - /** - * Method description - * - * - * @param object - * @param path - * - * @throws IOException - */ public void write(T object, String path) throws IOException { write(object, new File(path)); diff --git a/scm-core/src/main/java/sonia/scm/io/Command.java b/scm-core/src/main/java/sonia/scm/io/Command.java index e4072ecdcc..56044819b7 100644 --- a/scm-core/src/main/java/sonia/scm/io/Command.java +++ b/scm-core/src/main/java/sonia/scm/io/Command.java @@ -24,35 +24,17 @@ package sonia.scm.io; -//~--- JDK imports ------------------------------------------------------------ - import java.io.File; import java.io.IOException; -/** - * - * @author Sebastian Sdorra - */ + public interface Command { - /** - * Method description - * - * - * @return - * - * @throws IOException - */ + public CommandResult execute() throws IOException; - //~--- set methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param file - */ + public void setWorkDirectory(File file); } diff --git a/scm-core/src/main/java/sonia/scm/io/CommandResult.java b/scm-core/src/main/java/sonia/scm/io/CommandResult.java index 78cc580d35..7120de9c6b 100644 --- a/scm-core/src/main/java/sonia/scm/io/CommandResult.java +++ b/scm-core/src/main/java/sonia/scm/io/CommandResult.java @@ -24,34 +24,16 @@ package sonia.scm.io; -/** - * - * @author Sebastian Sdorra - */ + public interface CommandResult { - /** - * Method description - * - * - * @return - */ + public String getOutput(); - /** - * Method description - * - * - * @return - */ + public int getReturnCode(); - /** - * Method description - * - * - * @return - */ + public boolean isSuccessfull(); } diff --git a/scm-core/src/main/java/sonia/scm/io/ContentType.java b/scm-core/src/main/java/sonia/scm/io/ContentType.java index 941a8f63f1..ffcf02f69b 100644 --- a/scm-core/src/main/java/sonia/scm/io/ContentType.java +++ b/scm-core/src/main/java/sonia/scm/io/ContentType.java @@ -37,44 +37,32 @@ public interface ContentType { /** * Returns the primary part of the content type (e.g.: text of text/plain). - * - * @return primary content type part */ String getPrimary(); /** * Returns the secondary part of the content type (e.g.: plain of text/plain). - * - * @return secondary content type part */ String getSecondary(); /** * Returns the raw presentation of the content type (e.g.: text/plain). - * - * @return raw presentation */ String getRaw(); /** * Returns {@code true} if the content type is text based. - * - * @return {@code true} for text content */ boolean isText(); /** * Returns an optional with the programming language * or empty if the content is not programming language. - * - * @return programming language or empty */ Optional getLanguage(); /** * Returns a map of syntax modes such as codemirror, ace or prism. - * - * @return map of syntax modes * @since 2.28.0 */ default Map getSyntaxModes() { diff --git a/scm-core/src/main/java/sonia/scm/io/ContentTypeResolver.java b/scm-core/src/main/java/sonia/scm/io/ContentTypeResolver.java index c56315b01c..74f77f8533 100644 --- a/scm-core/src/main/java/sonia/scm/io/ContentTypeResolver.java +++ b/scm-core/src/main/java/sonia/scm/io/ContentTypeResolver.java @@ -54,7 +54,6 @@ public interface ContentTypeResolver { /** * Returns a map of syntax highlighting modes such as ace, codemirror or prism by language. * @param language name of the coding language - * @return map of syntax highlighting modes * @since 2.28.0 */ default Map findSyntaxModesByLanguage(String language) { diff --git a/scm-core/src/main/java/sonia/scm/io/DeepCopy.java b/scm-core/src/main/java/sonia/scm/io/DeepCopy.java index 2dcd71085d..f0505771f0 100644 --- a/scm-core/src/main/java/sonia/scm/io/DeepCopy.java +++ b/scm-core/src/main/java/sonia/scm/io/DeepCopy.java @@ -24,12 +24,9 @@ package sonia.scm.io; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.io.Closer; -//~--- JDK imports ------------------------------------------------------------ - import java.io.IOException; import java.io.ObjectInputStream; import java.io.ObjectOutputStream; @@ -43,7 +40,6 @@ import java.io.ObjectOutputStream; * null is returned. Depending on your specific application, it might * make more sense to have copy(...) re-throw the exception. * - * @author Sebastian Sdorra * @since 1.29 * @see http://javatechniques.com/blog/faster-deep-copies-of-java-objects */ diff --git a/scm-core/src/main/java/sonia/scm/io/DefaultFileSystem.java b/scm-core/src/main/java/sonia/scm/io/DefaultFileSystem.java index 0f038d513a..4a282b37e9 100644 --- a/scm-core/src/main/java/sonia/scm/io/DefaultFileSystem.java +++ b/scm-core/src/main/java/sonia/scm/io/DefaultFileSystem.java @@ -24,39 +24,21 @@ package sonia.scm.io; -//~--- non-JDK imports -------------------------------------------------------- import org.slf4j.Logger; import org.slf4j.LoggerFactory; import sonia.scm.util.IOUtil; -//~--- JDK imports ------------------------------------------------------------ - import java.io.File; import java.io.IOException; -/** - * - * @author Sebastian Sdorra - */ + public class DefaultFileSystem implements FileSystem { - - /** the logger for DefaultFileSystem */ private static final Logger logger = LoggerFactory.getLogger(DefaultFileSystem.class); - //~--- methods -------------------------------------------------------------- - - /** - * Method description - * - * - * @param directory - * - * @throws IOException - */ @Override public void create(File directory) throws IOException { @@ -68,14 +50,6 @@ public class DefaultFileSystem implements FileSystem IOUtil.mkdirs(directory); } - /** - * Method description - * - * - * @param directory - * - * @throws IOException - */ @Override public void destroy(File directory) throws IOException { diff --git a/scm-core/src/main/java/sonia/scm/io/DirectoryFileFilter.java b/scm-core/src/main/java/sonia/scm/io/DirectoryFileFilter.java index 46558038c6..befc8cf1d1 100644 --- a/scm-core/src/main/java/sonia/scm/io/DirectoryFileFilter.java +++ b/scm-core/src/main/java/sonia/scm/io/DirectoryFileFilter.java @@ -24,32 +24,18 @@ package sonia.scm.io; -//~--- JDK imports ------------------------------------------------------------ - import java.io.File; import java.io.FileFilter; /** * - * @author Sebastian Sdorra * @since 1.6 */ public class DirectoryFileFilter implements FileFilter { - /** Field description */ public static final DirectoryFileFilter instance = new DirectoryFileFilter(); - //~--- methods -------------------------------------------------------------- - - /** - * Method description - * - * - * @param file - * - * @return - */ @Override public boolean accept(File file) { diff --git a/scm-core/src/main/java/sonia/scm/io/ExtendedCommand.java b/scm-core/src/main/java/sonia/scm/io/ExtendedCommand.java index 4c13b27cfa..c3874bdd17 100644 --- a/scm-core/src/main/java/sonia/scm/io/ExtendedCommand.java +++ b/scm-core/src/main/java/sonia/scm/io/ExtendedCommand.java @@ -24,40 +24,20 @@ package sonia.scm.io; -//~--- JDK imports ------------------------------------------------------------ - import java.io.IOException; import java.util.Timer; -/** - * - * @author Sebastian Sdorra - */ + public class ExtendedCommand extends SimpleCommand { + private long timeout = 30000; - /** - * Constructs ... - * - * - * @param command - */ public ExtendedCommand(String... command) { super(command); } - //~--- methods -------------------------------------------------------------- - - /** - * Method description - * - * - * @return - * - * @throws IOException - */ @Override public SimpleCommandResult execute() throws IOException { @@ -80,34 +60,14 @@ public class ExtendedCommand extends SimpleCommand return result; } - //~--- get methods ---------------------------------------------------------- - - /** - * Method description - * - * - * @return - */ public long getTimeout() { return timeout; } - //~--- set methods ---------------------------------------------------------- - - /** - * Method description - * - * - * @param timeout - */ public void setTimeout(long timeout) { this.timeout = timeout; } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private long timeout = 30000; } diff --git a/scm-core/src/main/java/sonia/scm/io/FastByteArrayInputStream.java b/scm-core/src/main/java/sonia/scm/io/FastByteArrayInputStream.java index 83bef78ba5..dfea422503 100644 --- a/scm-core/src/main/java/sonia/scm/io/FastByteArrayInputStream.java +++ b/scm-core/src/main/java/sonia/scm/io/FastByteArrayInputStream.java @@ -24,53 +24,44 @@ package sonia.scm.io; -//~--- JDK imports ------------------------------------------------------------ - import java.io.InputStream; /** * ByteArrayInputStream implementation that does not synchronize methods. * - * @author Sebastian Sdorra * @since 1.29 * @see http://javatechniques.com/blog/faster-deep-copies-of-java-objects */ public final class FastByteArrayInputStream extends InputStream { + /** + * Our byte buffer + */ + private byte[] buf = null; /** - * Constructs ... - * - * - * @param buf - * @param count + * Number of bytes that we can read from the buffer */ + private int count = 0; + + /** + * Number of bytes that have been read from the buffer + */ + private int pos = 0; + public FastByteArrayInputStream(byte[] buf, int count) { this.buf = buf; this.count = count; } - //~--- methods -------------------------------------------------------------- - - /** - * Method description - * - * - * @return - */ @Override public final int available() { return count - pos; } - /** - * Method description - * - * - * @return - */ + @Override public final int read() { @@ -79,16 +70,6 @@ public final class FastByteArrayInputStream extends InputStream : -1; } - /** - * Method description - * - * - * @param b - * @param off - * @param len - * - * @return - */ @Override public final int read(byte[] b, int off, int len) { @@ -108,14 +89,6 @@ public final class FastByteArrayInputStream extends InputStream return len; } - /** - * Method description - * - * - * @param n - * - * @return - */ @Override public final long skip(long n) { @@ -134,20 +107,4 @@ public final class FastByteArrayInputStream extends InputStream return n; } - //~--- fields --------------------------------------------------------------- - - /** - * Our byte buffer - */ - private byte[] buf = null; - - /** - * Number of bytes that we can read from the buffer - */ - private int count = 0; - - /** - * Number of bytes that have been read from the buffer - */ - private int pos = 0; } diff --git a/scm-core/src/main/java/sonia/scm/io/FastByteArrayOutputStream.java b/scm-core/src/main/java/sonia/scm/io/FastByteArrayOutputStream.java index e45c87c04d..8dc09362da 100644 --- a/scm-core/src/main/java/sonia/scm/io/FastByteArrayOutputStream.java +++ b/scm-core/src/main/java/sonia/scm/io/FastByteArrayOutputStream.java @@ -24,8 +24,6 @@ package sonia.scm.io; -//~--- JDK imports ------------------------------------------------------------ - import java.io.InputStream; import java.io.OutputStream; @@ -33,12 +31,14 @@ import java.io.OutputStream; * ByteArrayOutputStream implementation that doesn't synchronize methods * and doesn't copy the data on toByteArray(). * - * @author Sebastian Sdorra * @since 1.29 * @see http://javatechniques.com/blog/faster-deep-copies-of-java-objects */ public final class FastByteArrayOutputStream extends OutputStream { + private byte[] buf = null; + + private int size = 0; /** * Constructs a stream with buffer capacity size 5K @@ -59,14 +59,6 @@ public final class FastByteArrayOutputStream extends OutputStream this.buf = new byte[initSize]; } - //~--- methods -------------------------------------------------------------- - - /** - * Method description - * - * - * @param b - */ @Override public final void write(byte b[]) { @@ -75,14 +67,6 @@ public final class FastByteArrayOutputStream extends OutputStream size += b.length; } - /** - * Method description - * - * - * @param b - * @param off - * @param len - */ @Override public final void write(byte b[], int off, int len) { @@ -91,12 +75,6 @@ public final class FastByteArrayOutputStream extends OutputStream size += len; } - /** - * Method description - * - * - * @param b - */ @Override public final void write(int b) { @@ -104,16 +82,11 @@ public final class FastByteArrayOutputStream extends OutputStream buf[size++] = (byte) b; } - /** - * Method description - * - */ - public void reset() + public void reset() { size = 0; } - //~--- get methods ---------------------------------------------------------- /** * Returns the byte array containing the written data. Note that this @@ -137,18 +110,12 @@ public final class FastByteArrayOutputStream extends OutputStream return new FastByteArrayInputStream(buf, size); } - /** - * Method description - * - * - * @return - */ + public int getSize() { return size; } - //~--- methods -------------------------------------------------------------- /** * Ensures that we have a large enough buffer for the given size. @@ -167,13 +134,4 @@ public final class FastByteArrayOutputStream extends OutputStream } } - //~--- fields --------------------------------------------------------------- - - /** - * Buffer and size - */ - private byte[] buf = null; - - /** Field description */ - private int size = 0; } diff --git a/scm-core/src/main/java/sonia/scm/io/FileSystem.java b/scm-core/src/main/java/sonia/scm/io/FileSystem.java index c19fe97b98..c9b5450617 100644 --- a/scm-core/src/main/java/sonia/scm/io/FileSystem.java +++ b/scm-core/src/main/java/sonia/scm/io/FileSystem.java @@ -24,42 +24,18 @@ package sonia.scm.io; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.plugin.ExtensionPoint; -//~--- JDK imports ------------------------------------------------------------ - import java.io.File; import java.io.IOException; -/** - * - * @author Sebastian Sdorra - */ + @ExtensionPoint(multi=false) public interface FileSystem { - /** - * Method description - * - * - * - * @param directory - * - * @throws IOException - */ public void create(File directory) throws IOException; - /** - * Method description - * - * - * - * @param directory - * - * @throws IOException - */ public void destroy(File directory) throws IOException; } diff --git a/scm-core/src/main/java/sonia/scm/io/INIConfiguration.java b/scm-core/src/main/java/sonia/scm/io/INIConfiguration.java index 1e8ac9666a..bd119fa7da 100644 --- a/scm-core/src/main/java/sonia/scm/io/INIConfiguration.java +++ b/scm-core/src/main/java/sonia/scm/io/INIConfiguration.java @@ -24,8 +24,6 @@ package sonia.scm.io; -//~--- JDK imports ------------------------------------------------------------ - import com.google.common.collect.ImmutableList; import jakarta.annotation.Nullable; @@ -37,7 +35,6 @@ import java.util.Map; * Configuration in the ini format. * The format consists of sections, keys and values. * - * @author Sebastian Sdorra * @see Wikipedia article */ public class INIConfiguration { @@ -46,7 +43,6 @@ public class INIConfiguration { /** * Add a new section to the configuration. - * @param section section */ public void addSection(INISection section) { sectionMap.put(section.getName(), section); @@ -54,7 +50,6 @@ public class INIConfiguration { /** * Remove an existing section from the configuration. - * @param name name of the section */ public void removeSection(String name) { sectionMap.remove(name); @@ -72,7 +67,6 @@ public class INIConfiguration { /** * Returns all sections of the configuration. - * @return all sections */ public Collection getSections() { return ImmutableList.copyOf(sectionMap.values()); diff --git a/scm-core/src/main/java/sonia/scm/io/INIConfigurationReader.java b/scm-core/src/main/java/sonia/scm/io/INIConfigurationReader.java index 6d7be1e259..1e605189ee 100644 --- a/scm-core/src/main/java/sonia/scm/io/INIConfigurationReader.java +++ b/scm-core/src/main/java/sonia/scm/io/INIConfigurationReader.java @@ -33,7 +33,6 @@ import java.util.regex.Pattern; /** * Read configuration in ini format from files and streams. - * @author Sebastian Sdorra */ public class INIConfigurationReader extends AbstractReader { diff --git a/scm-core/src/main/java/sonia/scm/io/INIConfigurationWriter.java b/scm-core/src/main/java/sonia/scm/io/INIConfigurationWriter.java index e3f74c4257..f5514eb470 100644 --- a/scm-core/src/main/java/sonia/scm/io/INIConfigurationWriter.java +++ b/scm-core/src/main/java/sonia/scm/io/INIConfigurationWriter.java @@ -30,7 +30,6 @@ import java.io.PrintWriter; /** * Write configurations in ini format to file and streams. - * @author Sebastian Sdorra */ public class INIConfigurationWriter extends AbstractWriter { diff --git a/scm-core/src/main/java/sonia/scm/io/INISection.java b/scm-core/src/main/java/sonia/scm/io/INISection.java index 96c5de7516..0ec48eec78 100644 --- a/scm-core/src/main/java/sonia/scm/io/INISection.java +++ b/scm-core/src/main/java/sonia/scm/io/INISection.java @@ -24,8 +24,6 @@ package sonia.scm.io; -//~--- JDK imports ------------------------------------------------------------ - import com.google.common.collect.ImmutableList; import java.util.Collection; @@ -36,7 +34,6 @@ import java.util.Map; * A section of {@link INIConfiguration}. * The section consists of keys and values. * - * @author Sebastian Sdorra */ public class INISection { @@ -65,7 +62,6 @@ public class INISection { /** * Returns the name of the section. - * @return name of section */ public String getName() { return name; @@ -73,8 +69,6 @@ public class INISection { /** * Returns the value of the parameter with the given key or {@code null} if the given parameter does not exist. - * @param key key of parameter - * @return value of parameter or {@code null} */ public String getParameter(String key) { return parameters.get(key); @@ -82,7 +76,6 @@ public class INISection { /** * Returns all parameter keys of the section. - * @return all parameters of section */ public Collection getParameterKeys() { return ImmutableList.copyOf(parameters.keySet()); @@ -90,8 +83,6 @@ public class INISection { /** * Sets the parameter with the given key to the given value. - * @param key key of parameter - * @param value value of parameter */ public void setParameter(String key, String value) { parameters.put(key, value); @@ -99,7 +90,6 @@ public class INISection { /** * Remove parameter with the given name from the section. - * @param key name of parameter */ public void removeParameter(String key) { parameters.remove(key); diff --git a/scm-core/src/main/java/sonia/scm/io/ProcessInterruptScheduler.java b/scm-core/src/main/java/sonia/scm/io/ProcessInterruptScheduler.java index 040f7aeaea..0e0344c3f6 100644 --- a/scm-core/src/main/java/sonia/scm/io/ProcessInterruptScheduler.java +++ b/scm-core/src/main/java/sonia/scm/io/ProcessInterruptScheduler.java @@ -24,42 +24,23 @@ package sonia.scm.io; -//~--- JDK imports ------------------------------------------------------------ - import java.util.TimerTask; -/** - * - * @author Sebastian Sdorra - */ + public class ProcessInterruptScheduler extends TimerTask { + private Process process; - /** - * Constructs ... - * - * - * @param process - */ public ProcessInterruptScheduler(Process process) { this.process = process; } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - */ - @Override + @Override public void run() { process.destroy(); } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private Process process; } diff --git a/scm-core/src/main/java/sonia/scm/io/RegexResourceProcessor.java b/scm-core/src/main/java/sonia/scm/io/RegexResourceProcessor.java index cb9e8136bf..5d937896af 100644 --- a/scm-core/src/main/java/sonia/scm/io/RegexResourceProcessor.java +++ b/scm-core/src/main/java/sonia/scm/io/RegexResourceProcessor.java @@ -24,12 +24,9 @@ package sonia.scm.io; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.util.IOUtil; -//~--- JDK imports ------------------------------------------------------------ - import java.io.BufferedReader; import java.io.BufferedWriter; import java.io.IOException; @@ -38,28 +35,13 @@ import java.util.Map; import java.util.regex.Matcher; import java.util.regex.Pattern; -/** - * - * @author Sebastian Sdorra - */ + public class RegexResourceProcessor extends AbstractResourceProcessor { - /** Field description */ public static final Pattern PATTERN = Pattern.compile("\\$\\{([^\\$]+)\\}"); - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param variableMap - * @param reader - * @param writer - * - * @throws IOException - */ @Override protected void process(Map variableMap, BufferedReader reader, BufferedWriter writer) @@ -88,15 +70,6 @@ public class RegexResourceProcessor extends AbstractResourceProcessor } } - /** - * Method description - * - * - * @param variableMap - * @param line - * - * @return - */ private String parseLine(Map variableMap, String line) { StringBuffer result = null; diff --git a/scm-core/src/main/java/sonia/scm/io/ResourceProcessor.java b/scm-core/src/main/java/sonia/scm/io/ResourceProcessor.java index 9ed515849e..06cc3e6fac 100644 --- a/scm-core/src/main/java/sonia/scm/io/ResourceProcessor.java +++ b/scm-core/src/main/java/sonia/scm/io/ResourceProcessor.java @@ -24,8 +24,6 @@ package sonia.scm.io; -//~--- JDK imports ------------------------------------------------------------ - import java.io.File; import java.io.IOException; import java.io.InputStream; @@ -33,61 +31,17 @@ import java.io.OutputStream; import java.io.Reader; import java.io.Writer; -/** - * - * @author Sebastian Sdorra - */ + public interface ResourceProcessor { - - /** - * Method description - * - * - * @param key - * @param value - */ public void addVariable(String key, String value); - /** - * Method description - * - * - * @param input - * @param output - * - * @throws IOException - */ public void process(InputStream input, OutputStream output) throws IOException; - /** - * Method description - * - * - * @param input - * @param output - * - * @throws IOException - */ public void process(File input, File output) throws IOException; - /** - * Method description - * - * - * @param reader - * @param writer - * - * @throws IOException - */ public void process(Reader reader, Writer writer) throws IOException; - /** - * Method description - * - * - * @param key - */ public void removeVariable(String key); } diff --git a/scm-core/src/main/java/sonia/scm/io/ScmObjectInputStream.java b/scm-core/src/main/java/sonia/scm/io/ScmObjectInputStream.java index 9d9fefacb6..89b16b9926 100644 --- a/scm-core/src/main/java/sonia/scm/io/ScmObjectInputStream.java +++ b/scm-core/src/main/java/sonia/scm/io/ScmObjectInputStream.java @@ -24,13 +24,10 @@ package sonia.scm.io; -//~--- non-JDK imports -------------------------------------------------------- import org.slf4j.Logger; import org.slf4j.LoggerFactory; -//~--- JDK imports ------------------------------------------------------------ - import java.io.IOException; import java.io.InputStream; import java.io.ObjectInputStream; @@ -40,28 +37,20 @@ import java.io.ObjectStreamClass; * {@link ObjectInputStream} implementation which uses the context class loader * to resolve classes. * - * @author Sebastian Sdorra * @since 1.36 */ public class ScmObjectInputStream extends ObjectInputStream { - /** - * the logger for ScmObjectInputStream - */ private static final Logger logger = LoggerFactory.getLogger(ScmObjectInputStream.class); - //~--- constructors --------------------------------------------------------- public ScmObjectInputStream(InputStream stream) throws IOException { super(stream); } - //~--- methods -------------------------------------------------------------- - /** - * {@inheritDoc} - */ + @Override protected Class resolveClass(ObjectStreamClass desc) throws IOException, ClassNotFoundException { @@ -82,15 +71,6 @@ public class ScmObjectInputStream extends ObjectInputStream { return clazz; } - //~--- get methods ---------------------------------------------------------- - - /** - * Returns the context class loader if available. If the context class loader - * is not available the method will fall back to the class loader which has - * load this class. - * - * @return context class loader or default class loader - */ private ClassLoader getClassLoader() { ClassLoader classLoader = Thread.currentThread().getContextClassLoader(); diff --git a/scm-core/src/main/java/sonia/scm/io/SimpleCommand.java b/scm-core/src/main/java/sonia/scm/io/SimpleCommand.java index 2c25048d44..eb542c53ad 100644 --- a/scm-core/src/main/java/sonia/scm/io/SimpleCommand.java +++ b/scm-core/src/main/java/sonia/scm/io/SimpleCommand.java @@ -24,15 +24,12 @@ package sonia.scm.io; -//~--- non-JDK imports -------------------------------------------------------- import org.slf4j.Logger; import org.slf4j.LoggerFactory; import sonia.scm.util.IOUtil; -//~--- JDK imports ------------------------------------------------------------ - import java.io.BufferedReader; import java.io.File; import java.io.IOException; @@ -40,36 +37,26 @@ import java.io.InputStreamReader; import java.util.Map; -/** - * - * @author Sebastian Sdorra - */ + public class SimpleCommand implements Command { + private String[] command; + + private Map environment; + + private boolean useSystemEnvironment = false; + + private File workDirectory; - /** Field description */ private static final Logger logger = LoggerFactory.getLogger(SimpleCommand.class); - //~--- constructors --------------------------------------------------------- - - /** - * Constructs ... - * - * - * @param command - */ public SimpleCommand(String... command) { this(null, command); } /** - * Constructs ... - * - * - * @param environment - * @param command * @since 1.8 */ public SimpleCommand(Map environment, String... command) @@ -78,16 +65,6 @@ public class SimpleCommand implements Command this.command = command; } - //~--- methods -------------------------------------------------------------- - - /** - * Method description - * - * - * @return - * - * @throws IOException - */ @Override public SimpleCommandResult execute() throws IOException { @@ -96,14 +73,8 @@ public class SimpleCommand implements Command return getResult(process); } - //~--- get methods ---------------------------------------------------------- /** - * Method description - * - * - * @return - * * @since 1.23 */ public boolean isUseSystemEnvironment() @@ -111,13 +82,8 @@ public class SimpleCommand implements Command return useSystemEnvironment; } - //~--- set methods ---------------------------------------------------------- /** - * Method description - * - * - * @param environment * @since 1.8 */ public void setEnvironment(Map environment) @@ -126,11 +92,6 @@ public class SimpleCommand implements Command } /** - * Method description - * - * - * @param useSystemEnvironment - * * @since 1.23 */ public void setUseSystemEnvironment(boolean useSystemEnvironment) @@ -138,28 +99,12 @@ public class SimpleCommand implements Command this.useSystemEnvironment = useSystemEnvironment; } - /** - * Method description - * - * - * @param workDirectory - */ @Override public void setWorkDirectory(File workDirectory) { this.workDirectory = workDirectory; } - //~--- methods -------------------------------------------------------------- - - /** - * Method description - * - * - * @return - * - * @throws IOException - */ protected Process createProcess() throws IOException { if (logger.isDebugEnabled()) @@ -195,18 +140,6 @@ public class SimpleCommand implements Command return processBuilder.redirectErrorStream(true).start(); } - //~--- get methods ---------------------------------------------------------- - - /** - * Method description - * - * - * @param process - * - * @return - * - * @throws IOException - */ protected SimpleCommandResult getResult(Process process) throws IOException { SimpleCommandResult result = null; @@ -261,17 +194,4 @@ public class SimpleCommand implements Command return result; } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private String[] command; - - /** Field description */ - private Map environment; - - /** Field description */ - private boolean useSystemEnvironment = false; - - /** Field description */ - private File workDirectory; } diff --git a/scm-core/src/main/java/sonia/scm/io/SimpleCommandResult.java b/scm-core/src/main/java/sonia/scm/io/SimpleCommandResult.java index 425f7d2090..47b126bfef 100644 --- a/scm-core/src/main/java/sonia/scm/io/SimpleCommandResult.java +++ b/scm-core/src/main/java/sonia/scm/io/SimpleCommandResult.java @@ -24,69 +24,37 @@ package sonia.scm.io; -/** - * - * @author Sebastian Sdorra - */ + public class SimpleCommandResult implements CommandResult { + private String output; + + private int returnCode; - /** - * Constructs ... - * - * - * @param output - * @param returnCode - */ public SimpleCommandResult(String output, int returnCode) { this.output = output; this.returnCode = returnCode; } - //~--- get methods ---------------------------------------------------------- - - /** - * Method description - * - * - * @return - */ @Override public String getOutput() { return output; } - /** - * Method description - * - * - * @return - */ + @Override public int getReturnCode() { return returnCode; } - /** - * Method description - * - * - * @return - */ + @Override public boolean isSuccessfull() { return returnCode == 0; } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private String output; - - /** Field description */ - private int returnCode; } diff --git a/scm-core/src/main/java/sonia/scm/io/UnArchiver.java b/scm-core/src/main/java/sonia/scm/io/UnArchiver.java index 490822009b..0888f8910d 100644 --- a/scm-core/src/main/java/sonia/scm/io/UnArchiver.java +++ b/scm-core/src/main/java/sonia/scm/io/UnArchiver.java @@ -24,39 +24,14 @@ package sonia.scm.io; -//~--- JDK imports ------------------------------------------------------------ - import java.io.File; import java.io.IOException; -/** - * - * @author Sebastian Sdorra - */ + public interface UnArchiver { - - /** - * Method description - * - * - * @param archive - * @param outputDirectory - * @param force - * - * @throws IOException - */ public void extract(File archive, File outputDirectory, boolean force) throws IOException; - /** - * Method description - * - * - * @param archive - * @param outputDirectory - * - * @throws IOException - */ public void extract(File archive, File outputDirectory) throws IOException; } diff --git a/scm-core/src/main/java/sonia/scm/io/ZipUnArchiver.java b/scm-core/src/main/java/sonia/scm/io/ZipUnArchiver.java index fa256413b4..e1de934750 100644 --- a/scm-core/src/main/java/sonia/scm/io/ZipUnArchiver.java +++ b/scm-core/src/main/java/sonia/scm/io/ZipUnArchiver.java @@ -24,15 +24,12 @@ package sonia.scm.io; -//~--- non-JDK imports -------------------------------------------------------- import org.slf4j.Logger; import org.slf4j.LoggerFactory; import sonia.scm.util.IOUtil; -//~--- JDK imports ------------------------------------------------------------ - import java.io.File; import java.io.FileInputStream; import java.io.FileOutputStream; @@ -42,30 +39,17 @@ import java.io.InputStream; import java.util.zip.ZipEntry; import java.util.zip.ZipInputStream; -/** - * - * @author Sebastian Sdorra - */ + public class ZipUnArchiver extends AbstractUnArchiver { - /** Field description */ public static final String EXTENSION = ".zip"; - /** the logger for ZipUnArchiver */ private static final Logger logger = LoggerFactory.getLogger(ZipUnArchiver.class); - //~--- methods -------------------------------------------------------------- /** - * Method description - * - * - * @param inputStream - * @param outputDirectory - * - * @throws IOException * @since 1.21 */ public void extractArchive(InputStream inputStream, File outputDirectory) @@ -82,15 +66,6 @@ public class ZipUnArchiver extends AbstractUnArchiver } } - /** - * Method description - * - * - * @param archive - * @param outputDirectory - * - * @throws IOException - */ @Override protected void extractArchive(File archive, File outputDirectory) throws IOException @@ -114,15 +89,6 @@ public class ZipUnArchiver extends AbstractUnArchiver } } - /** - * Method description - * - * - * @param outputDirectory - * @param name - * - * @return - */ private File createFile(File outputDirectory, String name) { if (name.contains("..")) @@ -133,16 +99,6 @@ public class ZipUnArchiver extends AbstractUnArchiver return new File(outputDirectory, name); } - /** - * Method description - * - * - * @param outputDirectory - * @param input - * @param entry - * - * @throws IOException - */ private void extractEntry(File outputDirectory, ZipInputStream input, ZipEntry entry) throws IOException @@ -176,15 +132,6 @@ public class ZipUnArchiver extends AbstractUnArchiver } } - /** - * Method description - * - * - * @param input - * @param outputFile - * - * @throws IOException - */ private void extractFile(ZipInputStream input, File outputFile) throws IOException { diff --git a/scm-core/src/main/java/sonia/scm/lifecycle/RestartEvent.java b/scm-core/src/main/java/sonia/scm/lifecycle/RestartEvent.java index 2485e78de4..f3d1f56794 100644 --- a/scm-core/src/main/java/sonia/scm/lifecycle/RestartEvent.java +++ b/scm-core/src/main/java/sonia/scm/lifecycle/RestartEvent.java @@ -24,13 +24,11 @@ package sonia.scm.lifecycle; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.event.Event; /** * This event indicates a forced restart of scm-manager. - * @author Sebastian Sdorra * @since 2.0.0 */ @Event @@ -46,8 +44,6 @@ public class RestartEvent { /** * The class which has fired the restart event. - * - * @return class which has fired the restart event */ public Class getCause() { return cause; @@ -55,8 +51,6 @@ public class RestartEvent { /** * Returns the reason for the restart. - * - * @return reason for restart */ public String getReason() { return reason; diff --git a/scm-core/src/main/java/sonia/scm/lifecycle/Restarter.java b/scm-core/src/main/java/sonia/scm/lifecycle/Restarter.java index 12f9279c80..eee520e238 100644 --- a/scm-core/src/main/java/sonia/scm/lifecycle/Restarter.java +++ b/scm-core/src/main/java/sonia/scm/lifecycle/Restarter.java @@ -32,8 +32,6 @@ public interface Restarter { /** * Return {@code true} if restarting scm-manager is supported. - * - * @return {@code true} if restart is supported */ boolean isSupported(); diff --git a/scm-core/src/main/java/sonia/scm/logging/LoggingOutputStream.java b/scm-core/src/main/java/sonia/scm/logging/LoggingOutputStream.java index dcb9263f08..611829bc07 100644 --- a/scm-core/src/main/java/sonia/scm/logging/LoggingOutputStream.java +++ b/scm-core/src/main/java/sonia/scm/logging/LoggingOutputStream.java @@ -24,12 +24,9 @@ package sonia.scm.logging; -//~--- non-JDK imports -------------------------------------------------------- import org.slf4j.Logger; -//~--- JDK imports ------------------------------------------------------------ - import java.io.IOException; import java.io.OutputStream; @@ -37,7 +34,6 @@ import java.io.OutputStream; * An OutputStream that flushes out to a Logger. * Based on LoggingOutputStream by Jim Moore * - * @author Sebastian Sdorra */ public class LoggingOutputStream extends OutputStream { @@ -47,22 +43,40 @@ public class LoggingOutputStream extends OutputStream */ public static final int DEFAULT_BUFFER_LENGTH = 2048; - /** Field description */ public static final int LEVEL_DEBUG = 1; - /** Field description */ public static final int LEVEL_ERROR = 4; - /** Field description */ public static final int LEVEL_INFO = 2; - /** Field description */ public static final int LEVEL_TRACE = 0; - /** Field description */ public static final int LEVEL_WARN = 3; - //~--- constructors --------------------------------------------------------- + /** + * The internal buffer where data is stored. + */ + private byte[] buffer; + + /** + * Remembers the size of the buffer for speed. + */ + private int bufferLength; + + private boolean closed = false; + + /** + * The number of valid bytes in the buffer. This value is always + * in the range 0 through buf.length; elements + * buf[0] through buf[count-1] contain valid + * byte data. + */ + private int count; + + private int level = -1; + + /** The logger to write to. */ + private Logger logger; /** * Creates the LoggingOutputStream to flush to the given Logger. @@ -87,7 +101,6 @@ public class LoggingOutputStream extends OutputStream count = 0; } - //~--- methods -------------------------------------------------------------- /** * Closes this output stream and releases any system resources @@ -152,12 +165,6 @@ public class LoggingOutputStream extends OutputStream reset(); } - /** - * Method description - * - * - * @param message - */ public void log(String message) { switch (level) @@ -228,41 +235,9 @@ public class LoggingOutputStream extends OutputStream count++; } - /** - * Method description - * - */ - private void reset() + private void reset() { count = 0; } - //~--- fields --------------------------------------------------------------- - - /** - * The internal buffer where data is stored. - */ - private byte[] buffer; - - /** - * Remembers the size of the buffer for speed. - */ - private int bufferLength; - - /** Field description */ - private boolean closed = false; - - /** - * The number of valid bytes in the buffer. This value is always - * in the range 0 through buf.length; elements - * buf[0] through buf[count-1] contain valid - * byte data. - */ - private int count; - - /** Field description */ - private int level = -1; - - /** The logger to write to. */ - private Logger logger; } diff --git a/scm-core/src/main/java/sonia/scm/metrics/MonitoringSystem.java b/scm-core/src/main/java/sonia/scm/metrics/MonitoringSystem.java index 40fb0e878f..daa71e0b6e 100644 --- a/scm-core/src/main/java/sonia/scm/metrics/MonitoringSystem.java +++ b/scm-core/src/main/java/sonia/scm/metrics/MonitoringSystem.java @@ -37,17 +37,10 @@ import java.util.Optional; @ExtensionPoint public interface MonitoringSystem { - /** - * Returns name of monitoring system. - * - * @return name of monitoring system - */ String getName(); /** * Returns registry of metrics provider. - * - * @return metrics registry */ MeterRegistry getRegistry(); diff --git a/scm-core/src/main/java/sonia/scm/metrics/ScrapeTarget.java b/scm-core/src/main/java/sonia/scm/metrics/ScrapeTarget.java index 36beecaca4..567ad7e0c7 100644 --- a/scm-core/src/main/java/sonia/scm/metrics/ScrapeTarget.java +++ b/scm-core/src/main/java/sonia/scm/metrics/ScrapeTarget.java @@ -37,8 +37,6 @@ public interface ScrapeTarget { /** * Returns content type of output format. - * - * @return content type */ String getContentType(); diff --git a/scm-core/src/main/java/sonia/scm/net/ChildFirstURLClassLoader.java b/scm-core/src/main/java/sonia/scm/net/ChildFirstURLClassLoader.java index fffd412235..1e3caefdb9 100644 --- a/scm-core/src/main/java/sonia/scm/net/ChildFirstURLClassLoader.java +++ b/scm-core/src/main/java/sonia/scm/net/ChildFirstURLClassLoader.java @@ -24,8 +24,6 @@ package sonia.scm.net; -//~--- JDK imports ------------------------------------------------------------ - import java.net.URL; import java.net.URLClassLoader; import java.net.URLStreamHandlerFactory; @@ -33,10 +31,9 @@ import java.net.URLStreamHandlerFactory; /** * The ChildFirstURLClassLoader alters regular ClassLoader delegation and will * check the URLs used in its initialization for matching classes before - * delegating to it's parent. Sometimes also referred to as a + * delegating to its parent. Sometimes also referred to as a * ParentLastClassLoader. * - * @author Sebastian Sdorra * @since 1.29 */ public class ChildFirstURLClassLoader extends URLClassLoader @@ -82,7 +79,6 @@ public class ChildFirstURLClassLoader extends URLClassLoader super(urls, parent, factory); } - //~--- methods -------------------------------------------------------------- /** * Loads the class with the specified name. The default implementation of this @@ -154,11 +150,7 @@ public class ChildFirstURLClassLoader extends URLClassLoader return clazz; } - //~--- get methods ---------------------------------------------------------- - /** - * {@inheritDoc } - */ @Override public URL getResource(String name) { diff --git a/scm-core/src/main/java/sonia/scm/net/HttpConnectionOptions.java b/scm-core/src/main/java/sonia/scm/net/HttpConnectionOptions.java index d05fb3dc83..1565f7d257 100644 --- a/scm-core/src/main/java/sonia/scm/net/HttpConnectionOptions.java +++ b/scm-core/src/main/java/sonia/scm/net/HttpConnectionOptions.java @@ -173,7 +173,7 @@ public final class HttpConnectionOptions { /** * Add a request property that will be converted to headers in the request. - * @param key The property (aka header) name (eg. "User-Agent"). + * @param key The property (aka header) name (e.g. "User-Agent"). * @param value The value of the property. * @return {@code this} */ diff --git a/scm-core/src/main/java/sonia/scm/net/HttpURLConnectionFactory.java b/scm-core/src/main/java/sonia/scm/net/HttpURLConnectionFactory.java index cbfe539119..6aff74df76 100644 --- a/scm-core/src/main/java/sonia/scm/net/HttpURLConnectionFactory.java +++ b/scm-core/src/main/java/sonia/scm/net/HttpURLConnectionFactory.java @@ -96,9 +96,6 @@ public final class HttpURLConnectionFactory { /** * Creates a new {@link HttpURLConnection} from the given url with default options. - * @param url url - * @return a new connection with default options. - * @throws IOException */ public HttpURLConnection create(URL url) throws IOException { return create(url, new HttpConnectionOptions()); @@ -106,10 +103,6 @@ public final class HttpURLConnectionFactory { /** * Creates a new {@link HttpURLConnection} from the given url and options. - * @param url url - * @param options options for the new connection - * @return a new connection with the given options - * @throws IOException */ public HttpURLConnection create(URL url, HttpConnectionOptions options) throws IOException { Preconditions.checkArgument(options != null, "Options are required"); diff --git a/scm-core/src/main/java/sonia/scm/net/Proxies.java b/scm-core/src/main/java/sonia/scm/net/Proxies.java index a2d60eb9ca..b4eb032034 100644 --- a/scm-core/src/main/java/sonia/scm/net/Proxies.java +++ b/scm-core/src/main/java/sonia/scm/net/Proxies.java @@ -24,7 +24,6 @@ package sonia.scm.net; -//~--- non-JDK imports -------------------------------------------------------- import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -32,33 +31,21 @@ import org.slf4j.LoggerFactory; import sonia.scm.config.ScmConfiguration; import sonia.scm.util.GlobUtil; -//~--- JDK imports ------------------------------------------------------------ - import java.net.URL; /** * Util class for proxy settings. * - * @author Sebastian Sdorra * @since 1.23 */ public final class Proxies { - /** - * the logger for Proxies - */ private static final Logger logger = LoggerFactory.getLogger(Proxies.class); - //~--- constructors --------------------------------------------------------- - /** - * Constructs ... - * - */ private Proxies() {} - //~--- get methods ---------------------------------------------------------- /** * Returns true if proxy settings should be used to access the given url. diff --git a/scm-core/src/main/java/sonia/scm/net/ProxyConfiguration.java b/scm-core/src/main/java/sonia/scm/net/ProxyConfiguration.java index c7d2c801a7..9aa45cae64 100644 --- a/scm-core/src/main/java/sonia/scm/net/ProxyConfiguration.java +++ b/scm-core/src/main/java/sonia/scm/net/ProxyConfiguration.java @@ -33,45 +33,35 @@ import java.util.Collection; */ public interface ProxyConfiguration { - /** - * Returns {@code true} if proxy configuration is enabled. - * @return {@code true} if enabled - */ boolean isEnabled(); /** * Return the hostname or ip address of the proxy server. - * @return proxy server hostname or ip address */ String getHost(); /** * Returns port of the proxy server. - * @return port of proxy server */ int getPort(); /** * Returns a list of hostnames which should not be routed over the proxy server. - * @return list of excluded hostnames */ Collection getExcludes(); /** * Returns the username for proxy server authentication. - * @return username for authentication */ String getUsername(); /** * Returns thr password for proxy server authentication. - * @return password for authentication */ String getPassword(); /** * Return {@code true} if the proxy server required authentication. - * @return {@code true} if authentication is required */ boolean isAuthenticationRequired(); } diff --git a/scm-core/src/main/java/sonia/scm/net/ahc/AdvancedHttpClient.java b/scm-core/src/main/java/sonia/scm/net/ahc/AdvancedHttpClient.java index 38e24f86c6..5cd3554b8e 100644 --- a/scm-core/src/main/java/sonia/scm/net/ahc/AdvancedHttpClient.java +++ b/scm-core/src/main/java/sonia/scm/net/ahc/AdvancedHttpClient.java @@ -24,8 +24,6 @@ package sonia.scm.net.ahc; -//~--- JDK imports ------------------------------------------------------------ - import java.io.IOException; /** @@ -60,7 +58,6 @@ import java.io.IOException; * } * * - * @author Sebastian Sdorra * @apiviz.landmark * @since 1.46 */ @@ -80,7 +77,7 @@ public abstract class AdvancedHttpClient { /** * Executes the given request and returns the http response. Implementation - * have to check, if the instance if from type + * have to check, if the instance is from type * {@link AdvancedHttpRequestWithBody} in order to handle request contents. * * @param request request to execute @@ -92,9 +89,6 @@ public abstract class AdvancedHttpClient { /** * Returns a builder for a DELETE request. - * - * @param url request url - * @return request builder */ public AdvancedHttpRequestWithBody delete(String url) { return new AdvancedHttpRequestWithBody(this, HttpMethod.DELETE, url); @@ -102,9 +96,6 @@ public abstract class AdvancedHttpClient { /** * Returns a builder for a HEAD request. - * - * @param url request url - * @return request builder */ public AdvancedHttpRequest head(String url) { return new AdvancedHttpRequest(this, HttpMethod.HEAD, url); @@ -114,10 +105,6 @@ public abstract class AdvancedHttpClient { * Returns a request builder with a custom method. Note: not * every method is supported by the underlying implementation of the http * client. - * - * @param method http method - * @param url request url - * @return request builder */ public AdvancedHttpRequestWithBody method(String method, String url) { return new AdvancedHttpRequestWithBody(this, method, url); @@ -125,9 +112,6 @@ public abstract class AdvancedHttpClient { /** * Returns a builder for a OPTIONS request. - * - * @param url request url - * @return request builder */ public AdvancedHttpRequestWithBody options(String url) { return new AdvancedHttpRequestWithBody(this, HttpMethod.OPTIONS, url); @@ -135,9 +119,6 @@ public abstract class AdvancedHttpClient { /** * Returns a builder for a POST request. - * - * @param url request url - * @return request builder */ public AdvancedHttpRequestWithBody post(String url) { return new AdvancedHttpRequestWithBody(this, HttpMethod.POST, url); @@ -145,21 +126,14 @@ public abstract class AdvancedHttpClient { /** * Returns a builder for a PUT request. - * - * @param url request url - * @return request builder */ public AdvancedHttpRequestWithBody put(String url) { return new AdvancedHttpRequestWithBody(this, HttpMethod.PUT, url); } - //~--- get methods ---------------------------------------------------------- /** * Returns a builder for a GET request. - * - * @param url request url - * @return request builder */ public AdvancedHttpRequest get(String url) { return new AdvancedHttpRequest(this, HttpMethod.GET, url); diff --git a/scm-core/src/main/java/sonia/scm/net/ahc/AdvancedHttpRequest.java b/scm-core/src/main/java/sonia/scm/net/ahc/AdvancedHttpRequest.java index 75f84bcd23..97799b3f6a 100644 --- a/scm-core/src/main/java/sonia/scm/net/ahc/AdvancedHttpRequest.java +++ b/scm-core/src/main/java/sonia/scm/net/ahc/AdvancedHttpRequest.java @@ -24,39 +24,20 @@ package sonia.scm.net.ahc; -//~--- JDK imports ------------------------------------------------------------ - /** - * An http request without {@link Content} for example a GET or HEAD request. + * A http request without {@link Content} for example a GET or HEAD request. * - * @author Sebastian Sdorra * @since 1.46 */ public class AdvancedHttpRequest extends BaseHttpRequest { - /** - * Constructs a new {@link AdvancedHttpRequest} - * - * - * @param client - * @param method - * @param url - */ AdvancedHttpRequest(AdvancedHttpClient client, String method, String url) { super(client, method, url); } - //~--- methods -------------------------------------------------------------- - - /** - * Returns {@code this}. - * - * - * @return {@code this} - */ @Override protected AdvancedHttpRequest self() { diff --git a/scm-core/src/main/java/sonia/scm/net/ahc/AdvancedHttpRequestWithBody.java b/scm-core/src/main/java/sonia/scm/net/ahc/AdvancedHttpRequestWithBody.java index 679ee72e37..9998de68c6 100644 --- a/scm-core/src/main/java/sonia/scm/net/ahc/AdvancedHttpRequestWithBody.java +++ b/scm-core/src/main/java/sonia/scm/net/ahc/AdvancedHttpRequestWithBody.java @@ -21,15 +21,12 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ - + package sonia.scm.net.ahc; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.io.ByteSource; -//~--- JDK imports ------------------------------------------------------------ - import java.io.File; import java.nio.charset.Charset; @@ -38,20 +35,15 @@ import java.nio.charset.StandardCharsets; /** * Http request with body. * - * @author Sebastian Sdorra * @since 1.46 */ public class AdvancedHttpRequestWithBody extends BaseHttpRequest { + private Content content; /** * Constructs a new {@link AdvancedHttpRequestWithBody}. - * - * - * @param client http client - * @param method http method - * @param url url */ AdvancedHttpRequestWithBody(AdvancedHttpClient client, String method, String url) @@ -64,9 +56,6 @@ public class AdvancedHttpRequestWithBody /** * Sets the content length for the request. * - * - * @param length content length - * * @return {@code this} */ public AdvancedHttpRequestWithBody contentLength(long length) @@ -77,9 +66,6 @@ public class AdvancedHttpRequestWithBody /** * Sets the content type for the request. * - * - * @param contentType content type - * * @return {@code this} */ public AdvancedHttpRequestWithBody contentType(String contentType) @@ -90,9 +76,6 @@ public class AdvancedHttpRequestWithBody /** * Sets the content of the file as request content. * - * - * @param file file - * * @return {@code this} */ public AdvancedHttpRequestWithBody fileContent(File file) @@ -133,9 +116,6 @@ public class AdvancedHttpRequestWithBody /** * Sets the raw data as request content. * - * - * @param data raw data - * * @return {@code this} */ public AdvancedHttpRequestWithBody rawContent(byte[] data) @@ -148,9 +128,6 @@ public class AdvancedHttpRequestWithBody /** * Sets the raw data as request content. * - * - * @param source byte source - * * @return {@code this} */ public AdvancedHttpRequestWithBody rawContent(ByteSource source) @@ -163,9 +140,6 @@ public class AdvancedHttpRequestWithBody /** * Sets the string as request content. * - * - * @param content string content - * * @return {@code this} */ public AdvancedHttpRequestWithBody stringContent(String content) @@ -176,7 +150,6 @@ public class AdvancedHttpRequestWithBody /** * Sets the string as request content. * - * * @param content string content * @param charset charset of content * @@ -241,35 +214,20 @@ public class AdvancedHttpRequestWithBody return transformedContent(ContentType.XML, object); } - //~--- get methods ---------------------------------------------------------- /** * Returns the content or the request. - * - * - * @return request content */ public Content getContent() { return content; } - //~--- methods -------------------------------------------------------------- - /** - * Returns {@code this}. - * - * - * @return {@code this} - */ @Override protected AdvancedHttpRequestWithBody self() { return this; } - //~--- fields --------------------------------------------------------------- - - /** request content */ - private Content content; } diff --git a/scm-core/src/main/java/sonia/scm/net/ahc/AdvancedHttpResponse.java b/scm-core/src/main/java/sonia/scm/net/ahc/AdvancedHttpResponse.java index fb4b9d07f7..4ce9345eba 100644 --- a/scm-core/src/main/java/sonia/scm/net/ahc/AdvancedHttpResponse.java +++ b/scm-core/src/main/java/sonia/scm/net/ahc/AdvancedHttpResponse.java @@ -21,10 +21,9 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ - + package sonia.scm.net.ahc; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Charsets; import com.google.common.base.Strings; @@ -32,8 +31,6 @@ import com.google.common.collect.Iterables; import com.google.common.collect.Multimap; import com.google.common.io.ByteSource; -//~--- JDK imports ------------------------------------------------------------ - import java.io.BufferedReader; import java.io.IOException; import java.io.InputStream; @@ -42,7 +39,6 @@ import java.io.InputStream; * Http response. The response of a {@link AdvancedHttpRequest} or * {@link AdvancedHttpRequestWithBody}. * - * @author Sebastian Sdorra * @since 1.46 */ public abstract class AdvancedHttpResponse @@ -50,40 +46,25 @@ public abstract class AdvancedHttpResponse /** * Returns the response content as byte source. - * - * - * @return response content as byte source - * @throws IOException */ public abstract ByteSource contentAsByteSource() throws IOException; - //~--- get methods ---------------------------------------------------------- /** * Returns the response headers. - * - * - * @return response headers */ public abstract Multimap getHeaders(); /** * Returns the status code of the response. - * - * - * @return status code */ public abstract int getStatus(); /** * Returns the status text of the response. - * - * - * @return status text */ public abstract String getStatusText(); - //~--- methods -------------------------------------------------------------- /** * Creates a {@link ContentTransformer} for the given Content-Type. @@ -100,11 +81,6 @@ public abstract class AdvancedHttpResponse /** * Returns the content of the response as byte array. - * - * - * @return content as byte array - * - * @throws IOException */ public byte[] content() throws IOException { @@ -121,11 +97,6 @@ public abstract class AdvancedHttpResponse /** * Returns a reader for the content of the response. - * - * - * @return read of response content - * - * @throws IOException */ public BufferedReader contentAsReader() throws IOException { @@ -142,11 +113,6 @@ public abstract class AdvancedHttpResponse /** * Returns response content as stream. - * - * - * @return response content as stram - * - * @throws IOException */ public InputStream contentAsStream() throws IOException { @@ -163,11 +129,6 @@ public abstract class AdvancedHttpResponse /** * Returns the response content as string. - * - * - * @return response content - * - * @throws IOException */ public String contentAsString() throws IOException { @@ -247,7 +208,7 @@ public abstract class AdvancedHttpResponse /** * Transforms the response content to the given type. The method will use - * the {@link ContentTransformer} which is responsible for the the given + * the {@link ContentTransformer} which is responsible for the given * content type. * * @param object type @@ -277,15 +238,8 @@ public abstract class AdvancedHttpResponse return object; } - //~--- get methods ---------------------------------------------------------- - /** * Returns the first header value for the given header name or {@code null}. - * - * - * @param name header name - * - * @return header value or {@code null} */ public String getFirstHeader(String name) { @@ -295,8 +249,6 @@ public abstract class AdvancedHttpResponse /** * Returns {@code true} if the response was successful. A response is * successful, if the status code is greater than 199 and lower than 400. - * - * @return {@code true} if the response was successful */ public boolean isSuccessful() { diff --git a/scm-core/src/main/java/sonia/scm/net/ahc/BaseHttpRequest.java b/scm-core/src/main/java/sonia/scm/net/ahc/BaseHttpRequest.java index 55ef1f033b..9f0037aeed 100644 --- a/scm-core/src/main/java/sonia/scm/net/ahc/BaseHttpRequest.java +++ b/scm-core/src/main/java/sonia/scm/net/ahc/BaseHttpRequest.java @@ -24,7 +24,6 @@ package sonia.scm.net.ahc; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Strings; import com.google.common.collect.LinkedHashMultimap; @@ -35,27 +34,39 @@ import sonia.scm.util.HttpUtil; import java.io.IOException; import java.nio.charset.StandardCharsets; -//~--- JDK imports ------------------------------------------------------------ - /** * Base class for http requests. * - * @author Sebastian Sdorra * @param request implementation * * @since 1.46 */ public abstract class BaseHttpRequest { + protected final AdvancedHttpClient client; + + private final Multimap headers = LinkedHashMultimap.create(); + + private final String method; + + private boolean ignoreProxySettings = false; + + /** disable ssl hostname validation */ + private boolean disableHostnameValidation = false; + + /** disable ssl certificate validation */ + private boolean disableCertificateValidation = false; + + private boolean decodeGZip = false; + + private String url; + + /** kind of span for trace api */ + private String spanKind = "HTTP Request"; + + /** codes which will be marked as successful by tracer */ + private int[] acceptedStatusCodes = new int[]{}; - /** - * Constructs a new {@link BaseHttpRequest}. - * - * - * @param client http client - * @param method http method - * @param url url - */ public BaseHttpRequest(AdvancedHttpClient client, String method, String url) { this.client = client; @@ -63,7 +74,6 @@ public abstract class BaseHttpRequest this.url = url; } - //~--- methods -------------------------------------------------------------- /** * Executes the request and returns the http response. @@ -296,13 +306,9 @@ public abstract class BaseHttpRequest return self(); } - //~--- get methods ---------------------------------------------------------- /** * Return a map with http headers used for the request. - * - * - * @return map with http headers */ public Multimap getHeaders() { @@ -311,9 +317,6 @@ public abstract class BaseHttpRequest /** * Returns the http method for the request. - * - * - * @return http method of request */ public String getMethod() { @@ -322,9 +325,6 @@ public abstract class BaseHttpRequest /** * Returns the url for the request. - * - * - * @return url of the request */ public String getUrl() { @@ -334,8 +334,6 @@ public abstract class BaseHttpRequest /** * Returns the kind of span which is used for the trace api. * - * @return kind of span - * * @since 2.9.0 */ public String getSpanKind() { @@ -356,9 +354,6 @@ public abstract class BaseHttpRequest /** * Returns true if the request decodes gzip compression. - * - * - * @return true if the request decodes gzip compression */ public boolean isDecodeGZip() { @@ -367,9 +362,6 @@ public abstract class BaseHttpRequest /** * Returns true if the verification of ssl certificates is disabled. - * - * - * @return true if certificate verification is disabled */ public boolean isDisableCertificateValidation() { @@ -378,9 +370,6 @@ public abstract class BaseHttpRequest /** * Returns true if the ssl hostname validation is disabled. - * - * - * @return true if the ssl hostname validation is disabled */ public boolean isDisableHostnameValidation() { @@ -389,16 +378,12 @@ public abstract class BaseHttpRequest /** * Returns true if the proxy settings are ignored. - * - * - * @return true if the proxy settings are ignored */ public boolean isIgnoreProxySettings() { return ignoreProxySettings; } - //~--- methods -------------------------------------------------------------- /** * Returns the value url encoded. @@ -416,11 +401,6 @@ public abstract class BaseHttpRequest /** * Returns string representation of the given object or {@code null}, if the * object is {@code null}. - * - * - * @param object object - * - * @return string representation or {@code null} */ protected String toString(Object object) { @@ -446,35 +426,4 @@ public abstract class BaseHttpRequest url = url.concat(buffer.toString()); } - //~--- fields --------------------------------------------------------------- - - /** http client */ - protected final AdvancedHttpClient client; - - /** http header */ - private final Multimap headers = LinkedHashMultimap.create(); - - /** http method */ - private final String method; - - /** ignore proxy settings */ - private boolean ignoreProxySettings = false; - - /** disable ssl hostname validation */ - private boolean disableHostnameValidation = false; - - /** disable ssl certificate validation */ - private boolean disableCertificateValidation = false; - - /** decode gzip */ - private boolean decodeGZip = false; - - /** url of request */ - private String url; - - /** kind of span for trace api */ - private String spanKind = "HTTP Request"; - - /** codes which will be marked as successful by tracer */ - private int[] acceptedStatusCodes = new int[]{}; } diff --git a/scm-core/src/main/java/sonia/scm/net/ahc/ByteSourceContent.java b/scm-core/src/main/java/sonia/scm/net/ahc/ByteSourceContent.java index 37af9516d5..c35eefe995 100644 --- a/scm-core/src/main/java/sonia/scm/net/ahc/ByteSourceContent.java +++ b/scm-core/src/main/java/sonia/scm/net/ahc/ByteSourceContent.java @@ -24,36 +24,26 @@ package sonia.scm.net.ahc; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.io.ByteSource; -//~--- JDK imports ------------------------------------------------------------ - import java.io.IOException; import java.io.OutputStream; /** * {@link ByteSource} content for {@link AdvancedHttpRequestWithBody}. * - * @author Sebastian Sdorra * @since 1.46 */ public class ByteSourceContent implements Content { + private final ByteSource byteSource; - /** - * Constructs a new {@link ByteSourceContent}. - * - * - * @param byteSource byte source - */ public ByteSourceContent(ByteSource byteSource) { this.byteSource = byteSource; } - //~--- methods -------------------------------------------------------------- /** * Sets the content length for the request. @@ -83,8 +73,4 @@ public class ByteSourceContent implements Content byteSource.copyTo(output); } - //~--- fields --------------------------------------------------------------- - - /** byte source */ - private final ByteSource byteSource; } diff --git a/scm-core/src/main/java/sonia/scm/net/ahc/Content.java b/scm-core/src/main/java/sonia/scm/net/ahc/Content.java index adb241bbca..6130d4677e 100644 --- a/scm-core/src/main/java/sonia/scm/net/ahc/Content.java +++ b/scm-core/src/main/java/sonia/scm/net/ahc/Content.java @@ -24,15 +24,12 @@ package sonia.scm.net.ahc; -//~--- JDK imports ------------------------------------------------------------ - import java.io.IOException; import java.io.OutputStream; /** * Content of a {@link AdvancedHttpRequestWithBody}. * - * @author Sebastian Sdorra * @since 1.46 */ public interface Content diff --git a/scm-core/src/main/java/sonia/scm/net/ahc/ContentTransformer.java b/scm-core/src/main/java/sonia/scm/net/ahc/ContentTransformer.java index 2ea132d011..053a7075e2 100644 --- a/scm-core/src/main/java/sonia/scm/net/ahc/ContentTransformer.java +++ b/scm-core/src/main/java/sonia/scm/net/ahc/ContentTransformer.java @@ -34,7 +34,6 @@ import sonia.scm.plugin.ExtensionPoint; * annotate the implementation with the {@link sonia.scm.plugin.Extension} * annotation. * - * @author Sebastian Sdorra * @since 1.46 */ @ExtensionPoint @@ -47,8 +46,6 @@ public interface ContentTransformer * * @param type object type * @param contentType content type - * - * @return {@code true} if the transformer is responsible */ public boolean isResponsible(Class type, String contentType); @@ -69,8 +66,6 @@ public interface ContentTransformer * @param type type of result object * @param content content * @param type of result object - * - * @return */ public T unmarshall(Class type, ByteSource content); } diff --git a/scm-core/src/main/java/sonia/scm/net/ahc/ContentTransformerException.java b/scm-core/src/main/java/sonia/scm/net/ahc/ContentTransformerException.java index 74fb0c2643..b8395613b8 100644 --- a/scm-core/src/main/java/sonia/scm/net/ahc/ContentTransformerException.java +++ b/scm-core/src/main/java/sonia/scm/net/ahc/ContentTransformerException.java @@ -28,36 +28,20 @@ package sonia.scm.net.ahc; * A {@link ContentTransformerException} is thrown if an error occurs during * content transformation by an {@link ContentTransformer}. * - * @author Sebastian Sdorra * * @since 1.46 */ public class ContentTransformerException extends RuntimeException { - /** Field description */ private static final long serialVersionUID = 367333504151208563L; - //~--- constructors --------------------------------------------------------- - /** - * Constructs a new {@link ContentTransformerException}. - * - * - * @param message exception message - */ public ContentTransformerException(String message) { super(message); } - /** - * Constructs a new {@link ContentTransformerException}. - * - * - * @param message exception message - * @param cause exception cause - */ public ContentTransformerException(String message, Throwable cause) { super(message, cause); diff --git a/scm-core/src/main/java/sonia/scm/net/ahc/ContentTransformerNotFoundException.java b/scm-core/src/main/java/sonia/scm/net/ahc/ContentTransformerNotFoundException.java index ed37e9cf5b..2a9b69e44a 100644 --- a/scm-core/src/main/java/sonia/scm/net/ahc/ContentTransformerNotFoundException.java +++ b/scm-core/src/main/java/sonia/scm/net/ahc/ContentTransformerNotFoundException.java @@ -28,24 +28,14 @@ package sonia.scm.net.ahc; * The ContentTransformerNotFoundException is thrown, if no * {@link ContentTransformer} could be found for the given type. * - * @author Sebastian Sdorra * @since 1.46 */ public class ContentTransformerNotFoundException extends ContentTransformerException { - /** Field description */ private static final long serialVersionUID = 6374525163951460938L; - //~--- constructors --------------------------------------------------------- - - /** - * Constructs a new ContentTransformerNotFoundException. - * - * - * @param message exception message - */ public ContentTransformerNotFoundException(String message) { super(message); diff --git a/scm-core/src/main/java/sonia/scm/net/ahc/ContentType.java b/scm-core/src/main/java/sonia/scm/net/ahc/ContentType.java index 631b2724a1..92880980bc 100644 --- a/scm-core/src/main/java/sonia/scm/net/ahc/ContentType.java +++ b/scm-core/src/main/java/sonia/scm/net/ahc/ContentType.java @@ -27,19 +27,15 @@ package sonia.scm.net.ahc; /** * Content-Types. * - * @author Sebastian Sdorra * @since 1.46 */ public final class ContentType { - /** json content type */ public static final String JSON = "application/json"; - /** xml content type */ public static final String XML = "application/xml"; - //~--- constructors --------------------------------------------------------- private ContentType() {} } diff --git a/scm-core/src/main/java/sonia/scm/net/ahc/FileContent.java b/scm-core/src/main/java/sonia/scm/net/ahc/FileContent.java index 170a2383b8..6201be497b 100644 --- a/scm-core/src/main/java/sonia/scm/net/ahc/FileContent.java +++ b/scm-core/src/main/java/sonia/scm/net/ahc/FileContent.java @@ -24,13 +24,10 @@ package sonia.scm.net.ahc; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.io.ByteStreams; import com.google.common.io.Closeables; -//~--- JDK imports ------------------------------------------------------------ - import java.io.File; import java.io.FileInputStream; import java.io.IOException; @@ -40,24 +37,17 @@ import java.io.OutputStream; /** * Sets the content of the file to the request. * - * @author Sebastian Sdorra * @since 1.46 */ public class FileContent implements Content { + private final File file; - /** - * Constructs a new {@link FileContent}. - * - * - * @param file file - */ public FileContent(File file) { this.file = file; } - //~--- methods -------------------------------------------------------------- /** * Sets the content length of the file as request header. @@ -94,9 +84,4 @@ public class FileContent implements Content Closeables.close(stream, true); } } - - //~--- fields --------------------------------------------------------------- - - /** file */ - private final File file; } diff --git a/scm-core/src/main/java/sonia/scm/net/ahc/FormContentBuilder.java b/scm-core/src/main/java/sonia/scm/net/ahc/FormContentBuilder.java index a4ee56834f..2b5fd65410 100644 --- a/scm-core/src/main/java/sonia/scm/net/ahc/FormContentBuilder.java +++ b/scm-core/src/main/java/sonia/scm/net/ahc/FormContentBuilder.java @@ -42,7 +42,6 @@ import java.util.function.Supplier; /** * The form builder is able to add form parameters to a request. * - * @author Sebastian Sdorra * @since 1.46 */ public class FormContentBuilder { @@ -52,11 +51,6 @@ public class FormContentBuilder { private final List fileEntries = new ArrayList<>(); private final Supplier boundaryFactory; - /** - * Constructs a new {@link FormContentBuilder}. - * - * @param request request - */ public FormContentBuilder(AdvancedHttpRequestWithBody request) { this(request, () -> "------------------------" + System.currentTimeMillis()); } diff --git a/scm-core/src/main/java/sonia/scm/net/ahc/HttpMethod.java b/scm-core/src/main/java/sonia/scm/net/ahc/HttpMethod.java index 3580f5b908..41a32365b1 100644 --- a/scm-core/src/main/java/sonia/scm/net/ahc/HttpMethod.java +++ b/scm-core/src/main/java/sonia/scm/net/ahc/HttpMethod.java @@ -27,31 +27,23 @@ package sonia.scm.net.ahc; /** * Http methods. * - * @author Sebastian Sdorra * @since 1.46 */ public final class HttpMethod { - /** http delete method */ public static final String DELETE = "DELETE"; - /** http get method */ public static final String GET = "GET"; - /** http head method */ public static final String HEAD = "HEAD"; - /** http options method */ public static final String OPTIONS = "OPTIONS"; - /** http post method */ public static final String POST = "POST"; - /** http put method */ public static final String PUT = "PUT"; - //~--- constructors --------------------------------------------------------- private HttpMethod() {} } diff --git a/scm-core/src/main/java/sonia/scm/net/ahc/RawContent.java b/scm-core/src/main/java/sonia/scm/net/ahc/RawContent.java index 8f0e416936..3260d029e2 100644 --- a/scm-core/src/main/java/sonia/scm/net/ahc/RawContent.java +++ b/scm-core/src/main/java/sonia/scm/net/ahc/RawContent.java @@ -24,36 +24,26 @@ package sonia.scm.net.ahc; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.annotations.VisibleForTesting; -//~--- JDK imports ------------------------------------------------------------ - import java.io.IOException; import java.io.OutputStream; /** * Byte array content for {@link AdvancedHttpRequestWithBody}. * - * @author Sebastian Sdorra * @since 1.46 */ public class RawContent implements Content { + private final byte[] data; - /** - * Constructs a new {@link RawContent}. - * - * - * @param data data - */ public RawContent(byte[] data) { this.data = data; } - //~--- methods -------------------------------------------------------------- /** * Sets the length of the byte array as http header. @@ -81,22 +71,9 @@ public class RawContent implements Content output.write(data); } - //~--- get methods ---------------------------------------------------------- - - /** - * Returns content data. - * - * - * @return content data - */ @VisibleForTesting byte[] getData() { return data; } - - //~--- fields --------------------------------------------------------------- - - /** byte array */ - private final byte[] data; } diff --git a/scm-core/src/main/java/sonia/scm/net/ahc/StringContent.java b/scm-core/src/main/java/sonia/scm/net/ahc/StringContent.java index 7cc610dd37..d0fab09eb4 100644 --- a/scm-core/src/main/java/sonia/scm/net/ahc/StringContent.java +++ b/scm-core/src/main/java/sonia/scm/net/ahc/StringContent.java @@ -24,26 +24,16 @@ package sonia.scm.net.ahc; -//~--- JDK imports ------------------------------------------------------------ - import java.nio.charset.Charset; /** * String content for {@link AdvancedHttpRequestWithBody}. * - * @author Sebastian Sdorra * @since 1.46 */ public class StringContent extends RawContent { - /** - * Constructs a new {@link StringContent}. - * - * - * @param content content - * @param charset charset - */ public StringContent(String content, Charset charset) { super(content.getBytes(charset)); diff --git a/scm-core/src/main/java/sonia/scm/plugin/ClassElement.java b/scm-core/src/main/java/sonia/scm/plugin/ClassElement.java index 71dc07bf13..41e9e9de70 100644 --- a/scm-core/src/main/java/sonia/scm/plugin/ClassElement.java +++ b/scm-core/src/main/java/sonia/scm/plugin/ClassElement.java @@ -24,7 +24,6 @@ package sonia.scm.plugin; -//~--- non-JDK imports -------------------------------------------------------- import jakarta.xml.bind.annotation.XmlAccessType; import jakarta.xml.bind.annotation.XmlAccessorType; @@ -40,7 +39,6 @@ import java.util.HashSet; import java.util.Set; /** - * @author Sebastian Sdorra * @since 2.0.0 */ @Getter diff --git a/scm-core/src/main/java/sonia/scm/plugin/ExtensionPointElement.java b/scm-core/src/main/java/sonia/scm/plugin/ExtensionPointElement.java index 5952ea01da..214cc9a17f 100644 --- a/scm-core/src/main/java/sonia/scm/plugin/ExtensionPointElement.java +++ b/scm-core/src/main/java/sonia/scm/plugin/ExtensionPointElement.java @@ -24,7 +24,6 @@ package sonia.scm.plugin; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.MoreObjects; import com.google.common.base.Objects; @@ -33,33 +32,26 @@ import jakarta.xml.bind.annotation.XmlAccessorType; import jakarta.xml.bind.annotation.XmlElement; import jakarta.xml.bind.annotation.XmlRootElement; -//~--- JDK imports ------------------------------------------------------------ - /** * - * @author Sebastian Sdorra * @since 2.0.0 */ @XmlAccessorType(XmlAccessType.FIELD) @XmlRootElement(name = "extension-point") public final class ExtensionPointElement { + @XmlElement(name = "class") + private Class clazz; + + private String description; + + @XmlElement(name = "multi") + private boolean multiple = true; + + private boolean autoBind = true; - /** - * Constructs ... - * - */ ExtensionPointElement() {} - /** - * Constructs ... - * - * - * @param clazz - * @param description - * @param multiple - * @param autoBind - */ public ExtensionPointElement(Class clazz, String description, boolean multiple, boolean autoBind) { @@ -69,16 +61,6 @@ public final class ExtensionPointElement this.autoBind = autoBind; } - //~--- methods -------------------------------------------------------------- - - /** - * Method description - * - * - * @param obj - * - * @return - */ @Override public boolean equals(Object obj) { @@ -100,24 +82,14 @@ public final class ExtensionPointElement && Objects.equal(autoBind, other.autoBind); } - /** - * Method description - * - * - * @return - */ + @Override public int hashCode() { return Objects.hashCode(clazz, description, multiple, autoBind); } - /** - * Method description - * - * - * @return - */ + @Override public String toString() { @@ -131,65 +103,29 @@ public final class ExtensionPointElement //J+ } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + public Class getClazz() { return clazz; } - /** - * Method description - * - * - * @return - */ + public String getDescription() { return description; } - /** - * Method description - * - * - * @return - */ + public boolean isAutoBind() { return autoBind; } - /** - * Method description - * - * - * @return - */ + public boolean isMultiple() { return multiple; } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - @XmlElement(name = "class") - private Class clazz; - - /** Field description */ - private String description; - - /** Field description */ - @XmlElement(name = "multi") - private boolean multiple = true; - - /** Field description */ - private boolean autoBind = true; } diff --git a/scm-core/src/main/java/sonia/scm/plugin/ExtensionProcessor.java b/scm-core/src/main/java/sonia/scm/plugin/ExtensionProcessor.java index 7641c62df1..4b21b48acd 100644 --- a/scm-core/src/main/java/sonia/scm/plugin/ExtensionProcessor.java +++ b/scm-core/src/main/java/sonia/scm/plugin/ExtensionProcessor.java @@ -24,7 +24,6 @@ package sonia.scm.plugin; -//~--- non-JDK imports -------------------------------------------------------- import com.google.inject.Binder; import sonia.scm.config.ConfigBinding; @@ -34,7 +33,6 @@ import static java.util.Collections.emptySet; /** * Process and resolve extensions. * - * @author Sebastian Sdorra * @since 2.0.0 */ public interface ExtensionProcessor @@ -64,19 +62,12 @@ public interface ExtensionProcessor /** * Process auto bind extensions. - * - * - * @param binder injection binder */ void processAutoBindExtensions(Binder binder); - //~--- get methods ---------------------------------------------------------- /** * Returns all collected web elements (servlets and filters). - * - * - * @return collected web elements */ Iterable getWebElements(); @@ -89,8 +80,6 @@ public interface ExtensionProcessor /** * Returns all collected indexable types. - * - * @return collected indexable types * @since 2.21.0 */ default Iterable> getIndexedTypes() { diff --git a/scm-core/src/main/java/sonia/scm/plugin/InstalledPlugin.java b/scm-core/src/main/java/sonia/scm/plugin/InstalledPlugin.java index c342463311..df4c8797e6 100644 --- a/scm-core/src/main/java/sonia/scm/plugin/InstalledPlugin.java +++ b/scm-core/src/main/java/sonia/scm/plugin/InstalledPlugin.java @@ -24,19 +24,28 @@ package sonia.scm.plugin; -//~--- JDK imports ------------------------------------------------------------ - import java.nio.file.Path; /** * Wrapper for a {@link InstalledPluginDescriptor}. The wrapper holds the directory, * {@link ClassLoader} and {@link WebResourceLoader} of a plugin. * - * @author Sebastian Sdorra * @since 2.0.0 */ public final class InstalledPlugin implements Plugin { + private final ClassLoader classLoader; + + private final Path directory; + + private final InstalledPluginDescriptor descriptor; + + private final WebResourceLoader webResourceLoader; + + private final boolean core; + + private boolean markedForUninstall = false; + private boolean uninstallable = false; public static final String UNINSTALL_MARKER_FILENAME = "uninstall"; /** @@ -57,12 +66,8 @@ public final class InstalledPlugin implements Plugin { this.core = core; } - //~--- get methods ---------------------------------------------------------- - /** * Returns plugin class loader. - * - * @return plugin class loader */ public ClassLoader getClassLoader() { return classLoader; @@ -70,8 +75,6 @@ public final class InstalledPlugin implements Plugin { /** * Returns plugin directory. - * - * @return plugin directory */ public Path getDirectory() { return directory; @@ -79,8 +82,6 @@ public final class InstalledPlugin implements Plugin { /** * Returns the id of the plugin. - * - * @return id of plugin */ public String getId() { return descriptor.getInformation().getId(); @@ -88,8 +89,6 @@ public final class InstalledPlugin implements Plugin { /** * Returns the plugin descriptor. - * - * @return plugin descriptor */ @Override public InstalledPluginDescriptor getDescriptor() { @@ -98,8 +97,6 @@ public final class InstalledPlugin implements Plugin { /** * Returns the {@link WebResourceLoader} for this plugin. - * - * @return web resource loader */ public WebResourceLoader getWebResourceLoader() { return webResourceLoader; @@ -125,30 +122,4 @@ public final class InstalledPlugin implements Plugin { this.uninstallable = uninstallable; } -//~--- fields --------------------------------------------------------------- - - /** - * plugin class loader - */ - private final ClassLoader classLoader; - - /** - * plugin directory - */ - private final Path directory; - - /** - * plugin - */ - private final InstalledPluginDescriptor descriptor; - - /** - * plugin web resource loader - */ - private final WebResourceLoader webResourceLoader; - - private final boolean core; - - private boolean markedForUninstall = false; - private boolean uninstallable = false; } diff --git a/scm-core/src/main/java/sonia/scm/plugin/InstalledPluginDescriptor.java b/scm-core/src/main/java/sonia/scm/plugin/InstalledPluginDescriptor.java index bdaeaec06b..adde854c86 100644 --- a/scm-core/src/main/java/sonia/scm/plugin/InstalledPluginDescriptor.java +++ b/scm-core/src/main/java/sonia/scm/plugin/InstalledPluginDescriptor.java @@ -24,7 +24,6 @@ package sonia.scm.plugin; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.MoreObjects; import com.google.common.base.Objects; @@ -39,36 +38,39 @@ import jakarta.xml.bind.annotation.XmlRootElement; import java.util.Set; import java.util.stream.Collectors; -//~--- JDK imports ------------------------------------------------------------ -/** - * - * @author Sebastian Sdorra - */ @XmlRootElement(name = "plugin") @XmlAccessorType(XmlAccessType.FIELD) public final class InstalledPluginDescriptor extends ScmModule implements PluginDescriptor { + @XmlElement(name = "child-first-classloader") + private boolean childFirstClassLoader; + + @XmlElement(name = "conditions") + private PluginCondition condition; + + @XmlElement(name = "dependency") + @XmlElementWrapper(name = "dependencies") + private Set dependencies; + + @XmlElement(name = "dependency") + @XmlElementWrapper(name = "optional-dependencies") + private Set optionalDependencies; + + @XmlElement(name = "information") + private PluginInformation information; + + private PluginResources resources; + + @XmlElement(name = "scm-version") + private int scmVersion = 1; + private static final PluginCondition EMPTY_CONDITION = new PluginCondition(); - /** - * Constructs ... - * - */ InstalledPluginDescriptor() {} /** - * Constructs ... - * - * - * @param scmVersion - * @param information - * @param resources - * @param condition - * @param childFirstClassLoader - * @param dependencies - * * @deprecated this constructor uses dependencies with plain strings, * which is deprecated because the version information is missing. * This class should not instantiated manually, it is designed to be loaded by jaxb. @@ -96,16 +98,6 @@ public final class InstalledPluginDescriptor extends ScmModule implements Plugin .collect(Collectors.toSet()); } - //~--- methods -------------------------------------------------------------- - - /** - * Method description - * - * - * @param obj - * - * @return - */ @Override public boolean equals(Object obj) { @@ -130,12 +122,7 @@ public final class InstalledPluginDescriptor extends ScmModule implements Plugin && Objects.equal(optionalDependencies, other.optionalDependencies); } - /** - * Method description - * - * - * @return - */ + @Override public int hashCode() { @@ -143,12 +130,7 @@ public final class InstalledPluginDescriptor extends ScmModule implements Plugin childFirstClassLoader, dependencies, optionalDependencies); } - /** - * Method description - * - * - * @return - */ + @Override public String toString() { @@ -165,14 +147,8 @@ public final class InstalledPluginDescriptor extends ScmModule implements Plugin //J+ } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + @Override public PluginCondition getCondition() { @@ -180,11 +156,6 @@ public final class InstalledPluginDescriptor extends ScmModule implements Plugin } /** - * Method description - * - * - * @return - * * @since 2.0.0 */ @Override @@ -194,7 +165,6 @@ public final class InstalledPluginDescriptor extends ScmModule implements Plugin /** * Returns name and versions of the plugins which are this plugin depends on. - * @return dependencies with their versions * @since 2.4.0 */ public Set getDependenciesWithVersion() { @@ -205,11 +175,6 @@ public final class InstalledPluginDescriptor extends ScmModule implements Plugin } /** - * Method description - * - * - * @return - * * @since 2.0.0 */ @Override @@ -219,7 +184,6 @@ public final class InstalledPluginDescriptor extends ScmModule implements Plugin /** * Returns name and versions of the plugins which are this plugin optional depends on. - * @return optional dependencies with their versions * @since 2.4.0 */ public Set getOptionalDependenciesWithVersion() { @@ -239,79 +203,29 @@ public final class InstalledPluginDescriptor extends ScmModule implements Plugin .collect(Collectors.toSet()); } - /** - * Method description - * - * - * @return - */ + @Override public PluginInformation getInformation() { return information; } - /** - * Method description - * - * - * @return - */ + public PluginResources getResources() { return resources; } - /** - * Method description - * - * - * @return - */ + public int getScmVersion() { return scmVersion; } - /** - * Method description - * - * - * @return - */ + public boolean isChildFirstClassLoader() { return childFirstClassLoader; } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - @XmlElement(name = "child-first-classloader") - private boolean childFirstClassLoader; - - /** Field description */ - @XmlElement(name = "conditions") - private PluginCondition condition; - - /** Field description */ - @XmlElement(name = "dependency") - @XmlElementWrapper(name = "dependencies") - private Set dependencies; - - /** Field description */ - @XmlElement(name = "dependency") - @XmlElementWrapper(name = "optional-dependencies") - private Set optionalDependencies; - - /** Field description */ - @XmlElement(name = "information") - private PluginInformation information; - - /** Field description */ - private PluginResources resources; - - /** Field description */ - @XmlElement(name = "scm-version") - private int scmVersion = 1; } diff --git a/scm-core/src/main/java/sonia/scm/plugin/PluginCircularDependencyException.java b/scm-core/src/main/java/sonia/scm/plugin/PluginCircularDependencyException.java index 72fc8b86c5..af40bcfcea 100644 --- a/scm-core/src/main/java/sonia/scm/plugin/PluginCircularDependencyException.java +++ b/scm-core/src/main/java/sonia/scm/plugin/PluginCircularDependencyException.java @@ -26,23 +26,13 @@ package sonia.scm.plugin; /** * - * @author Sebastian Sdorra * @since 2.0.0 */ public class PluginCircularDependencyException extends PluginException { - /** Field description */ private static final long serialVersionUID = -4163410666933840934L; - //~--- constructors --------------------------------------------------------- - - /** - * Constructs ... - * - * - * @param message - */ public PluginCircularDependencyException(String message) { super(message); diff --git a/scm-core/src/main/java/sonia/scm/plugin/PluginCondition.java b/scm-core/src/main/java/sonia/scm/plugin/PluginCondition.java index 6b6d5f609d..352840d62e 100644 --- a/scm-core/src/main/java/sonia/scm/plugin/PluginCondition.java +++ b/scm-core/src/main/java/sonia/scm/plugin/PluginCondition.java @@ -24,7 +24,6 @@ package sonia.scm.plugin; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.MoreObjects; import com.google.common.base.Objects; @@ -44,36 +43,25 @@ import java.util.ArrayList; import java.util.List; import java.util.Locale; -//~--- JDK imports ------------------------------------------------------------ -/** - * - * @author Sebastian Sdorra - */ @XmlRootElement(name = "conditions") @XmlAccessorType(XmlAccessType.FIELD) public class PluginCondition implements Cloneable, Serializable { - /** Field description */ private static final long serialVersionUID = 2406156062634968672L; - //~--- constructors --------------------------------------------------------- + private String arch; + + @XmlElement(name = "min-version") + private String minVersion; + + @XmlElement(name = "name") + @XmlElementWrapper(name = "os") + private List os; - /** - * Constructs ... - * - */ public PluginCondition() {} - /** - * Constructs ... - * - * - * @param minVersion - * @param os - * @param arch - */ public PluginCondition(String minVersion, List os, String arch) { this.minVersion = minVersion; @@ -81,13 +69,8 @@ public class PluginCondition implements Cloneable, Serializable this.arch = arch; } - //~--- methods -------------------------------------------------------------- /** - * Method description - * - * - * @return * @since 1.11 */ @Override @@ -103,14 +86,6 @@ public class PluginCondition implements Cloneable, Serializable return clone; } - /** - * Method description - * - * - * @param obj - * - * @return - */ @Override public boolean equals(Object obj) { @@ -131,24 +106,14 @@ public class PluginCondition implements Cloneable, Serializable && Objects.equal(os, other.os); } - /** - * Method description - * - * - * @return - */ + @Override public int hashCode() { return Objects.hashCode(arch, minVersion, os); } - /** - * Method description - * - * - * @return - */ + @Override public String toString() { @@ -161,63 +126,32 @@ public class PluginCondition implements Cloneable, Serializable //J+ } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + public String getArch() { return arch; } - /** - * Method description - * - * - * @return - */ + public String getMinVersion() { return minVersion; } - /** - * Method description - * - * - * @return - */ + public List getOs() { return os; } - /** - * Method description - * - * - * @return - */ + public boolean isSupported() { return isSupported(SCMContext.getContext().getVersion(), SystemUtil.getOS(), SystemUtil.getArch()); } - /** - * Method description - * - * - * @param version - * @param os - * @param arch - * - * @return - */ public boolean isSupported(String version, String os, String arch) { boolean supported = true; @@ -253,52 +187,23 @@ public class PluginCondition implements Cloneable, Serializable return supported; } - //~--- set methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param arch - */ public void setArch(String arch) { this.arch = arch; } - /** - * Method description - * - * - * @param minVersion - */ public void setMinVersion(String minVersion) { this.minVersion = minVersion; } - /** - * Method description - * - * - * @param os - */ public void setOs(List os) { this.os = os; } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param osType - * @param type - * - * @return - */ private boolean isOs(String osType, PlatformType type) { osType = osType.toLowerCase(Locale.ENGLISH); @@ -315,17 +220,4 @@ public class PluginCondition implements Cloneable, Serializable //J+ } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private String arch; - - /** Field description */ - @XmlElement(name = "min-version") - private String minVersion; - - /** Field description */ - @XmlElement(name = "name") - @XmlElementWrapper(name = "os") - private List os; } diff --git a/scm-core/src/main/java/sonia/scm/plugin/PluginConditionFailedException.java b/scm-core/src/main/java/sonia/scm/plugin/PluginConditionFailedException.java index 9b1b9366d7..6d6077bbc2 100644 --- a/scm-core/src/main/java/sonia/scm/plugin/PluginConditionFailedException.java +++ b/scm-core/src/main/java/sonia/scm/plugin/PluginConditionFailedException.java @@ -26,35 +26,20 @@ package sonia.scm.plugin; /** * - * @author Sebastian Sdorra * @since 1.21 */ public final class PluginConditionFailedException extends PluginException { + private final PluginCondition condition; - /** Field description */ private static final long serialVersionUID = 3257937172323964102L; - //~--- constructors --------------------------------------------------------- - /** - * Constructs ... - * - * - * @param condition - */ public PluginConditionFailedException(PluginCondition condition) { this.condition = condition; } - /** - * Constructs ... - * - * - * @param condition - * @param message - */ public PluginConditionFailedException(PluginCondition condition, String message) { @@ -62,21 +47,8 @@ public final class PluginConditionFailedException extends PluginException this.condition = condition; } - //~--- get methods ---------------------------------------------------------- - - /** - * Method description - * - * - * @return - */ public PluginCondition getCondition() { return condition; } - - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private final PluginCondition condition; } diff --git a/scm-core/src/main/java/sonia/scm/plugin/PluginConstants.java b/scm-core/src/main/java/sonia/scm/plugin/PluginConstants.java index f261b135e4..e32526d75a 100644 --- a/scm-core/src/main/java/sonia/scm/plugin/PluginConstants.java +++ b/scm-core/src/main/java/sonia/scm/plugin/PluginConstants.java @@ -26,7 +26,6 @@ package sonia.scm.plugin; /** * - * @author Sebastian Sdorra * @since 2.0.0 */ public interface PluginConstants @@ -38,12 +37,9 @@ public interface PluginConstants /** core file */ public static final String FILE_CORE = "core"; - /** Field description */ public static final String ID_DELIMITER = ":"; - /** Field description */ public static final String PATH_DESCRIPTOR = "/META-INF/scm/plugin.xml"; - /** Field description */ public static final String FILE_DESCRIPTOR = PATH_DESCRIPTOR.substring(1); } diff --git a/scm-core/src/main/java/sonia/scm/plugin/PluginException.java b/scm-core/src/main/java/sonia/scm/plugin/PluginException.java index 802af2ba0c..6f5e928252 100644 --- a/scm-core/src/main/java/sonia/scm/plugin/PluginException.java +++ b/scm-core/src/main/java/sonia/scm/plugin/PluginException.java @@ -24,56 +24,27 @@ package sonia.scm.plugin; -/** - * - * @author Sebastian Sdorra - */ + public class PluginException extends RuntimeException { - /** Field description */ private static final long serialVersionUID = -5370284100147219134L; - //~--- constructors --------------------------------------------------------- - /** - * Constructs ... - * - */ public PluginException() { super(); } - - /** - * Constructs ... - * - * - * @param message - */ public PluginException(String message) { super(message); } - /** - * Constructs ... - * - * - * @param cause - */ public PluginException(Throwable cause) { super(cause); } - /** - * Constructs ... - * - * - * @param message - * @param cause - */ public PluginException(String message, Throwable cause) { super(message, cause); diff --git a/scm-core/src/main/java/sonia/scm/plugin/PluginLoadException.java b/scm-core/src/main/java/sonia/scm/plugin/PluginLoadException.java index a53be1e6a0..c042d8d1b9 100644 --- a/scm-core/src/main/java/sonia/scm/plugin/PluginLoadException.java +++ b/scm-core/src/main/java/sonia/scm/plugin/PluginLoadException.java @@ -24,56 +24,28 @@ package sonia.scm.plugin; -/** - * - * @author Sebastian Sdorra - */ + public class PluginLoadException extends PluginException { - /** Field description */ private static final long serialVersionUID = -8683647962850692519L; - //~--- constructors --------------------------------------------------------- - /** - * Constructs ... - * - */ public PluginLoadException() { super(); } - /** - * Constructs ... - * - * - * @param message - */ public PluginLoadException(String message) { super(message); } - /** - * Constructs ... - * - * - * @param cause - */ public PluginLoadException(Throwable cause) { super(cause); } - /** - * Constructs ... - * - * - * @param message - * @param cause - */ public PluginLoadException(String message, Throwable cause) { super(message, cause); diff --git a/scm-core/src/main/java/sonia/scm/plugin/PluginLoader.java b/scm-core/src/main/java/sonia/scm/plugin/PluginLoader.java index 5c5ed266d4..134db66b99 100644 --- a/scm-core/src/main/java/sonia/scm/plugin/PluginLoader.java +++ b/scm-core/src/main/java/sonia/scm/plugin/PluginLoader.java @@ -24,41 +24,20 @@ package sonia.scm.plugin; -//~--- non-JDK imports -------------------------------------------------------- - -//~--- JDK imports ------------------------------------------------------------ import java.util.Collection; -/** - * - * @author Sebastian Sdorra - */ + public interface PluginLoader { - /** - * Method description - * - * - * @return - */ + public ExtensionProcessor getExtensionProcessor(); - /** - * Method description - * - * - * @return - */ + public Collection getInstalledModules(); - /** - * Method description - * - * - * @return - */ + public Collection getInstalledPlugins(); /** diff --git a/scm-core/src/main/java/sonia/scm/plugin/PluginManager.java b/scm-core/src/main/java/sonia/scm/plugin/PluginManager.java index 9e27634a2b..13b907bf38 100644 --- a/scm-core/src/main/java/sonia/scm/plugin/PluginManager.java +++ b/scm-core/src/main/java/sonia/scm/plugin/PluginManager.java @@ -35,29 +35,22 @@ import java.util.Set; /** * The plugin manager is responsible for plugin related tasks, such as install, uninstall or updating. * - * @author Sebastian Sdorra */ public interface PluginManager { /** * Returns the available plugin with the given name. - * @param name of plugin - * @return optional available plugin. */ Optional getAvailable(String name); /** * Returns the installed plugin with the given name. - * @param name of plugin - * @return optional installed plugin. */ Optional getInstalled(String name); /** * Returns all installed plugins. - * - * @return a list of installed plugins. */ List getInstalled(); @@ -71,15 +64,11 @@ public interface PluginManager { /** * Returns all available plugins. The list contains the plugins which are loaded from the plugin center, but without * the installed plugins. - * - * @return a list of available plugins. */ List getAvailable(); /** * Returns all available plugin sets from the plugin center. - * - * @return a list of available plugin sets * @since 2.35.0 */ Set getPluginSets(); @@ -95,16 +84,13 @@ public interface PluginManager { /** * Returns all updatable plugins. - * - * @return a list of updatable plugins. */ List getUpdatable(); /** * Returns all pending plugins. * - * @return a list of pending plugins. - * @since 2.38.0 + * @since 2.38.0 */ PendingPlugins getPending(); diff --git a/scm-core/src/main/java/sonia/scm/plugin/PluginNotInstalledException.java b/scm-core/src/main/java/sonia/scm/plugin/PluginNotInstalledException.java index 11d58216a0..5b82612cdb 100644 --- a/scm-core/src/main/java/sonia/scm/plugin/PluginNotInstalledException.java +++ b/scm-core/src/main/java/sonia/scm/plugin/PluginNotInstalledException.java @@ -24,56 +24,28 @@ package sonia.scm.plugin; -/** - * - * @author Sebastian Sdorra - */ + public class PluginNotInstalledException extends PluginException { - /** Field description */ private static final long serialVersionUID = 3990675453445423469L; - //~--- constructors --------------------------------------------------------- - /** - * Constructs ... - * - */ public PluginNotInstalledException() { super(); } - /** - * Constructs ... - * - * - * @param message - */ public PluginNotInstalledException(String message) { super(message); } - /** - * Constructs ... - * - * - * @param cause - */ public PluginNotInstalledException(Throwable cause) { super(cause); } - /** - * Constructs ... - * - * - * @param message - * @param cause - */ public PluginNotInstalledException(String message, Throwable cause) { super(message, cause); diff --git a/scm-core/src/main/java/sonia/scm/plugin/PluginResources.java b/scm-core/src/main/java/sonia/scm/plugin/PluginResources.java index 25a4891ac3..61cf38a156 100644 --- a/scm-core/src/main/java/sonia/scm/plugin/PluginResources.java +++ b/scm-core/src/main/java/sonia/scm/plugin/PluginResources.java @@ -24,7 +24,6 @@ package sonia.scm.plugin; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.MoreObjects; import com.google.common.base.Objects; @@ -34,29 +33,18 @@ import jakarta.xml.bind.annotation.XmlElement; import java.util.Set; -//~--- JDK imports ------------------------------------------------------------ -/** - * - * @author Sebastian Sdorra - */ @XmlAccessorType(XmlAccessType.NONE) public class PluginResources { + @XmlElement(name = "script") + private Set scriptResources; + + @XmlElement(name = "stylesheet") + private Set stylesheetResources; - /** - * Constructs ... - * - */ PluginResources() {} - /** - * Constructs ... - * - * - * @param scriptResources - * @param stylesheetResources - */ public PluginResources(Set scriptResources, Set stylesheetResources) { @@ -64,16 +52,6 @@ public class PluginResources this.stylesheetResources = stylesheetResources; } - //~--- methods -------------------------------------------------------------- - - /** - * Method description - * - * - * @param obj - * - * @return - */ @Override public boolean equals(Object obj) { @@ -93,24 +71,14 @@ public class PluginResources && Objects.equal(stylesheetResources, other.stylesheetResources); } - /** - * Method description - * - * - * @return - */ + @Override public int hashCode() { return Objects.hashCode(scriptResources, stylesheetResources); } - /** - * Method description - * - * - * @return - */ + @Override public String toString() { @@ -122,37 +90,17 @@ public class PluginResources //J+ } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + public Set getScriptResources() { return scriptResources; } - /** - * Method description - * - * - * @return - */ + public Set getStylesheetResources() { return stylesheetResources; } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - @XmlElement(name = "script") - private Set scriptResources; - - /** Field description */ - @XmlElement(name = "stylesheet") - private Set stylesheetResources; } diff --git a/scm-core/src/main/java/sonia/scm/plugin/Plugins.java b/scm-core/src/main/java/sonia/scm/plugin/Plugins.java index 25c6a7123d..82943c797e 100644 --- a/scm-core/src/main/java/sonia/scm/plugin/Plugins.java +++ b/scm-core/src/main/java/sonia/scm/plugin/Plugins.java @@ -24,7 +24,6 @@ package sonia.scm.plugin; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Preconditions; import com.google.common.io.ByteSource; @@ -39,17 +38,13 @@ import java.nio.file.Path; /** * Util methods to handle plugins. * - * @author Sebastian Sdorra * @since 2.0.0 */ public final class Plugins { - /** Field description */ private static JAXBContext context; - //~--- static initializers -------------------------------------------------- - static { try @@ -62,37 +57,15 @@ public final class Plugins } } - //~--- constructors --------------------------------------------------------- - /** - * Constructs ... - * - */ private Plugins() {} - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param path - * - * @return - */ public static InstalledPluginDescriptor parsePluginDescriptor(Path path) { return parsePluginDescriptor(Files.asByteSource(path.toFile())); } - /** - * Method description - * - * - * @param data - * - * @return - */ public static InstalledPluginDescriptor parsePluginDescriptor(ByteSource data) { Preconditions.checkNotNull(data, "data parameter is required"); diff --git a/scm-core/src/main/java/sonia/scm/plugin/ScmModule.java b/scm-core/src/main/java/sonia/scm/plugin/ScmModule.java index fba7993c81..715efe5223 100644 --- a/scm-core/src/main/java/sonia/scm/plugin/ScmModule.java +++ b/scm-core/src/main/java/sonia/scm/plugin/ScmModule.java @@ -34,7 +34,6 @@ import sonia.scm.config.ConfigElement; import java.util.Set; /** - * @author Sebastian Sdorra * @since 2.0.0 */ @XmlRootElement(name = "module") diff --git a/scm-core/src/main/java/sonia/scm/plugin/SmpArchive.java b/scm-core/src/main/java/sonia/scm/plugin/SmpArchive.java index 9620cbe156..d9c8cd8fb1 100644 --- a/scm-core/src/main/java/sonia/scm/plugin/SmpArchive.java +++ b/scm-core/src/main/java/sonia/scm/plugin/SmpArchive.java @@ -24,7 +24,6 @@ package sonia.scm.plugin; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.annotations.VisibleForTesting; import com.google.common.base.Strings; @@ -45,12 +44,9 @@ import java.nio.file.Path; import java.util.zip.ZipEntry; import java.util.zip.ZipInputStream; -//~--- JDK imports ------------------------------------------------------------ - /** * Smp plugin archive. * - * @author Sebastian Sdorra * @since 2.0.0 */ public final class SmpArchive { @@ -59,11 +55,6 @@ public final class SmpArchive { private final ZipInputStreamFactory zipInputStreamFactory; private InstalledPluginDescriptor plugin; - /** - * Constructs ... - * - * @param archive - */ public SmpArchive(ByteSource archive) { this(archive, source -> new ZipInputStream(archive.openStream(), StandardCharsets.UTF_8)); } @@ -74,56 +65,22 @@ public final class SmpArchive { this.zipInputStreamFactory = zipInputStreamFactory; } - //~--- methods -------------------------------------------------------------- - - /** - * Method description - * - * @param archive - * @return - */ public static SmpArchive create(ByteSource archive) { return new SmpArchive(archive); } - /** - * Method description - * - * @param archive - * @return - */ public static SmpArchive create(URL archive) { return create(Resources.asByteSource(archive)); } - /** - * Method description - * - * @param archive - * @return - */ public static SmpArchive create(Path archive) { return create(archive.toFile()); } - /** - * Method description - * - * @param archive - * @return - */ public static SmpArchive create(File archive) { return create(Files.asByteSource(archive)); } - //~--- get methods ---------------------------------------------------------- - - /** - * Method description - * - * @param entry - * @return - */ private static String getPath(ZipEntry entry) { String path = entry.getName().replace("\\", "/"); @@ -134,14 +91,6 @@ public final class SmpArchive { return path; } - //~--- methods -------------------------------------------------------------- - - /** - * Method description - * - * @param target - * @throws IOException - */ public void extract(File target) throws IOException { try (ZipInputStream zis = open()) { ZipEntry ze = zis.getNextEntry(); @@ -171,14 +120,6 @@ public final class SmpArchive { } } - //~--- get methods ---------------------------------------------------------- - - /** - * Method description - * - * @return - * @throws IOException - */ public InstalledPluginDescriptor getPlugin() throws IOException { if (plugin == null) { plugin = createPlugin(); @@ -203,14 +144,6 @@ public final class SmpArchive { return plugin; } - //~--- methods -------------------------------------------------------------- - - /** - * Method description - * - * @return - * @throws IOException - */ private InstalledPluginDescriptor createPlugin() throws IOException { InstalledPluginDescriptor p = null; NonClosingZipInputStream zis = null; @@ -242,103 +175,40 @@ public final class SmpArchive { return p; } - /** - * Method description - * - * @return - * @throws IOException - */ private ZipInputStream open() throws IOException { return zipInputStreamFactory.open(archive); } - /** - * Method description - * - * @return - * @throws IOException - */ private NonClosingZipInputStream openNonClosing() throws IOException { return new NonClosingZipInputStream(archive.openStream(), StandardCharsets.UTF_8); } - //~--- inner classes -------------------------------------------------------- - /** - * Class description - * - * @author Enter your name here... - * @version Enter version here..., 14/07/13 - */ private static class InputStreamByteSource extends ByteSource { + private final InputStream input; - /** - * Constructs ... - * - * @param input - */ public InputStreamByteSource(InputStream input) { this.input = input; } - //~--- methods ------------------------------------------------------------ - - /** - * Method description - * - * @return - * @throws IOException - */ @Override public InputStream openStream() throws IOException { return input; } - - //~--- fields ------------------------------------------------------------- - - /** - * Field description - */ - private final InputStream input; } - - /** - * Class description - * - * @author Enter your name here... - * @version Enter version here..., 14/07/12 - */ private static class NonClosingZipInputStream extends ZipInputStream { - /** - * Constructs ... - * - * @param in - * @param charset - */ public NonClosingZipInputStream(InputStream in, Charset charset) { super(in, charset); } - //~--- methods ------------------------------------------------------------ - - /** - * Method description - * - * @throws IOException - */ @Override public void close() throws IOException { // do nothing } - /** - * Method description - * - * @throws IOException - */ public void reallyClose() throws IOException { super.close(); } diff --git a/scm-core/src/main/java/sonia/scm/plugin/SubscriberElement.java b/scm-core/src/main/java/sonia/scm/plugin/SubscriberElement.java index 1d6bcd73e0..5ecce6143b 100644 --- a/scm-core/src/main/java/sonia/scm/plugin/SubscriberElement.java +++ b/scm-core/src/main/java/sonia/scm/plugin/SubscriberElement.java @@ -24,7 +24,6 @@ package sonia.scm.plugin; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.MoreObjects; import com.google.common.base.Objects; @@ -33,32 +32,24 @@ import jakarta.xml.bind.annotation.XmlAccessorType; import jakarta.xml.bind.annotation.XmlElement; import jakarta.xml.bind.annotation.XmlRootElement; -//~--- JDK imports ------------------------------------------------------------ - /** * - * @author Sebastian Sdorra * @since 2.0.0 */ @XmlRootElement(name = "subscriber") @XmlAccessorType(XmlAccessType.FIELD) public final class SubscriberElement { + private String description; + + @XmlElement(name = "event") + private Class eventClass; + + @XmlElement(name = "class") + private Class subscriberClass; - /** - * Constructs ... - * - */ SubscriberElement() {} - /** - * Constructs ... - * - * - * @param subscriberClass - * @param eventClass - * @param description - */ public SubscriberElement(Class subscriberClass, Class eventClass, String description) { @@ -67,16 +58,6 @@ public final class SubscriberElement this.description = description; } - //~--- methods -------------------------------------------------------------- - - /** - * Method description - * - * - * @param obj - * - * @return - */ @Override public boolean equals(Object obj) { @@ -97,24 +78,14 @@ public final class SubscriberElement && Objects.equal(description, other.description); } - /** - * Method description - * - * - * @return - */ + @Override public int hashCode() { return Objects.hashCode(eventClass, subscriberClass, description); } - /** - * Method description - * - * - * @return - */ + @Override public String toString() { @@ -127,51 +98,23 @@ public final class SubscriberElement //J+ } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + public String getDescription() { return description; } - /** - * Method description - * - * - * @return - */ + public Class getEventClass() { return eventClass; } - /** - * Method description - * - * - * @return - */ + public Class getSubscriberClass() { return subscriberClass; } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private String description; - - /** Field description */ - @XmlElement(name = "event") - private Class eventClass; - - /** Field description */ - @XmlElement(name = "class") - private Class subscriberClass; } diff --git a/scm-core/src/main/java/sonia/scm/plugin/UberWebResourceLoader.java b/scm-core/src/main/java/sonia/scm/plugin/UberWebResourceLoader.java index 8ff0589669..6b9dc86d3b 100644 --- a/scm-core/src/main/java/sonia/scm/plugin/UberWebResourceLoader.java +++ b/scm-core/src/main/java/sonia/scm/plugin/UberWebResourceLoader.java @@ -24,8 +24,6 @@ package sonia.scm.plugin; -//~--- JDK imports ------------------------------------------------------------ - import jakarta.servlet.ServletContext; import java.net.URL; @@ -36,7 +34,6 @@ import java.util.List; * The UberWebResourceLoader will first look into the {@link ServletContext} and * afterwards it will search the plugin directories. * - * @author Sebastian Sdorra * @since 2.0.0 */ public interface UberWebResourceLoader extends WebResourceLoader diff --git a/scm-core/src/main/java/sonia/scm/plugin/WebElementDescriptor.java b/scm-core/src/main/java/sonia/scm/plugin/WebElementDescriptor.java index 913c3e9697..c24ffa7d71 100644 --- a/scm-core/src/main/java/sonia/scm/plugin/WebElementDescriptor.java +++ b/scm-core/src/main/java/sonia/scm/plugin/WebElementDescriptor.java @@ -24,7 +24,6 @@ package sonia.scm.plugin; -//~--- non-JDK imports -------------------------------------------------------- import jakarta.xml.bind.annotation.XmlAccessType; import jakarta.xml.bind.annotation.XmlAccessorType; @@ -45,7 +44,6 @@ import java.util.Arrays; * Descriptor for web elements such as filter or servlets. A web element can be registered by using the * {@link sonia.scm.filter.WebElement} annotation. * - * @author Sebastian Sdorra * @since 2.0.0 */ @Getter diff --git a/scm-core/src/main/java/sonia/scm/plugin/WebResourceLoader.java b/scm-core/src/main/java/sonia/scm/plugin/WebResourceLoader.java index a84deecb76..d24720739f 100644 --- a/scm-core/src/main/java/sonia/scm/plugin/WebResourceLoader.java +++ b/scm-core/src/main/java/sonia/scm/plugin/WebResourceLoader.java @@ -24,8 +24,6 @@ package sonia.scm.plugin; -//~--- JDK imports ------------------------------------------------------------ - import jakarta.servlet.ServletContext; import java.net.URL; @@ -36,7 +34,6 @@ import java.net.URL; * to its implementation. The {@link UberWebResourceLoader} is able to load * resources from the {@link ServletContext} and all plugin directories. * - * @author Sebastian Sdorra * @since 2.0.0 */ public interface WebResourceLoader diff --git a/scm-core/src/main/java/sonia/scm/repository/AbstactImportHandler.java b/scm-core/src/main/java/sonia/scm/repository/AbstactImportHandler.java index d6d4b6f127..f949512d29 100644 --- a/scm-core/src/main/java/sonia/scm/repository/AbstactImportHandler.java +++ b/scm-core/src/main/java/sonia/scm/repository/AbstactImportHandler.java @@ -24,7 +24,6 @@ package sonia.scm.repository; -//~--- non-JDK imports -------------------------------------------------------- import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -34,13 +33,10 @@ import java.io.File; import java.io.IOException; import java.util.List; -//~--- JDK imports ------------------------------------------------------------ - /** * Abstract base class for directory based {@link ImportHandler} and * {@link AdvancedImportHandler}. * - * @author Sebastian Sdorra * @since 1.12 * @deprecated */ @@ -48,60 +44,29 @@ import java.util.List; public abstract class AbstactImportHandler implements AdvancedImportHandler { - /** - * the logger for AbstactImportHandler - */ + private static final Logger logger = LoggerFactory.getLogger(AbstactImportHandler.class); - //~--- get methods ---------------------------------------------------------- - /** - * Returns array of repository directory names. - * - * - * @return repository directory names - */ protected abstract String[] getDirectoryNames(); - /** - * Returns repository handler. - * - * - * @return repository handler - */ protected abstract AbstractRepositoryHandler getRepositoryHandler(); - //~--- methods -------------------------------------------------------------- - /** - * {@inheritDoc} - */ + @Override public List importRepositories(RepositoryManager manager) throws IOException { return doRepositoryImport(manager, true).getImportedDirectories(); } - /** - * {@inheritDoc} - */ + @Override public ImportResult importRepositoriesFromDirectory(RepositoryManager manager) { return doRepositoryImport(manager, false); } - /** - * Creates a repository. - * - * - * @param repositoryDirectory repository base directory - * @param repositoryName name of the repository - * - * @return repository - * - * @throws IOException - */ protected Repository createRepository(File repositoryDirectory, String repositoryName) throws IOException { Repository repository = new Repository(); @@ -149,16 +114,6 @@ public abstract class AbstactImportHandler implements AdvancedImportHandler return builder.build(); } - /** - * Method description - * - * - * @param ex - * @param throwExceptions - * @param - * - * @throws T - */ private void handleException(T ex, boolean throwExceptions) throws T @@ -171,17 +126,6 @@ public abstract class AbstactImportHandler implements AdvancedImportHandler } } - /** - * Method description - * - * - * @param manager - * @param builder - * @param throwExceptions - * @param directoryName - * - * @throws IOException - */ private void importRepository(RepositoryManager manager, Builder builder, boolean throwExceptions, String directoryName) throws IOException @@ -223,14 +167,8 @@ public abstract class AbstactImportHandler implements AdvancedImportHandler - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + private String getTypeName() { return getRepositoryHandler().getType().getName(); diff --git a/scm-core/src/main/java/sonia/scm/repository/AbstractRepositoryHandler.java b/scm-core/src/main/java/sonia/scm/repository/AbstractRepositoryHandler.java index d047ebb58a..3cefd82442 100644 --- a/scm-core/src/main/java/sonia/scm/repository/AbstractRepositoryHandler.java +++ b/scm-core/src/main/java/sonia/scm/repository/AbstractRepositoryHandler.java @@ -24,7 +24,6 @@ package sonia.scm.repository; -//~--- non-JDK imports -------------------------------------------------------- import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -33,36 +32,25 @@ import sonia.scm.FeatureNotSupportedException; import sonia.scm.SCMContextProvider; import sonia.scm.event.ScmEventBus; -//~--- JDK imports ------------------------------------------------------------ - import java.io.File; import java.io.IOException; import sonia.scm.store.ConfigurationStore; import sonia.scm.store.ConfigurationStoreFactory; - -/** - * - * @author Sebastian Sdorra - * - * @param - */ public abstract class AbstractRepositoryHandler implements RepositoryHandler { - /** the logger for AbstractRepositoryHandler */ + private static final Logger logger = LoggerFactory.getLogger(AbstractRepositoryHandler.class); - //~--- constructors --------------------------------------------------------- + protected File baseDirectory; - /** - * Constructs ... - * - * - * @param storeFactory - */ + protected C config; + + protected ConfigurationStore store; + protected AbstractRepositoryHandler(ConfigurationStoreFactory storeFactory) { this.store = storeFactory .withType(getConfigClass()) @@ -70,24 +58,11 @@ public abstract class AbstractRepositoryHandler .build(); } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + protected abstract Class getConfigClass(); - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @throws IOException - */ @Override public void close() throws IOException { @@ -95,12 +70,7 @@ public abstract class AbstractRepositoryHandler // do nothing } - /** - * Method description - * - * - * @param context - */ + @Override public void init(SCMContextProvider context) { @@ -108,11 +78,7 @@ public abstract class AbstractRepositoryHandler loadConfig(); } - /** - * Method description - * - */ - public void loadConfig() + public void loadConfig() { if (logger.isDebugEnabled()) { @@ -122,11 +88,7 @@ public abstract class AbstractRepositoryHandler config = store.get(); } - /** - * Method description - * - */ - public void storeConfig() + public void storeConfig() { if (config != null) { @@ -139,27 +101,14 @@ public abstract class AbstractRepositoryHandler } } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + public C getConfig() { return config; } - /** - * Method description - * - * - * @return - * - * @throws FeatureNotSupportedException - */ + @Override public ImportHandler getImportHandler() { @@ -168,9 +117,6 @@ public abstract class AbstractRepositoryHandler /** * Returns true if the plugin is configured and enabled. - * - * - * @return true if the plugin is configured and enabled */ @Override public boolean isConfigured() @@ -178,40 +124,19 @@ public abstract class AbstractRepositoryHandler return (config != null) && config.isValid() &&!config.isDisabled(); } - //~--- set methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param config - */ + public void setConfig(C config) { this.config = config; fireConfigChanged(); } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - */ - private void fireConfigChanged() + private void fireConfigChanged() { ScmEventBus.getInstance().post( new RepositoryHandlerConfigChangedEvent(config)); } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - protected File baseDirectory; - - /** Field description */ - protected C config; - - /** Field description */ - protected ConfigurationStore store; } diff --git a/scm-core/src/main/java/sonia/scm/repository/AbstractRepositoryManager.java b/scm-core/src/main/java/sonia/scm/repository/AbstractRepositoryManager.java index 96b60cfd82..c13faf274c 100644 --- a/scm-core/src/main/java/sonia/scm/repository/AbstractRepositoryManager.java +++ b/scm-core/src/main/java/sonia/scm/repository/AbstractRepositoryManager.java @@ -24,7 +24,6 @@ package sonia.scm.repository; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.HandlerEventType; import sonia.scm.event.ScmEventBus; @@ -35,7 +34,6 @@ import sonia.scm.util.AssertUtil; * implements the listener and hook methods of the {@link RepositoryManager} * interface. * - * @author Sebastian Sdorra */ public abstract class AbstractRepositoryManager implements RepositoryManager { @@ -84,7 +82,6 @@ public abstract class AbstractRepositoryManager implements RepositoryManager { * Prepare a hook event before it is fired to the event system of SCM-Manager. * * @param event hook event - * @return * @since 1.26 */ protected RepositoryHookEvent prepareHookEvent(RepositoryHookEvent event) { diff --git a/scm-core/src/main/java/sonia/scm/repository/AbstractSimpleRepositoryHandler.java b/scm-core/src/main/java/sonia/scm/repository/AbstractSimpleRepositoryHandler.java index 4cfcdc8215..9153f42d9c 100644 --- a/scm-core/src/main/java/sonia/scm/repository/AbstractSimpleRepositoryHandler.java +++ b/scm-core/src/main/java/sonia/scm/repository/AbstractSimpleRepositoryHandler.java @@ -24,7 +24,6 @@ package sonia.scm.repository; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Charsets; import com.google.common.io.Resources; @@ -41,20 +40,12 @@ import java.io.IOException; import java.net.URL; import java.nio.file.Path; -//~--- JDK imports ------------------------------------------------------------ - -/** - * @param - * @author Sebastian Sdorra - */ public abstract class AbstractSimpleRepositoryHandler extends AbstractRepositoryHandler implements RepositoryDirectoryHandler { public static final String DEFAULT_VERSION_INFORMATION = "unknown"; - /** - * the logger for AbstractSimpleRepositoryHandler - */ + private static final Logger logger = LoggerFactory.getLogger(AbstractSimpleRepositoryHandler.class); diff --git a/scm-core/src/main/java/sonia/scm/repository/AdvancedImportHandler.java b/scm-core/src/main/java/sonia/scm/repository/AdvancedImportHandler.java index 80c5840cb2..8820eff41c 100644 --- a/scm-core/src/main/java/sonia/scm/repository/AdvancedImportHandler.java +++ b/scm-core/src/main/java/sonia/scm/repository/AdvancedImportHandler.java @@ -29,7 +29,6 @@ package sonia.scm.repository; * gives more control over the result of the import as the * {@link ImportHandler}. * - * @author Sebastian Sdorra * @since 1.43 * @deprecated */ diff --git a/scm-core/src/main/java/sonia/scm/repository/BlameLine.java b/scm-core/src/main/java/sonia/scm/repository/BlameLine.java index b571658586..4aa38da50b 100644 --- a/scm-core/src/main/java/sonia/scm/repository/BlameLine.java +++ b/scm-core/src/main/java/sonia/scm/repository/BlameLine.java @@ -24,47 +24,36 @@ package sonia.scm.repository; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.MoreObjects; import com.google.common.base.Objects; import java.io.Serializable; -//~--- JDK imports ------------------------------------------------------------ - /** * Single line of a file, in a {@link BlameResult}. * - * @author Sebastian Sdorra * @since 1.8 */ public class BlameLine implements Serializable { - /** Field description */ private static final long serialVersionUID = 2816601606921153670L; - //~--- constructors --------------------------------------------------------- + private Person author; + + private String code; + + private String description; + + private int lineNumber; + + private String revision; + + private Long when; - /** - * Constructs ... - * - */ public BlameLine() {} - /** - * Constructs ... - * - * - * - * @param author - * @param when - * @param revision - * @param description - * @param code - * @param lineNumber - */ public BlameLine(int lineNumber, String revision, Long when, Person author, String description, String code) { @@ -76,16 +65,7 @@ public class BlameLine implements Serializable this.code = code; } - //~--- methods -------------------------------------------------------------- - /** - * {@inheritDoc} - * - * - * @param obj - * - * @return - */ @Override public boolean equals(Object obj) { @@ -109,12 +89,6 @@ public class BlameLine implements Serializable && Objects.equal(description, other.description); } - /** - * {@inheritDoc} - * - * - * @return - */ @Override public int hashCode() { @@ -122,12 +96,6 @@ public class BlameLine implements Serializable description); } - /** - * {@inheritDoc} - * - * - * @return - */ @Override public String toString() { @@ -143,159 +111,78 @@ public class BlameLine implements Serializable //J+ } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + public Person getAuthor() { return author; } - /** - * Method description - * - * - * @return - */ + public String getCode() { return code; } - /** - * Method description - * - * - * @return - */ + public String getDescription() { return description; } - /** - * Method description - * - * - * @return - */ + public int getLineNumber() { return lineNumber; } - /** - * Method description - * - * - * @return - */ + public String getRevision() { return revision; } - /** - * Method description - * - * - * @return - */ + public Long getWhen() { return when; } - //~--- set methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param author - */ + public void setAuthor(Person author) { this.author = author; } - /** - * Method description - * - * - * @param code - */ + public void setCode(String code) { this.code = code; } - /** - * Method description - * - * - * @param description - */ + public void setDescription(String description) { this.description = description; } - /** - * Method description - * - * - * @param lineNumber - */ + public void setLineNumber(int lineNumber) { this.lineNumber = lineNumber; } - /** - * Method description - * - * - * @param revision - */ + public void setRevision(String revision) { this.revision = revision; } - /** - * Method description - * - * - * @param when - */ + public void setWhen(Long when) { this.when = when; } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private Person author; - - /** Field description */ - private String code; - - /** Field description */ - private String description; - - /** Field description */ - private int lineNumber; - - /** Field description */ - private String revision; - - /** Field description */ - private Long when; } diff --git a/scm-core/src/main/java/sonia/scm/repository/BlameLinePreProcessor.java b/scm-core/src/main/java/sonia/scm/repository/BlameLinePreProcessor.java index 176c502623..2b851ce914 100644 --- a/scm-core/src/main/java/sonia/scm/repository/BlameLinePreProcessor.java +++ b/scm-core/src/main/java/sonia/scm/repository/BlameLinePreProcessor.java @@ -24,7 +24,6 @@ package sonia.scm.repository; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.plugin.ExtensionPoint; @@ -32,19 +31,11 @@ import sonia.scm.plugin.ExtensionPoint; * A pre processor for {@link BlameLine} objects. A pre processor is able to * modify the object before it is delivered to the user interface. * - * @author Sebastian Sdorra * @since 1.17 */ @ExtensionPoint public interface BlameLinePreProcessor extends PreProcessor { - - /** - * Process the given blame line. - * - * - * @param blameLine blame line to process. - */ @Override public void process(BlameLine blameLine); } diff --git a/scm-core/src/main/java/sonia/scm/repository/BlameLinePreProcessorFactory.java b/scm-core/src/main/java/sonia/scm/repository/BlameLinePreProcessorFactory.java index 42b2cf6054..7f056f32b5 100644 --- a/scm-core/src/main/java/sonia/scm/repository/BlameLinePreProcessorFactory.java +++ b/scm-core/src/main/java/sonia/scm/repository/BlameLinePreProcessorFactory.java @@ -24,7 +24,6 @@ package sonia.scm.repository; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.plugin.ExtensionPoint; @@ -32,7 +31,6 @@ import sonia.scm.plugin.ExtensionPoint; * The BlameLinePreProcessorFactory create {@link BlameLinePreProcessor} * objects for a specific repository. * - * @author Sebastian Sdorra * @since 1.17 */ @ExtensionPoint diff --git a/scm-core/src/main/java/sonia/scm/repository/BlameResult.java b/scm-core/src/main/java/sonia/scm/repository/BlameResult.java index 8a997041f6..8867dcf4a4 100644 --- a/scm-core/src/main/java/sonia/scm/repository/BlameResult.java +++ b/scm-core/src/main/java/sonia/scm/repository/BlameResult.java @@ -35,7 +35,6 @@ import java.util.List; /** * Changeset information by line for a given file. * - * @author Sebastian Sdorra * @since 1.8 */ @EqualsAndHashCode diff --git a/scm-core/src/main/java/sonia/scm/repository/Branch.java b/scm-core/src/main/java/sonia/scm/repository/Branch.java index 1961580469..196e2bdf09 100644 --- a/scm-core/src/main/java/sonia/scm/repository/Branch.java +++ b/scm-core/src/main/java/sonia/scm/repository/Branch.java @@ -38,7 +38,6 @@ import java.util.regex.Pattern; /** * Represents a branch in a repository. * - * @author Sebastian Sdorra * @since 1.18 */ @XmlRootElement(name = "branch") diff --git a/scm-core/src/main/java/sonia/scm/repository/Branches.java b/scm-core/src/main/java/sonia/scm/repository/Branches.java index ed4ead7dc2..2a0cd164ba 100644 --- a/scm-core/src/main/java/sonia/scm/repository/Branches.java +++ b/scm-core/src/main/java/sonia/scm/repository/Branches.java @@ -35,7 +35,6 @@ import java.util.List; /** * Represents all branches of a repository. * - * @author Sebastian Sdorra * @since 1.18 */ @EqualsAndHashCode diff --git a/scm-core/src/main/java/sonia/scm/repository/CacheClearHook.java b/scm-core/src/main/java/sonia/scm/repository/CacheClearHook.java index b424f54867..c6d8337933 100644 --- a/scm-core/src/main/java/sonia/scm/repository/CacheClearHook.java +++ b/scm-core/src/main/java/sonia/scm/repository/CacheClearHook.java @@ -24,7 +24,6 @@ package sonia.scm.repository; -//~--- non-JDK imports -------------------------------------------------------- import com.github.legman.Subscribe; @@ -37,23 +36,17 @@ import sonia.scm.cache.Cache; /** * - * @author Sebastian Sdorra * @since 1.6 */ public class CacheClearHook { - - /** the logger for CacheClearHook */ private static final Logger logger = LoggerFactory.getLogger(CacheClearHook.class); - //~--- methods -------------------------------------------------------------- + private Cache cache; /** - * Method description - * * @since 1.7 - * */ public void clearCache() { @@ -61,11 +54,7 @@ public class CacheClearHook } /** - * Method description - * * @since 1.9 - * - * @param predicate */ @SuppressWarnings("unchecked") public void clearCache(Predicate predicate) @@ -90,12 +79,7 @@ public class CacheClearHook } } - /** - * Method description - * - * - * @param event - */ + @Subscribe public void onEvent(PostReceiveRepositoryHookEvent event) { @@ -109,32 +93,17 @@ public class CacheClearHook } /** - * Method description - * * @since 1.9 - * - * - * @param event - * @return */ protected Predicate createPredicate(RepositoryHookEvent event) { return null; } - /** - * Method description - * - * - * @param cache - */ + protected void init(Cache cache) { this.cache = cache; } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private Cache cache; } diff --git a/scm-core/src/main/java/sonia/scm/repository/Changeset.java b/scm-core/src/main/java/sonia/scm/repository/Changeset.java index 6fecf507ce..6fe8d1941a 100644 --- a/scm-core/src/main/java/sonia/scm/repository/Changeset.java +++ b/scm-core/src/main/java/sonia/scm/repository/Changeset.java @@ -39,16 +39,12 @@ import java.util.List; /** * Represents a changeset/commit of a repository. * - * @author Sebastian Sdorra */ @EqualsAndHashCode(callSuper = true) public class Changeset extends BasicPropertiesAware implements ModelObject { private static final long serialVersionUID = -8373308448928993039L; - /** - * The author of the changeset - */ private Person author; /** @@ -61,14 +57,8 @@ public class Changeset extends BasicPropertiesAware implements ModelObject { */ private Long date; - /** - * The text of the changeset description - */ private String description; - /** - * The changeset identification string - */ private String id; /** @@ -127,8 +117,6 @@ public class Changeset extends BasicPropertiesAware implements ModelObject { /** * Returns a timestamp of the creation date of the {@link Changeset}. - * - * @return a timestamp of the creation date of the {@link Changeset} */ public Long getCreationDate() { return getDate(); @@ -141,8 +129,6 @@ public class Changeset extends BasicPropertiesAware implements ModelObject { /** * Returns the author of the changeset. - * - * @return author of the changeset */ public Person getAuthor() { return author; @@ -165,8 +151,6 @@ public class Changeset extends BasicPropertiesAware implements ModelObject { /** * Returns the creation date of the changeset. - * - * @return date of the changeset */ public Long getDate() { return date; @@ -174,8 +158,6 @@ public class Changeset extends BasicPropertiesAware implements ModelObject { /** * Return the description (commit message) of the changeset. - * - * @return description of the changeset */ public String getDescription() { return description; @@ -183,8 +165,6 @@ public class Changeset extends BasicPropertiesAware implements ModelObject { /** * Returns the id of the changeset. - * - * @return id of the changeset */ @Override public String getId() { @@ -259,8 +239,6 @@ public class Changeset extends BasicPropertiesAware implements ModelObject { /** * Sets the author of the changeset. - * - * @param author author of the changeset */ public void setAuthor(Person author) { this.author = author; @@ -268,8 +246,6 @@ public class Changeset extends BasicPropertiesAware implements ModelObject { /** * Sets the branches of the changeset. - * - * @param branches branches of the changeset */ public void setBranches(List branches) { this.branches = branches; @@ -277,8 +253,6 @@ public class Changeset extends BasicPropertiesAware implements ModelObject { /** * Sets the date of the changeset. - * - * @param date date of the changeset */ public void setDate(Long date) { this.date = date; @@ -286,8 +260,6 @@ public class Changeset extends BasicPropertiesAware implements ModelObject { /** * Sets the description (commit message) of the changeset. - * - * @param description description of the changeset */ public void setDescription(String description) { this.description = description; @@ -295,8 +267,6 @@ public class Changeset extends BasicPropertiesAware implements ModelObject { /** * Sets the id of the changeset. - * - * @param id id of the changeset */ public void setId(String id) { this.id = id; @@ -314,8 +284,6 @@ public class Changeset extends BasicPropertiesAware implements ModelObject { /** * Sets the tags of the changeset - * - * @param tags tags of the changeset */ public void setTags(List tags) { this.tags = tags; @@ -323,7 +291,7 @@ public class Changeset extends BasicPropertiesAware implements ModelObject { /** * Sets the collection of contributors. - * @param contributors collection of contributors + * * @since 2.1.0 */ public void setContributors(Collection contributors) { @@ -332,7 +300,7 @@ public class Changeset extends BasicPropertiesAware implements ModelObject { /** * Adds a contributor to the list of contributors. - * @param contributor contributor to add + * * @since 2.1.0 */ public void addContributor(Contributor contributor) { @@ -344,7 +312,7 @@ public class Changeset extends BasicPropertiesAware implements ModelObject { /** * Adds all contributors from the given collection to the list of contributors. - * @param contributors collection of contributor + * * @since 2.1.0 */ public void addContributors(Collection contributors) { diff --git a/scm-core/src/main/java/sonia/scm/repository/ChangesetPagingResult.java b/scm-core/src/main/java/sonia/scm/repository/ChangesetPagingResult.java index ca74b7dacf..de5b911f23 100644 --- a/scm-core/src/main/java/sonia/scm/repository/ChangesetPagingResult.java +++ b/scm-core/src/main/java/sonia/scm/repository/ChangesetPagingResult.java @@ -35,7 +35,6 @@ import java.util.List; * The changeset paging result is used to do a paging over the * {@link Changeset}s of a {@link Repository}. * - * @author Sebastian Sdorra */ @EqualsAndHashCode @ToString @@ -75,7 +74,6 @@ public class ChangesetPagingResult implements Iterable, Serializable /** * Returns an iterator which can iterate over the current list of changesets. * - * @return iterator for current list of changesets * @since 1.8 */ @Override @@ -91,8 +89,6 @@ public class ChangesetPagingResult implements Iterable, Serializable /** * Returns the current list of changesets. - * - * @return current list of changesets */ public List getChangesets() { return changesets; @@ -100,8 +96,6 @@ public class ChangesetPagingResult implements Iterable, Serializable /** * Returns the total number of changesets. - * - * @return total number of changesets */ public int getTotal() { return total; diff --git a/scm-core/src/main/java/sonia/scm/repository/ChangesetPreProcessor.java b/scm-core/src/main/java/sonia/scm/repository/ChangesetPreProcessor.java index c62b8dc06d..e8facc1d9d 100644 --- a/scm-core/src/main/java/sonia/scm/repository/ChangesetPreProcessor.java +++ b/scm-core/src/main/java/sonia/scm/repository/ChangesetPreProcessor.java @@ -21,18 +21,16 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ - + package sonia.scm.repository; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.plugin.ExtensionPoint; /** - * A pre processor for {@link Changeset} objects. A pre processor is able to + * A pre processor for {@link Changeset} objects. A pre processor is able to * modify the object before it is delivered to the user interface. - * - * @author Sebastian Sdorra + * */ @ExtensionPoint public interface ChangesetPreProcessor extends PreProcessor @@ -40,9 +38,6 @@ public interface ChangesetPreProcessor extends PreProcessor /** * Process the given changeset. - * - * - * @param changeset changeset to process */ @Override public void process(Changeset changeset); diff --git a/scm-core/src/main/java/sonia/scm/repository/ChangesetPreProcessorFactory.java b/scm-core/src/main/java/sonia/scm/repository/ChangesetPreProcessorFactory.java index 5075c662ca..284df64370 100644 --- a/scm-core/src/main/java/sonia/scm/repository/ChangesetPreProcessorFactory.java +++ b/scm-core/src/main/java/sonia/scm/repository/ChangesetPreProcessorFactory.java @@ -21,10 +21,9 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ - + package sonia.scm.repository; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.plugin.ExtensionPoint; @@ -32,7 +31,6 @@ import sonia.scm.plugin.ExtensionPoint; * The ChangesetPreProcessorFactory create {@link ChangesetPreProcessor} * objects for a specific repository. * - * @author Sebastian Sdorra * @since 1.7 */ @ExtensionPoint @@ -42,12 +40,7 @@ public interface ChangesetPreProcessorFactory /** * Create a new {@link ChangesetPreProcessor} for the given repository. - * - * - * @param repository repository - * - * @return {@link ChangesetPreProcessor} for the given repository */ @Override - public ChangesetPreProcessor createPreProcessor(Repository repository); + ChangesetPreProcessor createPreProcessor(Repository repository); } diff --git a/scm-core/src/main/java/sonia/scm/repository/ClearRepositoryCacheEvent.java b/scm-core/src/main/java/sonia/scm/repository/ClearRepositoryCacheEvent.java index 447db3145e..7011832248 100644 --- a/scm-core/src/main/java/sonia/scm/repository/ClearRepositoryCacheEvent.java +++ b/scm-core/src/main/java/sonia/scm/repository/ClearRepositoryCacheEvent.java @@ -29,7 +29,6 @@ import sonia.scm.event.Event; /** * Event which causes clearing of repository cache. * - * @author Sebastian Sdorra * @since 1.50 */ @Event @@ -37,20 +36,10 @@ public class ClearRepositoryCacheEvent { private final Repository repository; - /** - * Constructs a new instance. - * - * @param repository repository - */ public ClearRepositoryCacheEvent(Repository repository) { this.repository = repository; } - /** - * Returns repository. - * - * @return repository - */ public Repository getRepository() { return repository; } diff --git a/scm-core/src/main/java/sonia/scm/repository/DirectoryHealthCheck.java b/scm-core/src/main/java/sonia/scm/repository/DirectoryHealthCheck.java index 169df7ab4a..73dd632326 100644 --- a/scm-core/src/main/java/sonia/scm/repository/DirectoryHealthCheck.java +++ b/scm-core/src/main/java/sonia/scm/repository/DirectoryHealthCheck.java @@ -24,7 +24,6 @@ package sonia.scm.repository; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Preconditions; import com.google.common.base.Strings; @@ -32,80 +31,49 @@ import com.google.common.base.Strings; import org.slf4j.Logger; import org.slf4j.LoggerFactory; -//~--- JDK imports ------------------------------------------------------------ - import java.io.File; /** * - * @author Sebastian Sdorra * @since 1.36 */ public abstract class DirectoryHealthCheck implements HealthCheck { - /** Field description */ private static final HealthCheckFailure NO_TYPE = new HealthCheckFailure("2OOTx6ta71", "Repository has no type", "The repository does not have a configured type."); - /** Field description */ private static final HealthCheckFailure NO_HANDLER = new HealthCheckFailure("CqOTx7Jkq1", "No handler for repository type", "There is no registered repository handler for the type of the repository."); - /** Field description */ private static final HealthCheckFailure NO_DIRECTORY = new HealthCheckFailure("AcOTx7fD51", "handler could not return directory", "The repository handler was not able to return a directory for the repository"); - /** Field description */ private static final HealthCheckFailure DIRECTORY_DOES_NOT_EXISTS = new HealthCheckFailure("1oOTx803F1", "repository directory does not exists", "The repository does not exists. Perhaps it was deleted outside of scm-manager."); - /** - * the logger for DirectoryHealthCheck - */ + private static final Logger logger = LoggerFactory.getLogger(DirectoryHealthCheck.class); - //~--- constructors --------------------------------------------------------- - - /** - * Constructs ... - * - * - * @param repositoryManager - */ + private final RepositoryManager repositoryManager; + protected DirectoryHealthCheck(RepositoryManager repositoryManager) { this.repositoryManager = repositoryManager; } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param repository - * @param directory - * - * @return - */ + protected abstract HealthCheckResult check(Repository repository, File directory); - /** - * Method description - * - * - * @param repository - * - * @return - */ + @Override public HealthCheckResult check(Repository repository) { @@ -126,31 +94,15 @@ public abstract class DirectoryHealthCheck implements HealthCheck return result; } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param repository - * - * @return - */ + protected boolean isCheckResponsible(Repository repository) { return true; } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param repository - * - * @return - */ + private HealthCheckResult doCheck(Repository repository) { HealthCheckResult result; @@ -198,8 +150,4 @@ public abstract class DirectoryHealthCheck implements HealthCheck return result; } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private final RepositoryManager repositoryManager; } diff --git a/scm-core/src/main/java/sonia/scm/repository/Feature.java b/scm-core/src/main/java/sonia/scm/repository/Feature.java index fa34364752..e47c469529 100644 --- a/scm-core/src/main/java/sonia/scm/repository/Feature.java +++ b/scm-core/src/main/java/sonia/scm/repository/Feature.java @@ -27,7 +27,6 @@ package sonia.scm.repository; /** * Features which are supported by a {@link Repository}. * - * @author Sebastian Sdorra * @since 1.25 */ public enum Feature diff --git a/scm-core/src/main/java/sonia/scm/repository/FileObject.java b/scm-core/src/main/java/sonia/scm/repository/FileObject.java index a8b1d49e72..27c72aa2af 100644 --- a/scm-core/src/main/java/sonia/scm/repository/FileObject.java +++ b/scm-core/src/main/java/sonia/scm/repository/FileObject.java @@ -43,7 +43,6 @@ import static java.util.Optional.ofNullable; /** * The FileObject represents a file or a directory in a repository. * - * @author Sebastian Sdorra * @since 1.5 */ @EqualsAndHashCode @@ -54,50 +53,23 @@ public class FileObject implements LastModifiedAware, Serializable { private String description; - /** - * directory indicator - */ private boolean directory; - /** - * commit date - */ private Long commitDate; - /** - * file length - */ private Long length; - /** - * filename - */ private String name; - /** - * file path - */ private String path; - /** - * Marker for partial result. - */ private boolean partialResult = false; - /** - * Marker for aborted computation. - */ private boolean computationAborted = false; - /** - * sub repository informations - */ @XmlElement(name = "subrepository") private SubRepository subRepository; - /** - * Children of this file (aka directory). - */ private Collection children = new ArrayList<>(); private boolean truncated; @@ -144,8 +116,6 @@ public class FileObject implements LastModifiedAware, Serializable { /** * Returns the name of the file. - * - * @return name of file */ public String getName() { return name; @@ -153,8 +123,6 @@ public class FileObject implements LastModifiedAware, Serializable { /** * Returns the path of the file. - * - * @return path of file */ public String getPath() { return path; @@ -179,8 +147,6 @@ public class FileObject implements LastModifiedAware, Serializable { /** * Return sub repository information or null if the file is not * sub repository. - * - * @return sub repository informations or null * @since 1.10 */ public SubRepository getSubRepository() { @@ -189,17 +155,13 @@ public class FileObject implements LastModifiedAware, Serializable { /** * Returns true if the file is a directory. - * - * @return true if file is a directory */ public boolean isDirectory() { return directory; } /** - * Returns the children of this file. - * - * @return The children of this file if it is a directory. + * Returns the children of this file if it is a directory. */ public Collection getChildren() { return children == null ? null : unmodifiableCollection(children); @@ -234,12 +196,9 @@ public class FileObject implements LastModifiedAware, Serializable { return truncated; } - //~--- set methods ---------------------------------------------------------- /** * Sets the description of the file. - * - * @param description description of file */ public void setDescription(String description) { this.description = description; @@ -247,8 +206,6 @@ public class FileObject implements LastModifiedAware, Serializable { /** * Set to true to indicate that the file is a directory. - * - * @param directory true for directory */ public void setDirectory(boolean directory) { this.directory = directory; @@ -256,8 +213,6 @@ public class FileObject implements LastModifiedAware, Serializable { /** * Sets the commit date of the file. - * - * @param commitDate commit date */ public void setCommitDate(Long commitDate) { this.commitDate = commitDate; @@ -265,8 +220,6 @@ public class FileObject implements LastModifiedAware, Serializable { /** * Sets the length of the file. - * - * @param length file length */ public void setLength(Long length) { this.length = length; @@ -274,8 +227,6 @@ public class FileObject implements LastModifiedAware, Serializable { /** * Sets the name of the file. - * - * @param name filename */ public void setName(String name) { this.name = name; @@ -283,8 +234,6 @@ public class FileObject implements LastModifiedAware, Serializable { /** * Sets the path of the file. - * - * @param path file path */ public void setPath(String path) { this.path = path; @@ -293,8 +242,7 @@ public class FileObject implements LastModifiedAware, Serializable { /** * Set sub repository information for the file. * - * @param subRepository sub repository informations - * @since 1.10 + * @since 1.10 */ public void setSubRepository(SubRepository subRepository) { this.subRepository = subRepository; @@ -323,8 +271,6 @@ public class FileObject implements LastModifiedAware, Serializable { /** * Set the children for this file. - * - * @param children The new childre. */ public void setChildren(List children) { this.children = new ArrayList<>(children); diff --git a/scm-core/src/main/java/sonia/scm/repository/FileObjectNameComparator.java b/scm-core/src/main/java/sonia/scm/repository/FileObjectNameComparator.java index 53bbdce22a..f271c5857f 100644 --- a/scm-core/src/main/java/sonia/scm/repository/FileObjectNameComparator.java +++ b/scm-core/src/main/java/sonia/scm/repository/FileObjectNameComparator.java @@ -24,12 +24,9 @@ package sonia.scm.repository; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.util.Util; -//~--- JDK imports ------------------------------------------------------------ - import java.io.Serializable; import java.util.Comparator; @@ -37,30 +34,18 @@ import java.util.Comparator; /** * Compare {@link FileObject}'s by its name. * - * @author Sebastian Sdorra */ public class FileObjectNameComparator implements Comparator, Serializable { - /** Field description */ public static final FileObjectNameComparator instance = new FileObjectNameComparator(); - /** Field description */ private static final long serialVersionUID = -2133224334287527874L; - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param o1 - * @param o2 - * - * @return - */ + @Override public int compare(FileObject o1, FileObject o2) { diff --git a/scm-core/src/main/java/sonia/scm/repository/FileObjectPreProcessor.java b/scm-core/src/main/java/sonia/scm/repository/FileObjectPreProcessor.java index 1e4098d9b0..7096002241 100644 --- a/scm-core/src/main/java/sonia/scm/repository/FileObjectPreProcessor.java +++ b/scm-core/src/main/java/sonia/scm/repository/FileObjectPreProcessor.java @@ -24,7 +24,6 @@ package sonia.scm.repository; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.plugin.ExtensionPoint; @@ -32,19 +31,11 @@ import sonia.scm.plugin.ExtensionPoint; * A pre processor for {@link FileObject} objects. A pre processor is able to * modify the object before it is delivered to the user interface. * - * @author Sebastian Sdorra * @since 1.10 */ @ExtensionPoint public interface FileObjectPreProcessor extends PreProcessor { - - /** - * Process the given file object. - * - * - * @param fileObject file object to process - */ @Override public void process(FileObject fileObject); } diff --git a/scm-core/src/main/java/sonia/scm/repository/FileObjectPreProcessorFactory.java b/scm-core/src/main/java/sonia/scm/repository/FileObjectPreProcessorFactory.java index 272e64cc81..c7bccf93f3 100644 --- a/scm-core/src/main/java/sonia/scm/repository/FileObjectPreProcessorFactory.java +++ b/scm-core/src/main/java/sonia/scm/repository/FileObjectPreProcessorFactory.java @@ -24,7 +24,6 @@ package sonia.scm.repository; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.plugin.ExtensionPoint; @@ -32,7 +31,6 @@ import sonia.scm.plugin.ExtensionPoint; * The FileObjectPreProcessorFactory create {@link FileObjectPreProcessor} * objects for a specific repository. * - * @author Sebastian Sdorra * @since 1.10 */ @ExtensionPoint @@ -40,14 +38,6 @@ public interface FileObjectPreProcessorFactory extends PreProcessorFactory { - /** - * Create a new {@link FileObjectPreProcessor} for the given repository. - * - * - * @param repository repository - * - * @return {@link FileObjectPreProcessor} for the given repository - */ @Override public FileObjectPreProcessor createPreProcessor(Repository repository); } diff --git a/scm-core/src/main/java/sonia/scm/repository/HealthCheck.java b/scm-core/src/main/java/sonia/scm/repository/HealthCheck.java index 7db10a68e7..1d8c36bfb5 100644 --- a/scm-core/src/main/java/sonia/scm/repository/HealthCheck.java +++ b/scm-core/src/main/java/sonia/scm/repository/HealthCheck.java @@ -21,10 +21,9 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ - + package sonia.scm.repository; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.plugin.ExtensionPoint; @@ -32,7 +31,6 @@ import sonia.scm.plugin.ExtensionPoint; * Repository health check. Executes a check to verify the health * state of a repository. * - * @author Sebastian Sdorra * @since 1.36 */ @ExtensionPoint(multi = true) @@ -42,10 +40,7 @@ public interface HealthCheck /** * Returns the result of the repository health check. * - * * @param repository repository to check - * - * @return result of the health check */ - public HealthCheckResult check(Repository repository); + HealthCheckResult check(Repository repository); } diff --git a/scm-core/src/main/java/sonia/scm/repository/HealthCheckFailure.java b/scm-core/src/main/java/sonia/scm/repository/HealthCheckFailure.java index 4bbc7e7900..2801be98d9 100644 --- a/scm-core/src/main/java/sonia/scm/repository/HealthCheckFailure.java +++ b/scm-core/src/main/java/sonia/scm/repository/HealthCheckFailure.java @@ -24,7 +24,6 @@ package sonia.scm.repository; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.MoreObjects; import com.google.common.base.Objects; @@ -35,12 +34,9 @@ import jakarta.xml.bind.annotation.XmlRootElement; import java.io.Serializable; import java.text.MessageFormat; -//~--- JDK imports ------------------------------------------------------------ - /** * Single failure of a {@link HealthCheck}. * - * @author Sebastian Sdorra * @since 1.36 */ @XmlRootElement(name = "healthCheckFailure") @@ -51,10 +47,19 @@ public final class HealthCheckFailure implements Serializable private static final String URL_TEMPLATE = "https://scm-manager.org/docs/{0}/en/user/repo/health-checks/%s"; private static final String LATEST_VERSION = "latest"; + private String description; + + private String id; + + private String summary; + + private String url; + + /** Flag whether the url is a template or not */ + private boolean urlTemplated = false; + /** - * Constructs a new {@link HealthCheckFailure}. * This constructor is only for JAXB. - * */ HealthCheckFailure() {} @@ -119,7 +124,7 @@ public final class HealthCheckFailure implements Serializable /** * Use this to create {@link HealthCheckFailure} instances with a custom url for core health check * failures. If this url can be customized with a concrete version of SCM-Manager, you can use {0} - * as a placeholder for the version. This will be replaces later on. + * as a placeholder for the version. This will be replaced later on. * @param urlTemplate The url for this failure. * @since 2.17.0 */ @@ -171,8 +176,6 @@ public final class HealthCheckFailure implements Serializable /** * Returns the description of this failure. - * - * @return description of this failure */ public String getDescription() { @@ -181,8 +184,6 @@ public final class HealthCheckFailure implements Serializable /** * Returns the id of this failure. - * - * @return id of this failure */ public String getId() { @@ -191,8 +192,6 @@ public final class HealthCheckFailure implements Serializable /** * Returns the summary of the failure. - * - * @return summary of the failure */ public String getSummary() { @@ -226,21 +225,6 @@ public final class HealthCheckFailure implements Serializable } } - /** description of failure */ - private String description; - - /** id of failure */ - private String id; - - /** summary of failure */ - private String summary; - - /** url of failure */ - private String url; - - /** Flag whether the url is a template or not */ - private boolean urlTemplated = false; - public static final class UrlTemplate { private final String url; diff --git a/scm-core/src/main/java/sonia/scm/repository/HealthCheckResult.java b/scm-core/src/main/java/sonia/scm/repository/HealthCheckResult.java index e070f06be6..75d8667b28 100644 --- a/scm-core/src/main/java/sonia/scm/repository/HealthCheckResult.java +++ b/scm-core/src/main/java/sonia/scm/repository/HealthCheckResult.java @@ -21,10 +21,9 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ - + package sonia.scm.repository; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.MoreObjects; import com.google.common.base.Objects; @@ -32,35 +31,24 @@ import com.google.common.collect.ImmutableSet; import java.util.Set; -//~--- JDK imports ------------------------------------------------------------ - /** * Result of {@link HealthCheck}. * - * @author Sebastian Sdorra * @since 1.36 */ public final class HealthCheckResult { - /** healthy result */ private static final HealthCheckResult HEALTHY = new HealthCheckResult(ImmutableSet.of()); - //~--- constructors --------------------------------------------------------- + private final Set failures; - /** - * Constructs ... - * - * - * @param failures - */ private HealthCheckResult(Set failures) { this.failures = failures; } - //~--- methods -------------------------------------------------------------- /** * Returns a {@link HealthCheckResult} for a healthy repository. @@ -99,18 +87,16 @@ public final class HealthCheckResult HealthCheckFailure... otherFailures) { //J- - return new HealthCheckResult( + return new HealthCheckResult( ImmutableSet.builder() .add(failure) .add(otherFailures) - .build() + .build() ); //J+ } - /** - * {@inheritDoc} - */ + @Override public boolean equals(Object obj) { @@ -129,9 +115,7 @@ public final class HealthCheckResult return Objects.equal(failures, other.failures); } - /** - * {@inheritDoc} - */ + @Override public int hashCode() { @@ -139,7 +123,7 @@ public final class HealthCheckResult } /** - * Merge this {@link HealthCheckResult} with another + * Merge this {@link HealthCheckResult} with another * {@link HealthCheckResult}. * * @@ -170,19 +154,16 @@ public final class HealthCheckResult return merged; } - /** - * {@inheritDoc} - */ + @Override public String toString() { return MoreObjects.toStringHelper(this).add("failures", failures).toString(); } - //~--- get methods ---------------------------------------------------------- /** - * Returns a {@link Set} of {@link HealthCheckFailure}s. The set is empty if + * Returns a {@link Set} of {@link HealthCheckFailure}s. The set is empty if * the repository is healthy. * * @return {@link Set} of {@link HealthCheckFailure}s @@ -194,8 +175,6 @@ public final class HealthCheckResult /** * Returns {@code true} if the result is healthy. - * - * @return {@code true} if the result is healthy */ public boolean isHealthy() { @@ -204,16 +183,10 @@ public final class HealthCheckResult /** * Returns {@code true} if the result is unhealthy - * - * @return {@code true} if the result is unhealthy. */ public boolean isUnhealthy() { return !failures.isEmpty(); } - //~--- fields --------------------------------------------------------------- - - /** set of failures */ - private final Set failures; } diff --git a/scm-core/src/main/java/sonia/scm/repository/ImportHandler.java b/scm-core/src/main/java/sonia/scm/repository/ImportHandler.java index a4280048c7..fd7fdcab3c 100644 --- a/scm-core/src/main/java/sonia/scm/repository/ImportHandler.java +++ b/scm-core/src/main/java/sonia/scm/repository/ImportHandler.java @@ -24,15 +24,12 @@ package sonia.scm.repository; -//~--- JDK imports ------------------------------------------------------------ - import java.io.IOException; import java.util.List; /** * Searches and import existing repositories. * - * @author Sebastian Sdorra * @since 1.12 * @deprecated */ diff --git a/scm-core/src/main/java/sonia/scm/repository/ImportRepositoryHookEvent.java b/scm-core/src/main/java/sonia/scm/repository/ImportRepositoryHookEvent.java index c802958193..b7e59d183b 100644 --- a/scm-core/src/main/java/sonia/scm/repository/ImportRepositoryHookEvent.java +++ b/scm-core/src/main/java/sonia/scm/repository/ImportRepositoryHookEvent.java @@ -32,7 +32,6 @@ import sonia.scm.event.Event; * This class is wrapper of {@link RepositoryHookEvent} for the event system of * SCM-Manager. * - * @author Sebastian Sdorra * @since 2.14.0 */ @Event diff --git a/scm-core/src/main/java/sonia/scm/repository/ImportResult.java b/scm-core/src/main/java/sonia/scm/repository/ImportResult.java index 62b38ede79..49a60b29a3 100644 --- a/scm-core/src/main/java/sonia/scm/repository/ImportResult.java +++ b/scm-core/src/main/java/sonia/scm/repository/ImportResult.java @@ -37,7 +37,6 @@ import static com.google.common.base.Preconditions.checkNotNull; /** * Import result of the {@link AdvancedImportHandler}. * - * @author Sebastian Sdorra * @since 1.43 * @deprecated */ diff --git a/scm-core/src/main/java/sonia/scm/repository/InitialRepositoryLocationResolver.java b/scm-core/src/main/java/sonia/scm/repository/InitialRepositoryLocationResolver.java index 8ec95c5c9a..22dde20847 100644 --- a/scm-core/src/main/java/sonia/scm/repository/InitialRepositoryLocationResolver.java +++ b/scm-core/src/main/java/sonia/scm/repository/InitialRepositoryLocationResolver.java @@ -42,7 +42,6 @@ import static com.google.common.base.Preconditions.checkArgument; * Please use the {@link sonia.scm.store.BlobStoreFactory } and the {@link sonia.scm.store.BlobStore} classes to store binary files
* Please use the {@link sonia.scm.store.ConfigurationStoreFactory} and the {@link sonia.scm.store.ConfigurationStore} classes to store configurations * - * @author Mohamed Karray * @since 2.0.0 */ public class InitialRepositoryLocationResolver { @@ -60,10 +59,6 @@ public class InitialRepositoryLocationResolver { /** * Returns the initial path to repository. - * - * @param repositoryId id of the repository - * - * @return initial path of repository */ @SuppressWarnings("squid:S2083") // path traversal is prevented with ID_MATCHER public Path getPath(String repositoryId) { diff --git a/scm-core/src/main/java/sonia/scm/repository/ModificationsPreProcessor.java b/scm-core/src/main/java/sonia/scm/repository/ModificationsPreProcessor.java index 2bfeebe0c6..42b0f9d983 100644 --- a/scm-core/src/main/java/sonia/scm/repository/ModificationsPreProcessor.java +++ b/scm-core/src/main/java/sonia/scm/repository/ModificationsPreProcessor.java @@ -31,17 +31,10 @@ import sonia.scm.plugin.ExtensionPoint; * A pre processor for {@link Modifications} objects. A pre processor is able to * modify the object before it is delivered to the user interface. * - * @author Mohamed Karray * @since 2.0 */ @ExtensionPoint public interface ModificationsPreProcessor extends PreProcessor { - - /** - * Process the given modifications. - * - * @param modifications modifications to process - */ @Override void process(Modifications modifications); } diff --git a/scm-core/src/main/java/sonia/scm/repository/ModificationsPreProcessorFactory.java b/scm-core/src/main/java/sonia/scm/repository/ModificationsPreProcessorFactory.java index 1daa9cd582..e66cce979f 100644 --- a/scm-core/src/main/java/sonia/scm/repository/ModificationsPreProcessorFactory.java +++ b/scm-core/src/main/java/sonia/scm/repository/ModificationsPreProcessorFactory.java @@ -30,20 +30,11 @@ import sonia.scm.plugin.ExtensionPoint; /** * This factory create a {@link ModificationsPreProcessor} * - * @author Mohamed Karray * @since 2.0 */ @ExtensionPoint public interface ModificationsPreProcessorFactory extends PreProcessorFactory { - /** - * Create a new {@link ModificationsPreProcessor} for the given repository. - * - * - * @param repository repository - * - * @return {@link ModificationsPreProcessor} for the given repository - */ @Override ModificationsPreProcessor createPreProcessor(Repository repository); diff --git a/scm-core/src/main/java/sonia/scm/repository/NamespaceManager.java b/scm-core/src/main/java/sonia/scm/repository/NamespaceManager.java index 01ad2815d6..15c32398c5 100644 --- a/scm-core/src/main/java/sonia/scm/repository/NamespaceManager.java +++ b/scm-core/src/main/java/sonia/scm/repository/NamespaceManager.java @@ -37,25 +37,18 @@ import java.util.Optional; public interface NamespaceManager { /** - * Returns the Namespace with the given name. - * - * @param namespace The name of the requested namespace. - * @return Optional with the namespace for the given name, or an empty Optional if there is no such namespace - * (that is, there is no repository with this namespace). + * Returns {@link Optional} with the namespace for the given name, or an empty {@link Optional} if there is no such + * namespace (that is, there is no repository with this namespace). */ Optional get(String namespace); /** * Returns a {@link java.util.Collection} of all namespaces. - * - * @return all namespaces */ Collection getAll(); /** * Modifies the given namespace. - * - * @param namespace The namespace to be modified. */ void modify(Namespace namespace); } diff --git a/scm-core/src/main/java/sonia/scm/repository/NamespaceStrategy.java b/scm-core/src/main/java/sonia/scm/repository/NamespaceStrategy.java index 4548d2b82b..e29c51d30d 100644 --- a/scm-core/src/main/java/sonia/scm/repository/NamespaceStrategy.java +++ b/scm-core/src/main/java/sonia/scm/repository/NamespaceStrategy.java @@ -34,9 +34,6 @@ public interface NamespaceStrategy { /** * Create new namespace for the given repository. - * - * @param repository repository - * @return namespace */ String createNamespace(Repository repository); diff --git a/scm-core/src/main/java/sonia/scm/repository/PartCacheClearHook.java b/scm-core/src/main/java/sonia/scm/repository/PartCacheClearHook.java index f52d6300da..86ed913153 100644 --- a/scm-core/src/main/java/sonia/scm/repository/PartCacheClearHook.java +++ b/scm-core/src/main/java/sonia/scm/repository/PartCacheClearHook.java @@ -24,7 +24,6 @@ package sonia.scm.repository; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Predicate; @@ -32,20 +31,12 @@ import com.google.common.base.Predicate; /** * - * @author Sebastian Sdorra * @since 1.9 */ public class PartCacheClearHook extends CacheClearHook { - /** - * Method description - * - * - * @param event - * - * @return - */ + @Override protected Predicate createPredicate(RepositoryHookEvent event) { diff --git a/scm-core/src/main/java/sonia/scm/repository/Person.java b/scm-core/src/main/java/sonia/scm/repository/Person.java index 503108e076..bbb9253591 100644 --- a/scm-core/src/main/java/sonia/scm/repository/Person.java +++ b/scm-core/src/main/java/sonia/scm/repository/Person.java @@ -45,14 +45,8 @@ public class Person implements Validateable, Serializable { private static final long serialVersionUID = -4675080650527063196L; - /** - * mail address of the person - */ private String mail; - /** - * name of the person - */ private String name; public Person() { @@ -98,8 +92,6 @@ public class Person implements Validateable, Serializable { /** * Returns a string representation of the {@link Person} object, * in the format "name >mail<". - * - * @return string representation of {@link Person} object */ @Override public String toString() { @@ -112,12 +104,8 @@ public class Person implements Validateable, Serializable { return out; } - //~--- get methods ---------------------------------------------------------- - /** * Returns the mail address of the changeset author. - * - * @return */ public String getMail() { return mail; @@ -125,8 +113,6 @@ public class Person implements Validateable, Serializable { /** * Returns the name of the changeset author. - * - * @return name of the changeset person */ public String getName() { return name; @@ -135,8 +121,6 @@ public class Person implements Validateable, Serializable { /** * Returns true if the person is valid. - * - * @return true if the person is valid */ @Override public boolean isValid() { diff --git a/scm-core/src/main/java/sonia/scm/repository/PostReceiveRepositoryHookEvent.java b/scm-core/src/main/java/sonia/scm/repository/PostReceiveRepositoryHookEvent.java index 8f4790eaa9..999689cfae 100644 --- a/scm-core/src/main/java/sonia/scm/repository/PostReceiveRepositoryHookEvent.java +++ b/scm-core/src/main/java/sonia/scm/repository/PostReceiveRepositoryHookEvent.java @@ -31,20 +31,12 @@ import sonia.scm.event.Event; * This class is wrapper of {@link RepositoryHookEvent} for the event system of * SCM-Manager. * - * @author Sebastian Sdorra * @since 1.23 */ @Event public final class PostReceiveRepositoryHookEvent extends WrappedRepositoryHookEvent { - - /** - * Constructs a new PostReceiveRepositoryHookEvent. - * - * - * @param wrappedEvent event to wrap - */ public PostReceiveRepositoryHookEvent(RepositoryHookEvent wrappedEvent) { super(wrappedEvent); diff --git a/scm-core/src/main/java/sonia/scm/repository/PreProcessor.java b/scm-core/src/main/java/sonia/scm/repository/PreProcessor.java index d7a39b59e1..dde30f0a00 100644 --- a/scm-core/src/main/java/sonia/scm/repository/PreProcessor.java +++ b/scm-core/src/main/java/sonia/scm/repository/PreProcessor.java @@ -28,19 +28,11 @@ package sonia.scm.repository; * A pre processor is able to modify a object before it is delivered * to the user interface. * - * @author Sebastian Sdorra * @since 1.17 * * @param object type */ public interface PreProcessor { - - /** - * Process the given object. - * - * - * @param item object to process - */ public void process(T item); } diff --git a/scm-core/src/main/java/sonia/scm/repository/PreProcessorFactory.java b/scm-core/src/main/java/sonia/scm/repository/PreProcessorFactory.java index d9692b5de8..4cf46edeb5 100644 --- a/scm-core/src/main/java/sonia/scm/repository/PreProcessorFactory.java +++ b/scm-core/src/main/java/sonia/scm/repository/PreProcessorFactory.java @@ -28,21 +28,11 @@ package sonia.scm.repository; * A pre processor factory creates a specific {@link PreProcessor} for * the given repository. * - * @author Sebastian Sdorra * * @param object type for the {@link PreProcessor} * @since 1.17 */ public interface PreProcessorFactory { - - /** - * Create a new {@link PreProcessor} for the given repository. - * - * - * @param repository repository - * - * @return {@link PreProcessor} for the given repository - */ public PreProcessor createPreProcessor(Repository repository); } diff --git a/scm-core/src/main/java/sonia/scm/repository/PreProcessorUtil.java b/scm-core/src/main/java/sonia/scm/repository/PreProcessorUtil.java index 0027ca8da6..6517f5f550 100644 --- a/scm-core/src/main/java/sonia/scm/repository/PreProcessorUtil.java +++ b/scm-core/src/main/java/sonia/scm/repository/PreProcessorUtil.java @@ -24,7 +24,6 @@ package sonia.scm.repository; -//~--- non-JDK imports -------------------------------------------------------- import com.google.inject.Inject; import org.slf4j.Logger; @@ -34,37 +33,33 @@ import sonia.scm.util.Util; import java.util.Collection; import java.util.Set; -//~--- JDK imports ------------------------------------------------------------ - /** * - * @author Sebastian Sdorra * @since 1.17 */ public class PreProcessorUtil { - /** - * the logger for PreProcessorUtil - */ + private static final Logger logger = LoggerFactory.getLogger(PreProcessorUtil.class); - //~--- constructors --------------------------------------------------------- + private final Collection blameLinePreProcessorFactorySet; + + private final Collection blameLinePreProcessorSet; + + private final Collection changesetPreProcessorFactorySet; + + private final Collection changesetPreProcessorSet; + + private final Collection modificationsPreProcessorFactorySet; + + private final Collection modificationsPreProcessorSet; + + private final Collection fileObjectPreProcessorFactorySet; + + private final Collection fileObjectPreProcessorSet; - /** - * Constructs ... - * - * - * @param changesetPreProcessorSet - * @param changesetPreProcessorFactorySet - * @param fileObjectPreProcessorSet - * @param fileObjectPreProcessorFactorySet - * @param blameLinePreProcessorSet - * @param blameLinePreProcessorFactorySet - * @param modificationsPreProcessorFactorySet - * @param modificationsPreProcessorSet - */ @Inject public PreProcessorUtil(Set changesetPreProcessorSet, Set changesetPreProcessorFactorySet, @@ -85,15 +80,8 @@ public class PreProcessorUtil this.modificationsPreProcessorSet = modificationsPreProcessorSet; } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param repository - * @param blameLine - */ + public void prepareForReturn(Repository repository, BlameLine blameLine) { if (logger.isTraceEnabled()) @@ -105,13 +93,7 @@ public class PreProcessorUtil handlePreProcess(repository,blameLine,blameLinePreProcessorFactorySet, blameLinePreProcessorSet); } - /** - * Method description - * - * - * @param repository - * @param blameResult - */ + public void prepareForReturn(Repository repository, BlameResult blameResult) { if (logger.isTraceEnabled()) @@ -123,13 +105,7 @@ public class PreProcessorUtil handlePreProcessForIterable(repository, blameResult.getBlameLines(),blameLinePreProcessorFactorySet, blameLinePreProcessorSet); } - /** - * Method description - * - * - * @param repository - * @param changeset - */ + public void prepareForReturn(Repository repository, Changeset changeset) { logger.trace("prepare changeset {} of repository {} for return", changeset.getId(), repository); @@ -141,13 +117,7 @@ public class PreProcessorUtil handlePreProcess(repository, modifications, modificationsPreProcessorFactorySet, modificationsPreProcessorSet); } - /** - * Method description - * - * - * @param repository - * @param result - */ + public void prepareForReturn(Repository repository, BrowserResult result) { if (logger.isTraceEnabled()) @@ -169,13 +139,7 @@ public class PreProcessorUtil handler.callPreProcessors(fileObject); } - /** - * Method description - * - * - * @param repository - * @param result - */ + public void prepareForReturn(Repository repository, ChangesetPagingResult result) { if (logger.isTraceEnabled()) @@ -203,28 +167,14 @@ public class PreProcessorUtil handler.callPreProcessorFactories(processedObjects); } - //~--- inner classes -------------------------------------------------------- - - /** - * Class description - * - * - * @param - * - * @version Enter version here..., 12/06/16 - * @author Enter your name here... - */ private static class PreProcessorHandler { + private final Collection> preProcessorFactorySet; + + private final Collection> preProcessorSet; + + private final Repository repository; - /** - * Constructs ... - * - * - * @param preProcessorFactorySet - * @param preProcessorSet - * @param repository - */ public PreProcessorHandler( Collection> preProcessorFactorySet, Collection> preProcessorSet, @@ -235,20 +185,6 @@ public class PreProcessorUtil this.repository = repository; } - //~--- methods ------------------------------------------------------------ - - /** - * Method description - * - * - * - * - * @param preProcessorFactorySet - * @param repository - * @param changesets - * @param items - * @param - */ public void callPreProcessorFactories(Iterable items) { if (Util.isNotEmpty(preProcessorFactorySet)) @@ -268,16 +204,6 @@ public class PreProcessorUtil } } - /** - * Method description - * - * - * - * @param preProcessorFactorySet - * @param repository - * @param item - * @param - */ public void callPreProcessorFactories(T item) { if (Util.isNotEmpty(preProcessorFactorySet)) @@ -294,16 +220,6 @@ public class PreProcessorUtil } } - /** - * Method description - * - * - * @param changesets - * - * @param preProcessorSet - * @param items - * @param - */ public void callPreProcessors(Iterable items) { if (Util.isNotEmpty(preProcessorSet)) @@ -315,16 +231,6 @@ public class PreProcessorUtil } } - /** - * Method description - * - * - * @param c - * - * @param preProcessorSet - * @param item - * @param - */ public void callPreProcessors(T item) { if (Util.isNotEmpty(preProcessorSet)) @@ -336,40 +242,6 @@ public class PreProcessorUtil } } - //~--- fields ------------------------------------------------------------- - - /** Field description */ - private final Collection> preProcessorFactorySet; - - /** Field description */ - private final Collection> preProcessorSet; - - /** Field description */ - private final Repository repository; } - - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private final Collection blameLinePreProcessorFactorySet; - - /** Field description */ - private final Collection blameLinePreProcessorSet; - - /** Field description */ - private final Collection changesetPreProcessorFactorySet; - - /** Field description */ - private final Collection changesetPreProcessorSet; - - private final Collection modificationsPreProcessorFactorySet; - - private final Collection modificationsPreProcessorSet; - - /** Field description */ - private final Collection fileObjectPreProcessorFactorySet; - - /** Field description */ - private final Collection fileObjectPreProcessorSet; } diff --git a/scm-core/src/main/java/sonia/scm/repository/PreReceiveRepositoryHookEvent.java b/scm-core/src/main/java/sonia/scm/repository/PreReceiveRepositoryHookEvent.java index 8ef2521a2d..af42163539 100644 --- a/scm-core/src/main/java/sonia/scm/repository/PreReceiveRepositoryHookEvent.java +++ b/scm-core/src/main/java/sonia/scm/repository/PreReceiveRepositoryHookEvent.java @@ -24,7 +24,6 @@ package sonia.scm.repository; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.event.Event; @@ -33,20 +32,12 @@ import sonia.scm.event.Event; * through the repository. This class is wrapper of {@link RepositoryHookEvent} * for the event system of SCM-Manager. * - * @author Sebastian Sdorra * @since 1.23 */ @Event public final class PreReceiveRepositoryHookEvent extends WrappedRepositoryHookEvent { - - /** - * Constructs new PreReceiveRepositoryHookEvent. - * - * - * @param wrappedEvent event to wrap - */ public PreReceiveRepositoryHookEvent(RepositoryHookEvent wrappedEvent) { super(wrappedEvent); diff --git a/scm-core/src/main/java/sonia/scm/repository/ReadOnlyCheck.java b/scm-core/src/main/java/sonia/scm/repository/ReadOnlyCheck.java index 28aa39a7bc..e0ddccdb3a 100644 --- a/scm-core/src/main/java/sonia/scm/repository/ReadOnlyCheck.java +++ b/scm-core/src/main/java/sonia/scm/repository/ReadOnlyCheck.java @@ -37,7 +37,6 @@ public interface ReadOnlyCheck { /** * Returns the reason for the write protection. - * @return reason for write protection */ String getReason(); diff --git a/scm-core/src/main/java/sonia/scm/repository/Repository.java b/scm-core/src/main/java/sonia/scm/repository/Repository.java index 918a778045..450da50372 100644 --- a/scm-core/src/main/java/sonia/scm/repository/Repository.java +++ b/scm-core/src/main/java/sonia/scm/repository/Repository.java @@ -53,7 +53,6 @@ import java.util.Set; /** * Source code repository. * - * @author Sebastian Sdorra */ @IndexedType(namespaceScoped = true) @XmlAccessorType(XmlAccessType.FIELD) @@ -96,7 +95,6 @@ public class Repository private boolean archived; /** - * Constructs a new {@link Repository}. * This constructor is used by JAXB. */ public Repository() { @@ -154,8 +152,6 @@ public class Repository /** * Returns a timestamp of the creation date of the {@link Repository}. - * - * @return a timestamp of the creation date of the {@link Repository} */ public Long getCreationDate() { return creationDate; @@ -163,8 +159,6 @@ public class Repository /** * Returns a short description of the {@link Repository}. - * - * @return short description */ public String getDescription() { return description; @@ -216,8 +210,6 @@ public class Repository /** * Returns the type (hg, git, svn ...) of the {@link Repository}. - * - * @return type of the repository */ @Override public String getType() { @@ -352,12 +344,6 @@ public class Repository // do not copy health check results } - /** - * Returns true if the {@link Repository} is the same as the obj argument. - * - * @param obj the reference object with which to compare - * @return true if the {@link Repository} is the same as the obj argument - */ @Override public boolean equals(Object obj) { if (obj == null) { diff --git a/scm-core/src/main/java/sonia/scm/repository/RepositoryArchivedCheck.java b/scm-core/src/main/java/sonia/scm/repository/RepositoryArchivedCheck.java index 313634358e..f987361071 100644 --- a/scm-core/src/main/java/sonia/scm/repository/RepositoryArchivedCheck.java +++ b/scm-core/src/main/java/sonia/scm/repository/RepositoryArchivedCheck.java @@ -31,18 +31,11 @@ package sonia.scm.repository; */ public interface RepositoryArchivedCheck extends ReadOnlyCheck { - /** - * Checks whether the repository with the given id is archived or not. - * @param repositoryId The id of the repository to check. - * @return true when the repository with the given id is archived, false otherwise. - */ boolean isArchived(String repositoryId); /** * Checks whether the given repository is archived or not. This checks the status on behalf of the id of the * repository, not by the archive flag provided by the repository itself. - * @param repository The repository to check. - * @return true when the given repository is archived, false otherwise. */ default boolean isArchived(Repository repository) { return isArchived(repository.getId()); diff --git a/scm-core/src/main/java/sonia/scm/repository/RepositoryCacheKey.java b/scm-core/src/main/java/sonia/scm/repository/RepositoryCacheKey.java index d9e1fe7923..237bcca65d 100644 --- a/scm-core/src/main/java/sonia/scm/repository/RepositoryCacheKey.java +++ b/scm-core/src/main/java/sonia/scm/repository/RepositoryCacheKey.java @@ -26,17 +26,11 @@ package sonia.scm.repository; /** * - * @author Sebastian Sdorra * @since 1.9 */ public interface RepositoryCacheKey { - /** - * Method description - * - * - * @return - */ + public String getRepositoryId(); } diff --git a/scm-core/src/main/java/sonia/scm/repository/RepositoryCacheKeyPredicate.java b/scm-core/src/main/java/sonia/scm/repository/RepositoryCacheKeyPredicate.java index 42e6016059..f512920c0c 100644 --- a/scm-core/src/main/java/sonia/scm/repository/RepositoryCacheKeyPredicate.java +++ b/scm-core/src/main/java/sonia/scm/repository/RepositoryCacheKeyPredicate.java @@ -24,50 +24,28 @@ package sonia.scm.repository; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Predicate; /** - * - * @author Sebastian Sdorra * @since 1.17 - * - * @param */ public class RepositoryCacheKeyPredicate implements Predicate { - - /** - * Constructs ... - * - * - * @param repositoryId - */ + private final String repositoryId; + public RepositoryCacheKeyPredicate(String repositoryId) { this.repositoryId = repositoryId; } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param item - * - * @return - */ + @Override public boolean apply(T item) { return repositoryId.equals(item.getRepositoryId()); } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private final String repositoryId; } diff --git a/scm-core/src/main/java/sonia/scm/repository/RepositoryConfig.java b/scm-core/src/main/java/sonia/scm/repository/RepositoryConfig.java index cbb53c1d2e..1f4b7d7e2c 100644 --- a/scm-core/src/main/java/sonia/scm/repository/RepositoryConfig.java +++ b/scm-core/src/main/java/sonia/scm/repository/RepositoryConfig.java @@ -21,7 +21,7 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ - + package sonia.scm.repository; import jakarta.xml.bind.annotation.XmlRootElement; @@ -32,19 +32,15 @@ import sonia.scm.config.Configuration; /** * Basic {@link Repository} configuration class. * - * @author Sebastian Sdorra */ @XmlRootElement public abstract class RepositoryConfig implements Validateable, Configuration { - /** true if the plugin is disabled */ private boolean disabled = false; /** * Returns true if the plugin is disabled. * - * - * @return true if the plugin is disabled - * @since 1.13 + * @since 1.13 */ public boolean isDisabled() { return disabled; @@ -52,23 +48,17 @@ public abstract class RepositoryConfig implements Validateable, Configuration { /** * Returns true if the configuration object is valid. - * - * - * @return true if the configuration object is valid */ @Override public boolean isValid() { return true; } - //~--- set methods ---------------------------------------------------------- /** * Enable or disable the plugin. * - * - * @param disabled - * @since 1.13 + * @since 1.13 */ public void setDisabled(boolean disabled) { this.disabled = disabled; diff --git a/scm-core/src/main/java/sonia/scm/repository/RepositoryContentInitializer.java b/scm-core/src/main/java/sonia/scm/repository/RepositoryContentInitializer.java index ffd3689ebc..a6eeab1004 100644 --- a/scm-core/src/main/java/sonia/scm/repository/RepositoryContentInitializer.java +++ b/scm-core/src/main/java/sonia/scm/repository/RepositoryContentInitializer.java @@ -40,7 +40,6 @@ public interface RepositoryContentInitializer { /** * @param context add content to this context in order to commit files in the initial repository commit - * @throws IOException */ void initialize(InitializerContext context) throws IOException; @@ -57,14 +56,11 @@ public interface RepositoryContentInitializer { /** * create new file which will be included in initial repository commit - * - * @param path path of new file - * @return */ CreateFile create(String path); /** - * Returns the the context entry with the given key and unmarshalls it to the given type. + * Returns the context entry with the given key and unmarshalls it to the given type. * It no entry with the given key is available an empty optional is returned. * * @param key key of the context object diff --git a/scm-core/src/main/java/sonia/scm/repository/RepositoryCoordinates.java b/scm-core/src/main/java/sonia/scm/repository/RepositoryCoordinates.java index d726d687e1..c9c2a13990 100644 --- a/scm-core/src/main/java/sonia/scm/repository/RepositoryCoordinates.java +++ b/scm-core/src/main/java/sonia/scm/repository/RepositoryCoordinates.java @@ -35,20 +35,16 @@ public interface RepositoryCoordinates extends TypedObject { /** * Returns the internal id of the repository. - * @return internal id */ String getId(); /** * Returns the namespace of the repository. - * - * @return namespace */ String getNamespace(); /** * Returns the name of the repository. - * @return name */ String getName(); } diff --git a/scm-core/src/main/java/sonia/scm/repository/RepositoryDAO.java b/scm-core/src/main/java/sonia/scm/repository/RepositoryDAO.java index 0837bcb528..10e7f19741 100644 --- a/scm-core/src/main/java/sonia/scm/repository/RepositoryDAO.java +++ b/scm-core/src/main/java/sonia/scm/repository/RepositoryDAO.java @@ -24,7 +24,6 @@ package sonia.scm.repository; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.GenericDAO; @@ -33,7 +32,6 @@ import sonia.scm.GenericDAO; * {@link RepositoryManager}. Plugins and other classes should use the * {@link RepositoryManager} instead. * - * @author Sebastian Sdorra * @since 1.14 */ public interface RepositoryDAO extends GenericDAO @@ -50,7 +48,6 @@ public interface RepositoryDAO extends GenericDAO */ boolean contains(NamespaceAndName namespaceAndName); - //~--- get methods ---------------------------------------------------------- /** * Returns the repository with the specified namespace and name or null diff --git a/scm-core/src/main/java/sonia/scm/repository/RepositoryDirectoryHandler.java b/scm-core/src/main/java/sonia/scm/repository/RepositoryDirectoryHandler.java index 6db1534dc1..b78d0f1411 100644 --- a/scm-core/src/main/java/sonia/scm/repository/RepositoryDirectoryHandler.java +++ b/scm-core/src/main/java/sonia/scm/repository/RepositoryDirectoryHandler.java @@ -24,13 +24,10 @@ package sonia.scm.repository; -//~--- JDK imports ------------------------------------------------------------ - import java.io.File; /** * - * @author Sebastian Sdorra * @since 1.36 */ public interface RepositoryDirectoryHandler extends RepositoryHandler { @@ -39,7 +36,6 @@ public interface RepositoryDirectoryHandler extends RepositoryHandler { /** * Get the current directory of the repository for the given id. - * @return the current directory of the given repository */ File getDirectory(String repositoryId); } diff --git a/scm-core/src/main/java/sonia/scm/repository/RepositoryEvent.java b/scm-core/src/main/java/sonia/scm/repository/RepositoryEvent.java index 34c3dbadc0..19b81a6af2 100644 --- a/scm-core/src/main/java/sonia/scm/repository/RepositoryEvent.java +++ b/scm-core/src/main/java/sonia/scm/repository/RepositoryEvent.java @@ -24,7 +24,6 @@ package sonia.scm.repository; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.HandlerEventType; @@ -34,33 +33,16 @@ import sonia.scm.event.Event; /** * The RepositoryEvent is fired if a {@link Repository} object changes. * - * @author Sebastian Sdorra * @since 1.23 */ @Event public class RepositoryEvent extends AbstractHandlerEvent { - - /** - * Constructs a new repository event. - * - * - * @param eventType type of the event - * @param repository changed repository - */ public RepositoryEvent(HandlerEventType eventType, Repository repository) { super(eventType, repository); } - /** - * Constructs a new repository event. - * - * - * @param eventType type of the event - * @param repository changed repository - * @param oldRepository old repository - */ public RepositoryEvent(HandlerEventType eventType, Repository repository, Repository oldRepository) { diff --git a/scm-core/src/main/java/sonia/scm/repository/RepositoryHandler.java b/scm-core/src/main/java/sonia/scm/repository/RepositoryHandler.java index 068380e93c..b939887aab 100644 --- a/scm-core/src/main/java/sonia/scm/repository/RepositoryHandler.java +++ b/scm-core/src/main/java/sonia/scm/repository/RepositoryHandler.java @@ -24,7 +24,6 @@ package sonia.scm.repository; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.Handler; import sonia.scm.FeatureNotSupportedException; @@ -34,14 +33,12 @@ import sonia.scm.plugin.ExtensionPoint; * Handler class for a specific {@link Repository} type. * These classes are singletons. * - * @author Sebastian Sdorra */ @ExtensionPoint public interface RepositoryHandler extends Handler { - //~--- get methods ---------------------------------------------------------- /** * Returns the {@link ImportHandler} for the repository type of this handler. @@ -57,10 +54,7 @@ public interface RepositoryHandler public ImportHandler getImportHandler() throws FeatureNotSupportedException; /** - * Returns informations about the version of the RepositoryHandler. - * - * - * @return version informations + * Returns information about the version of the RepositoryHandler. * @since 1.15 */ public String getVersionInformation(); diff --git a/scm-core/src/main/java/sonia/scm/repository/RepositoryHandlerConfigChangedEvent.java b/scm-core/src/main/java/sonia/scm/repository/RepositoryHandlerConfigChangedEvent.java index 22668a1605..84131d3f34 100644 --- a/scm-core/src/main/java/sonia/scm/repository/RepositoryHandlerConfigChangedEvent.java +++ b/scm-core/src/main/java/sonia/scm/repository/RepositoryHandlerConfigChangedEvent.java @@ -28,7 +28,6 @@ import sonia.scm.event.Event; /** * - * @author Sebastian Sdorra * @since 2.0.0 */ @Event diff --git a/scm-core/src/main/java/sonia/scm/repository/RepositoryHookEvent.java b/scm-core/src/main/java/sonia/scm/repository/RepositoryHookEvent.java index a022832243..b57585377d 100644 --- a/scm-core/src/main/java/sonia/scm/repository/RepositoryHookEvent.java +++ b/scm-core/src/main/java/sonia/scm/repository/RepositoryHookEvent.java @@ -24,26 +24,26 @@ package sonia.scm.repository; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.repository.api.HookContext; /** * Repository hook event represents an change event of a repository. * - * @author Sebastian Sdorra * @since 1.6 */ public class RepositoryHookEvent { - /** - * Constructs a new {@link RepositoryHookEvent}. - * - * @param context context of current hook - * @param repository - * @param type type of current hook - */ + /** context of current hook */ + private final HookContext context; + + /** modified repository */ + private final Repository repository; + + /** hook type */ + private final RepositoryHookType type; + public RepositoryHookEvent(HookContext context, Repository repository, RepositoryHookType type) { @@ -52,35 +52,19 @@ public class RepositoryHookEvent this.type = type; } - //~--- get methods ---------------------------------------------------------- - /** - * Returns the context of the current hook. - * - * @return context of current hook - */ public HookContext getContext() { return context; } - /** - * Method description - * - * - * @return - */ + public Repository getRepository() { return repository; } - /** - * Method description - * - * - * @return - */ + public RepositoryHookType getType() { return type; @@ -93,15 +77,4 @@ public class RepositoryHookEvent ", type=" + type + '}'; } - - //~--- fields --------------------------------------------------------------- - - /** context of current hook */ - private final HookContext context; - - /** modified repository */ - private final Repository repository; - - /** hook type */ - private final RepositoryHookType type; } diff --git a/scm-core/src/main/java/sonia/scm/repository/RepositoryHookType.java b/scm-core/src/main/java/sonia/scm/repository/RepositoryHookType.java index dab466c78a..5ba81fff4b 100644 --- a/scm-core/src/main/java/sonia/scm/repository/RepositoryHookType.java +++ b/scm-core/src/main/java/sonia/scm/repository/RepositoryHookType.java @@ -27,7 +27,6 @@ package sonia.scm.repository; /** * Type of repository hook. * - * @author Sebastian Sdorra * @since 1.6 */ public enum RepositoryHookType diff --git a/scm-core/src/main/java/sonia/scm/repository/RepositoryManager.java b/scm-core/src/main/java/sonia/scm/repository/RepositoryManager.java index 8adb523ce0..ca500ff17b 100644 --- a/scm-core/src/main/java/sonia/scm/repository/RepositoryManager.java +++ b/scm-core/src/main/java/sonia/scm/repository/RepositoryManager.java @@ -34,7 +34,6 @@ import java.util.function.Consumer; * The central class for managing {@link Repository} objects. * This class is a singleton and is available via injection. * - * @author Sebastian Sdorra * @apiviz.uses sonia.scm.repository.RepositoryHandler */ public interface RepositoryManager @@ -69,8 +68,6 @@ public interface RepositoryManager /** * Returns all configured repository types. - * - * @return all configured repository types */ Collection getConfiguredTypes(); @@ -93,8 +90,6 @@ public interface RepositoryManager /** * Returns all namespaces. - * - * @return all namespaces */ Collection getAllNamespaces(); @@ -115,14 +110,14 @@ public interface RepositoryManager } /** - * @param repository the {@link Repository} to be archived. + * Archives the given repository. * * @since 2.12.0 */ void archive(Repository repository); /** - * @param repository the {@link Repository} to be "unarchived". + * Un-archives the given repository. * * @since 2.12.0 */ diff --git a/scm-core/src/main/java/sonia/scm/repository/RepositoryManagerDecorator.java b/scm-core/src/main/java/sonia/scm/repository/RepositoryManagerDecorator.java index f4aed720d8..7b188b005a 100644 --- a/scm-core/src/main/java/sonia/scm/repository/RepositoryManagerDecorator.java +++ b/scm-core/src/main/java/sonia/scm/repository/RepositoryManagerDecorator.java @@ -24,7 +24,6 @@ package sonia.scm.repository; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.ManagerDecorator; import sonia.scm.Type; @@ -32,58 +31,41 @@ import sonia.scm.Type; import java.io.IOException; import java.util.Collection; -//~--- JDK imports ------------------------------------------------------------ - /** * Decorator for {@link RepositoryManager}. * - * @author Sebastian Sdorra * @since 1.23 */ public class RepositoryManagerDecorator extends ManagerDecorator implements RepositoryManager { - /** - * Constructs ... - * - * @param decorated - */ + private final RepositoryManager decorated; + public RepositoryManagerDecorator(RepositoryManager decorated) { super(decorated); this.decorated = decorated; } - //~--- methods -------------------------------------------------------------- - /** - * {@inheritDoc} - */ + @Override public void fireHookEvent(RepositoryHookEvent event) { decorated.fireHookEvent(event); } - /** - * {@inheritDoc} - */ + @Override public void importRepository(Repository repository) throws IOException { decorated.importRepository(repository); } - //~--- get methods ---------------------------------------------------------- @Override public Repository get(NamespaceAndName namespaceAndName) { return decorated.get(namespaceAndName); } - /** - * {@inheritDoc} - * - * @return - */ @Override public Collection getConfiguredTypes() { return decorated.getConfiguredTypes(); @@ -99,33 +81,17 @@ public class RepositoryManagerDecorator return decorated; } - /** - * {@inheritDoc} - * - * @param type - * @return - */ @Override @SuppressWarnings("unchecked") public RepositoryHandler getHandler(String type) { return decorated.getHandler(type); } - /** - * {@inheritDoc} - * - * @return - */ @Override public Collection getTypes() { return decorated.getTypes(); } - /** - * {@inheritDoc} - * - * @return - */ @Override public Repository rename(Repository repository, String newNamespace, String newName) { return decorated.rename(repository, newNamespace, newName); @@ -146,10 +112,4 @@ public class RepositoryManagerDecorator decorated.unarchive(repository); } - //~--- fields --------------------------------------------------------------- - - /** - * Field description - */ - private final RepositoryManager decorated; } diff --git a/scm-core/src/main/java/sonia/scm/repository/RepositoryManagerDecoratorFactory.java b/scm-core/src/main/java/sonia/scm/repository/RepositoryManagerDecoratorFactory.java index 584e5049a5..2ef5203307 100644 --- a/scm-core/src/main/java/sonia/scm/repository/RepositoryManagerDecoratorFactory.java +++ b/scm-core/src/main/java/sonia/scm/repository/RepositoryManagerDecoratorFactory.java @@ -24,7 +24,6 @@ package sonia.scm.repository; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.DecoratorFactory; import sonia.scm.plugin.ExtensionPoint; @@ -32,7 +31,6 @@ import sonia.scm.plugin.ExtensionPoint; /** * Factory for repository manager decorators. * - * @author Sebastian Sdorra * @since 1.23 */ @ExtensionPoint diff --git a/scm-core/src/main/java/sonia/scm/repository/RepositoryModificationEvent.java b/scm-core/src/main/java/sonia/scm/repository/RepositoryModificationEvent.java index 8b199622d4..6dd51cc2fc 100644 --- a/scm-core/src/main/java/sonia/scm/repository/RepositoryModificationEvent.java +++ b/scm-core/src/main/java/sonia/scm/repository/RepositoryModificationEvent.java @@ -31,7 +31,6 @@ import sonia.scm.event.Event; /** * Event which is fired whenever a repository is modified. * - * @author Sebastian Sdorra * @since 1.48 */ @Event diff --git a/scm-core/src/main/java/sonia/scm/repository/RepositoryPathMatcher.java b/scm-core/src/main/java/sonia/scm/repository/RepositoryPathMatcher.java index 5782f7ae92..a5d14f8f01 100644 --- a/scm-core/src/main/java/sonia/scm/repository/RepositoryPathMatcher.java +++ b/scm-core/src/main/java/sonia/scm/repository/RepositoryPathMatcher.java @@ -29,7 +29,6 @@ import sonia.scm.plugin.ExtensionPoint; /** * ExtensionPoint to modify the path matching behaviour for a certain type of repositories. * - * @author Sebastian Sdorra * @since 1.54 */ @ExtensionPoint @@ -47,8 +46,6 @@ public interface RepositoryPathMatcher { /** * Returns the type of repository for which the matcher is responsible. - * - * @return type of repository */ String getType(); } diff --git a/scm-core/src/main/java/sonia/scm/repository/RepositoryPermission.java b/scm-core/src/main/java/sonia/scm/repository/RepositoryPermission.java index afccec2dd8..ff663f87b3 100644 --- a/scm-core/src/main/java/sonia/scm/repository/RepositoryPermission.java +++ b/scm-core/src/main/java/sonia/scm/repository/RepositoryPermission.java @@ -24,7 +24,6 @@ package sonia.scm.repository; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.MoreObjects; import com.google.common.base.Objects; @@ -45,14 +44,11 @@ import static java.util.Collections.emptyList; import static java.util.Collections.emptySet; import static java.util.Collections.unmodifiableSet; -//~--- JDK imports ------------------------------------------------------------ - /** * Permissions controls the access to {@link Repository}. * This object should be immutable, but could not be due to mapstruct. Do not modify instances of this because this * would change the hash code and therefor make it undeletable in a repository. * - * @author Sebastian Sdorra */ @XmlRootElement(name = "permissions") @XmlAccessorType(XmlAccessType.FIELD) @@ -93,7 +89,6 @@ public class RepositoryPermission implements PermissionObject, Serializable this.groupPermission = groupPermission; } - //~--- methods -------------------------------------------------------------- /** * Returns true if the {@link RepositoryPermission} is the same as the obj argument. @@ -131,9 +126,6 @@ public class RepositoryPermission implements PermissionObject, Serializable /** * Returns the hash code value for the {@link RepositoryPermission}. - * - * - * @return the hash code value for the {@link RepositoryPermission} */ @Override public int hashCode() @@ -157,13 +149,9 @@ public class RepositoryPermission implements PermissionObject, Serializable //J+ } - //~--- get methods ---------------------------------------------------------- /** * Returns the name of the user or group. - * - * - * @return name of the user or group */ @Override public String getName() @@ -173,9 +161,6 @@ public class RepositoryPermission implements PermissionObject, Serializable /** * Returns the verb of the permission. - * - * - * @return verb of the permission */ public Collection getVerbs() { @@ -184,27 +169,17 @@ public class RepositoryPermission implements PermissionObject, Serializable /** * Returns the role of the permission. - * - * - * @return role of the permission */ public String getRole() { return role; } - /** - * Returns true if the permission is a permission which affects a group. - * - * - * @return true if the permision is a group permission - */ @Override public boolean isGroupPermission() { return groupPermission; } - //~--- set methods ---------------------------------------------------------- /** * Use this for creation only. This will throw an {@link IllegalStateException} when modified. diff --git a/scm-core/src/main/java/sonia/scm/repository/RepositoryPredicate.java b/scm-core/src/main/java/sonia/scm/repository/RepositoryPredicate.java index 42edbd50e6..4b462c5845 100644 --- a/scm-core/src/main/java/sonia/scm/repository/RepositoryPredicate.java +++ b/scm-core/src/main/java/sonia/scm/repository/RepositoryPredicate.java @@ -24,70 +24,41 @@ package sonia.scm.repository; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Predicate; /** * - * @author Sebastian Sdorra * @since 1.9 * */ public class RepositoryPredicate implements Predicate { - - /** - * Constructs ... - * - * - * @param repository - */ + private final String repositoryId; + public RepositoryPredicate(Repository repository) { this(repository.getId()); } - /** - * Constructs ... - * - * - * @param event - */ + public RepositoryPredicate(RepositoryHookEvent event) { this(event.getRepository()); } - /** - * Constructs ... - * - * - * @param repositoryId - */ + public RepositoryPredicate(String repositoryId) { this.repositoryId = repositoryId; } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param key - * - * @return - */ + @Override public boolean apply(RepositoryCacheKey key) { return repositoryId.equals(key.getRepositoryId()); } - //~--- fields --------------------------------------------------------------- - - /** repository id */ - private final String repositoryId; } diff --git a/scm-core/src/main/java/sonia/scm/repository/RepositoryProvider.java b/scm-core/src/main/java/sonia/scm/repository/RepositoryProvider.java index dad764eeed..d3e7fe8c8c 100644 --- a/scm-core/src/main/java/sonia/scm/repository/RepositoryProvider.java +++ b/scm-core/src/main/java/sonia/scm/repository/RepositoryProvider.java @@ -24,13 +24,11 @@ package sonia.scm.repository; -//~--- non-JDK imports -------------------------------------------------------- import com.google.inject.throwingproviders.CheckedProvider; /** * - * @author Sebastian Sdorra * @since 1.10 */ public interface RepositoryProvider extends CheckedProvider { diff --git a/scm-core/src/main/java/sonia/scm/repository/RepositoryRequestListener.java b/scm-core/src/main/java/sonia/scm/repository/RepositoryRequestListener.java index c2929d4044..0d99d1c77e 100644 --- a/scm-core/src/main/java/sonia/scm/repository/RepositoryRequestListener.java +++ b/scm-core/src/main/java/sonia/scm/repository/RepositoryRequestListener.java @@ -24,7 +24,6 @@ package sonia.scm.repository; -//~--- non-JDK imports -------------------------------------------------------- import jakarta.servlet.http.HttpServletRequest; import jakarta.servlet.http.HttpServletResponse; @@ -32,15 +31,12 @@ import sonia.scm.plugin.ExtensionPoint; import java.io.IOException; -//~--- JDK imports ------------------------------------------------------------ - /** * Listener before a repository request is executed. Repository request are * request to a repository from a client like git, mercurial or svn. * * TODO replace with event bus implementation. * - * @author Sebastian Sdorra * @since 1.10 */ @ExtensionPoint diff --git a/scm-core/src/main/java/sonia/scm/repository/RepositoryRequestListenerUtil.java b/scm-core/src/main/java/sonia/scm/repository/RepositoryRequestListenerUtil.java index 700a22c694..bc456f59ea 100644 --- a/scm-core/src/main/java/sonia/scm/repository/RepositoryRequestListenerUtil.java +++ b/scm-core/src/main/java/sonia/scm/repository/RepositoryRequestListenerUtil.java @@ -24,7 +24,6 @@ package sonia.scm.repository; -//~--- non-JDK imports -------------------------------------------------------- import com.google.inject.Inject; import com.google.inject.Singleton; @@ -38,25 +37,17 @@ import java.util.Set; /** * - * @author Sebastian Sdorra * @since 1.10 */ @Singleton public class RepositoryRequestListenerUtil { - /** the logger for RepositoryRequestListenerUtil */ private static final Logger logger = LoggerFactory.getLogger(RepositoryRequestListenerUtil.class); - //~--- constructors --------------------------------------------------------- - - /** - * Constructs ... - * - * - * @param listenerSet - */ + private Set listenerSet; + @Inject public RepositoryRequestListenerUtil( Set listenerSet) @@ -64,18 +55,7 @@ public class RepositoryRequestListenerUtil this.listenerSet = listenerSet; } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param request - * @param response - * @param repository - * - * @return - */ public boolean callListeners(HttpServletRequest request, HttpServletResponse response, Repository repository) @@ -120,8 +100,4 @@ public class RepositoryRequestListenerUtil return process; } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private Set listenerSet; } diff --git a/scm-core/src/main/java/sonia/scm/repository/RepositoryRole.java b/scm-core/src/main/java/sonia/scm/repository/RepositoryRole.java index 0e97edb316..c00b55c282 100644 --- a/scm-core/src/main/java/sonia/scm/repository/RepositoryRole.java +++ b/scm-core/src/main/java/sonia/scm/repository/RepositoryRole.java @@ -83,14 +83,6 @@ public class RepositoryRole implements ModelObject, PermissionObject, AuditLogEn this.type = type; } - /** - * Returns true if the {@link RepositoryRole} is the same as the obj argument. - * - * - * @param obj the reference object with which to compare - * - * @return true if the {@link RepositoryRole} is the same as the obj argument - */ @Override public boolean equals(Object obj) { if (obj == null) { @@ -110,9 +102,6 @@ public class RepositoryRole implements ModelObject, PermissionObject, AuditLogEn /** * Returns the hash code value for the {@link RepositoryRole}. - * - * - * @return the hash code value for the {@link RepositoryRole} */ @Override public int hashCode() diff --git a/scm-core/src/main/java/sonia/scm/repository/RepositoryType.java b/scm-core/src/main/java/sonia/scm/repository/RepositoryType.java index 7a44e09bfd..c7a4f5b4d2 100644 --- a/scm-core/src/main/java/sonia/scm/repository/RepositoryType.java +++ b/scm-core/src/main/java/sonia/scm/repository/RepositoryType.java @@ -21,32 +21,29 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ - + package sonia.scm.repository; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.Type; import sonia.scm.repository.api.Command; -//~--- JDK imports ------------------------------------------------------------ - import java.util.Collections; import java.util.Set; /** * The type (mercurial, subversion, git) of a {@link Repository}. * - * @author Sebastian Sdorra * @since 1.18 */ public class RepositoryType extends Type { + private Set supportedCommands; + + private Set supportedFeatures; /** - * Constructs {@link RepositoryType} object. * This constructor is required for JAXB. - * */ public RepositoryType() {} @@ -84,13 +81,9 @@ public class RepositoryType extends Type this.supportedFeatures = supportedFeatures; } - //~--- get methods ---------------------------------------------------------- /** * Returns a set of commands, which are supported by the repository type. - * - * - * @return set of supported commands */ public Set getSupportedCommands() { @@ -99,9 +92,6 @@ public class RepositoryType extends Type /** * Returns a set of features, which are supported by the repository type. - * - * - * @return set of supported features * @since 1.25 */ public Set getSupportedFeatures() @@ -109,11 +99,4 @@ public class RepositoryType extends Type return supportedFeatures; } - //~--- fields --------------------------------------------------------------- - - /** set of supported commands */ - private Set supportedCommands; - - /** set of supported features */ - private Set supportedFeatures; } diff --git a/scm-core/src/main/java/sonia/scm/repository/RepositoryTypePredicate.java b/scm-core/src/main/java/sonia/scm/repository/RepositoryTypePredicate.java index b9f04d60b2..3cabf43152 100644 --- a/scm-core/src/main/java/sonia/scm/repository/RepositoryTypePredicate.java +++ b/scm-core/src/main/java/sonia/scm/repository/RepositoryTypePredicate.java @@ -24,39 +24,29 @@ package sonia.scm.repository; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Predicate; /** * Used to filter collections of repositories by its type. * - * @author Sebastian Sdorra * @since 1.16 */ public class RepositoryTypePredicate implements Predicate { + /** type to filter */ + private String type; - /** - * Constructs new {@link RepositoryTypePredicate} object. - * - * - * @param type type to filter - */ public RepositoryTypePredicate(String type) { this.type = type; } - //~--- methods -------------------------------------------------------------- /** * Return true if the repository is from the given type. * - * * @param repository repository to check - * - * @return true if the repository is from the given type */ @Override public boolean apply(Repository repository) @@ -64,8 +54,4 @@ public class RepositoryTypePredicate implements Predicate return type.equalsIgnoreCase(repository.getType()); } - //~--- fields --------------------------------------------------------------- - - /** type to filter */ - private String type; } diff --git a/scm-core/src/main/java/sonia/scm/repository/Tag.java b/scm-core/src/main/java/sonia/scm/repository/Tag.java index 933faa403d..b608024caa 100644 --- a/scm-core/src/main/java/sonia/scm/repository/Tag.java +++ b/scm-core/src/main/java/sonia/scm/repository/Tag.java @@ -36,7 +36,6 @@ import java.util.regex.Pattern; /** * Represents a tag in a repository. * - * @author Sebastian Sdorra * @since 1.18 */ @EqualsAndHashCode @@ -53,12 +52,6 @@ public final class Tag { private final List signatures = new ArrayList<>(); private final Boolean deletable; - /** - * Constructs a new tag. - * - * @param name name of the tag - * @param revision tagged revision - */ public Tag(String name, String revision) { this(name, revision, null); } diff --git a/scm-core/src/main/java/sonia/scm/repository/Tags.java b/scm-core/src/main/java/sonia/scm/repository/Tags.java index d1be764c20..8642217694 100644 --- a/scm-core/src/main/java/sonia/scm/repository/Tags.java +++ b/scm-core/src/main/java/sonia/scm/repository/Tags.java @@ -35,7 +35,6 @@ import java.util.List; /** * Represents all tags of a repository. * - * @author Sebastian Sdorra * @since 1.18 */ @EqualsAndHashCode @@ -59,9 +58,6 @@ public final class Tags implements Iterable { /** * Returns the {@link Tag} with the given name or null. - * - * @param name name of the tag - * @return {@link Tag} with the given name or null */ public Tag getTagByName(String name) { Tag tag = null; @@ -79,9 +75,6 @@ public final class Tags implements Iterable { /** * Returns the {@link Tag} with the given revision or null. - * - * @param revision revision of the tag - * @return {@link Tag} with the given revision or null */ public Tag getTagByRevision(String revision) { Tag tag = null; @@ -99,8 +92,6 @@ public final class Tags implements Iterable { /** * Returns all tags of a repository. - * - * @return all tags */ public List getTags() { if (tags == null) { diff --git a/scm-core/src/main/java/sonia/scm/repository/WrappedRepositoryHookEvent.java b/scm-core/src/main/java/sonia/scm/repository/WrappedRepositoryHookEvent.java index ee615a62ea..51e9cf333b 100644 --- a/scm-core/src/main/java/sonia/scm/repository/WrappedRepositoryHookEvent.java +++ b/scm-core/src/main/java/sonia/scm/repository/WrappedRepositoryHookEvent.java @@ -27,29 +27,15 @@ package sonia.scm.repository; /** * Base class for {@link RepositoryHookEvent} wrappers. * - * @author Sebastian Sdorra * @since 1.23 */ public class WrappedRepositoryHookEvent extends RepositoryHookEvent { - /** - * Constructs a new WrappedRepositoryHookEvent. - * - * @param wrappedEvent event to wrap - */ protected WrappedRepositoryHookEvent(RepositoryHookEvent wrappedEvent) { super(wrappedEvent.getContext(), wrappedEvent.getRepository(), wrappedEvent.getType()); } - //~--- methods -------------------------------------------------------------- - - /** - * Returns a wrapped instance of the {@link RepositoryHookEvent}- - * - * @param event event to wrap - * @return wrapper - */ public static WrappedRepositoryHookEvent wrap(RepositoryHookEvent event) { WrappedRepositoryHookEvent wrappedEvent = null; diff --git a/scm-core/src/main/java/sonia/scm/repository/api/AbstractBundleOrUnbundleCommandResponse.java b/scm-core/src/main/java/sonia/scm/repository/api/AbstractBundleOrUnbundleCommandResponse.java index c86ff5078a..e4b2a1f96e 100644 --- a/scm-core/src/main/java/sonia/scm/repository/api/AbstractBundleOrUnbundleCommandResponse.java +++ b/scm-core/src/main/java/sonia/scm/repository/api/AbstractBundleOrUnbundleCommandResponse.java @@ -24,35 +24,24 @@ package sonia.scm.repository.api; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.MoreObjects; import com.google.common.base.Objects; /** * Abstract class for bundle or unbundle command. * - * @author Sebastian Sdorra * @since 1.43 */ public abstract class AbstractBundleOrUnbundleCommandResponse { + /** count of bundled/unbundled changesets */ + private final long changesetCount; - /** - * Constructs a new bundle/unbundle response. - * - * - * @param changesetCount count of bundled/unbundled changesets - */ protected AbstractBundleOrUnbundleCommandResponse(long changesetCount) { this.changesetCount = changesetCount; } - //~--- methods -------------------------------------------------------------- - - /** - * {@inheritDoc} - */ @Override public boolean equals(Object obj) { @@ -72,18 +61,14 @@ public abstract class AbstractBundleOrUnbundleCommandResponse return Objects.equal(changesetCount, other.changesetCount); } - /** - * {@inheritDoc} - */ + @Override public int hashCode() { return Objects.hashCode(changesetCount); } - /** - * {@inheritDoc} - */ + @Override public String toString() { @@ -94,21 +79,13 @@ public abstract class AbstractBundleOrUnbundleCommandResponse //J+ } - //~--- get methods ---------------------------------------------------------- /** * Returns the count of bundled/unbundled changesets. - * - * - * @return count of bundled/unbundled changesets */ public long getChangesetCount() { return changesetCount; } - //~--- fields --------------------------------------------------------------- - - /** count of bundled/unbundled changesets */ - private final long changesetCount; } diff --git a/scm-core/src/main/java/sonia/scm/repository/api/AbstractPushOrPullResponse.java b/scm-core/src/main/java/sonia/scm/repository/api/AbstractPushOrPullResponse.java index 7162838506..cf930ac56b 100644 --- a/scm-core/src/main/java/sonia/scm/repository/api/AbstractPushOrPullResponse.java +++ b/scm-core/src/main/java/sonia/scm/repository/api/AbstractPushOrPullResponse.java @@ -24,8 +24,6 @@ package sonia.scm.repository.api; -//~--- JDK imports ------------------------------------------------------------ - import jakarta.xml.bind.annotation.XmlAccessType; import jakarta.xml.bind.annotation.XmlAccessorType; import jakarta.xml.bind.annotation.XmlElement; @@ -33,45 +31,28 @@ import jakarta.xml.bind.annotation.XmlElement; /** * Abstract base class for {@link PushResponse} and {@link PullResponse}. * - * @author Sebastian Sdorra * @since 1.31 */ @XmlAccessorType(XmlAccessType.FIELD) public abstract class AbstractPushOrPullResponse { + /** count of pushed/pulled changesets */ + @XmlElement(name = "changeset-count") + private long changesetCount; - /** - * Constructs a new AbstractPushOrPullResponse. - * - */ public AbstractPushOrPullResponse() {} - /** - * Constructs a new AbstractPushOrPullResponse. - * - * @param changesetCount count of pushed/pulled changesets - */ public AbstractPushOrPullResponse(long changesetCount) { this.changesetCount = changesetCount; } - //~--- get methods ---------------------------------------------------------- - /** * Returns the count of pushed/pulled changesets. - * - * - * @return count of pushed/pulled changesets */ public long getChangesetCount() { return changesetCount; } - //~--- fields --------------------------------------------------------------- - - /** count of pushed/pulled changesets */ - @XmlElement(name = "changeset-count") - private long changesetCount; } diff --git a/scm-core/src/main/java/sonia/scm/repository/api/BlameCommandBuilder.java b/scm-core/src/main/java/sonia/scm/repository/api/BlameCommandBuilder.java index e6625fd432..28446db325 100644 --- a/scm-core/src/main/java/sonia/scm/repository/api/BlameCommandBuilder.java +++ b/scm-core/src/main/java/sonia/scm/repository/api/BlameCommandBuilder.java @@ -24,7 +24,6 @@ package sonia.scm.repository.api; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Objects; import com.google.common.base.Preconditions; @@ -43,8 +42,6 @@ import sonia.scm.repository.spi.BlameCommandRequest; import java.io.IOException; import java.io.Serializable; -//~--- JDK imports ------------------------------------------------------------ - /** * Shows changeset information by line for a given file. * Blame is also known as annotate in some SCM systems.
@@ -64,22 +61,30 @@ import java.io.Serializable; * } * * - * @author Sebastian Sdorra * @since 1.17 */ public final class BlameCommandBuilder { - /** name of the cache */ static final String CACHE_NAME = "sonia.cache.cmd.blame"; - /** - * the logger for BlameCommandBuilder - */ + private static final Logger logger = LoggerFactory.getLogger(BlameCommandBuilder.class); - //~--- constructors --------------------------------------------------------- + private final BlameCommand blameCommand; + + private final Cache cache; + + private boolean disableCache = false; + + private boolean disablePreProcessors = false; + + private final PreProcessorUtil preProcessorUtil; + + private final Repository repository; + + private final BlameCommandRequest request = new BlameCommandRequest(); /** * Constructs a new {@link BlameCommandBuilder}, this constructor should @@ -99,7 +104,6 @@ public final class BlameCommandBuilder this.preProcessorUtil = preProcessorUtil; } - //~--- methods -------------------------------------------------------------- /** * Reset each parameter to its default value. @@ -115,13 +119,12 @@ public final class BlameCommandBuilder return this; } - //~--- get methods ---------------------------------------------------------- /** - * Returns changeset informations by line for the given file. + * Returns changeset information by line for the given file. * * @param path path of the file - * @return changeset informations by line for the given file + * @return changeset information by line for the given file * * @throws IllegalArgumentException if the path is null or empty * @@ -182,7 +185,6 @@ public final class BlameCommandBuilder return result; } - //~--- set methods ---------------------------------------------------------- /** * Disables the cache. This means that every {@link BlameResult} @@ -202,7 +204,7 @@ public final class BlameCommandBuilder } /** - * Disable the execution of pre processors. + * Disable the execution of pre-processors. * * * @param disablePreProcessors true to disable the pre processors execution @@ -232,46 +234,24 @@ public final class BlameCommandBuilder return this; } - //~--- inner classes -------------------------------------------------------- - - /** - * Key for cache. - * - * - * @version Enter version here..., 12/06/05 - * @author Enter your name here... - */ static class CacheKey implements RepositoryCacheKey, Serializable { - /** Field description */ - private static final long serialVersionUID = 8373766042131887789L; + private static final long serialVersionUID = 8373766042131887789L; - //~--- constructors ------------------------------------------------------- + private final String repositoryId; + + private final BlameCommandRequest request; - /** - * Constructs ... - * - * - * @param repository - * @param request - */ public CacheKey(Repository repository, BlameCommandRequest request) { this.repositoryId = repository.getId(); this.request = request; } - //~--- methods ------------------------------------------------------------ + - /** - * Method description - * - * - * @param obj - * - * @return - */ + @Override public boolean equals(Object obj) { @@ -291,62 +271,19 @@ public final class BlameCommandBuilder && Objects.equal(request, other.request); } - /** - * Method description - * - * - * @return - */ + @Override public int hashCode() { return Objects.hashCode(repositoryId, request); } - //~--- get methods -------------------------------------------------------- - - /** - * Method description - * - * - * @return - */ @Override public String getRepositoryId() { return repositoryId; } - //~--- fields ------------------------------------------------------------- - - /** repository id */ - private final String repositoryId; - - /** request object */ - private final BlameCommandRequest request; } - - //~--- fields --------------------------------------------------------------- - - /** implementation of the blame command */ - private final BlameCommand blameCommand; - - /** the cache */ - private final Cache cache; - - /** disable change */ - private boolean disableCache = false; - - /** disable the execution of pre processors */ - private boolean disablePreProcessors = false; - - /** Field description */ - private final PreProcessorUtil preProcessorUtil; - - /** the repository */ - private final Repository repository; - - /** request for the blame command implementation */ - private final BlameCommandRequest request = new BlameCommandRequest(); } diff --git a/scm-core/src/main/java/sonia/scm/repository/api/BranchesCommandBuilder.java b/scm-core/src/main/java/sonia/scm/repository/api/BranchesCommandBuilder.java index c6f3719f57..d267cf0dc1 100644 --- a/scm-core/src/main/java/sonia/scm/repository/api/BranchesCommandBuilder.java +++ b/scm-core/src/main/java/sonia/scm/repository/api/BranchesCommandBuilder.java @@ -49,22 +49,26 @@ import java.io.IOException; * BranchesCommandBuilder branchesCommand = repositoryService.getBranchesCommand(); * Branches branches = tagsCommand.getBranches(); * - * @author Sebastian Sdorra * @since 1.18 */ public final class BranchesCommandBuilder { - /** name of the cache */ static final String CACHE_NAME = "sonia.cache.cmd.branches"; - /** - * the logger for BranchesCommandBuilder - */ + /** branches command implementation */ + private final BranchesCommand branchesCommand; + + /** cache for branches */ + private final Cache cache; + + private boolean disableCache = false; + + private final Repository repository; + private static final Logger logger = LoggerFactory.getLogger(BranchesCommandBuilder.class); - //~--- constructors --------------------------------------------------------- /** * Constructs a new {@link BlameCommandBuilder}, this constructor should @@ -82,7 +86,6 @@ public final class BranchesCommandBuilder this.repository = repository; } - //~--- get methods ---------------------------------------------------------- /** * Returns all branches from the repository. @@ -131,12 +134,11 @@ public final class BranchesCommandBuilder return branches; } - //~--- set methods ---------------------------------------------------------- /** * Disables the cache for tags. This means that every {@link Branch} * is directly retrieved from the {@link Repository}. Note: Disabling - * the cache cost a lot of performance and could be much more slower. + * the cache cost a lot of performance and could be much slower. * * * @param disableCache true to disable the cache @@ -150,55 +152,29 @@ public final class BranchesCommandBuilder return this; } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - * - * @throws IOException - */ + private Branches getBranchesFromCommand() throws IOException { return new Branches(branchesCommand.getBranchesWithStaleFlags(new BranchXDaysOlderThanDefaultStaleComputer())); } - //~--- inner classes -------------------------------------------------------- + /** * Key for caching branches; - * - * - * @version Enter version here..., 12/07/05 - * @author Enter your name here... */ static class CacheKey implements RepositoryCacheKey { - - /** - * Constructs ... - * - * - * @param repository - */ + private final String repositoryId; + public CacheKey(Repository repository) { this.repositoryId = repository.getId(); } - //~--- methods ------------------------------------------------------------ - /** - * Method description - * - * - * @param obj - * - * @return - */ @Override public boolean equals(Object obj) { @@ -217,50 +193,19 @@ public final class BranchesCommandBuilder return Objects.equal(repositoryId, other.repositoryId); } - /** - * Method description - * - * - * @return - */ + @Override public int hashCode() { return Objects.hashCode(repositoryId); } - //~--- get methods -------------------------------------------------------- - - /** - * Method description - * - * - * @return - */ + @Override public String getRepositoryId() { return repositoryId; } - - //~--- fields ------------------------------------------------------------- - - /** repository id */ - private final String repositoryId; } - - //~--- fields --------------------------------------------------------------- - - /** branches command implementation */ - private final BranchesCommand branchesCommand; - - /** cache for branches */ - private final Cache cache; - - /** disable cache */ - private boolean disableCache = false; - - /** repository */ - private final Repository repository; } diff --git a/scm-core/src/main/java/sonia/scm/repository/api/BrowseCommandBuilder.java b/scm-core/src/main/java/sonia/scm/repository/api/BrowseCommandBuilder.java index 30b5a3f60f..4df128a410 100644 --- a/scm-core/src/main/java/sonia/scm/repository/api/BrowseCommandBuilder.java +++ b/scm-core/src/main/java/sonia/scm/repository/api/BrowseCommandBuilder.java @@ -24,7 +24,6 @@ package sonia.scm.repository.api; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Objects; import org.slf4j.Logger; @@ -43,8 +42,6 @@ import java.io.IOException; import java.io.Serializable; import java.util.function.Supplier; -//~--- JDK imports ------------------------------------------------------------ - /** * BrowseCommandBuilder is able to browse the files of a {@link Repository}. *

@@ -63,22 +60,31 @@ import java.util.function.Supplier; * } * * - * @author Sebastian Sdorra * @since 1.17 */ public final class BrowseCommandBuilder { - /** Name of the cache */ static final String CACHE_NAME = "sonia.cache.cmd.browse"; - /** - * the logger for BrowseCommandBuilder - */ + private static final Logger logger = LoggerFactory.getLogger(BrowseCommandBuilder.class); - //~--- constructors --------------------------------------------------------- + private final BrowseCommand browseCommand; + + private final Cache cache; + + private boolean disableCache = false; + + private boolean disablePreProcessors = false; + + private final PreProcessorUtil preProcessorUtil; + private final Supplier browseCommandFactory; + + private final Repository repository; + + private final BrowseCommandRequest request = new BrowseCommandRequest(this::updateCache); /** * Constructs a new {@link BrowseCommandBuilder}, this constructor should @@ -100,7 +106,6 @@ public final class BrowseCommandBuilder this.browseCommandFactory = browseCommandFactory; } - //~--- methods -------------------------------------------------------------- /** * Reset each parameter to its default value. @@ -117,14 +122,10 @@ public final class BrowseCommandBuilder return this; } - //~--- get methods ---------------------------------------------------------- /** * Return the files for the given parameters. * - * - * @return files for the given parameters - * * @throws IOException */ public BrowserResult getBrowserResult() throws IOException { @@ -182,7 +183,6 @@ public final class BrowseCommandBuilder return result; } - //~--- set methods ---------------------------------------------------------- /** * Disables the cache. This means that every {@link BrowserResult} @@ -222,10 +222,7 @@ public final class BrowseCommandBuilder } /** - * Disable the execution of pre processors. - * - * - * @param disablePreProcessors true to disable the pre processors execution + * Disable the execution of pre processors if set to true. * * @return {@code this} */ @@ -302,7 +299,7 @@ public final class BrowseCommandBuilder } /** - * Limit the number of result files to limit entries. By default this is set to + * Limit the number of result files to limit entries. By default, this is set to * {@value BrowseCommandRequest#DEFAULT_REQUEST_LIMIT}. Be aware that this parameter can have * severe performance implications. Reading a repository with thousands of files in one folder * can generate a huge load for a longer time. @@ -321,7 +318,7 @@ public final class BrowseCommandBuilder * * @param offset The number of the file, the result should start with (zero based). * All preceding files will be omitted. Directories are not - * counted. Therefore directories are only listed in results without + * counted. Therefore, directories are only listed in results without * offset. * @since 2.0.0 */ @@ -349,46 +346,27 @@ public final class BrowseCommandBuilder } } - //~--- inner classes -------------------------------------------------------- - /** - * Key for cache. - * - * - * @version Enter version here..., 12/06/05 - * @author Enter your name here... - */ static class CacheKey implements RepositoryCacheKey, Serializable { - /** Field description */ - private static final long serialVersionUID = 8078650026812373524L; + private static final long serialVersionUID = 8078650026812373524L; + + + private final String repositoryId; + + private final BrowseCommandRequest request; - //~--- constructors ------------------------------------------------------- - /** - * Constructs ... - * - * - * @param repository - * @param request - */ public CacheKey(Repository repository, BrowseCommandRequest request) { this.repositoryId = repository.getId(); this.request = request.clone(); } - //~--- methods ------------------------------------------------------------ - /** - * Method description - * - * - * @param obj - * - * @return - */ + + @Override public boolean equals(Object obj) { @@ -408,63 +386,22 @@ public final class BrowseCommandBuilder && Objects.equal(request, other.request); } - /** - * Method description - * - * - * @return - */ + @Override public int hashCode() { return Objects.hashCode(repositoryId, request); } - //~--- get methods -------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + + @Override public String getRepositoryId() { return repositoryId; } - //~--- fields ------------------------------------------------------------- - - /** repository id */ - private final String repositoryId; - - /** request object */ - private final BrowseCommandRequest request; } - - //~--- fields --------------------------------------------------------------- - - /** implementation of the browse command */ - private final BrowseCommand browseCommand; - - /** cache */ - private final Cache cache; - - /** disables the cache */ - private boolean disableCache = false; - - /** disables the execution of pre processors */ - private boolean disablePreProcessors = false; - - /** Field description */ - private final PreProcessorUtil preProcessorUtil; - private final Supplier browseCommandFactory; - - /** the repsitory */ - private final Repository repository; - - /** request for the command */ - private final BrowseCommandRequest request = new BrowseCommandRequest(this::updateCache); } diff --git a/scm-core/src/main/java/sonia/scm/repository/api/BundleCommandBuilder.java b/scm-core/src/main/java/sonia/scm/repository/api/BundleCommandBuilder.java index fa3997e32c..6f998dab37 100644 --- a/scm-core/src/main/java/sonia/scm/repository/api/BundleCommandBuilder.java +++ b/scm-core/src/main/java/sonia/scm/repository/api/BundleCommandBuilder.java @@ -24,7 +24,6 @@ package sonia.scm.repository.api; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.io.ByteSink; import com.google.common.io.Files; @@ -43,39 +42,30 @@ import java.io.OutputStream; import static com.google.common.base.Preconditions.checkArgument; import static com.google.common.base.Preconditions.checkNotNull; -//~--- JDK imports ------------------------------------------------------------ - /** * The bundle command dumps a repository to a byte source such as a file. The * created bundle can be restored to an empty repository with the * {@link UnbundleCommandBuilder}. * - * @author Sebastian Sdorra * @since 1.43 */ public final class BundleCommandBuilder { - /** - * logger for BundleCommandBuilder - */ private static final Logger logger = LoggerFactory.getLogger(BundleCommandBuilder.class); - //~--- constructors --------------------------------------------------------- + private final BundleCommand bundleCommand; + + private final Repository repository; + + private final RepositoryExportingCheck repositoryExportingCheck; - /** - * Constructs a new {@link BundleCommandBuilder}. - * @param bundleCommand bundle command implementation - * @param repositoryExportingCheck - * @param repository repository - */ BundleCommandBuilder(BundleCommand bundleCommand, RepositoryExportingCheck repositoryExportingCheck, Repository repository) { this.bundleCommand = bundleCommand; this.repositoryExportingCheck = repositoryExportingCheck; this.repository = repository; } - //~--- methods -------------------------------------------------------------- /** * Dumps the repository to the given {@link File}. @@ -137,8 +127,6 @@ public final class BundleCommandBuilder { /** * Checks for the file extension of the bundled repository - * - * @return the file extension of the bundle */ public String getFileExtension() { return bundleCommand.getFileExtension(); @@ -160,17 +148,4 @@ public final class BundleCommandBuilder { }; } - //~--- fields --------------------------------------------------------------- - - /** - * bundle command implementation - */ - private final BundleCommand bundleCommand; - - /** - * repository - */ - private final Repository repository; - - private final RepositoryExportingCheck repositoryExportingCheck; } diff --git a/scm-core/src/main/java/sonia/scm/repository/api/BundleResponse.java b/scm-core/src/main/java/sonia/scm/repository/api/BundleResponse.java index ace1954add..6957dda004 100644 --- a/scm-core/src/main/java/sonia/scm/repository/api/BundleResponse.java +++ b/scm-core/src/main/java/sonia/scm/repository/api/BundleResponse.java @@ -27,19 +27,12 @@ package sonia.scm.repository.api; /** * Response of bundle command. * - * @author Sebastian Sdorra * @since 1.43 */ public final class BundleResponse extends AbstractBundleOrUnbundleCommandResponse { - /** - * Constructs a new bundle response. - * - * - * @param changesetCount count of bundled changesets - */ public BundleResponse(long changesetCount) { super(changesetCount); diff --git a/scm-core/src/main/java/sonia/scm/repository/api/CatCommandBuilder.java b/scm-core/src/main/java/sonia/scm/repository/api/CatCommandBuilder.java index 09c8165c5e..994a88688e 100644 --- a/scm-core/src/main/java/sonia/scm/repository/api/CatCommandBuilder.java +++ b/scm-core/src/main/java/sonia/scm/repository/api/CatCommandBuilder.java @@ -21,7 +21,7 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ - + package sonia.scm.repository.api; import com.google.common.base.Preconditions; @@ -51,19 +51,16 @@ import java.io.OutputStream; * System.out.println(content); * * - * @author Sebastian Sdorra * @since 1.17 */ public final class CatCommandBuilder { - - /** - * the logger for CatCommandBuilder - */ private static final Logger logger = LoggerFactory.getLogger(CatCommandBuilder.class); - //~--- constructors --------------------------------------------------------- + private final CatCommand catCommand; + + private final CatCommandRequest request = new CatCommandRequest(); /** * Constructs a new {@link CatCommandBuilder}, this constructor should @@ -76,7 +73,6 @@ public final class CatCommandBuilder this.catCommand = catCommand; } - //~--- methods -------------------------------------------------------------- /** * Reset each parameter to its default value. @@ -118,15 +114,8 @@ public final class CatCommandBuilder return catCommand.getCatResultStream(requestClone); } - //~--- get methods ---------------------------------------------------------- - /** * Returns the content of the given file. - * - * @param path file path - * @return content of the file - * - * @throws IOException */ public String getContent(String path) throws IOException { String content = null; @@ -151,9 +140,6 @@ public final class CatCommandBuilder /** * Sets the revision of the file. * - * - * @param revision revision of the file - * * @return {@code this} */ public CatCommandBuilder setRevision(String revision) @@ -163,7 +149,6 @@ public final class CatCommandBuilder return this; } - //~--- get methods ---------------------------------------------------------- /** * Executes the cat command. @@ -192,11 +177,4 @@ public final class CatCommandBuilder catCommand.getCatResult(requestClone, outputStream); } - //~--- fields --------------------------------------------------------------- - - /** implementation of the cat command */ - private final CatCommand catCommand; - - /** request for the cat command */ - private final CatCommandRequest request = new CatCommandRequest(); } diff --git a/scm-core/src/main/java/sonia/scm/repository/api/Command.java b/scm-core/src/main/java/sonia/scm/repository/api/Command.java index 55a738be86..28ddff4658 100644 --- a/scm-core/src/main/java/sonia/scm/repository/api/Command.java +++ b/scm-core/src/main/java/sonia/scm/repository/api/Command.java @@ -27,7 +27,6 @@ package sonia.scm.repository.api; /** * Enumeration of available commands. * - * @author Sebastian Sdorra * @since 1.17 */ public enum Command diff --git a/scm-core/src/main/java/sonia/scm/repository/api/CommandNotSupportedException.java b/scm-core/src/main/java/sonia/scm/repository/api/CommandNotSupportedException.java index d36b74d28a..a6102a2e48 100644 --- a/scm-core/src/main/java/sonia/scm/repository/api/CommandNotSupportedException.java +++ b/scm-core/src/main/java/sonia/scm/repository/api/CommandNotSupportedException.java @@ -28,18 +28,13 @@ package sonia.scm.repository.api; * This exception is thrown if the {@link RepositoryService} does not support * the requested command. * - * @author Sebastian Sdorra * @since 1.17 */ public final class CommandNotSupportedException extends RuntimeException { + /** not supported command */ + private Command command; - /** - * Constructs a new {@link CommandNotSupportedException}. - * - * - * @param command not supported command - */ public CommandNotSupportedException(Command command) { //J- @@ -52,34 +47,19 @@ public final class CommandNotSupportedException extends RuntimeException //J+ } - /** - * Constructs a new {@link CommandNotSupportedException}. - * - * - * @param command not supported command - * @param message message to be shown - */ public CommandNotSupportedException(Command command, String message) { super(message); this.command = command; } - //~--- get methods ---------------------------------------------------------- /** * Returns the command which is not supported. - * - * - * @return not supported command */ public Command getCommand() { return command; } - //~--- fields --------------------------------------------------------------- - - /** not supported command */ - private Command command; } diff --git a/scm-core/src/main/java/sonia/scm/repository/api/DiffCommandBuilder.java b/scm-core/src/main/java/sonia/scm/repository/api/DiffCommandBuilder.java index 6418444689..5e4fb0717b 100644 --- a/scm-core/src/main/java/sonia/scm/repository/api/DiffCommandBuilder.java +++ b/scm-core/src/main/java/sonia/scm/repository/api/DiffCommandBuilder.java @@ -24,7 +24,6 @@ package sonia.scm.repository.api; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Preconditions; import org.slf4j.Logger; @@ -39,8 +38,6 @@ import java.io.OutputStream; import java.nio.charset.StandardCharsets; import java.util.Set; -//~--- JDK imports ------------------------------------------------------------ - /** * Shows differences between revisions for a specified file or * the entire revision.
@@ -56,22 +53,17 @@ import java.util.Set; * System.out.println(content); * * - * @author Sebastian Sdorra * @since 1.17 */ public final class DiffCommandBuilder extends AbstractDiffCommandBuilder { - /** - * the logger for DiffCommandBuilder - */ + private static final Logger logger = LoggerFactory.getLogger(DiffCommandBuilder.class); - /** implementation of the diff command */ private final DiffCommand diffCommand; - //~--- constructors --------------------------------------------------------- /** * Constructs a new {@link DiffCommandBuilder}, this constructor should @@ -86,7 +78,6 @@ public final class DiffCommandBuilder extends AbstractDiffCommandBuilderNote: If the repository provider does not support the - * diff format, it will fallback to its default format. + * diff format, it will fall back to its default format. * * * @param format format of the diff output @@ -141,15 +130,7 @@ public final class DiffCommandBuilder extends AbstractDiffCommandBuilderforce(true). + * Set the command to force unlock. Shortcut for force(true). * * @return This builder instance. * @see #force(boolean) diff --git a/scm-core/src/main/java/sonia/scm/repository/api/HookBranchProvider.java b/scm-core/src/main/java/sonia/scm/repository/api/HookBranchProvider.java index b0612914a2..be21e08fb4 100644 --- a/scm-core/src/main/java/sonia/scm/repository/api/HookBranchProvider.java +++ b/scm-core/src/main/java/sonia/scm/repository/api/HookBranchProvider.java @@ -24,15 +24,12 @@ package sonia.scm.repository.api; -//~--- JDK imports ------------------------------------------------------------ - import java.util.List; /** - * The HookBranchProvider returns informations about branch changes during the + * The HookBranchProvider returns information about branch changes during the * current hook. * - * @author Sebastian Sdorra * @since 1.45 */ public interface HookBranchProvider diff --git a/scm-core/src/main/java/sonia/scm/repository/api/HookChangesetBuilder.java b/scm-core/src/main/java/sonia/scm/repository/api/HookChangesetBuilder.java index e8aec2f958..cd05020b28 100644 --- a/scm-core/src/main/java/sonia/scm/repository/api/HookChangesetBuilder.java +++ b/scm-core/src/main/java/sonia/scm/repository/api/HookChangesetBuilder.java @@ -24,7 +24,6 @@ package sonia.scm.repository.api; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.collect.ImmutableList; import com.google.common.collect.Iterables; @@ -44,19 +43,23 @@ import java.util.List; * The {@link HookChangesetBuilder} is able to return all {@link Changeset}s * which are added during the current push/commit. * - * @author Sebastian Sdorra * @since 1.33 */ public final class HookChangesetBuilder { + private boolean disablePreProcessors = false; + + private PreProcessorUtil preProcessorUtil; + + private HookChangesetProvider provider; + + /** changed repository */ + private Repository repository; - /** request */ private static final HookChangesetRequest request = new HookChangesetRequest(); - /** - * the logger for HookChangesetBuilder - */ + private static final Logger logger = LoggerFactory.getLogger(HookChangesetBuilder.class); @@ -78,14 +81,13 @@ public final class HookChangesetBuilder this.preProcessorUtil = preProcessorUtil; } - //~--- get methods ---------------------------------------------------------- /** - * Returns a immutable {@link List} of added {@link Changeset}'s. + * Returns an immutable {@link List} of added {@link Changeset}'s. * Note: Use this method only if you need a {@link List}, if * you just want to iterate over the {@link Changeset}'s use * {@link #getChangesets()} instead. The {@link #getChangesets()} needs less - * memory and should be much more faster then this method. + * memory and should be much faster than this method. * * @return immutable {@link List} of added {@link Changeset}'s */ @@ -136,13 +138,9 @@ public final class HookChangesetBuilder }); } - //~--- set methods ---------------------------------------------------------- /** - * Disable the execution of pre processors. - * - * - * @param disablePreProcessors true to disable the pre processors execution + * Disable the execution of pre processors if set to true. * * @return {@code this} */ @@ -154,17 +152,4 @@ public final class HookChangesetBuilder return this; } - //~--- fields --------------------------------------------------------------- - - /** disable pre processors marker */ - private boolean disablePreProcessors = false; - - /** PreProcessorUtil */ - private PreProcessorUtil preProcessorUtil; - - /** provider implementation */ - private HookChangesetProvider provider; - - /** changed repository */ - private Repository repository; } diff --git a/scm-core/src/main/java/sonia/scm/repository/api/HookChangesetProvider.java b/scm-core/src/main/java/sonia/scm/repository/api/HookChangesetProvider.java index d271d43609..f25a6f6345 100644 --- a/scm-core/src/main/java/sonia/scm/repository/api/HookChangesetProvider.java +++ b/scm-core/src/main/java/sonia/scm/repository/api/HookChangesetProvider.java @@ -28,7 +28,6 @@ import sonia.scm.repository.spi.HookChangesetRequest; import sonia.scm.repository.spi.HookChangesetResponse; /** - * @author Sebastian Sdorra * @since 1.33 */ public interface HookChangesetProvider { diff --git a/scm-core/src/main/java/sonia/scm/repository/api/HookContext.java b/scm-core/src/main/java/sonia/scm/repository/api/HookContext.java index 43915f3e6d..32a2fb298d 100644 --- a/scm-core/src/main/java/sonia/scm/repository/api/HookContext.java +++ b/scm-core/src/main/java/sonia/scm/repository/api/HookContext.java @@ -24,7 +24,6 @@ package sonia.scm.repository.api; -//~--- non-JDK imports -------------------------------------------------------- import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -38,38 +37,33 @@ import sonia.scm.repository.spi.HookMergeDetectionProvider; /** * The context for all repository hooks. With the {@link HookContext} class it * is able to send messages back to the client, retrieve {@link Changeset}s - * which are added during this push/commit and gives informations about changed + * which are added during this push/commit and gives information about changed * branches and tags. * - * @author Sebastian Sdorra * @since 1.33 */ public final class HookContext { - /** - * the logger for HookContext - */ + private static final Logger logger = LoggerFactory.getLogger(HookContext.class); - /** - * Constructs ... - * - * - * @param provider - * @param repository - * @param preProcessorUtil - */ + private final PreProcessorUtil preProcessorUtil; + + private final HookContextProvider provider; + + private final Repository repository; + + HookContext(HookContextProvider provider, Repository repository, PreProcessorUtil preProcessorUtil) { this.provider = provider; this.repository = repository; this.preProcessorUtil = preProcessorUtil; } - //~--- get methods ---------------------------------------------------------- /** - * Returns a {@link HookBranchProvider} which is able to return informations + * Returns a {@link HookBranchProvider} which is able to return information * about changed branches during the current hook. * * @return {@link HookBranchProvider} @@ -185,14 +179,4 @@ public final class HookContext { return provider.getSupportedFeatures().contains(feature); } - //~--- fields --------------------------------------------------------------- - - /** pre processor util */ - private final PreProcessorUtil preProcessorUtil; - - /** hook context provider */ - private final HookContextProvider provider; - - /** repository */ - private final Repository repository; } diff --git a/scm-core/src/main/java/sonia/scm/repository/api/HookContextFactory.java b/scm-core/src/main/java/sonia/scm/repository/api/HookContextFactory.java index 41d0cd6dd3..68bd24e5e1 100644 --- a/scm-core/src/main/java/sonia/scm/repository/api/HookContextFactory.java +++ b/scm-core/src/main/java/sonia/scm/repository/api/HookContextFactory.java @@ -24,7 +24,6 @@ package sonia.scm.repository.api; -//~--- non-JDK imports -------------------------------------------------------- import com.google.inject.Inject; @@ -38,33 +37,22 @@ import sonia.scm.repository.spi.HookContextProvider; /** * Injectable factory for {@link HookContext} objects. * - * @author Sebastian Sdorra * @since 1.33 */ public final class HookContextFactory { - /** - * the logger for HookContextFactory - */ private static final Logger logger = LoggerFactory.getLogger(HookContextFactory.class); - //~--- constructors --------------------------------------------------------- + private PreProcessorUtil preProcessorUtil; - /** - * Constructs a new {@link HookContextFactory}. - * - * - * @param preProcessorUtil pre processor util - */ @Inject public HookContextFactory(PreProcessorUtil preProcessorUtil) { this.preProcessorUtil = preProcessorUtil; } - //~--- methods -------------------------------------------------------------- /** * Creates a new {@link HookContext}. @@ -84,8 +72,4 @@ public final class HookContextFactory return new HookContext(provider, repository, preProcessorUtil); } - //~--- fields --------------------------------------------------------------- - - /** pre processor util */ - private PreProcessorUtil preProcessorUtil; } diff --git a/scm-core/src/main/java/sonia/scm/repository/api/HookException.java b/scm-core/src/main/java/sonia/scm/repository/api/HookException.java index 12ef054cf3..57a2608470 100644 --- a/scm-core/src/main/java/sonia/scm/repository/api/HookException.java +++ b/scm-core/src/main/java/sonia/scm/repository/api/HookException.java @@ -28,52 +28,28 @@ package sonia.scm.repository.api; * Base exception for all exceptions which can occur during the hook * initialization. * - * @author Sebastian Sdorra * @since 1.33 */ public class HookException extends RuntimeException { - /** Field description */ private static final long serialVersionUID = 2572704247316715734L; - //~--- constructors --------------------------------------------------------- - /** - * Constructs ... - * - */ public HookException() {} - /** - * Constructs ... - * - * - * @param message - */ + public HookException(String message) { super(message); } - /** - * Constructs ... - * - * - * @param cause - */ public HookException(Throwable cause) { super(cause); } - /** - * Constructs ... - * - * - * @param message - * @param cause - */ + public HookException(String message, Throwable cause) { super(message, cause); diff --git a/scm-core/src/main/java/sonia/scm/repository/api/HookFeature.java b/scm-core/src/main/java/sonia/scm/repository/api/HookFeature.java index fe3abbfbe5..2762ec4c12 100644 --- a/scm-core/src/main/java/sonia/scm/repository/api/HookFeature.java +++ b/scm-core/src/main/java/sonia/scm/repository/api/HookFeature.java @@ -27,7 +27,6 @@ package sonia.scm.repository.api; /** * Enumeration of available hook features. * - * @author Sebastian Sdorra * @since 1.33 */ public enum HookFeature diff --git a/scm-core/src/main/java/sonia/scm/repository/api/HookFeatureIsNotSupportedException.java b/scm-core/src/main/java/sonia/scm/repository/api/HookFeatureIsNotSupportedException.java index e2cebd9deb..80c2bb8b4d 100644 --- a/scm-core/src/main/java/sonia/scm/repository/api/HookFeatureIsNotSupportedException.java +++ b/scm-core/src/main/java/sonia/scm/repository/api/HookFeatureIsNotSupportedException.java @@ -28,36 +28,21 @@ package sonia.scm.repository.api; * This exception is thrown if the underlying provider of the * {@link HookContext} does not support the requested {@link HookFeature}. * - * @author Sebastian Sdorra * @since 1.33 */ public class HookFeatureIsNotSupportedException extends HookException { - /** Field description */ private static final long serialVersionUID = -7670872902321373610L; - //~--- constructors --------------------------------------------------------- + private HookFeature unsupportedFeature; - /** - * Constructs a new {@link HookFeatureIsNotSupportedException}. - * - * - * @param unsupportedFeature feature which is not supported - */ public HookFeatureIsNotSupportedException(HookFeature unsupportedFeature) { super(unsupportedFeature.toString().concat(" is not supported")); this.unsupportedFeature = unsupportedFeature; } - /** - * Constructs a new {@link HookFeatureIsNotSupportedException}. - * - * - * @param message message for the exception - * @param unsupportedFeature feature which is not supported - */ public HookFeatureIsNotSupportedException(String message, HookFeature unsupportedFeature) { @@ -65,21 +50,10 @@ public class HookFeatureIsNotSupportedException extends HookException this.unsupportedFeature = unsupportedFeature; } - //~--- get methods ---------------------------------------------------------- - /** - * Returns the feature which is not supported. - * - * - * @return unsupported hook feature - */ public HookFeature getUnsupportedFeature() { return unsupportedFeature; } - //~--- fields --------------------------------------------------------------- - - /** unsupported hook feature */ - private HookFeature unsupportedFeature; } diff --git a/scm-core/src/main/java/sonia/scm/repository/api/HookMessageProvider.java b/scm-core/src/main/java/sonia/scm/repository/api/HookMessageProvider.java index 1222f92e7c..356a68f45d 100644 --- a/scm-core/src/main/java/sonia/scm/repository/api/HookMessageProvider.java +++ b/scm-core/src/main/java/sonia/scm/repository/api/HookMessageProvider.java @@ -27,7 +27,6 @@ package sonia.scm.repository.api; /** * Send messages back to scm client during hook execution. * - * @author Sebastian Sdorra * @since 1.33 */ public interface HookMessageProvider diff --git a/scm-core/src/main/java/sonia/scm/repository/api/HookTagProvider.java b/scm-core/src/main/java/sonia/scm/repository/api/HookTagProvider.java index 40a8d45153..883109f222 100644 --- a/scm-core/src/main/java/sonia/scm/repository/api/HookTagProvider.java +++ b/scm-core/src/main/java/sonia/scm/repository/api/HookTagProvider.java @@ -28,11 +28,10 @@ import java.util.List; import sonia.scm.repository.Tag; /** - * The HookTagProvider returns informations about tags during the + * The HookTagProvider returns information about tags during the * current hook. * * @since 1.50 - * @author Sebastian Sdorra */ public interface HookTagProvider { diff --git a/scm-core/src/main/java/sonia/scm/repository/api/IncomingCommandBuilder.java b/scm-core/src/main/java/sonia/scm/repository/api/IncomingCommandBuilder.java index c650968403..9ac242098d 100644 --- a/scm-core/src/main/java/sonia/scm/repository/api/IncomingCommandBuilder.java +++ b/scm-core/src/main/java/sonia/scm/repository/api/IncomingCommandBuilder.java @@ -24,7 +24,6 @@ package sonia.scm.repository.api; -//~--- non-JDK imports -------------------------------------------------------- import org.apache.shiro.SecurityUtils; import org.apache.shiro.subject.Subject; @@ -39,17 +38,23 @@ import sonia.scm.repository.spi.IncomingCommandRequest; import java.io.IOException; -//~--- JDK imports ------------------------------------------------------------ - /** * The incoming command shows new {@link Changeset}s found in a different * repository location. * - * @author Sebastian Sdorra * @since 1.31 */ public final class IncomingCommandBuilder { + private IncomingCommand command; + + /** disable the execution of pre processors */ + private boolean disablePreProcessors = false; + + /** disable the execution of pre processors */ + private PreProcessorUtil preProcessorUtil; + + private IncomingCommandRequest request = new IncomingCommandRequest(); /** * Constructs a new {@link IncomingCommandBuilder}, this constructor should @@ -67,7 +72,6 @@ public final class IncomingCommandBuilder this.preProcessorUtil = preProcessorUtil; } - //~--- get methods ---------------------------------------------------------- /** * Returns the incoming changesets for the remote repository. @@ -100,7 +104,6 @@ public final class IncomingCommandBuilder return cpr; } - //~--- set methods ---------------------------------------------------------- /** * Disable the execution of pre processors. @@ -150,17 +153,4 @@ public final class IncomingCommandBuilder return this; } - //~--- fields --------------------------------------------------------------- - - /** incoming command implementation */ - private IncomingCommand command; - - /** disable the execution of pre processors */ - private boolean disablePreProcessors = false; - - /** disable the execution of pre processors */ - private PreProcessorUtil preProcessorUtil; - - /** request object */ - private IncomingCommandRequest request = new IncomingCommandRequest(); } diff --git a/scm-core/src/main/java/sonia/scm/repository/api/LogCommandBuilder.java b/scm-core/src/main/java/sonia/scm/repository/api/LogCommandBuilder.java index 33f7001b32..2ea90ecde4 100644 --- a/scm-core/src/main/java/sonia/scm/repository/api/LogCommandBuilder.java +++ b/scm-core/src/main/java/sonia/scm/repository/api/LogCommandBuilder.java @@ -21,10 +21,9 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ - + package sonia.scm.repository.api; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Objects; import com.google.common.collect.ImmutableList; @@ -46,8 +45,6 @@ import java.io.IOException; import java.io.Serializable; import java.util.Set; -//~--- JDK imports ------------------------------------------------------------ - /** * LogCommandBuilder is able to show the history of a file in a * {@link Repository} or the entire history of a {@link Repository}. @@ -78,22 +75,31 @@ import java.util.Set; * log.setPath("pom.xml").disablePagingLimit().getChangesets(); * * - * @author Sebastian Sdorra * @since 1.17 */ public final class LogCommandBuilder { - /** name of the cache */ static final String CACHE_NAME = "sonia.cache.cmd.log"; - /** - * the logger for LogCommandBuilder - */ private static final Logger logger = LoggerFactory.getLogger(LogCommandBuilder.class); - //~--- constructors --------------------------------------------------------- + /** cache for changesets */ + private final Cache cache; + + private final LogCommand logCommand; + + private final PreProcessorUtil preProcessorUtil; + private Set supportedFeatures; + + private final Repository repository; + + private boolean disableCache = false; + + private boolean disablePreProcessors = false; + + private final LogCommandRequest request = new LogCommandRequest(); /** * Constructs a new {@link LogCommandBuilder}, this constructor should @@ -114,7 +120,6 @@ public final class LogCommandBuilder this.supportedFeatures = supportedFeatures; } - //~--- methods -------------------------------------------------------------- /** * Disable paging limit all available changesets will be retrieved. @@ -146,7 +151,6 @@ public final class LogCommandBuilder return this; } - //~--- get methods ---------------------------------------------------------- /** * Returns the {@link Changeset} with the given id or null if the @@ -264,7 +268,6 @@ public final class LogCommandBuilder return cpr; } - //~--- set methods ---------------------------------------------------------- /** * Retrieves only changesets of the given branch.
@@ -301,12 +304,7 @@ public final class LogCommandBuilder } /** - * Disable the execution of pre processors. - * - * - * @param disablePreProcessors true to disable the pre processors execution - * - * @return {@code this} + * Disable the execution of pre processors if set to true. */ public LogCommandBuilder setDisablePreProcessors(boolean disablePreProcessors) { @@ -407,30 +405,21 @@ public final class LogCommandBuilder return this; } - //~--- inner classes -------------------------------------------------------- - /** - * Class description - * - * - * @version Enter version here..., 12/06/05 - * @author Enter your name here... - */ + + static class CacheKey implements RepositoryCacheKey, Serializable { - /** Field description */ - private static final long serialVersionUID = 5701675009949268863L; + private static final long serialVersionUID = 5701675009949268863L; + + private final String changesetId; + + private final String repositoryId; + + private final LogCommandRequest request; - //~--- constructors ------------------------------------------------------- - /** - * Constructs ... - * - * - * @param repository - * @param request - */ public CacheKey(Repository repository, LogCommandRequest request) { this.repositoryId = repository.getId(); @@ -438,14 +427,6 @@ public final class LogCommandBuilder this.changesetId = null; } - /** - * Constructs ... - * - * - * - * @param repository - * @param changesetId - */ public CacheKey(Repository repository, String changesetId) { this.repositoryId = repository.getId(); @@ -453,16 +434,9 @@ public final class LogCommandBuilder this.request = null; } - //~--- methods ------------------------------------------------------------ - /** - * Method description - * - * - * @param obj - * - * @return - */ + + @Override public boolean equals(Object obj) { @@ -483,66 +457,19 @@ public final class LogCommandBuilder && Objects.equal(request, other.request); } - /** - * Method description - * - * - * @return - */ + @Override public int hashCode() { return Objects.hashCode(repositoryId, changesetId, request); } - //~--- get methods -------------------------------------------------------- - /** - * Method description - * - * - * @return - */ @Override public String getRepositoryId() { return repositoryId; } - //~--- fields ------------------------------------------------------------- - - /** Field description */ - private final String changesetId; - - /** Field description */ - private final String repositoryId; - - /** Field description */ - private final LogCommandRequest request; } - - - //~--- fields --------------------------------------------------------------- - - /** cache for changesets */ - private final Cache cache; - - /** Implementation of the log command */ - private final LogCommand logCommand; - - /** Field description */ - private final PreProcessorUtil preProcessorUtil; - private Set supportedFeatures; - - /** repository to query */ - private final Repository repository; - - /** disable cache */ - private boolean disableCache = false; - - /** disable the execution of pre processors */ - private boolean disablePreProcessors = false; - - /** request for the log command */ - private final LogCommandRequest request = new LogCommandRequest(); } diff --git a/scm-core/src/main/java/sonia/scm/repository/api/ModificationsCommandBuilder.java b/scm-core/src/main/java/sonia/scm/repository/api/ModificationsCommandBuilder.java index 275e166934..9a393049f5 100644 --- a/scm-core/src/main/java/sonia/scm/repository/api/ModificationsCommandBuilder.java +++ b/scm-core/src/main/java/sonia/scm/repository/api/ModificationsCommandBuilder.java @@ -47,7 +47,6 @@ import java.io.IOException; *

* Modifications are for example: Add, Update and Delete * - * @author Mohamed Karray * @since 2.0 */ @Slf4j diff --git a/scm-core/src/main/java/sonia/scm/repository/api/ModifyCommandBuilder.java b/scm-core/src/main/java/sonia/scm/repository/api/ModifyCommandBuilder.java index 24970cc510..03913dd54f 100644 --- a/scm-core/src/main/java/sonia/scm/repository/api/ModifyCommandBuilder.java +++ b/scm-core/src/main/java/sonia/scm/repository/api/ModifyCommandBuilder.java @@ -260,7 +260,7 @@ public class ModifyCommandBuilder { } /** - * Set this to true to overwrite the file if it already exists. Otherwise an + * Set this to true to overwrite the file if it already exists. Otherwise, an * {@link sonia.scm.AlreadyExistsException} will be thrown. * @return This loader instance. */ diff --git a/scm-core/src/main/java/sonia/scm/repository/api/OutgoingCommandBuilder.java b/scm-core/src/main/java/sonia/scm/repository/api/OutgoingCommandBuilder.java index 95b7c0a4ef..8602506475 100644 --- a/scm-core/src/main/java/sonia/scm/repository/api/OutgoingCommandBuilder.java +++ b/scm-core/src/main/java/sonia/scm/repository/api/OutgoingCommandBuilder.java @@ -21,7 +21,7 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ - + package sonia.scm.repository.api; import org.apache.shiro.SecurityUtils; @@ -39,13 +39,18 @@ import java.io.IOException; /** * Show changesets not found in a remote repository. * - * @author Sebastian Sdorra * @since 1.31 */ public final class OutgoingCommandBuilder { - - + private OutgoingCommand command; + + private boolean disablePreProcessors = false; + + private PreProcessorUtil preProcessorUtil; + + private OutgoingCommandRequest request = new OutgoingCommandRequest(); + /** * Constructs a new {@link OutgoingCommandBuilder}, this constructor should * only be called from the {@link RepositoryService}. @@ -62,7 +67,6 @@ public final class OutgoingCommandBuilder this.preProcessorUtil = preProcessorUtil; } - //~--- get methods ---------------------------------------------------------- /** * Returns the outgoing changesets for the remote repository. @@ -92,15 +96,9 @@ public final class OutgoingCommandBuilder return cpr; } - //~--- set methods ---------------------------------------------------------- /** - * Disable the execution of pre processors. - * - * - * @param disablePreProcessors true to disable the pre processors execution - * - * @return {@code this} + * Disable the execution of pre processors if set to true. */ public OutgoingCommandBuilder setDisablePreProcessors( boolean disablePreProcessors) @@ -141,19 +139,4 @@ public final class OutgoingCommandBuilder return this; } - - //~--- fields --------------------------------------------------------------- - - /** outgoing command implementation */ - private OutgoingCommand command; - - /** disable the execution of pre processors */ - private boolean disablePreProcessors = false; - - /** disable the execution of pre processors */ - private PreProcessorUtil preProcessorUtil; - - /** request object */ - private OutgoingCommandRequest request = new OutgoingCommandRequest(); - } diff --git a/scm-core/src/main/java/sonia/scm/repository/api/PullCommandBuilder.java b/scm-core/src/main/java/sonia/scm/repository/api/PullCommandBuilder.java index 80146d085a..8550f77688 100644 --- a/scm-core/src/main/java/sonia/scm/repository/api/PullCommandBuilder.java +++ b/scm-core/src/main/java/sonia/scm/repository/api/PullCommandBuilder.java @@ -39,7 +39,6 @@ import java.net.URL; /** * The pull command pull changes from a other repository. * - * @author Sebastian Sdorra * @since 1.31 */ public final class PullCommandBuilder { @@ -50,12 +49,6 @@ public final class PullCommandBuilder { private final Repository localRepository; private final PullCommandRequest request = new PullCommandRequest(); - /** - * Constructs a new PullCommandBuilder. - * - * @param command pull command implementation - * @param localRepository local repository - */ PullCommandBuilder(PullCommand command, Repository localRepository) { this.command = command; this.localRepository = localRepository; @@ -103,7 +96,7 @@ public final class PullCommandBuilder { * Pull all changes from the given remote url. * * @param url remote url - * @return informations over the executed pull command + * @return information over the executed pull command * @throws IOException * @since 1.43 */ @@ -125,7 +118,7 @@ public final class PullCommandBuilder { * Pull all changes from the given remote repository. * * @param remoteRepository remote repository - * @return informations over the executed pull command + * @return information over the executed pull command * @throws IOException */ public PullResponse pull(Repository remoteRepository) throws IOException { diff --git a/scm-core/src/main/java/sonia/scm/repository/api/PullResponse.java b/scm-core/src/main/java/sonia/scm/repository/api/PullResponse.java index ec187968fa..3b145f7b14 100644 --- a/scm-core/src/main/java/sonia/scm/repository/api/PullResponse.java +++ b/scm-core/src/main/java/sonia/scm/repository/api/PullResponse.java @@ -32,7 +32,6 @@ import lombok.Value; * {@link PullCommandBuilder#pull(String)} and * contains information for the executed pull command. * - * @author Sebastian Sdorra * @since 1.31 */ public final class PullResponse extends AbstractPushOrPullResponse @@ -40,30 +39,15 @@ public final class PullResponse extends AbstractPushOrPullResponse private final LfsCount lfsCount; - /** - * Constructs a new PullResponse. - * - */ public PullResponse() { this.lfsCount = new LfsCount(0, 0); } - /** - * Constructs a new PullResponse. - * - * @param changesetCount count of pulled changesets - */ public PullResponse(long changesetCount) { this(changesetCount, new LfsCount(0, 0)); } - /** - * Constructs a new PullResponse. - * - * @param changesetCount count of pulled changesets - * @param lfsCount Object for the count of potentially loaded lfs files - */ public PullResponse(long changesetCount, LfsCount lfsCount) { super(changesetCount); this.lfsCount = lfsCount; diff --git a/scm-core/src/main/java/sonia/scm/repository/api/PushCommandBuilder.java b/scm-core/src/main/java/sonia/scm/repository/api/PushCommandBuilder.java index ceefec206f..4b42e5a629 100644 --- a/scm-core/src/main/java/sonia/scm/repository/api/PushCommandBuilder.java +++ b/scm-core/src/main/java/sonia/scm/repository/api/PushCommandBuilder.java @@ -40,9 +40,8 @@ import java.net.URL; import java.util.Set; /** - * The push command push changes to a other repository. + * The push command push changes to another repository. * - * @author Sebastian Sdorra * @since 1.31 */ public final class PushCommandBuilder { @@ -85,7 +84,7 @@ public final class PushCommandBuilder { * Push all changes to the given remote repository. * * @param remoteRepository remote repository - * @return informations of the executed push command + * @return information of the executed push command * @throws IOException * @throws PushFailedException when the push (maybe just partially) failed (since 2.47.0) */ @@ -108,7 +107,7 @@ public final class PushCommandBuilder { * Push all changes to the given remote url. * * @param url url of a remote repository - * @return informations of the executed push command + * @return information of the executed push command * @throws IOException * @throws PushFailedException when the push (maybe just partially) failed (since 2.47.0) * @since 1.43 diff --git a/scm-core/src/main/java/sonia/scm/repository/api/PushResponse.java b/scm-core/src/main/java/sonia/scm/repository/api/PushResponse.java index e639748cc3..3a2073bb2d 100644 --- a/scm-core/src/main/java/sonia/scm/repository/api/PushResponse.java +++ b/scm-core/src/main/java/sonia/scm/repository/api/PushResponse.java @@ -27,18 +27,12 @@ package sonia.scm.repository.api; /** * The {@link PushResponse} is the result of the * {@link PushCommandBuilder#push(sonia.scm.repository.Repository)} method and - * contains informations over the executed push command. + * contains information over the executed push command. * - * @author Sebastian Sdorra * @since 1.31 */ public final class PushResponse extends AbstractPushOrPullResponse { - /** - * Constructs a new PushResponse. - * - * @param changesetCount count of pushed changesets - */ public PushResponse(long changesetCount) { super(changesetCount); } diff --git a/scm-core/src/main/java/sonia/scm/repository/api/RepositoryService.java b/scm-core/src/main/java/sonia/scm/repository/api/RepositoryService.java index 473a59cd6d..e4d3cee02c 100644 --- a/scm-core/src/main/java/sonia/scm/repository/api/RepositoryService.java +++ b/scm-core/src/main/java/sonia/scm/repository/api/RepositoryService.java @@ -63,7 +63,6 @@ import java.util.stream.Stream; * after work is finished. For closing the connection to the repository use the * {@link #close()} method. * - * @author Sebastian Sdorra * @apiviz.uses sonia.scm.repository.Feature * @apiviz.uses sonia.scm.repository.api.Command * @apiviz.uses sonia.scm.repository.api.BlameCommandBuilder diff --git a/scm-core/src/main/java/sonia/scm/repository/api/RepositoryServiceFactory.java b/scm-core/src/main/java/sonia/scm/repository/api/RepositoryServiceFactory.java index b2636094f7..49ee989055 100644 --- a/scm-core/src/main/java/sonia/scm/repository/api/RepositoryServiceFactory.java +++ b/scm-core/src/main/java/sonia/scm/repository/api/RepositoryServiceFactory.java @@ -24,7 +24,6 @@ package sonia.scm.repository.api; -//~--- non-JDK imports -------------------------------------------------------- import com.github.legman.ReferenceType; import com.github.legman.Subscribe; @@ -67,8 +66,6 @@ import java.util.Set; import static sonia.scm.ContextEntry.ContextBuilder.entity; import static sonia.scm.NotFoundException.notFound; -//~--- JDK imports ------------------------------------------------------------ - /** * The {@link RepositoryServiceFactory} is the entrypoint of the repository api. * You could create {@link RepositoryService} from a {@link Repository} and @@ -104,7 +101,6 @@ import static sonia.scm.NotFoundException.notFound; * } * * - * @author Sebastian Sdorra * @apiviz.landmark * @apiviz.uses sonia.scm.repository.api.RepositoryService * @since 1.17 @@ -112,9 +108,7 @@ import static sonia.scm.NotFoundException.notFound; @Singleton public final class RepositoryServiceFactory { - /** - * the logger for RepositoryServiceFactory - */ + private static final Logger logger = LoggerFactory.getLogger(RepositoryServiceFactory.class); diff --git a/scm-core/src/main/java/sonia/scm/repository/api/RepositoryServiceNotFoundException.java b/scm-core/src/main/java/sonia/scm/repository/api/RepositoryServiceNotFoundException.java index cb3c53aa04..4e42ebcb1d 100644 --- a/scm-core/src/main/java/sonia/scm/repository/api/RepositoryServiceNotFoundException.java +++ b/scm-core/src/main/java/sonia/scm/repository/api/RepositoryServiceNotFoundException.java @@ -24,7 +24,6 @@ package sonia.scm.repository.api; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.repository.Repository; @@ -32,18 +31,12 @@ import sonia.scm.repository.Repository; * This exception is throw if no {@link RepositoryService} * is available for the given {@link Repository}. * - * @author Sebastian Sdorra * @since 1.17 */ public final class RepositoryServiceNotFoundException extends RuntimeException { + private Repository repository; - /** - * Constructs a new {@link RepositoryServiceNotFoundException}. - * - * - * @param repository unsupported repository - */ public RepositoryServiceNotFoundException(Repository repository) { super("could not find a repository service provider implementation for repository " @@ -51,21 +44,13 @@ public final class RepositoryServiceNotFoundException extends RuntimeException this.repository = repository; } - //~--- get methods ---------------------------------------------------------- /** * Returns the unsupported repository. - * - * - * @return unsupported repository */ public Repository getRepository() { return repository; } - //~--- fields --------------------------------------------------------------- - - /** unsupported repository */ - private Repository repository; } diff --git a/scm-core/src/main/java/sonia/scm/repository/api/TagsCommandBuilder.java b/scm-core/src/main/java/sonia/scm/repository/api/TagsCommandBuilder.java index 43689fe73b..00961c83a7 100644 --- a/scm-core/src/main/java/sonia/scm/repository/api/TagsCommandBuilder.java +++ b/scm-core/src/main/java/sonia/scm/repository/api/TagsCommandBuilder.java @@ -24,7 +24,6 @@ package sonia.scm.repository.api; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Objects; import org.slf4j.Logger; @@ -40,8 +39,6 @@ import sonia.scm.repository.spi.TagsCommand; import java.io.IOException; import java.util.List; -//~--- JDK imports ------------------------------------------------------------ - /** * The tags command list all repository tags.
*
@@ -53,22 +50,25 @@ import java.util.List; * TagsCommandBuilder tagsCommand = repositoryService.getTagsCommand(); * Tags tags = tagsCommand.getTags(); * - * @author Sebastian Sdorra * @since 1.18 */ public final class TagsCommandBuilder { - /** name of the cache */ static final String CACHE_NAME = "sonia.cache.cmd.tags"; - /** - * the logger for TagsCommandBuilder - */ + private static final Logger logger = LoggerFactory.getLogger(TagsCommandBuilder.class); - //~--- constructors --------------------------------------------------------- + /** cache for changesets */ + private final Cache cache; + + private final TagsCommand command; + + private final Repository repository; + + private boolean disableCache = false; /** * Constructs a new {@link TagsCommandBuilder}, this constructor should @@ -86,15 +86,9 @@ public final class TagsCommandBuilder this.repository = repository; } - //~--- get methods ---------------------------------------------------------- /** * Returns all tags from the repository. - * - * - * @return tags from the repository - * - * @throws IOException */ public Tags getTags() throws IOException { Tags tags; @@ -139,12 +133,11 @@ public final class TagsCommandBuilder return tags; } - //~--- set methods ---------------------------------------------------------- /** * Disables the cache for tags. This means that every {@link Tag} * is directly retrieved from the {@link Repository}. Note: Disabling - * the cache cost a lot of performance and could be much more slower. + * the cache cost a lot of performance and could be much slower. * * * @param disableCache true to disable the cache @@ -158,16 +151,8 @@ public final class TagsCommandBuilder return this; } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - * - * @throws IOException - */ + private Tags getTagsFromCommand() throws IOException { List tagList = command.getTags(); @@ -175,39 +160,18 @@ public final class TagsCommandBuilder return new Tags(tagList); } - //~--- inner classes -------------------------------------------------------- - /** - * Class description - * - * - * @version Enter version here..., 12/07/05 - * @author Enter your name here... - */ + + static class CacheKey implements RepositoryCacheKey { - - /** - * Constructs ... - * - * - * @param repository - */ + private final String repositoryId; + public CacheKey(Repository repository) { this.repositoryId = repository.getId(); } - //~--- methods ------------------------------------------------------------ - - /** - * Method description - * - * - * @param obj - * - * @return - */ @Override public boolean equals(Object obj) { @@ -226,50 +190,20 @@ public final class TagsCommandBuilder return Objects.equal(repositoryId, other.repositoryId); } - /** - * Method description - * - * - * @return - */ + @Override public int hashCode() { return Objects.hashCode(repositoryId); } - //~--- get methods -------------------------------------------------------- - /** - * Method description - * - * - * @return - */ @Override public String getRepositoryId() { return repositoryId; } - //~--- fields ------------------------------------------------------------- - - /** repository id */ - private final String repositoryId; } - - //~--- fields --------------------------------------------------------------- - - /** cache for changesets */ - private final Cache cache; - - /** command implementation */ - private final TagsCommand command; - - /** repository */ - private final Repository repository; - - /** disable cache */ - private boolean disableCache = false; } diff --git a/scm-core/src/main/java/sonia/scm/repository/api/UnbundleCommandBuilder.java b/scm-core/src/main/java/sonia/scm/repository/api/UnbundleCommandBuilder.java index d65e0a738e..2247ae1c48 100644 --- a/scm-core/src/main/java/sonia/scm/repository/api/UnbundleCommandBuilder.java +++ b/scm-core/src/main/java/sonia/scm/repository/api/UnbundleCommandBuilder.java @@ -24,7 +24,6 @@ package sonia.scm.repository.api; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.io.ByteSource; import com.google.common.io.Files; @@ -44,8 +43,6 @@ import java.util.zip.GZIPInputStream; import static com.google.common.base.Preconditions.checkArgument; import static com.google.common.base.Preconditions.checkNotNull; -//~--- JDK imports ------------------------------------------------------------ - /** * The unbundle command can restore an empty repository from a bundle. The * bundle can be created with the {@link BundleCommandBuilder}. @@ -56,19 +53,18 @@ import static com.google.common.base.Preconditions.checkNotNull; public final class UnbundleCommandBuilder { - /** logger for UnbundleCommandBuilder */ private static final Logger logger = LoggerFactory.getLogger(UnbundleCommandBuilder.class); - //~--- constructors --------------------------------------------------------- + private final Repository repository; + + private final UnbundleCommand unbundleCommand; + + private boolean compressed = false; + + private Consumer postEventSink; + - /** - * Constructs a new UnbundleCommandBuilder. - * - * - * @param unbundleCommand unbundle command implementation - * @param repository repository - */ public UnbundleCommandBuilder(UnbundleCommand unbundleCommand, Repository repository) { @@ -76,7 +72,6 @@ public final class UnbundleCommandBuilder this.repository = repository; } - //~--- methods -------------------------------------------------------------- /** * Restores the repository from the given bundle. @@ -140,7 +135,6 @@ public final class UnbundleCommandBuilder return unbundleCommand.unbundle(createRequest(byteSource)); } - //~--- set methods ---------------------------------------------------------- /** * Set to {@code true} if bundle is gzip compressed. Default is {@code false}. @@ -171,7 +165,6 @@ public final class UnbundleCommandBuilder return this; } - //~--- methods -------------------------------------------------------------- /** * Converts an {@link InputStream} into a {@link ByteSource}. @@ -194,14 +187,6 @@ public final class UnbundleCommandBuilder }; } - /** - * Creates the {@link UnbundleCommandRequest}. - * - * - * @param source byte source - * - * @return the create request - */ private UnbundleCommandRequest createRequest(ByteSource source) { ByteSource bs; @@ -223,26 +208,20 @@ public final class UnbundleCommandBuilder return request; } - //~--- inner classes -------------------------------------------------------- + /** * ByteSource which is able to handle gzip compressed resources. */ private static class CompressedByteSource extends ByteSource { - - /** - * Constructs ... - * - * - * @param wrapped - */ + private final ByteSource wrapped; + public CompressedByteSource(ByteSource wrapped) { this.wrapped = wrapped; } - //~--- methods ------------------------------------------------------------ /** * Opens the stream for reading the compressed source. @@ -257,24 +236,6 @@ public final class UnbundleCommandBuilder { return new GZIPInputStream(wrapped.openStream()); } - - //~--- fields ------------------------------------------------------------- - - /** Field description */ - private final ByteSource wrapped; } - - //~--- fields --------------------------------------------------------------- - - /** repository */ - private final Repository repository; - - /** unbundle command implementation */ - private final UnbundleCommand unbundleCommand; - - /** Field description */ - private boolean compressed = false; - - private Consumer postEventSink; } diff --git a/scm-core/src/main/java/sonia/scm/repository/api/UnbundleResponse.java b/scm-core/src/main/java/sonia/scm/repository/api/UnbundleResponse.java index 3fbdc01070..9d90add670 100644 --- a/scm-core/src/main/java/sonia/scm/repository/api/UnbundleResponse.java +++ b/scm-core/src/main/java/sonia/scm/repository/api/UnbundleResponse.java @@ -27,18 +27,10 @@ package sonia.scm.repository.api; /** * Response of unbundle command. * - * @author Sebastian Sdorra * @since 1.43 */ public class UnbundleResponse extends AbstractBundleOrUnbundleCommandResponse { - - /** - * Constructs a new unbundle response. - * - * - * @param changesetCount count of unbundled changesets - */ public UnbundleResponse(long changesetCount) { super(changesetCount); diff --git a/scm-core/src/main/java/sonia/scm/repository/api/UnlockCommandResult.java b/scm-core/src/main/java/sonia/scm/repository/api/UnlockCommandResult.java index 3f7d7e6d70..d6b6cfcf76 100644 --- a/scm-core/src/main/java/sonia/scm/repository/api/UnlockCommandResult.java +++ b/scm-core/src/main/java/sonia/scm/repository/api/UnlockCommandResult.java @@ -27,7 +27,7 @@ package sonia.scm.repository.api; import lombok.AllArgsConstructor; /** - * Result of a unlock command. + * Result of an unlock command. * * @since 2.26.0 */ diff --git a/scm-core/src/main/java/sonia/scm/repository/spi/BlameCommand.java b/scm-core/src/main/java/sonia/scm/repository/spi/BlameCommand.java index 7a872aac28..17526c7f00 100644 --- a/scm-core/src/main/java/sonia/scm/repository/spi/BlameCommand.java +++ b/scm-core/src/main/java/sonia/scm/repository/spi/BlameCommand.java @@ -24,31 +24,16 @@ package sonia.scm.repository.spi; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.repository.BlameResult; import java.io.IOException; -//~--- JDK imports ------------------------------------------------------------ - /** * - * @author Sebastian Sdorra * @since 1.17 */ public interface BlameCommand { - - /** - * Method description - * - * - * @param request - * - * @return - * - * @throws IOException - */ BlameResult getBlameResult(BlameCommandRequest request) throws IOException; } diff --git a/scm-core/src/main/java/sonia/scm/repository/spi/BlameCommandRequest.java b/scm-core/src/main/java/sonia/scm/repository/spi/BlameCommandRequest.java index e208e3256a..d1a1876985 100644 --- a/scm-core/src/main/java/sonia/scm/repository/spi/BlameCommandRequest.java +++ b/scm-core/src/main/java/sonia/scm/repository/spi/BlameCommandRequest.java @@ -28,24 +28,16 @@ import lombok.EqualsAndHashCode; /** * - * @author Sebastian Sdorra * @since 1.17 */ @EqualsAndHashCode(callSuper = true) public final class BlameCommandRequest extends FileBaseCommandRequest { - /** Field description */ private static final long serialVersionUID = 6421975024231127315L; - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + @Override public BlameCommandRequest clone() { diff --git a/scm-core/src/main/java/sonia/scm/repository/spi/BranchesCommand.java b/scm-core/src/main/java/sonia/scm/repository/spi/BranchesCommand.java index 9fa28a49aa..5153372f06 100644 --- a/scm-core/src/main/java/sonia/scm/repository/spi/BranchesCommand.java +++ b/scm-core/src/main/java/sonia/scm/repository/spi/BranchesCommand.java @@ -31,7 +31,6 @@ import java.util.List; import java.util.Optional; /** - * @author Sebastian Sdorra * @since 1.18 */ public interface BranchesCommand { diff --git a/scm-core/src/main/java/sonia/scm/repository/spi/BrowseCommand.java b/scm-core/src/main/java/sonia/scm/repository/spi/BrowseCommand.java index 0789ae5244..9a30f5c559 100644 --- a/scm-core/src/main/java/sonia/scm/repository/spi/BrowseCommand.java +++ b/scm-core/src/main/java/sonia/scm/repository/spi/BrowseCommand.java @@ -24,7 +24,6 @@ package sonia.scm.repository.spi; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.repository.BrowserResult; @@ -33,26 +32,12 @@ import java.util.List; import java.util.Locale; import java.util.function.Function; -//~--- JDK imports ------------------------------------------------------------ - /** * - * @author Sebastian Sdorra * @since 1.17 */ public interface BrowseCommand { - - /** - * Method description - * - * - * @param request - * - * @return - * - * @throws IOException - */ BrowserResult getBrowserResult(BrowseCommandRequest request) throws IOException; default void sort(List entries, Function isDirectory, Function nameOf) { diff --git a/scm-core/src/main/java/sonia/scm/repository/spi/BrowseCommandRequest.java b/scm-core/src/main/java/sonia/scm/repository/spi/BrowseCommandRequest.java index 69ae01ad6b..b82071adda 100644 --- a/scm-core/src/main/java/sonia/scm/repository/spi/BrowseCommandRequest.java +++ b/scm-core/src/main/java/sonia/scm/repository/spi/BrowseCommandRequest.java @@ -31,7 +31,6 @@ import sonia.scm.repository.BrowserResult; import java.util.function.Consumer; /** - * @author Sebastian Sdorra * @since 1.17 */ @EqualsAndHashCode(callSuper = true) diff --git a/scm-core/src/main/java/sonia/scm/repository/spi/BundleCommand.java b/scm-core/src/main/java/sonia/scm/repository/spi/BundleCommand.java index d7d34a0b6a..ef24b12445 100644 --- a/scm-core/src/main/java/sonia/scm/repository/spi/BundleCommand.java +++ b/scm-core/src/main/java/sonia/scm/repository/spi/BundleCommand.java @@ -24,18 +24,14 @@ package sonia.scm.repository.spi; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.repository.api.BundleResponse; import java.io.IOException; -//~--- JDK imports ------------------------------------------------------------ - /** * Service provider implementation for the bundle command. * - * @author Sebastian Sdorra * @since 1.43 */ public interface BundleCommand diff --git a/scm-core/src/main/java/sonia/scm/repository/spi/BundleCommandRequest.java b/scm-core/src/main/java/sonia/scm/repository/spi/BundleCommandRequest.java index f35958938d..14fd2e0276 100644 --- a/scm-core/src/main/java/sonia/scm/repository/spi/BundleCommandRequest.java +++ b/scm-core/src/main/java/sonia/scm/repository/spi/BundleCommandRequest.java @@ -21,10 +21,9 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ - + package sonia.scm.repository.spi; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Objects; import com.google.common.io.ByteSink; @@ -37,23 +36,13 @@ import com.google.common.io.ByteSink; */ public final class BundleCommandRequest { + private final ByteSink archive; - /** - * Constructs a new bundle command request. - * - * - * @param archive byte sink archive - */ public BundleCommandRequest(ByteSink archive) { this.archive = archive; } - //~--- methods -------------------------------------------------------------- - - /** - * {@inheritDoc} - */ @Override public boolean equals(Object obj) { @@ -72,9 +61,7 @@ public final class BundleCommandRequest return Objects.equal(archive, other.archive); } - /** - * {@inheritDoc} - */ + @Override public int hashCode() { @@ -85,17 +72,11 @@ public final class BundleCommandRequest /** * Returns the archive as {@link ByteSink}. - * - * - * @return {@link ByteSink} archive. */ public ByteSink getArchive() { return archive; } - //~--- fields --------------------------------------------------------------- - /** byte sink archive */ - private final ByteSink archive; } diff --git a/scm-core/src/main/java/sonia/scm/repository/spi/CatCommand.java b/scm-core/src/main/java/sonia/scm/repository/spi/CatCommand.java index e3f96b0cac..9017a379c3 100644 --- a/scm-core/src/main/java/sonia/scm/repository/spi/CatCommand.java +++ b/scm-core/src/main/java/sonia/scm/repository/spi/CatCommand.java @@ -30,7 +30,6 @@ import java.io.OutputStream; /** * - * @author Sebastian Sdorra * @since 1.17 */ public interface CatCommand { diff --git a/scm-core/src/main/java/sonia/scm/repository/spi/CatCommandRequest.java b/scm-core/src/main/java/sonia/scm/repository/spi/CatCommandRequest.java index ed8424cfc4..d8b52dde2c 100644 --- a/scm-core/src/main/java/sonia/scm/repository/spi/CatCommandRequest.java +++ b/scm-core/src/main/java/sonia/scm/repository/spi/CatCommandRequest.java @@ -28,24 +28,16 @@ import lombok.EqualsAndHashCode; /** * - * @author Sebastian Sdorra * @since 1.17 */ @EqualsAndHashCode(callSuper = true) public final class CatCommandRequest extends FileBaseCommandRequest { - /** Field description */ private static final long serialVersionUID = -6404958421249874551L; - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + @Override public CatCommandRequest clone() { diff --git a/scm-core/src/main/java/sonia/scm/repository/spi/DiffCommand.java b/scm-core/src/main/java/sonia/scm/repository/spi/DiffCommand.java index af0e364917..96e007dea4 100644 --- a/scm-core/src/main/java/sonia/scm/repository/spi/DiffCommand.java +++ b/scm-core/src/main/java/sonia/scm/repository/spi/DiffCommand.java @@ -30,7 +30,6 @@ import java.io.IOException; /** * - * @author Sebastian Sdorra * @since 1.17 */ public interface DiffCommand diff --git a/scm-core/src/main/java/sonia/scm/repository/spi/DiffCommandRequest.java b/scm-core/src/main/java/sonia/scm/repository/spi/DiffCommandRequest.java index 9e245ef3f9..9ad5035a6e 100644 --- a/scm-core/src/main/java/sonia/scm/repository/spi/DiffCommandRequest.java +++ b/scm-core/src/main/java/sonia/scm/repository/spi/DiffCommandRequest.java @@ -24,7 +24,6 @@ package sonia.scm.repository.spi; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Strings; import lombok.EqualsAndHashCode; @@ -33,7 +32,6 @@ import sonia.scm.repository.api.DiffFormat; /** * - * @author Sebastian Sdorra * @since 1.17 */ @EqualsAndHashCode(callSuper = true) @@ -42,6 +40,10 @@ public class DiffCommandRequest extends FileBaseCommandRequest private static final long serialVersionUID = 4026911212676859626L; + private DiffFormat format = DiffFormat.NATIVE; + + private String ancestorChangeset; + @Override public DiffCommandRequest clone() { @@ -87,10 +89,6 @@ public class DiffCommandRequest extends FileBaseCommandRequest /** * Return the output format of the diff command. - * - * - * @return output format - * * @since 1.34 */ public DiffFormat getFormat() @@ -102,8 +100,4 @@ public class DiffCommandRequest extends FileBaseCommandRequest return ancestorChangeset; } - /** diff format */ - private DiffFormat format = DiffFormat.NATIVE; - - private String ancestorChangeset; } diff --git a/scm-core/src/main/java/sonia/scm/repository/spi/FileBaseCommandRequest.java b/scm-core/src/main/java/sonia/scm/repository/spi/FileBaseCommandRequest.java index 457c528694..8e82b447b2 100644 --- a/scm-core/src/main/java/sonia/scm/repository/spi/FileBaseCommandRequest.java +++ b/scm-core/src/main/java/sonia/scm/repository/spi/FileBaseCommandRequest.java @@ -24,18 +24,14 @@ package sonia.scm.repository.spi; -//~--- non-JDK imports -------------------------------------------------------- import lombok.EqualsAndHashCode; import lombok.ToString; import java.io.Serializable; -//~--- JDK imports ------------------------------------------------------------ - /** * - * @author Sebastian Sdorra * @since 1.17 */ @EqualsAndHashCode @@ -43,14 +39,9 @@ import java.io.Serializable; public abstract class FileBaseCommandRequest implements Resetable, Serializable, Cloneable { - /** Field description */ private static final long serialVersionUID = -3442101119408346165L; - /** - * Method description - * - */ - @Override + @Override public void reset() { path = null; diff --git a/scm-core/src/main/java/sonia/scm/repository/spi/HookChangesetRequest.java b/scm-core/src/main/java/sonia/scm/repository/spi/HookChangesetRequest.java index 19384ab828..841929bedd 100644 --- a/scm-core/src/main/java/sonia/scm/repository/spi/HookChangesetRequest.java +++ b/scm-core/src/main/java/sonia/scm/repository/spi/HookChangesetRequest.java @@ -31,7 +31,6 @@ import sonia.scm.repository.Changeset; * this object has no functionality, but it is used to be prepared for further * functions. * - * @author Sebastian Sdorra * @since 1.33 */ public final class HookChangesetRequest {} diff --git a/scm-core/src/main/java/sonia/scm/repository/spi/HookChangesetResponse.java b/scm-core/src/main/java/sonia/scm/repository/spi/HookChangesetResponse.java index d3197e7b8f..9848e19d0a 100644 --- a/scm-core/src/main/java/sonia/scm/repository/spi/HookChangesetResponse.java +++ b/scm-core/src/main/java/sonia/scm/repository/spi/HookChangesetResponse.java @@ -31,7 +31,6 @@ import static java.util.Collections.emptyList; /** * Response object to retrieve {@link Changeset}s during a hook. * - * @author Sebastian Sdorra * @since 1.33 */ public final class HookChangesetResponse { @@ -47,11 +46,8 @@ public final class HookChangesetResponse { this(changesets, emptyList()); } - /** * Return added changesets. - * - * @return added changesets */ public Iterable getChangesets() { return addedChangesets; @@ -60,8 +56,7 @@ public final class HookChangesetResponse { /** * Return removed changesets. * - * @return removed changesets - * @since 2.39.0 + * @since 2.39.0 */ public Iterable getRemovedChangesets() { return removedChangesets; diff --git a/scm-core/src/main/java/sonia/scm/repository/spi/HookContextProvider.java b/scm-core/src/main/java/sonia/scm/repository/spi/HookContextProvider.java index b4e6db826e..393b2d4869 100644 --- a/scm-core/src/main/java/sonia/scm/repository/spi/HookContextProvider.java +++ b/scm-core/src/main/java/sonia/scm/repository/spi/HookContextProvider.java @@ -39,11 +39,11 @@ import java.util.Set; /** * Repository type specific provider for {@link HookContext}. * - * @author Sebastian Sdorra * @since 1.33 */ public abstract class HookContextProvider { + private boolean clientDisconnected = false; /** * Return the provider specific {@link HookMessageProvider} or throws a {@link HookFeatureIsNotSupportedException}. @@ -62,7 +62,6 @@ public abstract class HookContextProvider return createMessageProvider(); } - //~--- methods -------------------------------------------------------------- /** * Mark client connection as disconnected. @@ -73,7 +72,6 @@ public abstract class HookContextProvider clientDisconnected = true; } - //~--- get methods ---------------------------------------------------------- /** * Returns a set of supported hook features of the client. @@ -130,7 +128,6 @@ public abstract class HookContextProvider throw new HookFeatureIsNotSupportedException(HookFeature.MODIFICATIONS_PROVIDER); } - //~--- methods -------------------------------------------------------------- /** * Creates a new provider specific {@link HookMessageProvider} or throws a {@link HookFeatureIsNotSupportedException}. @@ -142,7 +139,4 @@ public abstract class HookContextProvider throw new HookFeatureIsNotSupportedException(HookFeature.MESSAGE_PROVIDER); } - //~--- fields --------------------------------------------------------------- - - private boolean clientDisconnected = false; } diff --git a/scm-core/src/main/java/sonia/scm/repository/spi/HookEventFacade.java b/scm-core/src/main/java/sonia/scm/repository/spi/HookEventFacade.java index 6789d843a3..cc5cd3b406 100644 --- a/scm-core/src/main/java/sonia/scm/repository/spi/HookEventFacade.java +++ b/scm-core/src/main/java/sonia/scm/repository/spi/HookEventFacade.java @@ -24,7 +24,6 @@ package sonia.scm.repository.spi; -//~--- non-JDK imports -------------------------------------------------------- import com.google.inject.Inject; import com.google.inject.Provider; @@ -41,19 +40,15 @@ import static sonia.scm.NotFoundException.notFound; /** * - * @author Sebastian Sdorra * @since 1.33 */ public final class HookEventFacade { + private final HookContextFactory hookContextFactory; + + private final Provider repositoryManagerProvider; /** - * Constructs ... - * - * - * @param repositoryManagerProvider - * @param hookContextFactory - * * @since 1.38 */ @Inject @@ -64,7 +59,6 @@ public final class HookEventFacade this.hookContextFactory = hookContextFactory; } - //~--- methods -------------------------------------------------------------- public HookEventHandler handle(String id) { Repository repository = repositoryManagerProvider.get().get(id); @@ -89,26 +83,17 @@ public final class HookEventFacade hookContextFactory, repository); } - //~--- inner classes -------------------------------------------------------- - /** - * Class description - * - * - * @version Enter version here..., 13/07/21 - * @author Enter your name here... - */ + + public static class HookEventHandler { + private final HookContextFactory hookContextFactory; + + private final Repository repository; + + private final RepositoryManager repositoryManager; - /** - * Constructs ... - * - * - * @param repositoryManager - * @param hookContextFactory - * @param repository - */ public HookEventHandler(RepositoryManager repositoryManager, HookContextFactory hookContextFactory, Repository repository) { @@ -117,15 +102,6 @@ public final class HookEventFacade this.repository = repository; } - //~--- methods ------------------------------------------------------------ - - /** - * Method description - * - * - * @param type - * @param hookContextProvider - */ public void fireHookEvent(RepositoryHookType type, HookContextProvider hookContextProvider) { @@ -138,24 +114,6 @@ public final class HookEventFacade hookContextProvider.handleClientDisconnect(); } - //~--- fields ------------------------------------------------------------- - - /** Field description */ - private final HookContextFactory hookContextFactory; - - /** Field description */ - private final Repository repository; - - /** Field description */ - private final RepositoryManager repositoryManager; } - - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private final HookContextFactory hookContextFactory; - - /** Field description */ - private final Provider repositoryManagerProvider; } diff --git a/scm-core/src/main/java/sonia/scm/repository/spi/IncomingCommand.java b/scm-core/src/main/java/sonia/scm/repository/spi/IncomingCommand.java index b4c5450716..6fbd922957 100644 --- a/scm-core/src/main/java/sonia/scm/repository/spi/IncomingCommand.java +++ b/scm-core/src/main/java/sonia/scm/repository/spi/IncomingCommand.java @@ -24,17 +24,13 @@ package sonia.scm.repository.spi; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.repository.ChangesetPagingResult; import java.io.IOException; -//~--- JDK imports ------------------------------------------------------------ - /** * - * @author Sebastian Sdorra * @since 1.31 */ public interface IncomingCommand diff --git a/scm-core/src/main/java/sonia/scm/repository/spi/IncomingCommandRequest.java b/scm-core/src/main/java/sonia/scm/repository/spi/IncomingCommandRequest.java index 07210a8a60..1b13da3590 100644 --- a/scm-core/src/main/java/sonia/scm/repository/spi/IncomingCommandRequest.java +++ b/scm-core/src/main/java/sonia/scm/repository/spi/IncomingCommandRequest.java @@ -26,7 +26,6 @@ package sonia.scm.repository.spi; /** * - * @author Sebastian Sdorra * @since 1.31 */ public final class IncomingCommandRequest extends PagedRemoteCommandRequest {} diff --git a/scm-core/src/main/java/sonia/scm/repository/spi/InitializingHttpScmProtocolWrapper.java b/scm-core/src/main/java/sonia/scm/repository/spi/InitializingHttpScmProtocolWrapper.java index ef4c93a816..e386a10382 100644 --- a/scm-core/src/main/java/sonia/scm/repository/spi/InitializingHttpScmProtocolWrapper.java +++ b/scm-core/src/main/java/sonia/scm/repository/spi/InitializingHttpScmProtocolWrapper.java @@ -52,12 +52,6 @@ public abstract class InitializingHttpScmProtocolWrapper implements ScmProtocolP private volatile boolean isInitialized = false; /** - * Constructs a new {@link InitializingHttpScmProtocolWrapper}. - * - * @param delegateProvider injection provider for the servlet delegate - * @param pathInfoStore url info store - * @param scmConfiguration scm-manager main configuration - * * @deprecated use {@link InitializingHttpScmProtocolWrapper(Provider, RootURL)} instead. */ @Deprecated @@ -67,11 +61,6 @@ public abstract class InitializingHttpScmProtocolWrapper implements ScmProtocolP } /** - * Constructs a new {@link InitializingHttpScmProtocolWrapper}. - * - * @param delegateProvider injection provider for the servlet delegate - * @param rootURL root url - * * @since 2.3.1 */ public InitializingHttpScmProtocolWrapper(Provider delegateProvider, RootURL rootURL) { diff --git a/scm-core/src/main/java/sonia/scm/repository/spi/LogCommand.java b/scm-core/src/main/java/sonia/scm/repository/spi/LogCommand.java index 4f2227f21a..0c67b336aa 100644 --- a/scm-core/src/main/java/sonia/scm/repository/spi/LogCommand.java +++ b/scm-core/src/main/java/sonia/scm/repository/spi/LogCommand.java @@ -24,18 +24,14 @@ package sonia.scm.repository.spi; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.repository.Changeset; import sonia.scm.repository.ChangesetPagingResult; import java.io.IOException; -//~--- JDK imports ------------------------------------------------------------ - /** * - * @author Sebastian Sdorra * @since 1.17 */ public interface LogCommand { diff --git a/scm-core/src/main/java/sonia/scm/repository/spi/LogCommandRequest.java b/scm-core/src/main/java/sonia/scm/repository/spi/LogCommandRequest.java index 0b67b3339d..8ad0b07de1 100644 --- a/scm-core/src/main/java/sonia/scm/repository/spi/LogCommandRequest.java +++ b/scm-core/src/main/java/sonia/scm/repository/spi/LogCommandRequest.java @@ -24,36 +24,35 @@ package sonia.scm.repository.spi; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.MoreObjects; import com.google.common.base.Objects; import java.io.Serializable; -//~--- JDK imports ------------------------------------------------------------ - /** * - * @author Sebastian Sdorra * @since 1.17 */ public final class LogCommandRequest implements Serializable, Resetable { - /** Field description */ private static final long serialVersionUID = 8759598040394428649L; - //~--- methods -------------------------------------------------------------- + private String branch; + + private String endChangeset; + + private int pagingLimit = 20; + + private int pagingStart = 0; + + private String path; + + private String startChangeset; + + private String ancestorChangeset; - /** - * Method description - * - * - * @param obj - * - * @return - */ @Override public boolean equals(Object obj) { @@ -80,12 +79,7 @@ public final class LogCommandRequest implements Serializable, Resetable //J+ } - /** - * Method description - * - * - * @return - */ + @Override public int hashCode() { @@ -93,11 +87,7 @@ public final class LogCommandRequest implements Serializable, Resetable pagingLimit, path, branch, ancestorChangeset); } - /** - * Method description - * - */ - @Override + @Override public void reset() { startChangeset = null; @@ -109,12 +99,7 @@ public final class LogCommandRequest implements Serializable, Resetable ancestorChangeset = null; } - /** - * Method description - * - * - * @return - */ + @Override public String toString() { @@ -131,69 +116,38 @@ public final class LogCommandRequest implements Serializable, Resetable //J+ } - //~--- set methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param branch - */ + public void setBranch(String branch) { this.branch = branch; } - /** - * Method description - * - * - * @param endChangeset - */ + public void setEndChangeset(String endChangeset) { this.endChangeset = endChangeset; } - /** - * Method description - * - * - * @param pagingLimit - */ + public void setPagingLimit(int pagingLimit) { this.pagingLimit = pagingLimit; } - /** - * Method description - * - * - * @param pagingStart - */ + public void setPagingStart(int pagingStart) { this.pagingStart = pagingStart; } - /** - * Method description - * - * - * @param path - */ + public void setPath(String path) { this.path = path; } - /** - * Method description - * - * - * @param startChangeset - */ + public void setStartChangeset(String startChangeset) { this.startChangeset = startChangeset; @@ -203,80 +157,44 @@ public final class LogCommandRequest implements Serializable, Resetable this.ancestorChangeset = ancestorChangeset; } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + public String getBranch() { return branch; } - /** - * Method description - * - * - * @return - */ + public String getEndChangeset() { return endChangeset; } - /** - * Method description - * - * - * @return - */ + public int getPagingLimit() { return pagingLimit; } - /** - * Method description - * - * - * @return - */ + public int getPagingStart() { return pagingStart; } - /** - * Method description - * - * - * @return - */ + public String getPath() { return path; } - /** - * Method description - * - * - * @return - */ + public String getStartChangeset() { return startChangeset; } - /** - * Method description - * - * - * @return - */ + public boolean isPagingUnlimited() { return pagingLimit < 0; @@ -286,25 +204,4 @@ public final class LogCommandRequest implements Serializable, Resetable return ancestorChangeset; } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private String branch; - - /** Field description */ - private String endChangeset; - - /** Field description */ - private int pagingLimit = 20; - - /** Field description */ - private int pagingStart = 0; - - /** Field description */ - private String path; - - /** Field description */ - private String startChangeset; - - private String ancestorChangeset; } diff --git a/scm-core/src/main/java/sonia/scm/repository/spi/ModificationsCommand.java b/scm-core/src/main/java/sonia/scm/repository/spi/ModificationsCommand.java index 2cfc5406c9..50bdcbfa53 100644 --- a/scm-core/src/main/java/sonia/scm/repository/spi/ModificationsCommand.java +++ b/scm-core/src/main/java/sonia/scm/repository/spi/ModificationsCommand.java @@ -35,7 +35,6 @@ import java.io.IOException; *

* Modifications are for example: Add, Update, Delete * - * @author Mohamed Karray * @since 2.0 */ public interface ModificationsCommand { diff --git a/scm-core/src/main/java/sonia/scm/repository/spi/OutgoingCommand.java b/scm-core/src/main/java/sonia/scm/repository/spi/OutgoingCommand.java index 4944710f4f..166751727e 100644 --- a/scm-core/src/main/java/sonia/scm/repository/spi/OutgoingCommand.java +++ b/scm-core/src/main/java/sonia/scm/repository/spi/OutgoingCommand.java @@ -24,31 +24,17 @@ package sonia.scm.repository.spi; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.repository.ChangesetPagingResult; import java.io.IOException; -//~--- JDK imports ------------------------------------------------------------ - /** * - * @author Sebastian Sdorra * @since 1.31 */ public interface OutgoingCommand { - /** - * Method description - * - * - * @param request - * - * @return - * - * @throws IOException - */ ChangesetPagingResult getOutgoingChangesets(OutgoingCommandRequest request) throws IOException; } diff --git a/scm-core/src/main/java/sonia/scm/repository/spi/OutgoingCommandRequest.java b/scm-core/src/main/java/sonia/scm/repository/spi/OutgoingCommandRequest.java index 27c198bfb7..3cd60dd1d8 100644 --- a/scm-core/src/main/java/sonia/scm/repository/spi/OutgoingCommandRequest.java +++ b/scm-core/src/main/java/sonia/scm/repository/spi/OutgoingCommandRequest.java @@ -26,7 +26,6 @@ package sonia.scm.repository.spi; /** * - * @author Sebastian Sdorra * @since 1.31 */ public final class OutgoingCommandRequest extends PagedRemoteCommandRequest {} diff --git a/scm-core/src/main/java/sonia/scm/repository/spi/PagedRemoteCommandRequest.java b/scm-core/src/main/java/sonia/scm/repository/spi/PagedRemoteCommandRequest.java index 5f513ac7a4..efbb8657ab 100644 --- a/scm-core/src/main/java/sonia/scm/repository/spi/PagedRemoteCommandRequest.java +++ b/scm-core/src/main/java/sonia/scm/repository/spi/PagedRemoteCommandRequest.java @@ -24,21 +24,19 @@ package sonia.scm.repository.spi; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.MoreObjects; import com.google.common.base.Objects; /** * - * @author Sebastian Sdorra * @since 1.31 */ public abstract class PagedRemoteCommandRequest extends RemoteCommandRequest { + private int pagingLimit = 20; - /** - * {@inheritDoc} - */ + private int pagingStart = 0; + @Override public boolean equals(Object obj) { @@ -59,18 +57,14 @@ public abstract class PagedRemoteCommandRequest extends RemoteCommandRequest && Objects.equal(pagingLimit, other.pagingLimit); } - /** - * {@inheritDoc} - */ + @Override public int hashCode() { return Objects.hashCode(remoteRepository, pagingStart, pagingLimit); } - /** - * {@inheritDoc} - */ + @Override public String toString() { @@ -84,59 +78,30 @@ public abstract class PagedRemoteCommandRequest extends RemoteCommandRequest //J+ } - //~--- set methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param pagingLimit - */ + public void setPagingLimit(int pagingLimit) { this.pagingLimit = pagingLimit; } - /** - * Method description - * - * - * @param pagingStart - */ + public void setPagingStart(int pagingStart) { this.pagingStart = pagingStart; } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + int getPagingLimit() { return pagingLimit; } - /** - * Method description - * - * - * @return - */ + int getPagingStart() { return pagingStart; } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private int pagingLimit = 20; - - /** Field description */ - private int pagingStart = 0; } diff --git a/scm-core/src/main/java/sonia/scm/repository/spi/PullCommand.java b/scm-core/src/main/java/sonia/scm/repository/spi/PullCommand.java index c94eaa8fc5..418ec5a904 100644 --- a/scm-core/src/main/java/sonia/scm/repository/spi/PullCommand.java +++ b/scm-core/src/main/java/sonia/scm/repository/spi/PullCommand.java @@ -24,31 +24,15 @@ package sonia.scm.repository.spi; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.repository.api.PullResponse; import java.io.IOException; -//~--- JDK imports ------------------------------------------------------------ - /** - * - * @author Sebastian Sdorra * @since 1.31 */ public interface PullCommand { - - /** - * Method description - * - * - * @param request - * - * @return - * - * @throws IOException - */ PullResponse pull(PullCommandRequest request) throws IOException; } diff --git a/scm-core/src/main/java/sonia/scm/repository/spi/PullCommandRequest.java b/scm-core/src/main/java/sonia/scm/repository/spi/PullCommandRequest.java index 3697a0eab0..5ac2346c58 100644 --- a/scm-core/src/main/java/sonia/scm/repository/spi/PullCommandRequest.java +++ b/scm-core/src/main/java/sonia/scm/repository/spi/PullCommandRequest.java @@ -32,7 +32,6 @@ import lombok.ToString; /** * Request object for {@link PullCommand}. * - * @author Sebastian Sdorra * @since 1.31 */ @Getter diff --git a/scm-core/src/main/java/sonia/scm/repository/spi/PushCommand.java b/scm-core/src/main/java/sonia/scm/repository/spi/PushCommand.java index 99098bdb57..8c8d366fef 100644 --- a/scm-core/src/main/java/sonia/scm/repository/spi/PushCommand.java +++ b/scm-core/src/main/java/sonia/scm/repository/spi/PushCommand.java @@ -24,31 +24,15 @@ package sonia.scm.repository.spi; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.repository.api.PushResponse; import java.io.IOException; -//~--- JDK imports ------------------------------------------------------------ - /** - * - * @author Sebastian Sdorra * @since 1.31 */ public interface PushCommand { - - /** - * Method description - * - * - * @param request - * - * @return - * - * @throws IOException - */ PushResponse push(PushCommandRequest request) throws IOException; } diff --git a/scm-core/src/main/java/sonia/scm/repository/spi/PushCommandRequest.java b/scm-core/src/main/java/sonia/scm/repository/spi/PushCommandRequest.java index 7574c57137..9710dfc7ba 100644 --- a/scm-core/src/main/java/sonia/scm/repository/spi/PushCommandRequest.java +++ b/scm-core/src/main/java/sonia/scm/repository/spi/PushCommandRequest.java @@ -30,7 +30,6 @@ import lombok.Setter; /** * Request object for {@link PushCommand}. * - * @author Sebastian Sdorra * @since 1.31 */ @Getter diff --git a/scm-core/src/main/java/sonia/scm/repository/spi/RemoteCommandRequest.java b/scm-core/src/main/java/sonia/scm/repository/spi/RemoteCommandRequest.java index a95c3d02b5..3e4f4fd7c3 100644 --- a/scm-core/src/main/java/sonia/scm/repository/spi/RemoteCommandRequest.java +++ b/scm-core/src/main/java/sonia/scm/repository/spi/RemoteCommandRequest.java @@ -33,7 +33,6 @@ import sonia.scm.repository.Repository; import java.net.URL; /** - * @author Sebastian Sdorra * @since 1.31 */ @Getter diff --git a/scm-core/src/main/java/sonia/scm/repository/spi/RepositoryServiceProvider.java b/scm-core/src/main/java/sonia/scm/repository/spi/RepositoryServiceProvider.java index 9f78be52d7..68e0b67101 100644 --- a/scm-core/src/main/java/sonia/scm/repository/spi/RepositoryServiceProvider.java +++ b/scm-core/src/main/java/sonia/scm/repository/spi/RepositoryServiceProvider.java @@ -33,25 +33,16 @@ import java.io.IOException; import java.util.Collections; import java.util.Set; -//~--- JDK imports ------------------------------------------------------------ - /** * - * @author Sebastian Sdorra * @since 1.17 */ public abstract class RepositoryServiceProvider implements Closeable { - /** - * Method description - * - * - * @return - */ + public abstract Set getSupportedCommands(); - //~--- methods -------------------------------------------------------------- /** * The default implementation of this method does nothing. If you need to @@ -68,58 +59,32 @@ public abstract class RepositoryServiceProvider implements Closeable // should be implmentented from a service provider } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + public BlameCommand getBlameCommand() { throw new CommandNotSupportedException(Command.BLAME); } - /** - * Method description - * - * - * @return - */ + public BranchesCommand getBranchesCommand() { throw new CommandNotSupportedException(Command.BRANCHES); } - /** - * Method description - * - * - * @return - */ + public BranchCommand getBranchCommand() { throw new CommandNotSupportedException(Command.BRANCH); } - /** - * Method description - * - * - * @return - */ + public BrowseCommand getBrowseCommand() { throw new CommandNotSupportedException(Command.BROWSE); } /** - * Method description - * - * - * @return - * * @since 1.43 */ public BundleCommand getBundleCommand() @@ -127,23 +92,12 @@ public abstract class RepositoryServiceProvider implements Closeable throw new CommandNotSupportedException(Command.BUNDLE); } - /** - * Method description - * - * - * @return - */ public CatCommand getCatCommand() { throw new CommandNotSupportedException(Command.CAT); } - /** - * Method description - * - * - * @return - */ + public DiffCommand getDiffCommand() { throw new CommandNotSupportedException(Command.DIFF); @@ -155,10 +109,6 @@ public abstract class RepositoryServiceProvider implements Closeable } /** - * Method description - * - * - * @return * @since 1.31 */ public IncomingCommand getIncomingCommand() @@ -166,12 +116,7 @@ public abstract class RepositoryServiceProvider implements Closeable throw new CommandNotSupportedException(Command.INCOMING); } - /** - * Method description - * - * - * @return - */ + public LogCommand getLogCommand() { throw new CommandNotSupportedException(Command.LOG); @@ -188,10 +133,6 @@ public abstract class RepositoryServiceProvider implements Closeable } /** - * Method description - * - * - * @return * @since 1.31 */ public OutgoingCommand getOutgoingCommand() @@ -200,10 +141,6 @@ public abstract class RepositoryServiceProvider implements Closeable } /** - * Method description - * - * - * @return * @since 1.31 */ public PullCommand getPullCommand() @@ -212,10 +149,6 @@ public abstract class RepositoryServiceProvider implements Closeable } /** - * Method description - * - * - * @return * @since 1.31 */ public PushCommand getPushCommand() @@ -223,23 +156,13 @@ public abstract class RepositoryServiceProvider implements Closeable throw new CommandNotSupportedException(Command.PUSH); } - /** - * Method description - * - * - * @return - */ + public Set getSupportedFeatures() { return Collections.emptySet(); } - /** - * Method description - * - * - * @return - */ + public TagsCommand getTagsCommand() { throw new CommandNotSupportedException(Command.TAGS); @@ -255,11 +178,6 @@ public abstract class RepositoryServiceProvider implements Closeable } /** - * Method description - * - * - * @return - * * @since 1.43 */ public UnbundleCommand getUnbundleCommand() diff --git a/scm-core/src/main/java/sonia/scm/repository/spi/RepositoryServiceResolver.java b/scm-core/src/main/java/sonia/scm/repository/spi/RepositoryServiceResolver.java index dbb3cb915f..fc65bf0ea7 100644 --- a/scm-core/src/main/java/sonia/scm/repository/spi/RepositoryServiceResolver.java +++ b/scm-core/src/main/java/sonia/scm/repository/spi/RepositoryServiceResolver.java @@ -29,20 +29,10 @@ import sonia.scm.repository.Repository; /** * - * @author Sebastian Sdorra * @since 1.17 */ @ExtensionPoint public interface RepositoryServiceResolver { - - /** - * Method description - * - * - * @param repository - * - * @return - */ public RepositoryServiceProvider resolve(Repository repository); } diff --git a/scm-core/src/main/java/sonia/scm/repository/spi/Resetable.java b/scm-core/src/main/java/sonia/scm/repository/spi/Resetable.java index 82710ea731..1ce74bc5c0 100644 --- a/scm-core/src/main/java/sonia/scm/repository/spi/Resetable.java +++ b/scm-core/src/main/java/sonia/scm/repository/spi/Resetable.java @@ -25,16 +25,10 @@ package sonia.scm.repository.spi; /** - * - * @author Sebastian Sdorra * @since 1.17 */ public interface Resetable { - /** - * Method description - * - */ - public void reset(); + public void reset(); } diff --git a/scm-core/src/main/java/sonia/scm/repository/spi/ScmProviderHttpServletDecoratorFactory.java b/scm-core/src/main/java/sonia/scm/repository/spi/ScmProviderHttpServletDecoratorFactory.java index b5f29d44b0..71eeeabb43 100644 --- a/scm-core/src/main/java/sonia/scm/repository/spi/ScmProviderHttpServletDecoratorFactory.java +++ b/scm-core/src/main/java/sonia/scm/repository/spi/ScmProviderHttpServletDecoratorFactory.java @@ -30,7 +30,7 @@ import sonia.scm.plugin.ExtensionPoint; @ExtensionPoint public interface ScmProviderHttpServletDecoratorFactory extends DecoratorFactory { /** - * Has to return true if this factory provides a decorator for the given scm type (eg. "git", "hg" or + * Has to return true if this factory provides a decorator for the given scm type (e.g. "git", "hg" or * "svn"). * @param type The current scm type this factory can provide a decorator for. * @return true when the provided decorator should be used for the given scm type. diff --git a/scm-core/src/main/java/sonia/scm/repository/spi/TagsCommand.java b/scm-core/src/main/java/sonia/scm/repository/spi/TagsCommand.java index 26f450dc69..9b29dcabe8 100644 --- a/scm-core/src/main/java/sonia/scm/repository/spi/TagsCommand.java +++ b/scm-core/src/main/java/sonia/scm/repository/spi/TagsCommand.java @@ -24,29 +24,16 @@ package sonia.scm.repository.spi; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.repository.Tag; import java.io.IOException; import java.util.List; -//~--- JDK imports ------------------------------------------------------------ -/** - * - * @author Sebastian Sdorra - */ public interface TagsCommand { - /** - * Method description - * - * - * @return - * - * @throws IOException - */ + public List getTags() throws IOException; } diff --git a/scm-core/src/main/java/sonia/scm/repository/spi/UnbundleCommand.java b/scm-core/src/main/java/sonia/scm/repository/spi/UnbundleCommand.java index 1c98cc5477..68bc7807cc 100644 --- a/scm-core/src/main/java/sonia/scm/repository/spi/UnbundleCommand.java +++ b/scm-core/src/main/java/sonia/scm/repository/spi/UnbundleCommand.java @@ -24,14 +24,11 @@ package sonia.scm.repository.spi; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.repository.api.UnbundleResponse; import java.io.IOException; -//~--- JDK imports ------------------------------------------------------------ - /** * Service provider implementation for the unbundle command. * diff --git a/scm-core/src/main/java/sonia/scm/repository/spi/UnbundleCommandRequest.java b/scm-core/src/main/java/sonia/scm/repository/spi/UnbundleCommandRequest.java index 29d2e0fd3e..da65d9fb29 100644 --- a/scm-core/src/main/java/sonia/scm/repository/spi/UnbundleCommandRequest.java +++ b/scm-core/src/main/java/sonia/scm/repository/spi/UnbundleCommandRequest.java @@ -24,7 +24,6 @@ package sonia.scm.repository.spi; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Objects; import com.google.common.io.ByteSource; @@ -42,20 +41,16 @@ import java.util.function.Consumer; */ public final class UnbundleCommandRequest { - /** - * Constructs a new unbundle command request. - * - * @param archive byte source archive - */ + private Consumer postEventSink = event -> + ScmEventBus.getInstance().post(new PostReceiveRepositoryHookEvent(event)); + + private final ByteSource archive; + public UnbundleCommandRequest(ByteSource archive) { this.archive = archive; } - //~--- methods -------------------------------------------------------------- - /** - * {@inheritDoc} - */ @Override public boolean equals(Object obj) { if (obj == null) { @@ -71,21 +66,13 @@ public final class UnbundleCommandRequest { return Objects.equal(archive, other.archive); } - /** - * {@inheritDoc} - */ + @Override public int hashCode() { return Objects.hashCode(archive); } - //~--- get methods ---------------------------------------------------------- - /** - * Returns the archive as {@link ByteSource}. - * - * @return {@link ByteSource} archive - */ public ByteSource getArchive() { return archive; } @@ -99,13 +86,4 @@ public final class UnbundleCommandRequest { this.postEventSink = postEventSink; } - //~--- fields --------------------------------------------------------------- - - private Consumer postEventSink = event -> - ScmEventBus.getInstance().post(new PostReceiveRepositoryHookEvent(event)); - - /** - * byte source archive - */ - private final ByteSource archive; } diff --git a/scm-core/src/main/java/sonia/scm/schedule/Scheduler.java b/scm-core/src/main/java/sonia/scm/schedule/Scheduler.java index 11b9c34abf..d7afdd87f0 100644 --- a/scm-core/src/main/java/sonia/scm/schedule/Scheduler.java +++ b/scm-core/src/main/java/sonia/scm/schedule/Scheduler.java @@ -29,7 +29,6 @@ import java.io.Closeable; /** * Scheduler is able to run tasks on the future in a background thread. Task can be scheduled with cron like expression. * Note: Task are always executed in an administrative context. - * @author Sebastian Sdorra * @since 1.47 */ public interface Scheduler extends Closeable { diff --git a/scm-core/src/main/java/sonia/scm/schedule/Task.java b/scm-core/src/main/java/sonia/scm/schedule/Task.java index 68ced1820e..d8d2b8e7b4 100644 --- a/scm-core/src/main/java/sonia/scm/schedule/Task.java +++ b/scm-core/src/main/java/sonia/scm/schedule/Task.java @@ -27,14 +27,10 @@ package sonia.scm.schedule; /** * Tasks are executed in the future and can be running more than once. A task execution can be canceled. * - * @author Sebastian Sdorra * @since 1.47 */ public interface Task { - /** - * Cancel task execution. - */ public void cancel(); } diff --git a/scm-core/src/main/java/sonia/scm/search/Id.java b/scm-core/src/main/java/sonia/scm/search/Id.java index 7bf54b61ba..b42e24a09f 100644 --- a/scm-core/src/main/java/sonia/scm/search/Id.java +++ b/scm-core/src/main/java/sonia/scm/search/Id.java @@ -63,7 +63,6 @@ public final class Id { * Creates a new combined id by adding a new type and value. * @param type other type * @param id other id - * @return new combined id * @since 2.23.0 */ public Id and(Class type, String id) { @@ -83,7 +82,6 @@ public final class Id { * Creates a new combined id by adding a new type and value. * @param type other type * @param idObject object which holds id - * @return new combined id * @since 2.23.0 */ public Id and(Class type, ModelObject idObject) { @@ -94,7 +92,6 @@ public final class Id { /** * Creates a new combined id by adding the given repository. * @param repository repository to add - * @return new combined id * @since 2.23.0 */ public Id and(Repository repository) { @@ -107,8 +104,6 @@ public final class Id { * * @param mainType main type of the id * @param mainId main id of the id - * - * @return new id */ public static Id of(Class mainType, String mainId) { Preconditions.checkArgument(mainType != null, "main type is required"); @@ -121,8 +116,6 @@ public final class Id { * * @param mainType main type of the id * @param mainIdObject object which holds the main id - * - * @return new id */ public static Id of(Class mainType, ModelObject mainIdObject) { Preconditions.checkArgument(mainIdObject != null, "main id object is required"); diff --git a/scm-core/src/main/java/sonia/scm/search/Index.java b/scm-core/src/main/java/sonia/scm/search/Index.java index 45acc48aef..e4e339717f 100644 --- a/scm-core/src/main/java/sonia/scm/search/Index.java +++ b/scm-core/src/main/java/sonia/scm/search/Index.java @@ -39,7 +39,6 @@ public interface Index { /** * Returns details such as name and type of index. * - * @return details of index * @since 2.23.0 */ IndexDetails getDetails(); diff --git a/scm-core/src/main/java/sonia/scm/search/IndexDetails.java b/scm-core/src/main/java/sonia/scm/search/IndexDetails.java index 23db92a53c..34822391d4 100644 --- a/scm-core/src/main/java/sonia/scm/search/IndexDetails.java +++ b/scm-core/src/main/java/sonia/scm/search/IndexDetails.java @@ -35,13 +35,11 @@ public interface IndexDetails { /** * Returns type of objects which are indexed. - * @return type of objects */ Class getType(); /** * Returns the name of the index (e.g. `default`) - * @return name */ String getName(); } diff --git a/scm-core/src/main/java/sonia/scm/search/IndexTask.java b/scm-core/src/main/java/sonia/scm/search/IndexTask.java index 11b5d9bfab..617ae87aa5 100644 --- a/scm-core/src/main/java/sonia/scm/search/IndexTask.java +++ b/scm-core/src/main/java/sonia/scm/search/IndexTask.java @@ -37,7 +37,6 @@ public interface IndexTask { /** * Execute operations on the index. - * @param index index to update */ void update(Index index); diff --git a/scm-core/src/main/java/sonia/scm/search/Indexer.java b/scm-core/src/main/java/sonia/scm/search/Indexer.java index 7e6967d78a..9663bfa071 100644 --- a/scm-core/src/main/java/sonia/scm/search/Indexer.java +++ b/scm-core/src/main/java/sonia/scm/search/Indexer.java @@ -42,8 +42,6 @@ public interface Indexer { /** * Returns class of type. - * - * @return class of type */ Class getType(); @@ -57,7 +55,6 @@ public interface Indexer { /** * Returns task which re index all items. - * @return task to re index all * @since 2.23.0 */ Class> getReIndexAllTask(); diff --git a/scm-core/src/main/java/sonia/scm/search/SearchEngine.java b/scm-core/src/main/java/sonia/scm/search/SearchEngine.java index b0dcd4dcc7..6bf61db031 100644 --- a/scm-core/src/main/java/sonia/scm/search/SearchEngine.java +++ b/scm-core/src/main/java/sonia/scm/search/SearchEngine.java @@ -186,7 +186,6 @@ public interface SearchEngine { /** * Returns a query builder object which can be used to search the index. - * @return query builder */ QueryBuilder search(); } diff --git a/scm-core/src/main/java/sonia/scm/search/SearchEngineException.java b/scm-core/src/main/java/sonia/scm/search/SearchEngineException.java index ccc0afed5f..287d1c3ea6 100644 --- a/scm-core/src/main/java/sonia/scm/search/SearchEngineException.java +++ b/scm-core/src/main/java/sonia/scm/search/SearchEngineException.java @@ -27,7 +27,7 @@ package sonia.scm.search; import com.google.common.annotations.Beta; /** - * Generic exception which could by thrown by any part of the search engine. + * Generic exception which could be thrown by any part of the search engine. * * @since 2.21.0 */ diff --git a/scm-core/src/main/java/sonia/scm/search/SearchRequest.java b/scm-core/src/main/java/sonia/scm/search/SearchRequest.java index 1547cb0e4d..38520dfdf3 100644 --- a/scm-core/src/main/java/sonia/scm/search/SearchRequest.java +++ b/scm-core/src/main/java/sonia/scm/search/SearchRequest.java @@ -24,37 +24,24 @@ package sonia.scm.search; -/** - * - * @author Sebastian Sdorra - */ + public class SearchRequest { + private boolean ignoreCase = false; + + private int maxResults = -1; + + private String query; + + private int startWith = 0; - /** - * Constructs ... - * - */ public SearchRequest() {} - /** - * Constructs ... - * - * - * @param query - */ public SearchRequest(String query) { this.query = query; } - /** - * Constructs ... - * - * - * @param query - * @param ignoreCase - */ public SearchRequest(String query, boolean ignoreCase) { this.query = query; @@ -67,109 +54,49 @@ public class SearchRequest this.maxResults = maxResults; } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + public int getMaxResults() { return maxResults; } - /** - * Method description - * - * - * @return - */ + public String getQuery() { return query; } - /** - * Method description - * - * - * @return - */ + public int getStartWith() { return startWith; } - /** - * Method description - * - * - * @return - */ + public boolean isIgnoreCase() { return ignoreCase; } - //~--- set methods ---------------------------------------------------------- - - /** - * Method description - * - * - * @param ignoreCase - */ public void setIgnoreCase(boolean ignoreCase) { this.ignoreCase = ignoreCase; } - /** - * Method description - * - * - * @param maxResults - */ public void setMaxResults(int maxResults) { this.maxResults = maxResults; } - /** - * Method description - * - * - * @param query - */ public void setQuery(String query) { this.query = query; } - /** - * Method description - * - * - * @param startWith - */ public void setStartWith(int startWith) { this.startWith = startWith; } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private boolean ignoreCase = false; - - /** Field description */ - private int maxResults = -1; - - /** Field description */ - private String query; - - /** Field description */ - private int startWith = 0; } diff --git a/scm-core/src/main/java/sonia/scm/search/Searchable.java b/scm-core/src/main/java/sonia/scm/search/Searchable.java index 5566b9d35d..b7acf946e7 100644 --- a/scm-core/src/main/java/sonia/scm/search/Searchable.java +++ b/scm-core/src/main/java/sonia/scm/search/Searchable.java @@ -24,26 +24,9 @@ package sonia.scm.search; -//~--- JDK imports ------------------------------------------------------------ - import java.util.Collection; -/** - * - * @author Sebastian Sdorra - * - * @param - */ public interface Searchable { - - /** - * Method description - * - * - * @param searchRequest - * - * @return - */ public Collection search(SearchRequest searchRequest); } diff --git a/scm-core/src/main/java/sonia/scm/search/SearchableField.java b/scm-core/src/main/java/sonia/scm/search/SearchableField.java index cd9b39335e..50398b5342 100644 --- a/scm-core/src/main/java/sonia/scm/search/SearchableField.java +++ b/scm-core/src/main/java/sonia/scm/search/SearchableField.java @@ -35,15 +35,11 @@ public interface SearchableField { /** * Returns the name of the searchable field. - * - * @return field name */ String getName(); /** * Returns the type of the searchable field. - * - * @return field type */ Class getType(); } diff --git a/scm-core/src/main/java/sonia/scm/search/SearchableType.java b/scm-core/src/main/java/sonia/scm/search/SearchableType.java index 2b43d4e33b..5737c356f3 100644 --- a/scm-core/src/main/java/sonia/scm/search/SearchableType.java +++ b/scm-core/src/main/java/sonia/scm/search/SearchableType.java @@ -38,23 +38,18 @@ public interface SearchableType { /** * Return name of the type. - * - * @return name of type */ String getName(); /** * Return type in form of class. - * - * @return class of type */ Class getType(); /** * Returns collection of searchable fields. * - * @return collection of searchable fields - * @since 2.23.0 + * @since 2.23.0 */ Collection getFields(); diff --git a/scm-core/src/main/java/sonia/scm/security/AccessToken.java b/scm-core/src/main/java/sonia/scm/security/AccessToken.java index 23513ee737..003e9d4ea8 100644 --- a/scm-core/src/main/java/sonia/scm/security/AccessToken.java +++ b/scm-core/src/main/java/sonia/scm/security/AccessToken.java @@ -35,73 +35,54 @@ import java.util.Set; * send along with every request. The token should be send in its compact representation as bearer authorization header * or as cookie. * - * @author Sebastian Sdorra * @since 2.0.0 */ public interface AccessToken { /** * Returns unique id of the access token. - * - * @return unique id */ String getId(); /** * Returns name of subject which identifies the principal. - * - * @return name of subject */ String getSubject(); /** * Returns optional issuer. The issuer identifies the principal that issued the token. - * - * @return optional issuer */ Optional getIssuer(); /** * Returns time at which the token was issued. - * - * @return time at which the token was issued */ Date getIssuedAt(); /** * Returns the expiration time of token. - * - * @return expiration time */ Date getExpiration(); /** * Returns refresh expiration of token. - * - * @return refresh expiration */ Optional getRefreshExpiration(); /** * Returns id of the parent key. - * - * @return parent key id */ Optional getParentKey(); /** * Returns the scope of the token. The scope is able to reduce the permissions of the subject in the context of this - * token. For example we could issue a token which can only be used to read a single repository. for more informations + * token. For example, we could issue a token which can only be used to read a single repository. for more informations * please have a look at {@link Scope}. - * - * @return scope of token. */ Scope getScope(); /** * Returns name of groups, in which the user should be a member. - * - * @return name of groups */ Set getGroups(); @@ -110,15 +91,11 @@ public interface AccessToken { * * @param type of field * @param key key of token field - * - * @return optional value of custom field */ Optional getCustom(String key); /** * Returns compact representation of token. - * - * @return compact representation */ String compact(); diff --git a/scm-core/src/main/java/sonia/scm/security/AccessTokenBuilder.java b/scm-core/src/main/java/sonia/scm/security/AccessTokenBuilder.java index 7d82628ee9..6701dd0b7b 100644 --- a/scm-core/src/main/java/sonia/scm/security/AccessTokenBuilder.java +++ b/scm-core/src/main/java/sonia/scm/security/AccessTokenBuilder.java @@ -30,7 +30,6 @@ import java.util.concurrent.TimeUnit; * The access token builder is able to create {@link AccessToken}. For more informations about access tokens have look * at {@link AccessToken}. * - * @author Sebastian Sdorra * @since 2.0.0 */ public interface AccessTokenBuilder { diff --git a/scm-core/src/main/java/sonia/scm/security/AccessTokenBuilderFactory.java b/scm-core/src/main/java/sonia/scm/security/AccessTokenBuilderFactory.java index 033964601e..cfe0b85e45 100644 --- a/scm-core/src/main/java/sonia/scm/security/AccessTokenBuilderFactory.java +++ b/scm-core/src/main/java/sonia/scm/security/AccessTokenBuilderFactory.java @@ -30,7 +30,6 @@ import sonia.scm.plugin.ExtensionPoint; * Creates new {@link AccessTokenBuilder}. The AccessTokenBuilderFactory resolves all required dependencies for the * access token builder. The builder factory is the main entry point for creating {@link AccessToken}. * - * @author Sebastian Sdorra * @since 2.0.0 */ @ExtensionPoint(multi = false) diff --git a/scm-core/src/main/java/sonia/scm/security/AccessTokenCookieIssuer.java b/scm-core/src/main/java/sonia/scm/security/AccessTokenCookieIssuer.java index b22cbaed65..81380f89d9 100644 --- a/scm-core/src/main/java/sonia/scm/security/AccessTokenCookieIssuer.java +++ b/scm-core/src/main/java/sonia/scm/security/AccessTokenCookieIssuer.java @@ -30,25 +30,17 @@ import jakarta.servlet.http.HttpServletResponse; /** * Generates cookies and invalidates access token cookies. * - * @author Sebastian Sdorra * @since 2.0.0 */ public interface AccessTokenCookieIssuer { /** * Creates a cookie for token authentication and attaches it to the response. - * - * @param request http servlet request - * @param response http servlet response - * @param accessToken access token */ void authenticate(HttpServletRequest request, HttpServletResponse response, AccessToken accessToken); /** * Invalidates the authentication cookie. - * - * @param request http servlet request - * @param response http servlet response */ void invalidate(HttpServletRequest request, HttpServletResponse response); diff --git a/scm-core/src/main/java/sonia/scm/security/AccessTokenEnricher.java b/scm-core/src/main/java/sonia/scm/security/AccessTokenEnricher.java index 489973e7be..06045a79d4 100644 --- a/scm-core/src/main/java/sonia/scm/security/AccessTokenEnricher.java +++ b/scm-core/src/main/java/sonia/scm/security/AccessTokenEnricher.java @@ -31,7 +31,6 @@ import sonia.scm.plugin.ExtensionPoint; * AccessTokenEnricher can be used to add custom fields to the {@link AccessToken}. The enricher is always called before * an {@link AccessToken} is build by the {@link AccessTokenBuilder}. * - * @author Sebastian Sdorra * @since 2.0.0 */ @ExtensionPoint diff --git a/scm-core/src/main/java/sonia/scm/security/AccessTokenResolver.java b/scm-core/src/main/java/sonia/scm/security/AccessTokenResolver.java index 47d20f71fd..e4ae2a75ec 100644 --- a/scm-core/src/main/java/sonia/scm/security/AccessTokenResolver.java +++ b/scm-core/src/main/java/sonia/scm/security/AccessTokenResolver.java @@ -30,7 +30,6 @@ import sonia.scm.plugin.ExtensionPoint; * AccessTokenResolver are used to parse, validate and verify an {@link AccessToken} from a {@link BearerToken}. The * resolver should be used to get an {@link AccessToken} from a {@link BearerToken}. * - * @author Sebastian Sdorra * @since 2.0.0 */ @ExtensionPoint(multi = false) diff --git a/scm-core/src/main/java/sonia/scm/security/AccessTokenValidator.java b/scm-core/src/main/java/sonia/scm/security/AccessTokenValidator.java index 036f4abf44..ffd093c196 100644 --- a/scm-core/src/main/java/sonia/scm/security/AccessTokenValidator.java +++ b/scm-core/src/main/java/sonia/scm/security/AccessTokenValidator.java @@ -30,7 +30,6 @@ import sonia.scm.plugin.ExtensionPoint; * Validates an {@link AccessToken}. The validator is called during authentication * with an {@link AccessToken}. * - * @author Sebastian Sdorra * @since 2.0.0 */ @ExtensionPoint @@ -41,8 +40,6 @@ public interface AccessTokenValidator { * method returns {@code false}, the authentication is treated as failed. * * @param token the access token to verify - * - * @return {@code true} if the token is valid */ boolean validate(AccessToken token); } diff --git a/scm-core/src/main/java/sonia/scm/security/AssignedPermission.java b/scm-core/src/main/java/sonia/scm/security/AssignedPermission.java index 45e7e0c657..723bde4260 100644 --- a/scm-core/src/main/java/sonia/scm/security/AssignedPermission.java +++ b/scm-core/src/main/java/sonia/scm/security/AssignedPermission.java @@ -24,7 +24,6 @@ package sonia.scm.security; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.MoreObjects; import com.google.common.base.Objects; @@ -37,12 +36,9 @@ import sonia.scm.auditlog.AuditLogEntity; import java.io.Serializable; -//~--- JDK imports ------------------------------------------------------------ - /** * Permission object which is assigned to a specific user or group. * - * @author Sebastian Sdorra * @since 1.31 */ @XmlAccessorType(XmlAccessType.FIELD) @@ -51,23 +47,23 @@ import java.io.Serializable; public class AssignedPermission implements PermissionObject, Serializable, AuditLogEntity { - /** serial version uid */ private static final long serialVersionUID = -7411338422110323879L; - //~--- constructors --------------------------------------------------------- + /** group permission indicator */ + @XmlElement(name = "group-permission") + private boolean groupPermission; + + /** name of the user or group */ + private String name; + + /** string representation of the permission */ + private PermissionDescriptor permission; /** * Constructor is only visible for JAXB. - * */ public AssignedPermission() {} - /** - * Constructs a new AssignedPermission. - * - * - * @param permission assigned permission - */ public AssignedPermission(AssignedPermission permission) { this.name = permission.name; @@ -75,13 +71,6 @@ public class AssignedPermission implements PermissionObject, Serializable, Audit this.permission = permission.permission; } - /** - * Constructs a new AssingnedPermmission. - * - * - * @param name name of the user - * @param permission permission string - */ public AssignedPermission(String name, String permission) { this(name, new PermissionDescriptor(permission)); @@ -92,14 +81,6 @@ public class AssignedPermission implements PermissionObject, Serializable, Audit this(name, false, permission); } - /** - * Constructs a new AssingnedPermmission. - * - * - * @param name name of the user or group - * @param groupPermission true if the permission should be assigned to a group - * @param permission permission string - */ public AssignedPermission(String name, boolean groupPermission, String permission) { @@ -114,11 +95,8 @@ public class AssignedPermission implements PermissionObject, Serializable, Audit this.permission = permission; } - //~--- methods -------------------------------------------------------------- - /** - * {@inheritDoc} - */ + @Override public boolean equals(Object obj) { @@ -139,18 +117,14 @@ public class AssignedPermission implements PermissionObject, Serializable, Audit && Objects.equal(permission, other.permission); } - /** - * {@inheritDoc} - */ + @Override public int hashCode() { return Objects.hashCode(name, groupPermission, permission); } - /** - * {@inheritDoc} - */ + @Override public String toString() { @@ -163,13 +137,9 @@ public class AssignedPermission implements PermissionObject, Serializable, Audit //J+ } - //~--- get methods ---------------------------------------------------------- /** * Returns the name of the user or group which the permission is assigned. - * - * - * @return name of user or group */ @Override public String getName() @@ -187,9 +157,6 @@ public class AssignedPermission implements PermissionObject, Serializable, Audit /** * Returns true if the permission is assigned to a group. - * - * - * @return true if the permission is assigned to a group */ @Override public boolean isGroupPermission() @@ -197,18 +164,6 @@ public class AssignedPermission implements PermissionObject, Serializable, Audit return groupPermission; } - //~--- fields --------------------------------------------------------------- - - /** group permission indicator */ - @XmlElement(name = "group-permission") - private boolean groupPermission; - - /** name of the user or group */ - private String name; - - /** string representation of the permission */ - private PermissionDescriptor permission; - @Override public String getEntityName() { return getName(); diff --git a/scm-core/src/main/java/sonia/scm/security/AssignedPermissionEvent.java b/scm-core/src/main/java/sonia/scm/security/AssignedPermissionEvent.java index ffe8b2fdc5..68fa257721 100644 --- a/scm-core/src/main/java/sonia/scm/security/AssignedPermissionEvent.java +++ b/scm-core/src/main/java/sonia/scm/security/AssignedPermissionEvent.java @@ -24,7 +24,6 @@ package sonia.scm.security; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.MoreObjects; import com.google.common.base.Objects; @@ -33,31 +32,22 @@ import sonia.scm.event.Event; import java.io.Serializable; -//~--- JDK imports ------------------------------------------------------------ - /** * Event which is fired after a {@link StoredAssignedPermission} was added, * removed or changed. * - * @author Sebastian Sdorra * @since 1.31 */ @Event public final class AssignedPermissionEvent implements Serializable { + /** changed permission */ + private AssignedPermission permission; + + private HandlerEventType type; - /** serial version uid */ private static final long serialVersionUID = 706824497813169009L; - //~--- constructors --------------------------------------------------------- - - /** - * Constructs a new AssignedPermissionEvent. - * - * - * @param type type of the event - * @param permission permission object which has changed - */ public AssignedPermissionEvent(HandlerEventType type, AssignedPermission permission) { @@ -65,11 +55,8 @@ public final class AssignedPermissionEvent implements Serializable this.permission = permission; } - //~--- methods -------------------------------------------------------------- - /** - * {@inheritDoc} - */ + @Override public boolean equals(Object obj) { @@ -90,18 +77,14 @@ public final class AssignedPermissionEvent implements Serializable && Objects.equal(permission, other.permission); } - /** - * {@inheritDoc} - */ + @Override public int hashCode() { return Objects.hashCode(type, permission); } - /** - * {@inheritDoc} - */ + @Override public String toString() { @@ -113,14 +96,6 @@ public final class AssignedPermissionEvent implements Serializable //J+ } - //~--- get methods ---------------------------------------------------------- - - /** - * Return the type of the event. - * - * - * @return type of event - */ public HandlerEventType getEventType() { return type; @@ -128,20 +103,10 @@ public final class AssignedPermissionEvent implements Serializable /** * Returns the changed permission object. - * - * - * @return changed permission */ public AssignedPermission getPermission() { return permission; } - //~--- fields --------------------------------------------------------------- - - /** changed permission */ - private AssignedPermission permission; - - /** type of the event */ - private HandlerEventType type; } diff --git a/scm-core/src/main/java/sonia/scm/security/AuthorizationChangedEvent.java b/scm-core/src/main/java/sonia/scm/security/AuthorizationChangedEvent.java index b4eb524669..0a4b205f51 100644 --- a/scm-core/src/main/java/sonia/scm/security/AuthorizationChangedEvent.java +++ b/scm-core/src/main/java/sonia/scm/security/AuthorizationChangedEvent.java @@ -21,63 +21,52 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ - + package sonia.scm.security; import sonia.scm.event.Event; /** - * This type of event is fired whenever a authorization relevant data changes. This event + * This type of event is fired whenever an authorization relevant data changes. This event * is especially useful for cache invalidation. - * - * @author Sebastian Sdorra + * * @since 1.52 */ @Event public final class AuthorizationChangedEvent { - + private final String nameOfAffectedUser; - + private AuthorizationChangedEvent(String nameOfAffectedUser) { this.nameOfAffectedUser = nameOfAffectedUser; } - + /** * Returns {@code true} if every user is affected by this data change. - * - * @return {@code true} if every user is affected */ public boolean isEveryUserAffected(){ return nameOfAffectedUser == null; } - + /** * Returns the name of the user which is affected by this event. - * - * @return name of affected user */ public String getNameOfAffectedUser(){ return nameOfAffectedUser; } - + /** * Creates a new event which affects every user. - * - * @return new event for every user */ public static AuthorizationChangedEvent createForEveryUser() { return new AuthorizationChangedEvent(null); } - + /** * Create a new event which affect a single user. - * - * @param nameOfAffectedUser name of affected user - * - * @return new event for a single user */ public static AuthorizationChangedEvent createForUser(String nameOfAffectedUser) { return new AuthorizationChangedEvent(nameOfAffectedUser); } - + } diff --git a/scm-core/src/main/java/sonia/scm/security/AuthorizationCollector.java b/scm-core/src/main/java/sonia/scm/security/AuthorizationCollector.java index 9687b717e8..0c26d06b55 100644 --- a/scm-core/src/main/java/sonia/scm/security/AuthorizationCollector.java +++ b/scm-core/src/main/java/sonia/scm/security/AuthorizationCollector.java @@ -24,7 +24,6 @@ package sonia.scm.security; -//~--- non-JDK imports -------------------------------------------------------- import org.apache.shiro.authz.AuthorizationInfo; import org.apache.shiro.subject.PrincipalCollection; @@ -33,7 +32,6 @@ import sonia.scm.plugin.ExtensionPoint; /** * Collect {@link AuthorizationInfo} for the authenticated user. * - * @author Sebastian Sdorra * @since 2.0.0 */ @ExtensionPoint @@ -44,8 +42,6 @@ public interface AuthorizationCollector * Returns {@link AuthorizationInfo} for the authenticated user. * * @param principalCollection collected principals - * - * @return {@link AuthorizationInfo} for authenticated user */ AuthorizationInfo collect(PrincipalCollection principalCollection); } diff --git a/scm-core/src/main/java/sonia/scm/security/BearerToken.java b/scm-core/src/main/java/sonia/scm/security/BearerToken.java index 7140c8fe6d..029fd1c281 100644 --- a/scm-core/src/main/java/sonia/scm/security/BearerToken.java +++ b/scm-core/src/main/java/sonia/scm/security/BearerToken.java @@ -24,7 +24,6 @@ package sonia.scm.security; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Preconditions; import com.google.common.base.Strings; @@ -34,7 +33,6 @@ import org.apache.shiro.authc.AuthenticationToken; /** * Token used for authentication with bearer tokens. * - * @author Sebastian Sdorra * @since 2.0.0 */ public final class BearerToken implements AuthenticationToken { @@ -55,8 +53,6 @@ public final class BearerToken implements AuthenticationToken { /** * Returns the wrapped raw format of the token. - * - * @return raw format */ @Override public String getCredentials() { @@ -65,8 +61,6 @@ public final class BearerToken implements AuthenticationToken { /** * Returns the session id or {@code null}. - * - * @return session id or {@code null} */ @Override public SessionId getPrincipal() { @@ -77,8 +71,6 @@ public final class BearerToken implements AuthenticationToken { * Creates a new {@link BearerToken} from raw string representation. * * @param raw string representation - * - * @return new bearer token */ public static BearerToken valueOf(String raw){ Preconditions.checkArgument(!Strings.isNullOrEmpty(raw), "raw token is required"); @@ -90,8 +82,6 @@ public final class BearerToken implements AuthenticationToken { * * @param session session id of the client * @param rawToken bearer token string representation - * - * @return new bearer token */ public static BearerToken create(@Nullable SessionId session, String rawToken) { Preconditions.checkArgument(!Strings.isNullOrEmpty(rawToken), "raw token is required"); diff --git a/scm-core/src/main/java/sonia/scm/security/CipherException.java b/scm-core/src/main/java/sonia/scm/security/CipherException.java index 10e5027c7b..0148df5838 100644 --- a/scm-core/src/main/java/sonia/scm/security/CipherException.java +++ b/scm-core/src/main/java/sonia/scm/security/CipherException.java @@ -26,55 +26,29 @@ package sonia.scm.security; /** * - * @author Sebastian Sdorra * @since 1.7 */ public class CipherException extends RuntimeException { - /** Field description */ private static final long serialVersionUID = -310359939906084281L; - //~--- constructors --------------------------------------------------------- - /** - * Constructs ... - * - */ public CipherException() { super(); } - /** - * Constructs ... - * - * - * @param message - */ public CipherException(String message) { super(message); } - /** - * Constructs ... - * - * - * @param cause - */ public CipherException(Throwable cause) { super(cause); } - /** - * Constructs ... - * - * - * @param message - * @param cause - */ public CipherException(String message, Throwable cause) { super(message, cause); diff --git a/scm-core/src/main/java/sonia/scm/security/CipherHandler.java b/scm-core/src/main/java/sonia/scm/security/CipherHandler.java index 7483562467..01ec48cffc 100644 --- a/scm-core/src/main/java/sonia/scm/security/CipherHandler.java +++ b/scm-core/src/main/java/sonia/scm/security/CipherHandler.java @@ -31,7 +31,6 @@ import static java.nio.charset.StandardCharsets.UTF_8; /** * Encrypts and decrypts string values. * - * @author Sebastian Sdorra * @since 1.7 */ public interface CipherHandler @@ -39,10 +38,6 @@ public interface CipherHandler /** * Decrypts the given value. - * - * @param value encrypted value - * - * @return decrypted value */ String decode(String value); @@ -64,10 +59,6 @@ public interface CipherHandler /** * Encrypts the given value. - * - * @param value plain text value to encrypt. - * - * @return encrypted value */ String encode(String value); diff --git a/scm-core/src/main/java/sonia/scm/security/CipherUtil.java b/scm-core/src/main/java/sonia/scm/security/CipherUtil.java index 2254a566b1..b5fcca95dc 100644 --- a/scm-core/src/main/java/sonia/scm/security/CipherUtil.java +++ b/scm-core/src/main/java/sonia/scm/security/CipherUtil.java @@ -29,7 +29,6 @@ import sonia.scm.util.ServiceUtil; /** * - * @author Sebastian Sdorra * @since 1.7 */ public final class CipherUtil { diff --git a/scm-core/src/main/java/sonia/scm/security/DAORealmHelper.java b/scm-core/src/main/java/sonia/scm/security/DAORealmHelper.java index 0ae38aca78..282405a513 100644 --- a/scm-core/src/main/java/sonia/scm/security/DAORealmHelper.java +++ b/scm-core/src/main/java/sonia/scm/security/DAORealmHelper.java @@ -24,7 +24,6 @@ package sonia.scm.security; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.MoreObjects; import com.google.common.base.Strings; @@ -49,14 +48,10 @@ import static com.google.common.base.Preconditions.checkArgument; * The {@link DAORealmHelper} provides a simple way to authenticate against the * {@link UserDAO}. The class is used by the default and the legacy realm. * - * @author Sebastian Sdorra * @since 2.0.0 */ public final class DAORealmHelper { - /** - * the logger for DAORealmHelper - */ private static final Logger LOG = LoggerFactory.getLogger(DAORealmHelper.class); private final LoginAttemptHandler loginAttemptHandler; @@ -65,7 +60,6 @@ public final class DAORealmHelper { private final String realm; - //~--- constructors --------------------------------------------------------- /** * Constructs a new instance. Consider to use {@link DAORealmHelperFactory} which @@ -81,7 +75,6 @@ public final class DAORealmHelper { this.userDAO = userDAO; } - //~--- get methods ---------------------------------------------------------- /** * Wraps credentials matcher and applies login attempt policies. @@ -111,13 +104,6 @@ public final class DAORealmHelper { return getAuthenticationInfo(principal, null, null, null); } - /** - * Returns a builder for {@link AuthenticationInfo}. - * - * @param principal name of principal (username) - * - * @return authentication info builder - */ public AuthenticationInfoBuilder authenticationInfoBuilder(String principal) { return new AuthenticationInfoBuilder(principal); } @@ -157,7 +143,6 @@ public final class DAORealmHelper { return new SimpleAuthenticationInfo(collection, creds); } - //~--- methods -------------------------------------------------------------- /** * Builder class for {@link AuthenticationInfo}. @@ -177,10 +162,6 @@ public final class DAORealmHelper { /** * With credentials uses the given credentials for the {@link AuthenticationInfo}, this is particularly important * for caching purposes. - * - * @param credentials credentials such as password - * - * @return {@code this} */ public AuthenticationInfoBuilder withCredentials(String credentials) { this.credentials = credentials; @@ -189,23 +170,12 @@ public final class DAORealmHelper { /** * With the scope object it is possible to limit the access permissions to scm-manager. - * - * @param scope scope object - * - * @return {@code this} */ public AuthenticationInfoBuilder withScope(Scope scope) { this.scope = scope; return this; } - /** - * With the session id. - * - * @param sessionId session id - * - * @return {@code this} - */ public AuthenticationInfoBuilder withSessionId(SessionId sessionId) { this.sessionId = sessionId; return this; diff --git a/scm-core/src/main/java/sonia/scm/security/DAORealmHelperFactory.java b/scm-core/src/main/java/sonia/scm/security/DAORealmHelperFactory.java index 24fb2d6eaa..e979302e92 100644 --- a/scm-core/src/main/java/sonia/scm/security/DAORealmHelperFactory.java +++ b/scm-core/src/main/java/sonia/scm/security/DAORealmHelperFactory.java @@ -31,7 +31,6 @@ import sonia.scm.user.UserDAO; /** * Factory to create {@link DAORealmHelper} instances. * - * @author Sebastian Sdorra * @since 2.0.0 */ public final class DAORealmHelperFactory { @@ -40,12 +39,6 @@ public final class DAORealmHelperFactory { private final UserDAO userDAO; private final CacheManager cacheManager; - /** - * Constructs a new instance. - * @param loginAttemptHandler login attempt handler - * @param userDAO user dao - * @param cacheManager - */ @Inject public DAORealmHelperFactory(LoginAttemptHandler loginAttemptHandler, UserDAO userDAO, CacheManager cacheManager) { this.loginAttemptHandler = loginAttemptHandler; diff --git a/scm-core/src/main/java/sonia/scm/security/DefaultCipherHandler.java b/scm-core/src/main/java/sonia/scm/security/DefaultCipherHandler.java index 9ef89ba725..c987726f98 100644 --- a/scm-core/src/main/java/sonia/scm/security/DefaultCipherHandler.java +++ b/scm-core/src/main/java/sonia/scm/security/DefaultCipherHandler.java @@ -24,7 +24,6 @@ package sonia.scm.security; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.annotations.VisibleForTesting; import org.slf4j.Logger; @@ -56,7 +55,6 @@ import java.util.Base64; * Default implementation of the {@link CipherHandler}, which uses AES for * encryption and decryption. * - * @author Sebastian Sdorra * @since 1.7 */ public class DefaultCipherHandler implements CipherHandler { @@ -73,16 +71,12 @@ public class DefaultCipherHandler implements CipherHandler { /** prefix to detect new format */ public static final String PREFIX_FORMAT_V2 = "v2:"; - /** digest type for key generation */ public static final String DIGEST_TYPE = "SHA-512"; - /** string encoding */ public static final Charset ENCODING = StandardCharsets.UTF_8; - /** default key length */ public static final int KEY_LENGTH = 16; - /** default salt length */ public static final int SALT_LENGTH = 16; @VisibleForTesting @@ -97,7 +91,6 @@ public class DefaultCipherHandler implements CipherHandler { private static final String KEY_TYPE = "AES"; - /** the logger for DefaultCipherHandler */ private static final Logger LOG = LoggerFactory.getLogger(DefaultCipherHandler.class); private final SecureRandom random = new SecureRandom(); @@ -142,7 +135,6 @@ public class DefaultCipherHandler implements CipherHandler { } } - //~--- methods -------------------------------------------------------------- @Override public String decode(String value) { @@ -154,8 +146,6 @@ public class DefaultCipherHandler implements CipherHandler { * * @param plainKey key which is used for decoding * @param value encrypted value - * - * @return decrypted value */ public String decode(char[] plainKey, String value) { Base64.Decoder decoder = Base64.getUrlDecoder(); @@ -201,8 +191,6 @@ public class DefaultCipherHandler implements CipherHandler { * * @param plainKey key which is used for encoding * @param value plain text value to encrypt - * - * @return encrypted value */ public String encode(char[] plainKey, String value) { String res = null; diff --git a/scm-core/src/main/java/sonia/scm/security/KeyGenerator.java b/scm-core/src/main/java/sonia/scm/security/KeyGenerator.java index 9a5d2527f4..308e1af06a 100644 --- a/scm-core/src/main/java/sonia/scm/security/KeyGenerator.java +++ b/scm-core/src/main/java/sonia/scm/security/KeyGenerator.java @@ -26,17 +26,11 @@ package sonia.scm.security; /** * - * @author Sebastian Sdorra * @since 1.7 */ public interface KeyGenerator { - /** - * Method description - * - * - * @return - */ + public String createKey(); } diff --git a/scm-core/src/main/java/sonia/scm/security/LoginAttemptHandler.java b/scm-core/src/main/java/sonia/scm/security/LoginAttemptHandler.java index 9f06b6153a..807395ab72 100644 --- a/scm-core/src/main/java/sonia/scm/security/LoginAttemptHandler.java +++ b/scm-core/src/main/java/sonia/scm/security/LoginAttemptHandler.java @@ -21,7 +21,7 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ - + package sonia.scm.security; import org.apache.shiro.authc.AuthenticationException; @@ -29,9 +29,6 @@ import org.apache.shiro.authc.AuthenticationInfo; import org.apache.shiro.authc.AuthenticationToken; /** - * Login attempt handler. - * - * @author Sebastian Sdorra * @since 1.34 */ public interface LoginAttemptHandler @@ -41,31 +38,24 @@ public interface LoginAttemptHandler * This method is called before the authentication procedure is invoked. * * @param token authentication token - * - * @throws AuthenticationException */ - public void beforeAuthentication(AuthenticationToken token) throws AuthenticationException; + void beforeAuthentication(AuthenticationToken token) throws AuthenticationException; /** * Handle successful authentication. * * @param token authentication token * @param info successful authentication result - * - * @throws AuthenticationException */ - public void onSuccessfulAuthentication(AuthenticationToken token, AuthenticationInfo info) + void onSuccessfulAuthentication(AuthenticationToken token, AuthenticationInfo info) throws AuthenticationException; /** * Handle unsuccessful authentication. * - * * @param token authentication token * @param info unsuccessful authentication result - * - * @throws AuthenticationException */ - public void onUnsuccessfulAuthentication(AuthenticationToken token, AuthenticationInfo info) + void onUnsuccessfulAuthentication(AuthenticationToken token, AuthenticationInfo info) throws AuthenticationException; -} \ No newline at end of file +} diff --git a/scm-core/src/main/java/sonia/scm/security/PermissionDescriptor.java b/scm-core/src/main/java/sonia/scm/security/PermissionDescriptor.java index 97c6a7771f..ce62222669 100644 --- a/scm-core/src/main/java/sonia/scm/security/PermissionDescriptor.java +++ b/scm-core/src/main/java/sonia/scm/security/PermissionDescriptor.java @@ -24,7 +24,6 @@ package sonia.scm.security; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.MoreObjects; import com.google.common.base.Objects; @@ -34,27 +33,22 @@ import jakarta.xml.bind.annotation.XmlRootElement; import java.io.Serializable; -//~--- JDK imports ------------------------------------------------------------ - /** * Descriptor for available permission objects. * - * @author Sebastian Sdorra * @since 1.31 */ @XmlRootElement(name = "permission") @XmlAccessorType(XmlAccessType.FIELD) public class PermissionDescriptor implements Serializable { + private String value; - /** Field description */ private static final long serialVersionUID = -9141065458354047154L; - //~--- constructors --------------------------------------------------------- /** * Constructor is only visible for JAXB. - * */ public PermissionDescriptor() {} @@ -63,11 +57,8 @@ public class PermissionDescriptor implements Serializable this.value = value; } - //~--- methods -------------------------------------------------------------- - /** - * {@inheritDoc} - */ + @Override public boolean equals(Object obj) { @@ -86,18 +77,14 @@ public class PermissionDescriptor implements Serializable return Objects.equal(value, other.value); } - /** - * {@inheritDoc} - */ + @Override public int hashCode() { return value == null? -1: value.hashCode(); } - /** - * {@inheritDoc} - */ + @Override public String toString() { @@ -110,21 +97,12 @@ public class PermissionDescriptor implements Serializable //J+ } - //~--- get methods ---------------------------------------------------------- /** * Returns the string representation of the permission. - * - * - * @return string representation */ public String getValue() { return value; } - - //~--- fields --------------------------------------------------------------- - - /** value */ - private String value; } diff --git a/scm-core/src/main/java/sonia/scm/security/PermissionObject.java b/scm-core/src/main/java/sonia/scm/security/PermissionObject.java index 2040c09619..a16baf419f 100644 --- a/scm-core/src/main/java/sonia/scm/security/PermissionObject.java +++ b/scm-core/src/main/java/sonia/scm/security/PermissionObject.java @@ -27,7 +27,6 @@ package sonia.scm.security; /** * Interface for permission objects. * - * @author Sebastian Sdorra * @since 1.31 */ public interface PermissionObject @@ -35,17 +34,11 @@ public interface PermissionObject /** * Returns the name of the user or group which the permission is assigned. - * - * - * @return name of user or group */ public String getName(); /** * Returns the id of the stored permission object. - * - * - * @return id of permission */ public boolean isGroupPermission(); } diff --git a/scm-core/src/main/java/sonia/scm/security/PrivateKey.java b/scm-core/src/main/java/sonia/scm/security/PrivateKey.java index 0ae639a3db..4d6f93f6d8 100644 --- a/scm-core/src/main/java/sonia/scm/security/PrivateKey.java +++ b/scm-core/src/main/java/sonia/scm/security/PrivateKey.java @@ -35,7 +35,6 @@ public interface PrivateKey { /** * Returns the key's id. - * @return id */ String getId(); diff --git a/scm-core/src/main/java/sonia/scm/security/PublicKey.java b/scm-core/src/main/java/sonia/scm/security/PublicKey.java index 7584bb28f5..8439544d66 100644 --- a/scm-core/src/main/java/sonia/scm/security/PublicKey.java +++ b/scm-core/src/main/java/sonia/scm/security/PublicKey.java @@ -41,15 +41,12 @@ public interface PublicKey { /** * Returns id of the public key. - * - * @return id of key */ String getId(); /** * Returns ids from gpg sub keys. * - * @return sub key ids * @since 2.19.0 */ default Set getSubkeys() { @@ -58,15 +55,11 @@ public interface PublicKey { /** * Returns the username of the owner or an empty optional. - * - * @return owner or empty optional */ Optional getOwner(); /** * Returns raw of the public key. - * - * @return raw of key */ String getRaw(); diff --git a/scm-core/src/main/java/sonia/scm/security/Role.java b/scm-core/src/main/java/sonia/scm/security/Role.java index ae01dc6925..1c9feef72b 100644 --- a/scm-core/src/main/java/sonia/scm/security/Role.java +++ b/scm-core/src/main/java/sonia/scm/security/Role.java @@ -26,20 +26,13 @@ package sonia.scm.security; /** * - * @author Sebastian Sdorra * @since 1.21 */ public final class Role { - /** Field description */ public static final String USER = "user"; - //~--- constructors --------------------------------------------------------- - /** - * Constructs ... - * - */ private Role() {} } diff --git a/scm-core/src/main/java/sonia/scm/security/ScmSecurityException.java b/scm-core/src/main/java/sonia/scm/security/ScmSecurityException.java index e39bf84091..79bbdc2c6e 100644 --- a/scm-core/src/main/java/sonia/scm/security/ScmSecurityException.java +++ b/scm-core/src/main/java/sonia/scm/security/ScmSecurityException.java @@ -24,53 +24,28 @@ package sonia.scm.security; -/** - * - * @author Sebastian Sdorra - */ + public class ScmSecurityException extends RuntimeException { - /** Field description */ private static final long serialVersionUID = 3166977667869197399L; - //~--- constructors --------------------------------------------------------- - /** - * Constructs ... - * - */ public ScmSecurityException() {} - /** - * Constructs ... - * - * - * @param message - */ + public ScmSecurityException(String message) { super(message); } - /** - * Constructs ... - * - * - * @param throwable - */ + public ScmSecurityException(Throwable throwable) { super(throwable); } - /** - * Constructs ... - * - * - * @param message - * @param throwable - */ + public ScmSecurityException(String message, Throwable throwable) { super(message, throwable); diff --git a/scm-core/src/main/java/sonia/scm/security/Scope.java b/scm-core/src/main/java/sonia/scm/security/Scope.java index 3fae3f4def..e660e30e4e 100644 --- a/scm-core/src/main/java/sonia/scm/security/Scope.java +++ b/scm-core/src/main/java/sonia/scm/security/Scope.java @@ -21,7 +21,7 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ - + package sonia.scm.security; import com.google.common.collect.ImmutableList; @@ -34,12 +34,11 @@ import java.util.Collections; import java.util.Iterator; /** - * Scope of a token. A scope is able to reduce the permissions of a token authentication. That means we can issue a + * Scope of a token. A scope is able to reduce the permissions of a token authentication. That means we can issue a * token which is only suitable for a single or a set of actions e.g.: we could create a token which can only read * a single repository. The values of the scope should be explicit string representations of shiro permissions. An empty * scope means all permissions of the user. - * - * @author Sebastian Sdorra + * * @since 2.0.0 */ @XmlRootElement(name = "scope") @@ -47,9 +46,9 @@ import java.util.Iterator; public final class Scope implements Iterable { private static final Scope EMPTY = new Scope(Collections.emptySet()); - + private final Collection values; - + private Scope(Collection values) { this.values = values; } @@ -58,41 +57,37 @@ public final class Scope implements Iterable { public Iterator iterator() { return values.iterator(); } - + /** * Returns {@code true} if the scope is empty. - * - * @return {@code true} if the scope is empty */ public boolean isEmpty() { return values.isEmpty(); } - + /** * Creates an empty scope. - * - * @return empty scope */ public static Scope empty(){ return EMPTY; } - + /** * Creates a scope object from the given iterable. - * + * * @param values values of scope - * + * * @return new scope */ public static Scope valueOf(Iterable values) { return new Scope(ImmutableList.copyOf(values)); } - + /** * Create a scope from the given array. - * + * * @param values values of scope - * + * * @return new scope. */ public static Scope valueOf(String... values) { @@ -111,5 +106,5 @@ public final class Scope implements Iterable { } return buffer.append("]").toString(); } - + } diff --git a/scm-core/src/main/java/sonia/scm/security/SecuritySystem.java b/scm-core/src/main/java/sonia/scm/security/SecuritySystem.java index 7f41b9785f..9122adf0bb 100644 --- a/scm-core/src/main/java/sonia/scm/security/SecuritySystem.java +++ b/scm-core/src/main/java/sonia/scm/security/SecuritySystem.java @@ -30,38 +30,28 @@ import java.util.function.Predicate; /** * The SecuritySystem manages global permissions. * - * @author Sebastian Sdorra * @since 1.31 */ public interface SecuritySystem { /** * Store a new permission. - * - * @param permission permission to be stored */ void addPermission(AssignedPermission permission); /** * Delete stored permission. - * - * @param permission permission to be deleted */ void deletePermission(AssignedPermission permission); /** * Return all available permissions. - * - * @return available permissions */ Collection getAvailablePermissions(); /** * Returns all stored permissions which are matched by the given * {@link Predicate}. - * - * @param predicate predicate to filter - * @return filtered permissions */ Collection getPermissions(Predicate predicate); } diff --git a/scm-core/src/main/java/sonia/scm/security/StoredAssignedPermission.java b/scm-core/src/main/java/sonia/scm/security/StoredAssignedPermission.java index 5fbc16bd76..6a27b8faf4 100644 --- a/scm-core/src/main/java/sonia/scm/security/StoredAssignedPermission.java +++ b/scm-core/src/main/java/sonia/scm/security/StoredAssignedPermission.java @@ -24,8 +24,6 @@ package sonia.scm.security; -//~--- JDK imports ------------------------------------------------------------ - import jakarta.xml.bind.annotation.XmlAccessType; import jakarta.xml.bind.annotation.XmlAccessorType; import jakarta.xml.bind.annotation.XmlRootElement; @@ -33,7 +31,6 @@ import jakarta.xml.bind.annotation.XmlRootElement; /** * Permission object which is stored and assigned to a specific user or group. * - * @author Sebastian Sdorra * @since 1.31 */ @XmlAccessorType(XmlAccessType.FIELD) @@ -41,24 +38,15 @@ import jakarta.xml.bind.annotation.XmlRootElement; public class StoredAssignedPermission extends AssignedPermission { - /** serial version uid */ private static final long serialVersionUID = -4593919877023168090L; - //~--- constructors --------------------------------------------------------- + private String id; /** * Constructor is only visible for JAXB. - * */ public StoredAssignedPermission() {} - /** - * Constructs a new StoredAssignedPermission. - * - * - * @param id id of the permission object - * @param permission assigned permission object - */ public StoredAssignedPermission(String id, AssignedPermission permission) { super(permission); @@ -66,21 +54,9 @@ public class StoredAssignedPermission extends AssignedPermission } - //~--- get methods ---------------------------------------------------------- - - /** - * Returns the id of the stored permission object. - * - * - * @return id of permission - */ public String getId() { return id; } - //~--- fields --------------------------------------------------------------- - - /** id */ - private String id; } diff --git a/scm-core/src/main/java/sonia/scm/security/StringablePermission.java b/scm-core/src/main/java/sonia/scm/security/StringablePermission.java index 82d2ba3b2e..2c6b90c7c9 100644 --- a/scm-core/src/main/java/sonia/scm/security/StringablePermission.java +++ b/scm-core/src/main/java/sonia/scm/security/StringablePermission.java @@ -24,7 +24,6 @@ package sonia.scm.security; -//~--- non-JDK imports -------------------------------------------------------- import org.apache.shiro.authz.Permission; @@ -32,17 +31,9 @@ import org.apache.shiro.authz.Permission; * Permission that can be represented by a string. {@link StringablePermission} * are the only permissions which are pushed to the ui. * - * @author Sebastian Sdorra * @since 1.31 */ public interface StringablePermission extends Permission { - - /** - * Return string representation of the permission. - * - * - * @return string representation of the permission - */ public String getAsString(); } diff --git a/scm-core/src/main/java/sonia/scm/security/SyncingRealmHelper.java b/scm-core/src/main/java/sonia/scm/security/SyncingRealmHelper.java index 46746b4781..e177b9a13b 100644 --- a/scm-core/src/main/java/sonia/scm/security/SyncingRealmHelper.java +++ b/scm-core/src/main/java/sonia/scm/security/SyncingRealmHelper.java @@ -46,7 +46,6 @@ import java.util.Set; * Helper class for syncing realms. The class should simplify the creation of realms, which are syncing authenticated * users with the local database. * - * @author Sebastian Sdorra * @since 2.0.0 */ @Slf4j diff --git a/scm-core/src/main/java/sonia/scm/security/TokenExpiredException.java b/scm-core/src/main/java/sonia/scm/security/TokenExpiredException.java index 5f570277a0..4e65e7bb9e 100644 --- a/scm-core/src/main/java/sonia/scm/security/TokenExpiredException.java +++ b/scm-core/src/main/java/sonia/scm/security/TokenExpiredException.java @@ -33,21 +33,10 @@ import org.apache.shiro.authc.AuthenticationException; @SuppressWarnings("squid:MaximumInheritanceDepth") // exceptions have a deep inheritance depth themselves; therefore we accept this here public class TokenExpiredException extends AuthenticationException { - /** - * Constructs a new SessionExpiredException. - * - * @param message the reason for the exception - */ public TokenExpiredException(String message) { super(message); } - /** - * Constructs a new SessionExpiredException. - * - * @param message the reason for the exception - * @param cause the underlying Throwable that caused this exception to be thrown. - */ public TokenExpiredException(String message, Throwable cause) { super(message, cause); } diff --git a/scm-core/src/main/java/sonia/scm/security/Tokens.java b/scm-core/src/main/java/sonia/scm/security/Tokens.java index 61307074ea..b99a152eb2 100644 --- a/scm-core/src/main/java/sonia/scm/security/Tokens.java +++ b/scm-core/src/main/java/sonia/scm/security/Tokens.java @@ -24,7 +24,6 @@ package sonia.scm.security; -//~--- non-JDK imports -------------------------------------------------------- import jakarta.servlet.http.HttpServletRequest; import org.apache.shiro.authc.AuthenticationToken; @@ -34,19 +33,13 @@ import org.apache.shiro.subject.Subject; /** * Create tokens for security reasons. * - * @author Sebastian Sdorra * @since 1.21 */ public final class Tokens { - /** - * Constructs ... - * - */ private Tokens() {} - //~--- methods -------------------------------------------------------------- /** * Build an {@link AuthenticationToken} for use with diff --git a/scm-core/src/main/java/sonia/scm/security/UUIDKeyGenerator.java b/scm-core/src/main/java/sonia/scm/security/UUIDKeyGenerator.java index 3fa45b69a7..f7445163c2 100644 --- a/scm-core/src/main/java/sonia/scm/security/UUIDKeyGenerator.java +++ b/scm-core/src/main/java/sonia/scm/security/UUIDKeyGenerator.java @@ -24,23 +24,13 @@ package sonia.scm.security; -//~--- JDK imports ------------------------------------------------------------ - import java.util.UUID; -/** - * - * @author Sebastian Sdorra - */ + public class UUIDKeyGenerator implements KeyGenerator { - /** - * Method description - * - * - * @return - */ + @Override public String createKey() { diff --git a/scm-core/src/main/java/sonia/scm/security/Xsrf.java b/scm-core/src/main/java/sonia/scm/security/Xsrf.java index 8a50b348f9..3752b00e8d 100644 --- a/scm-core/src/main/java/sonia/scm/security/Xsrf.java +++ b/scm-core/src/main/java/sonia/scm/security/Xsrf.java @@ -27,7 +27,6 @@ package sonia.scm.security; /** * Shared constants for Xsrf related classes. * - * @author Sebastian Sdorra * @since 2.0.0 */ public final class Xsrf { diff --git a/scm-core/src/main/java/sonia/scm/store/AbstractStore.java b/scm-core/src/main/java/sonia/scm/store/AbstractStore.java index 760fefb6e9..f93713aa2f 100644 --- a/scm-core/src/main/java/sonia/scm/store/AbstractStore.java +++ b/scm-core/src/main/java/sonia/scm/store/AbstractStore.java @@ -30,7 +30,6 @@ import java.util.function.BooleanSupplier; * Base class for {@link ConfigurationStore}. * * @param type of store objects - * @author Sebastian Sdorra * @since 1.16 */ public abstract class AbstractStore implements ConfigurationStore { diff --git a/scm-core/src/main/java/sonia/scm/store/Blob.java b/scm-core/src/main/java/sonia/scm/store/Blob.java index 7297dcca34..0d430bd636 100644 --- a/scm-core/src/main/java/sonia/scm/store/Blob.java +++ b/scm-core/src/main/java/sonia/scm/store/Blob.java @@ -24,8 +24,6 @@ package sonia.scm.store; -//~--- JDK imports ------------------------------------------------------------ - import java.io.IOException; import java.io.InputStream; import java.io.OutputStream; @@ -33,7 +31,6 @@ import java.io.OutputStream; /** * A blob is binary object. A blob can be used to store any unstructured data. * - * @author Sebastian Sdorra * @since 1.23 */ public interface Blob @@ -48,7 +45,6 @@ public interface Blob */ public void commit() throws IOException; - //~--- get methods ---------------------------------------------------------- /** * Returns the id of blob object. diff --git a/scm-core/src/main/java/sonia/scm/store/BlobStore.java b/scm-core/src/main/java/sonia/scm/store/BlobStore.java index 80b9910d16..96b4129715 100644 --- a/scm-core/src/main/java/sonia/scm/store/BlobStore.java +++ b/scm-core/src/main/java/sonia/scm/store/BlobStore.java @@ -24,14 +24,11 @@ package sonia.scm.store; -//~--- JDK imports ------------------------------------------------------------ - import java.util.List; /** * The blob store can be used store unstructured data in form of a {@link Blob}. * - * @author Sebastian Sdorra * @since 1.23 * * @apiviz.uses sonia.scm.store.Blob @@ -68,7 +65,6 @@ public interface BlobStore extends MultiEntryStore */ public void remove(Blob blob); - //~--- get methods ---------------------------------------------------------- /** * Return all blob object which are stored in this BlobStore. diff --git a/scm-core/src/main/java/sonia/scm/store/BlobStoreFactory.java b/scm-core/src/main/java/sonia/scm/store/BlobStoreFactory.java index e2477f1752..0543a84689 100644 --- a/scm-core/src/main/java/sonia/scm/store/BlobStoreFactory.java +++ b/scm-core/src/main/java/sonia/scm/store/BlobStoreFactory.java @@ -42,7 +42,6 @@ package sonia.scm.store; * .build(); * * - * @author Sebastian Sdorra * @since 1.23 * * @apiviz.landmark diff --git a/scm-core/src/main/java/sonia/scm/store/ConfigurationEntryStore.java b/scm-core/src/main/java/sonia/scm/store/ConfigurationEntryStore.java index c750196c9c..3469f89cbf 100644 --- a/scm-core/src/main/java/sonia/scm/store/ConfigurationEntryStore.java +++ b/scm-core/src/main/java/sonia/scm/store/ConfigurationEntryStore.java @@ -34,7 +34,6 @@ import java.util.function.Predicate; * configuration data. Note: the default implementation use JAXB to * marshall the items. * - * @author Sebastian Sdorra * * @param store value type * @since 1.31 diff --git a/scm-core/src/main/java/sonia/scm/store/ConfigurationEntryStoreFactory.java b/scm-core/src/main/java/sonia/scm/store/ConfigurationEntryStoreFactory.java index 09f1217815..4624315c8c 100644 --- a/scm-core/src/main/java/sonia/scm/store/ConfigurationEntryStoreFactory.java +++ b/scm-core/src/main/java/sonia/scm/store/ConfigurationEntryStoreFactory.java @@ -47,7 +47,6 @@ package sonia.scm.store; * .build(); * * - * @author Sebastian Sdorra * @since 1.31 * * @apiviz.landmark diff --git a/scm-core/src/main/java/sonia/scm/store/ConfigurationStore.java b/scm-core/src/main/java/sonia/scm/store/ConfigurationStore.java index 5dbd6b58bc..09532c87f9 100644 --- a/scm-core/src/main/java/sonia/scm/store/ConfigurationStore.java +++ b/scm-core/src/main/java/sonia/scm/store/ConfigurationStore.java @@ -33,7 +33,6 @@ import static java.util.Optional.ofNullable; * implementation use JAXB to marshall the configuration objects. * * @param type of the configuration objects - * @author Sebastian Sdorra */ public interface ConfigurationStore { diff --git a/scm-core/src/main/java/sonia/scm/store/ConfigurationStoreFactory.java b/scm-core/src/main/java/sonia/scm/store/ConfigurationStoreFactory.java index 8202f8425b..fc3c4e5d38 100644 --- a/scm-core/src/main/java/sonia/scm/store/ConfigurationStoreFactory.java +++ b/scm-core/src/main/java/sonia/scm/store/ConfigurationStoreFactory.java @@ -48,7 +48,6 @@ package sonia.scm.store; * .build(); * * - * @author Sebastian Sdorra * * @apiviz.landmark * @apiviz.uses sonia.scm.store.ConfigurationStore diff --git a/scm-core/src/main/java/sonia/scm/store/DataStore.java b/scm-core/src/main/java/sonia/scm/store/DataStore.java index 4877aacc02..72aa3d078f 100644 --- a/scm-core/src/main/java/sonia/scm/store/DataStore.java +++ b/scm-core/src/main/java/sonia/scm/store/DataStore.java @@ -24,15 +24,12 @@ package sonia.scm.store; -//~--- JDK imports ------------------------------------------------------------ - import java.util.Map; /** * A DataStore can be used to store any structured data. Note: the default * implementation use JAXB to marshall the items. * - * @author Sebastian Sdorra * @since 1.23 * * @param type of store items @@ -58,7 +55,6 @@ public interface DataStore extends MultiEntryStore { */ public void put(String id, T item); - //~--- get methods ---------------------------------------------------------- /** * Returns a map of all stored items. The key of the map is the item id and diff --git a/scm-core/src/main/java/sonia/scm/store/DataStoreFactory.java b/scm-core/src/main/java/sonia/scm/store/DataStoreFactory.java index 45d9a93993..ecf9a0afb2 100644 --- a/scm-core/src/main/java/sonia/scm/store/DataStoreFactory.java +++ b/scm-core/src/main/java/sonia/scm/store/DataStoreFactory.java @@ -44,7 +44,6 @@ package sonia.scm.store; * .build(); * * - * @author Sebastian Sdorra * @since 1.23 * * @apiviz.landmark diff --git a/scm-core/src/main/java/sonia/scm/store/EntryAlreadyExistsStoreException.java b/scm-core/src/main/java/sonia/scm/store/EntryAlreadyExistsStoreException.java index 05ec3e9d7e..94320dcdca 100644 --- a/scm-core/src/main/java/sonia/scm/store/EntryAlreadyExistsStoreException.java +++ b/scm-core/src/main/java/sonia/scm/store/EntryAlreadyExistsStoreException.java @@ -28,14 +28,12 @@ package sonia.scm.store; * This exception is thrown on a create method if an entry with the given id * already exists. * - * @author Sebastian Sdorra * @since 1.23 */ public class EntryAlreadyExistsStoreException extends StoreException { private static final long serialVersionUID = 7016781091599951287L; - //~--- constructors --------------------------------------------------------- /** * Constructs new EntryAllreadyExistsStoreException. diff --git a/scm-core/src/main/java/sonia/scm/store/MultiEntryStore.java b/scm-core/src/main/java/sonia/scm/store/MultiEntryStore.java index 8a447e333a..eb88502b17 100644 --- a/scm-core/src/main/java/sonia/scm/store/MultiEntryStore.java +++ b/scm-core/src/main/java/sonia/scm/store/MultiEntryStore.java @@ -31,7 +31,6 @@ import static java.util.Optional.ofNullable; /** * Base class for {@link BlobStore} and {@link DataStore}. * - * @author Sebastian Sdorra * @since 1.23 * * @param Type of the stored objects @@ -52,7 +51,6 @@ public interface MultiEntryStore { */ public void remove(String id); - //~--- get methods ---------------------------------------------------------- /** * Returns the item with the given id from the store. diff --git a/scm-core/src/main/java/sonia/scm/store/StoreException.java b/scm-core/src/main/java/sonia/scm/store/StoreException.java index ae5ca25cc1..4f3ed3daf7 100644 --- a/scm-core/src/main/java/sonia/scm/store/StoreException.java +++ b/scm-core/src/main/java/sonia/scm/store/StoreException.java @@ -27,14 +27,11 @@ package sonia.scm.store; /** * The store exception can be used by a store implementation. * - * @author Sebastian Sdorra */ public class StoreException extends RuntimeException { - /** Field description */ private static final long serialVersionUID = 6974469896007155294L; - //~--- constructors --------------------------------------------------------- /** * Constructs a new instance. diff --git a/scm-core/src/main/java/sonia/scm/template/Template.java b/scm-core/src/main/java/sonia/scm/template/Template.java index 58a07bde6c..df1e59235f 100644 --- a/scm-core/src/main/java/sonia/scm/template/Template.java +++ b/scm-core/src/main/java/sonia/scm/template/Template.java @@ -24,8 +24,6 @@ package sonia.scm.template; -//~--- JDK imports ------------------------------------------------------------ - import java.io.IOException; import java.io.Writer; @@ -33,7 +31,6 @@ import java.io.Writer; * The template represents a single template file and is able to render this * template. * - * @author Sebastian Sdorra * @since 1.19 */ public interface Template diff --git a/scm-core/src/main/java/sonia/scm/template/TemplateEngine.java b/scm-core/src/main/java/sonia/scm/template/TemplateEngine.java index a8c28fe370..ef5e398c1f 100644 --- a/scm-core/src/main/java/sonia/scm/template/TemplateEngine.java +++ b/scm-core/src/main/java/sonia/scm/template/TemplateEngine.java @@ -24,8 +24,6 @@ package sonia.scm.template; -//~--- JDK imports ------------------------------------------------------------ - import java.io.IOException; import java.io.Reader; import java.util.Locale; @@ -34,7 +32,6 @@ import java.util.Locale; * The {@link TemplateEngine} searches for {@link Template}s and prepares the * template for the rendering process. * - * @author Sebastian Sdorra * @since 1.19 * * @apiviz.uses sonia.scm.template.Template @@ -105,11 +102,6 @@ public interface TemplateEngine Template getTemplate(String templateIdentifier, Reader reader) throws IOException; - /** - * Returns the type of this template engine. - * - * @return type of template engine - */ TemplateType getType(); static String extendWithLanguage(String templatePath, Locale locale) { diff --git a/scm-core/src/main/java/sonia/scm/template/TemplateEngineFactory.java b/scm-core/src/main/java/sonia/scm/template/TemplateEngineFactory.java index 047e8226b2..cc88c70862 100644 --- a/scm-core/src/main/java/sonia/scm/template/TemplateEngineFactory.java +++ b/scm-core/src/main/java/sonia/scm/template/TemplateEngineFactory.java @@ -24,7 +24,6 @@ package sonia.scm.template; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.collect.Maps; import com.google.inject.Inject; @@ -35,8 +34,6 @@ import org.slf4j.LoggerFactory; import sonia.scm.Default; -//~--- JDK imports ------------------------------------------------------------ - import java.util.Collection; import java.util.Map; import java.util.Set; @@ -46,7 +43,6 @@ import java.util.Set; * The factory return available template engines. The * {@link TemplateEngineFactory} is available via injection. * - * @author Sebastian Sdorra * @since 1.19 * * @apiviz.landmark @@ -56,13 +52,14 @@ import java.util.Set; public final class TemplateEngineFactory { - /** - * the logger for TemplateEngineFactory - */ private static final Logger logger = LoggerFactory.getLogger(TemplateEngineFactory.class); - //~--- constructors --------------------------------------------------------- + /** default template engine */ + private final TemplateEngine defaultEngine; + + /** map of registered template engines */ + private final Map engineMap; /** * Constructs new template engine factory. This constructor should only be @@ -102,10 +99,9 @@ public final class TemplateEngineFactory this.defaultEngine = defaultEngine; } - //~--- get methods ---------------------------------------------------------- /** - * Returns the default template engine. In the normal case the should be a + * Returns the default template engine. In the normal case this should be an * implementation of the * mustache template * system. @@ -167,20 +163,10 @@ public final class TemplateEngineFactory /** * Returns all registered template engines. - * - * - * @return all registered template engines */ public Collection getEngines() { return engineMap.values(); } - //~--- fields --------------------------------------------------------------- - - /** default template engine */ - private final TemplateEngine defaultEngine; - - /** map of registered template engines */ - private final Map engineMap; } diff --git a/scm-core/src/main/java/sonia/scm/template/TemplateParseException.java b/scm-core/src/main/java/sonia/scm/template/TemplateParseException.java index e6877880b1..a8bf548349 100644 --- a/scm-core/src/main/java/sonia/scm/template/TemplateParseException.java +++ b/scm-core/src/main/java/sonia/scm/template/TemplateParseException.java @@ -24,60 +24,32 @@ package sonia.scm.template; -//~--- JDK imports ------------------------------------------------------------ - import java.io.IOException; /** * This exception is thrown, if an error during the template parse * phase occurs. * - * @author Sebastian Sdorra * @since 1.19 */ public class TemplateParseException extends IOException { - /** Field description */ private static final long serialVersionUID = 3583405534141707032L; - //~--- constructors --------------------------------------------------------- - /** - * Constructs ... - * - */ public TemplateParseException() {} - /** - * Constructs ... - * - * - * @param message - */ public TemplateParseException(String message) { super(message); } - /** - * Constructs ... - * - * - * @param cause - */ public TemplateParseException(Throwable cause) { super(cause); } - /** - * Constructs ... - * - * - * @param message - * @param cause - */ public TemplateParseException(String message, Throwable cause) { super(message, cause); diff --git a/scm-core/src/main/java/sonia/scm/template/TemplateRenderException.java b/scm-core/src/main/java/sonia/scm/template/TemplateRenderException.java index 011a121aac..bdbcd81d5f 100644 --- a/scm-core/src/main/java/sonia/scm/template/TemplateRenderException.java +++ b/scm-core/src/main/java/sonia/scm/template/TemplateRenderException.java @@ -24,60 +24,32 @@ package sonia.scm.template; -//~--- JDK imports ------------------------------------------------------------ - import java.io.IOException; /** * This exception is thrown, if an error during the template rendering * phase occurs. * - * @author Sebastian Sdorra * @since 1.19 */ public class TemplateRenderException extends IOException { - /** Field description */ private static final long serialVersionUID = 2176596549717814756L; - //~--- constructors --------------------------------------------------------- - /** - * Constructs ... - * - */ public TemplateRenderException() {} - /** - * Constructs ... - * - * - * @param message - */ public TemplateRenderException(String message) { super(message); } - /** - * Constructs ... - * - * - * @param cause - */ public TemplateRenderException(Throwable cause) { super(cause); } - /** - * Constructs ... - * - * - * @param message - * @param cause - */ public TemplateRenderException(String message, Throwable cause) { super(message, cause); diff --git a/scm-core/src/main/java/sonia/scm/template/TemplateType.java b/scm-core/src/main/java/sonia/scm/template/TemplateType.java index 66c9268102..be6c24cff8 100644 --- a/scm-core/src/main/java/sonia/scm/template/TemplateType.java +++ b/scm-core/src/main/java/sonia/scm/template/TemplateType.java @@ -24,14 +24,11 @@ package sonia.scm.template; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.collect.Lists; import sonia.scm.Type; -//~--- JDK imports ------------------------------------------------------------ - import java.io.Serializable; import java.util.Collection; @@ -39,25 +36,14 @@ import java.util.Collection; /** * Represents the type of a {@link TemplateType}. * - * @author Sebastian Sdorra * @since 1.19 */ public final class TemplateType extends Type implements Serializable { - /** serial version uid */ private static final long serialVersionUID = 7947596921895752539L; - //~--- constructors --------------------------------------------------------- - - /** - * Constructs new template type. - * - * - * @param name - * @param displayName - * @param extensions - */ + private Collection extensions; public TemplateType(String name, String displayName, Collection extensions) { @@ -65,22 +51,12 @@ public final class TemplateType extends Type implements Serializable this.extensions = extensions; } - /** - * Constructs new template type. - * - * - * @param name - * @param displayName - * @param extension - * @param extensions - */ public TemplateType(String name, String displayName, String extension, String... extensions) { this(name, displayName, Lists.asList(extension, extensions)); } - //~--- get methods ---------------------------------------------------------- /** * Returns all extensions associated with this template engine. @@ -93,8 +69,4 @@ public final class TemplateType extends Type implements Serializable return extensions; } - //~--- fields --------------------------------------------------------------- - - /** extensions */ - private Collection extensions; } diff --git a/scm-core/src/main/java/sonia/scm/template/Templates.java b/scm-core/src/main/java/sonia/scm/template/Templates.java index 5a2fbae738..b8acf74466 100644 --- a/scm-core/src/main/java/sonia/scm/template/Templates.java +++ b/scm-core/src/main/java/sonia/scm/template/Templates.java @@ -24,15 +24,12 @@ package sonia.scm.template; -//~--- non-JDK imports -------------------------------------------------------- import org.slf4j.Logger; import org.slf4j.LoggerFactory; import sonia.scm.util.IOUtil; -//~--- JDK imports ------------------------------------------------------------ - import java.io.File; import java.io.FileReader; import java.io.IOException; @@ -41,26 +38,15 @@ import java.io.Writer; /** * Util class for the template framework of scm-manager. * - * @author Sebastian Sdorra * @since 1.22 */ public final class Templates { - - /** - * the logger for Templates - */ private static final Logger logger = LoggerFactory.getLogger(Templates.class); - //~--- constructors --------------------------------------------------------- - /** - * Constructs ... - * - */ private Templates() {} - //~--- methods -------------------------------------------------------------- /** * Renders the given template file with the {@link TemplateEngine} which is diff --git a/scm-core/src/main/java/sonia/scm/template/Viewable.java b/scm-core/src/main/java/sonia/scm/template/Viewable.java index acc29edfa3..ab608cd025 100644 --- a/scm-core/src/main/java/sonia/scm/template/Viewable.java +++ b/scm-core/src/main/java/sonia/scm/template/Viewable.java @@ -31,7 +31,6 @@ import com.google.common.base.Objects; * A viewable holds the path to a template and the context object which is used to render the template. Viewables can * be used as return type of jax-rs resources. * - * @author Sebastian Sdorra * @since 2.0.0 */ public final class Viewable { diff --git a/scm-core/src/main/java/sonia/scm/trace/Exporter.java b/scm-core/src/main/java/sonia/scm/trace/Exporter.java index 91349d1cf2..034804c9a8 100644 --- a/scm-core/src/main/java/sonia/scm/trace/Exporter.java +++ b/scm-core/src/main/java/sonia/scm/trace/Exporter.java @@ -36,8 +36,6 @@ public interface Exporter { /** * Process the collected span. - * - * @param span collected span */ void export(SpanContext span); } diff --git a/scm-core/src/main/java/sonia/scm/trace/SpanContext.java b/scm-core/src/main/java/sonia/scm/trace/SpanContext.java index becf2c71a3..2bc1e1b466 100644 --- a/scm-core/src/main/java/sonia/scm/trace/SpanContext.java +++ b/scm-core/src/main/java/sonia/scm/trace/SpanContext.java @@ -71,8 +71,6 @@ public class SpanContext { /** * Calculates the duration of the span. - * - * @return duration of the span */ public Duration duration() { return Duration.between(opened, closed); diff --git a/scm-core/src/main/java/sonia/scm/trace/Tracer.java b/scm-core/src/main/java/sonia/scm/trace/Tracer.java index e4fef586f6..9b1de6af18 100644 --- a/scm-core/src/main/java/sonia/scm/trace/Tracer.java +++ b/scm-core/src/main/java/sonia/scm/trace/Tracer.java @@ -52,11 +52,6 @@ public final class Tracer { private final Set exporters; - /** - * Constructs a new tracer with the given set of exporters. - * - * @param exporters set of exporters - */ @Inject public Tracer(Set exporters) { this.exporters = exporters; @@ -65,7 +60,6 @@ public final class Tracer { /** * Creates a new span. * @param kind kind of span - * @return new span */ public Span span(String kind) { return new Span(this, kind); @@ -73,8 +67,6 @@ public final class Tracer { /** * Pass the finished span to the exporters. - * - * @param span finished span */ void export(SpanContext span) { for (Exporter exporter : exporters) { diff --git a/scm-core/src/main/java/sonia/scm/upgrade/UpgradeHandler.java b/scm-core/src/main/java/sonia/scm/upgrade/UpgradeHandler.java index 08433961a6..edb7c9b9aa 100644 --- a/scm-core/src/main/java/sonia/scm/upgrade/UpgradeHandler.java +++ b/scm-core/src/main/java/sonia/scm/upgrade/UpgradeHandler.java @@ -24,32 +24,18 @@ package sonia.scm.upgrade; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.version.Version; -//~--- JDK imports ------------------------------------------------------------ - import java.io.File; /** - * Handle upgrades from one SCM-Manager version to an other. + * Handle upgrades from one SCM-Manager version to another. * - * @author Sebastian Sdorra * @since 1.23 */ public interface UpgradeHandler { - - /** - * Handle upgrade of SCM-Manager - * - * - * @param homeDirectory home directory - * @param configDirectory config directory - * @param oldVersion old version - * @param newVersion new version - */ public void doUpgrade(File homeDirectory, File configDirectory, Version oldVersion, Version newVersion); } diff --git a/scm-core/src/main/java/sonia/scm/user/AbstractUserManager.java b/scm-core/src/main/java/sonia/scm/user/AbstractUserManager.java index 52a50314c6..7c9abe8a5e 100644 --- a/scm-core/src/main/java/sonia/scm/user/AbstractUserManager.java +++ b/scm-core/src/main/java/sonia/scm/user/AbstractUserManager.java @@ -24,7 +24,6 @@ package sonia.scm.user; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.HandlerEventType; import sonia.scm.event.ScmEventBus; @@ -33,7 +32,6 @@ import sonia.scm.event.ScmEventBus; * Abstract base class for {@link UserManager} implementations. This class * implements the listener methods of the {@link UserManager} interface. * - * @author Sebastian Sdorra */ public abstract class AbstractUserManager implements UserManager { diff --git a/scm-core/src/main/java/sonia/scm/user/UserDAO.java b/scm-core/src/main/java/sonia/scm/user/UserDAO.java index 0b42c6310f..0093c634c6 100644 --- a/scm-core/src/main/java/sonia/scm/user/UserDAO.java +++ b/scm-core/src/main/java/sonia/scm/user/UserDAO.java @@ -24,16 +24,14 @@ package sonia.scm.user; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.GenericDAO; /** - * Data access object for users. This class should only used by the + * Data access object for users. This class should only be used by the * {@link UserManager}. Plugins and other classes should use the * {@link UserManager} instead. * - * @author Sebastian Sdorra * @since 1.14 */ public interface UserDAO extends GenericDAO {} diff --git a/scm-core/src/main/java/sonia/scm/user/UserEvent.java b/scm-core/src/main/java/sonia/scm/user/UserEvent.java index bf9c9476e0..b00c44649f 100644 --- a/scm-core/src/main/java/sonia/scm/user/UserEvent.java +++ b/scm-core/src/main/java/sonia/scm/user/UserEvent.java @@ -24,7 +24,6 @@ package sonia.scm.user; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.HandlerEventType; import sonia.scm.event.AbstractHandlerEvent; @@ -33,7 +32,6 @@ import sonia.scm.event.Event; /** * The UserEvent is fired if a user object changes. * - * @author Sebastian Sdorra * @since 1.23 */ @Event diff --git a/scm-core/src/main/java/sonia/scm/user/UserManager.java b/scm-core/src/main/java/sonia/scm/user/UserManager.java index fe52126393..a1c618027d 100644 --- a/scm-core/src/main/java/sonia/scm/user/UserManager.java +++ b/scm-core/src/main/java/sonia/scm/user/UserManager.java @@ -21,10 +21,9 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ - + package sonia.scm.user; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.Manager; import sonia.scm.search.Searchable; @@ -34,8 +33,7 @@ import java.util.Collection; /** * The central class for managing {@link User} objects. * This class is a singleton and is available via injection. - * - * @author Sebastian Sdorra + * */ public interface UserManager extends Manager, Searchable @@ -43,22 +41,14 @@ public interface UserManager /** * Returns true if a user with the specified username exists. - * - * - * @param username username of the user - * - * @return true if the user exists */ public boolean contains(String username); - //~--- get methods ---------------------------------------------------------- /** * Returns the default type for users. * - * - * @return default user type - * @since 1.14 + * @since 1.14 */ public String getDefaultType(); diff --git a/scm-core/src/main/java/sonia/scm/user/UserManagerDecorator.java b/scm-core/src/main/java/sonia/scm/user/UserManagerDecorator.java index e04db00d77..81afaaa468 100644 --- a/scm-core/src/main/java/sonia/scm/user/UserManagerDecorator.java +++ b/scm-core/src/main/java/sonia/scm/user/UserManagerDecorator.java @@ -24,75 +24,44 @@ package sonia.scm.user; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.ManagerDecorator; import sonia.scm.search.SearchRequest; import java.util.Collection; -//~--- JDK imports ------------------------------------------------------------ - /** * Decorator for {@link UserManager}. * - * @author Sebastian Sdorra * @since 1.23 */ public class UserManagerDecorator extends ManagerDecorator implements UserManager { + private final UserManager decorated; - /** - * Constructs ... - * - * - * @param decorated - */ public UserManagerDecorator(UserManager decorated) { super(decorated); this.decorated = decorated; } - //~--- methods -------------------------------------------------------------- - - /** - * {@inheritDoc} - * - * - * @param username - * - * @return - */ @Override public boolean contains(String username) { return decorated.contains(username); } - /** - * {@inheritDoc} - * - * - * @param searchRequest - * - * @return - */ @Override public Collection search(SearchRequest searchRequest) { return decorated.search(searchRequest); } - //~--- get methods ---------------------------------------------------------- /** * Returns the decorated {@link UserManager}. * - * - * @return decorated {@link UserManager} - * * @since 1.34 */ public UserManager getDecorated() @@ -100,12 +69,6 @@ public class UserManagerDecorator extends ManagerDecorator return decorated; } - /** - * {@inheritDoc} - * - * - * @return - */ @Override public String getDefaultType() { @@ -121,8 +84,4 @@ public class UserManagerDecorator extends ManagerDecorator public void overwritePassword(String userId, String newPassword) { decorated.overwritePassword(userId, newPassword); } -//~--- fields --------------------------------------------------------------- - - /** Field description */ - private final UserManager decorated; } diff --git a/scm-core/src/main/java/sonia/scm/user/UserManagerDecoratorFactory.java b/scm-core/src/main/java/sonia/scm/user/UserManagerDecoratorFactory.java index 2ec6059fc5..330d1c1c14 100644 --- a/scm-core/src/main/java/sonia/scm/user/UserManagerDecoratorFactory.java +++ b/scm-core/src/main/java/sonia/scm/user/UserManagerDecoratorFactory.java @@ -24,7 +24,6 @@ package sonia.scm.user; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.DecoratorFactory; import sonia.scm.plugin.ExtensionPoint; @@ -32,7 +31,6 @@ import sonia.scm.plugin.ExtensionPoint; /** * Factory for user manager decorators. * - * @author Sebastian Sdorra * @since 1.23 */ @ExtensionPoint diff --git a/scm-core/src/main/java/sonia/scm/user/UserModificationEvent.java b/scm-core/src/main/java/sonia/scm/user/UserModificationEvent.java index fbf5f11912..14e395de34 100644 --- a/scm-core/src/main/java/sonia/scm/user/UserModificationEvent.java +++ b/scm-core/src/main/java/sonia/scm/user/UserModificationEvent.java @@ -31,7 +31,6 @@ import sonia.scm.event.Event; /** * Event which is fired whenever a user is modified. * - * @author Sebastian Sdorra * @since 1.48 */ @Event diff --git a/scm-core/src/main/java/sonia/scm/util/AbstractBase.java b/scm-core/src/main/java/sonia/scm/util/AbstractBase.java index 2c9a3702a9..03e8784346 100644 --- a/scm-core/src/main/java/sonia/scm/util/AbstractBase.java +++ b/scm-core/src/main/java/sonia/scm/util/AbstractBase.java @@ -24,19 +24,15 @@ package sonia.scm.util; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Preconditions; import com.google.common.base.Strings; -//~--- JDK imports ------------------------------------------------------------ - import java.math.BigInteger; /** * Abstract base class for encoding and decoding BaseX. * - * @author Sebastian Sdorra * @since 1.21 */ public abstract class AbstractBase diff --git a/scm-core/src/main/java/sonia/scm/util/AssertUtil.java b/scm-core/src/main/java/sonia/scm/util/AssertUtil.java index dc6fe5b127..b456e31ec8 100644 --- a/scm-core/src/main/java/sonia/scm/util/AssertUtil.java +++ b/scm-core/src/main/java/sonia/scm/util/AssertUtil.java @@ -24,35 +24,19 @@ package sonia.scm.util; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.Validateable; -//~--- JDK imports ------------------------------------------------------------ - import java.util.Collection; -/** - * - * @author Sebastian Sdorra - */ + public final class AssertUtil { - /** - * Constructs ... - * - */ private AssertUtil() {} - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param value - */ + public static void assertIsNotEmpty(String value) { if (Util.isEmpty(value)) @@ -61,12 +45,6 @@ public final class AssertUtil } } - /** - * Method description - * - * - * @param array - */ public static void assertIsNotEmpty(Object[] array) { if (Util.isEmpty(array)) @@ -75,12 +53,6 @@ public final class AssertUtil } } - /** - * Method description - * - * - * @param collection - */ public static void assertIsNotEmpty(Collection collection) { if (Util.isEmpty(collection)) @@ -89,12 +61,6 @@ public final class AssertUtil } } - /** - * Method description - * - * - * @param object - */ public static void assertIsNotNull(Object object) { if (object == null) @@ -103,12 +69,6 @@ public final class AssertUtil } } - /** - * Method description - * - * - * @param validateable - */ public static void assertIsValid(Validateable validateable) { assertIsNotNull(validateable); @@ -120,10 +80,6 @@ public final class AssertUtil } /** - * throws an IllegalArgumentException if the value is smaller then 0 - * - * - * @param value * @since 1.4 */ public static void assertPositive(int value) diff --git a/scm-core/src/main/java/sonia/scm/util/Base32.java b/scm-core/src/main/java/sonia/scm/util/Base32.java index f7409c051a..70f40af7c6 100644 --- a/scm-core/src/main/java/sonia/scm/util/Base32.java +++ b/scm-core/src/main/java/sonia/scm/util/Base32.java @@ -24,14 +24,11 @@ package sonia.scm.util; -//~--- JDK imports ------------------------------------------------------------ - import java.math.BigInteger; /** * Provides Base32 encoding and decoding for long values. * - * @author Sebastian Sdorra * @since 1.21 */ public final class Base32 extends AbstractBase @@ -43,7 +40,6 @@ public final class Base32 extends AbstractBase /** char table */ private static final String CHARS = "0123456789bcdefghjkmnpqrstuvwxyz"; - //~--- methods -------------------------------------------------------------- /** * Decode a Base32 string to a long value. diff --git a/scm-core/src/main/java/sonia/scm/util/Base62.java b/scm-core/src/main/java/sonia/scm/util/Base62.java index 8b19169b01..514a93679a 100644 --- a/scm-core/src/main/java/sonia/scm/util/Base62.java +++ b/scm-core/src/main/java/sonia/scm/util/Base62.java @@ -24,14 +24,11 @@ package sonia.scm.util; -//~--- JDK imports ------------------------------------------------------------ - import java.math.BigInteger; /** * Provides Base62 encoding and decoding for long values. * - * @author Sebastian Sdorra * @since 1.21 */ public final class Base62 extends AbstractBase @@ -44,7 +41,6 @@ public final class Base62 extends AbstractBase private static final String CHARS = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz"; - //~--- methods -------------------------------------------------------------- /** * Decode a Base62 string to a long value. diff --git a/scm-core/src/main/java/sonia/scm/util/ChecksumUtil.java b/scm-core/src/main/java/sonia/scm/util/ChecksumUtil.java index e2f432cd4c..61ef239a4b 100644 --- a/scm-core/src/main/java/sonia/scm/util/ChecksumUtil.java +++ b/scm-core/src/main/java/sonia/scm/util/ChecksumUtil.java @@ -24,8 +24,6 @@ package sonia.scm.util; -//~--- JDK imports ------------------------------------------------------------ - import java.io.ByteArrayInputStream; import java.io.File; import java.io.FileInputStream; @@ -35,36 +33,16 @@ import java.io.InputStream; import java.security.MessageDigest; import java.security.NoSuchAlgorithmException; -/** - * - * @author Sebastian Sdorra - */ + public final class ChecksumUtil { - /** Field description */ private static final String DIGEST_TYPE = "SHA-1"; - //~--- constructors --------------------------------------------------------- - /** - * Constructs ... - * - */ private ChecksumUtil() {} - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param in - * - * @return - * - * @throws IOException - */ public static String createChecksum(InputStream in) throws IOException { MessageDigest digest = null; @@ -99,16 +77,6 @@ public final class ChecksumUtil return Util.toString(digest.digest()); } - /** - * Method description - * - * - * @param input - * - * @return - * - * @throws IOException - */ public static String createChecksum(String input) throws IOException { MessageDigest digest = getDigest(); @@ -118,31 +86,12 @@ public final class ChecksumUtil return Util.toString(digest.digest()); } - /** - * Method description - * - * - * @param file - * - * @return - * - * @throws IOException - */ public static String createChecksum(File file) throws IOException { return createChecksum(new FileInputStream(file)); } /** - * Method description - * - * - * @param content - * - * @return - * - * @throws IOException - * * @since 1.12 */ public static String createChecksum(byte[] content) throws IOException @@ -150,14 +99,8 @@ public final class ChecksumUtil return createChecksum(new ByteArrayInputStream(content)); } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + private static MessageDigest getDigest() { MessageDigest digest = null; diff --git a/scm-core/src/main/java/sonia/scm/util/ClassLoaders.java b/scm-core/src/main/java/sonia/scm/util/ClassLoaders.java index 9e9e3e6d09..56e7d43a9d 100644 --- a/scm-core/src/main/java/sonia/scm/util/ClassLoaders.java +++ b/scm-core/src/main/java/sonia/scm/util/ClassLoaders.java @@ -24,26 +24,19 @@ package sonia.scm.util; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Preconditions; /** * Util methods for {@link ClassLoader}s. * - * @author Sebastian Sdorra * @since 1.37 */ public final class ClassLoaders { - /** - * Constructs ... - * - */ private ClassLoaders() {} - //~--- methods -------------------------------------------------------------- /** * Executes a {@link Runnable} with the given {@link ClassLoader} as context @@ -75,7 +68,6 @@ public final class ClassLoaders } } - //~--- get methods ---------------------------------------------------------- /** * Returns the context {@link ClassLoader} from the current {@link Thread}, if diff --git a/scm-core/src/main/java/sonia/scm/util/CollectionAppender.java b/scm-core/src/main/java/sonia/scm/util/CollectionAppender.java index 77b871a236..d1c4414ecc 100644 --- a/scm-core/src/main/java/sonia/scm/util/CollectionAppender.java +++ b/scm-core/src/main/java/sonia/scm/util/CollectionAppender.java @@ -24,26 +24,12 @@ package sonia.scm.util; -//~--- JDK imports ------------------------------------------------------------ - import java.util.Collection; /** - * - * @author Sebastian Sdorra - * - * @param * @since 1.4 */ public interface CollectionAppender { - - /** - * Method description - * - * - * @param collection - * @param item - */ public void append(Collection collection, T item); } diff --git a/scm-core/src/main/java/sonia/scm/util/Decorators.java b/scm-core/src/main/java/sonia/scm/util/Decorators.java index ec28310396..1758ca3b01 100644 --- a/scm-core/src/main/java/sonia/scm/util/Decorators.java +++ b/scm-core/src/main/java/sonia/scm/util/Decorators.java @@ -24,45 +24,21 @@ package sonia.scm.util; -//~--- non-JDK imports -------------------------------------------------------- import org.slf4j.Logger; import org.slf4j.LoggerFactory; import sonia.scm.DecoratorFactory; -/** - * - * @author Sebastian Sdorra - */ + public final class Decorators { - /** - * the logger for Decorators - */ private static final Logger logger = LoggerFactory.getLogger(Decorators.class); - //~--- constructors --------------------------------------------------------- - /** - * Constructs ... - * - */ private Decorators() {} - //~--- methods -------------------------------------------------------------- - - /** - * Method description - * - * - * @param object - * @param decoratorFactories - * @param - * - * @return - */ public static T decorate(T object, Iterable> decoratorFactories) { diff --git a/scm-core/src/main/java/sonia/scm/util/GlobUtil.java b/scm-core/src/main/java/sonia/scm/util/GlobUtil.java index b35d751a00..0f4c6a86a9 100644 --- a/scm-core/src/main/java/sonia/scm/util/GlobUtil.java +++ b/scm-core/src/main/java/sonia/scm/util/GlobUtil.java @@ -21,34 +21,24 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ - + package sonia.scm.util; /** * Util for pattern matching with glob * (http://en.wikipedia.org/wiki/Glob_%28programming%29) syntax. * - * @author Sebastian Sdorra * @since 1.8 */ public final class GlobUtil { - /** - * Constructs ... - * - */ private GlobUtil() {} //~--- methods -------------------------------------------------------------- /** * Converts the given glob string to a regular expression string. - * - * - * @param globString string to convert - * - * @return regular expression string */ public static String convertGlobToRegEx(String globString) { @@ -184,8 +174,6 @@ public final class GlobUtil * * @param glob glob pattern * @param value string value - * - * @return true if the glob string matches the given value */ public static boolean matches(String glob, String value) { diff --git a/scm-core/src/main/java/sonia/scm/util/HttpUtil.java b/scm-core/src/main/java/sonia/scm/util/HttpUtil.java index 42b987578e..e6002ffc05 100644 --- a/scm-core/src/main/java/sonia/scm/util/HttpUtil.java +++ b/scm-core/src/main/java/sonia/scm/util/HttpUtil.java @@ -24,7 +24,6 @@ package sonia.scm.util; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.annotations.VisibleForTesting; import com.google.common.base.CharMatcher; @@ -46,12 +45,9 @@ import java.util.Optional; import java.util.regex.Matcher; import java.util.regex.Pattern; -//~--- JDK imports ------------------------------------------------------------ - /** * Util method for the http protocol. * - * @author Sebastian Sdorra */ public final class HttpUtil { @@ -80,7 +76,6 @@ public final class HttpUtil */ public static final String COOKIE_BEARER_AUTHENTICATION = "X-Bearer-Token"; - /** Field description */ public static final String ENCODING = "UTF-8"; /** @@ -107,7 +102,6 @@ public final class HttpUtil */ public static final String HEADER_SCM_CLIENT = "X-SCM-Client"; - /** Field description */ public static final String HEADER_USERAGENT = "User-Agent"; /** authentication header */ @@ -212,7 +206,7 @@ public final class HttpUtil /** skip size for drain body method */ private static final int SKIP_SIZE = 4096; - /** the logger for HttpUtil */ + private static final Logger logger = LoggerFactory.getLogger(HttpUtil.class); /** @@ -229,15 +223,9 @@ public final class HttpUtil private static final CharMatcher CRLF_CHARMATCHER = CharMatcher.anyOf("\n\r%"); - //~--- constructors --------------------------------------------------------- - /** - * Constructs ... - * - */ private HttpUtil() {} - //~--- methods -------------------------------------------------------------- /** * Joins all path elements together separated by {@code {@link #SEPARATOR_PATH}}. @@ -436,13 +424,6 @@ public final class HttpUtil } /** - * Returns the normalized url. - * - * - * @param url to normalize - * - * @return normalized url - * * @since 1.26 */ public static String normalizeUrl(String url) @@ -618,7 +599,6 @@ public final class HttpUtil Strings.nullToEmpty(userAgent).toLowerCase(Locale.ENGLISH)); } - //~--- get methods ---------------------------------------------------------- /** * Returns an absolute url with context path. The method creates the url from @@ -675,16 +655,6 @@ public final class HttpUtil return append(configuration.getBaseUrl(), path); } - /** - * Method description - * - * - * @param request - * @param header - * @param defaultValue - * - * @return - */ public static String getHeader(HttpServletRequest request, String header, String defaultValue) { @@ -695,12 +665,6 @@ public final class HttpUtil return value; } - /** - * Returns the port of the url parameter. - * - * @param url - * @return port of url - */ public static int getPortFromUrl(String url) { AssertUtil.assertIsNotEmpty(url); @@ -742,15 +706,6 @@ public final class HttpUtil return port; } - /** - * Returns the server port - * - * - * @param configuration - * @param request - * - * @return the server port - */ public static int getServerPort(ScmConfiguration configuration, HttpServletRequest request) { @@ -770,12 +725,10 @@ public final class HttpUtil } /** - * Return the request uri with out the context path. + * Return the request uri without the context path. * * * @param request - the http client request - * - * @return the request uri with out the context path */ public static String getStrippedURI(HttpServletRequest request) { @@ -802,7 +755,7 @@ public final class HttpUtil * * @param uri - to strip ending separator * - * @return the given uri without a ending separator + * @return the given uri without an ending separator * @since 1.7 */ public static String getUriWithoutEndSeperator(String uri) @@ -838,8 +791,6 @@ public final class HttpUtil * * * @param uri - to strip leading separator - * - * @return the given uri without leading separator * @since 1.7 */ public static String getUriWithoutStartSeperator(String uri) @@ -855,11 +806,6 @@ public final class HttpUtil /** * Returns true if the body of the request is chunked. * - * - * @param request http request - * - * @return true if the request is chunked - * * @since 1.37 */ public static boolean isChunked(HttpServletRequest request) @@ -895,7 +841,6 @@ public final class HttpUtil return client.isPresent() && SCM_CLIENT_WUI.equalsIgnoreCase(client.get()); } - //~--- methods -------------------------------------------------------------- /** * Creates base url for request url. diff --git a/scm-core/src/main/java/sonia/scm/util/IOUtil.java b/scm-core/src/main/java/sonia/scm/util/IOUtil.java index 5df6e4968b..383ff723a6 100644 --- a/scm-core/src/main/java/sonia/scm/util/IOUtil.java +++ b/scm-core/src/main/java/sonia/scm/util/IOUtil.java @@ -24,7 +24,6 @@ package sonia.scm.util; -//~--- non-JDK imports -------------------------------------------------------- import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -48,22 +47,14 @@ import java.util.Arrays; import java.util.List; import java.util.Locale; -//~--- JDK imports ------------------------------------------------------------ -/** - * - * @author Sebastian Sdorra - */ public final class IOUtil { - /** Field description */ public static final int DEFAULT_BUFFERSIZE = 8192; - /** Field description */ private static final String DEFAULT_CHECKPARAMETER = "--version"; - /** Field description */ private static final String[] DEFAULT_PATH = new String[] { @@ -80,34 +71,18 @@ public final class IOUtil "/opt/csw/bin" }; - /** Field description */ private static final String[] EXTENSION_SCRIPT_UNIX = { ".sh", ".csh", ".bsh" }; - /** Field description */ private static final String[] EXTENSION_SCRIPT_WINDOWS = { ".bat", ".cmd", ".exe" }; - /** Field description */ private static final Logger logger = LoggerFactory.getLogger(IOUtil.class.getName()); - //~--- constructors --------------------------------------------------------- - /** - * Constructs ... - * - */ private IOUtil() {} - //~--- methods -------------------------------------------------------------- - - /** - * Method description - * - * - * @param closeable - */ public static void close(Closeable closeable) { if (closeable != null) @@ -123,16 +98,6 @@ public final class IOUtil } } - /** - * Method description - * - * - * @param reader - * @param writer - * @param bufferSize - * - * @throws IOException - */ public static void copy(Reader reader, Writer writer, int bufferSize) throws IOException { @@ -144,44 +109,16 @@ public final class IOUtil } } - /** - * Method description - * - * - * @param reader - * @param writer - * - * @throws IOException - */ public static void copy(Reader reader, Writer writer) throws IOException { copy(reader, writer, DEFAULT_BUFFERSIZE); } - /** - * Method description - * - * - * @param in - * @param out - * - * @throws IOException - */ public static void copy(InputStream in, OutputStream out) throws IOException { copy(in, out, DEFAULT_BUFFERSIZE); } - /** - * Method description - * - * - * @param in - * @param out - * @param bufferSize - * - * @throws IOException - */ public static void copy(InputStream in, OutputStream out, int bufferSize) throws IOException { @@ -195,17 +132,6 @@ public final class IOUtil out.flush(); } - /** - * Method description - * - * - * @param in - * @param out - * @param bufferSize - * @param byteCount - * - * @throws IOException - */ public static void copy(InputStream in, OutputStream out, int bufferSize, int byteCount) throws IOException @@ -250,15 +176,6 @@ public final class IOUtil out.flush(); } - /** - * Method description - * - * - * @param source - * @param target - * - * @throws IOException - */ public static void copy(File source, File target) throws IOException { if (source.isDirectory()) @@ -294,65 +211,27 @@ public final class IOUtil } } - /** - * Method description - * - * - * @param reader - * @param writer - */ public static void copyThread(Reader reader, Writer writer) { copyThread(reader, writer, DEFAULT_BUFFERSIZE); } - /** - * Method description - * - * - * @param input - * @param output - */ public static void copyThread(InputStream input, OutputStream output) { copyThread(input, output, DEFAULT_BUFFERSIZE); } - /** - * Method description - * - * - * @param reader - * @param writer - * @param bufferSize - */ public static void copyThread(Reader reader, Writer writer, int bufferSize) { new Thread(new IOCopyThread(reader, writer, bufferSize)).start(); } - /** - * Method description - * - * - * @param input - * @param output - * @param bufferSize - */ public static void copyThread(InputStream input, OutputStream output, int bufferSize) { new Thread(new IOStreamCopyThread(input, output, bufferSize)).start(); } - /** - * Method description - * - * - * @param file - * - * @throws IOException - */ public static void delete(File file) throws IOException { delete(file, false); @@ -367,15 +246,6 @@ public final class IOUtil } } - /** - * Method description - * - * - * @param file - * @param silent - * - * @throws IOException - */ public static void delete(File file, boolean silent) throws IOException { if (file.isDirectory()) @@ -416,15 +286,6 @@ public final class IOUtil } } - /** - * Method description - * - * - * @param archive - * @param outputDirectory - * - * @throws IOException - */ public static void extract(File archive, File outputDirectory) throws IOException { @@ -433,16 +294,6 @@ public final class IOUtil extract(archive, outputDirectory, name); } - /** - * Method description - * - * - * @param archive - * @param outputDirectory - * @param type - * - * @throws IOException - */ public static void extract(File archive, File outputDirectory, String type) throws IOException { @@ -456,12 +307,6 @@ public final class IOUtil } } - /** - * Method description - * - * - * @param directory - */ public static void mkdirs(File directory) { if (!directory.exists() &&!directory.mkdirs()) @@ -477,26 +322,11 @@ public final class IOUtil } } - /** - * - * - * @param cmd - * - * @return - */ public static String search(String cmd) { return search(DEFAULT_PATH, cmd, DEFAULT_CHECKPARAMETER); } - /** - * - * - * @param path - * @param cmd - * - * @return - */ public static String search(String[] path, String cmd) { return search(path, cmd, DEFAULT_CHECKPARAMETER); @@ -504,14 +334,6 @@ public final class IOUtil /** * TODO check for windows - * - * - * - * @param path - * @param cmd - * @param checkParameter - * - * @return */ public static String search(String[] path, String cmd, String checkParameter) { @@ -553,43 +375,16 @@ public final class IOUtil return cmdPath; } - /** - * Method description - * - * - * @param cmd - * - * @return - */ public static List searchAll(String cmd) { return searchAll(DEFAULT_PATH, cmd, DEFAULT_CHECKPARAMETER); } - /** - * Method description - * - * - * @param path - * @param cmd - * - * @return - */ public static List searchAll(String[] path, String cmd) { return searchAll(path, cmd, DEFAULT_CHECKPARAMETER); } - /** - * Method description - * - * - * @param path - * @param cmd - * @param checkParameter - * - * @return - */ public static List searchAll(String[] path, String cmd, String checkParameter) { @@ -615,12 +410,6 @@ public final class IOUtil } /** - * Method description - * - * - * @param name - * - * @return * @since 1.9 */ public static String trimSeperatorChars(String name) @@ -638,18 +427,9 @@ public final class IOUtil return name; } - //~--- get methods ---------------------------------------------------------- /** - * Method description - * - * - * @param in - * - * @return * @since 1.8 - * - * @throws IOException */ public static String getContent(InputStream in) throws IOException { @@ -672,13 +452,7 @@ public final class IOUtil } /** - * Method description - * - * - * @param basePath - * * @since 1.6 - * @return */ public static File getScript(String basePath) { @@ -686,13 +460,7 @@ public final class IOUtil } /** - * Method description - * - * - * @param baseFile - * * @since 1.6 - * @return */ public static File getScript(File baseFile) { @@ -707,8 +475,6 @@ public final class IOUtil * @param child chile file * @since 1.9 * - * @return true if the second file parameter is a child of the first one - * */ public static boolean isChild(File parent, File child) { @@ -733,12 +499,6 @@ public final class IOUtil } /** - * Returns true if the given directory is empty. - * - * - * @param directory directory to check - * - * @return true if the directory is empty * @since 1.16 */ public static boolean isEmpty(File directory) @@ -746,18 +506,6 @@ public final class IOUtil return Util.isEmpty(directory.listFiles()); } - //~--- methods -------------------------------------------------------------- - - /** - * Method description - * - * - * @param parentPath - * @param cmd - * @param potentialExtensions - * - * @return - */ private static File findFileByExtension(String parentPath, String cmd, List potentialExtensions) { @@ -779,13 +527,11 @@ public final class IOUtil return file; } - //~--- get methods ---------------------------------------------------------- /** * Returns a list of file extensions to use when searching for executables. * The list is in priority order, with the highest priority first. * - * @return */ private static List getExecutableSearchExtensions() { @@ -804,14 +550,7 @@ public final class IOUtil } /** - * Method description - * - * - * @param baseFile - * @param basePath - * * @since 1.6 - * @return */ private static File getScript(File baseFile, String basePath) { @@ -850,15 +589,6 @@ public final class IOUtil return script; } - /** - * Method description - * - * - * @param cmd - * @param checkParameter - * - * @return - */ private static boolean isCommandAvailable(String cmd, String checkParameter) { boolean success = false; @@ -881,26 +611,14 @@ public final class IOUtil return success; } - //~--- inner classes -------------------------------------------------------- - - /** - * Class description - * - * - * @version Enter version here..., 10/09/28 - * @author Enter your name here... - */ private static class IOCopyThread implements Runnable { + private int bufferSize; + + private Reader reader; + + private Writer writer; - /** - * Constructs ... - * - * - * @param reader - * @param writer - * @param bufferSize - */ public IOCopyThread(Reader reader, Writer writer, int bufferSize) { this.reader = reader; @@ -908,12 +626,8 @@ public final class IOUtil this.bufferSize = bufferSize; } - //~--- methods ------------------------------------------------------------ + - /** - * Method description - * - */ @Override public void run() { @@ -931,38 +645,16 @@ public final class IOUtil close(writer); } } - - //~--- fields ------------------------------------------------------------- - - /** Field description */ - private int bufferSize; - - /** Field description */ - private Reader reader; - - /** Field description */ - private Writer writer; } - - /** - * Class description - * - * - * @version Enter version here..., 2010-12-27 - * @author Sebastian Sdorra - */ private static class IOStreamCopyThread implements Runnable { + private int bufferSize; + + private InputStream input; + + private OutputStream output; - /** - * Constructs ... - * - * - * @param input - * @param output - * @param bufferSize - */ public IOStreamCopyThread(InputStream input, OutputStream output, int bufferSize) { @@ -971,12 +663,8 @@ public final class IOUtil this.bufferSize = bufferSize; } - //~--- methods ------------------------------------------------------------ + - /** - * Method description - * - */ @Override public void run() { @@ -994,16 +682,5 @@ public final class IOUtil close(output); } } - - //~--- fields ------------------------------------------------------------- - - /** Field description */ - private int bufferSize; - - /** Field description */ - private InputStream input; - - /** Field description */ - private OutputStream output; } } diff --git a/scm-core/src/main/java/sonia/scm/util/LinkTextParser.java b/scm-core/src/main/java/sonia/scm/util/LinkTextParser.java index 4432ceb3cf..77ac63d310 100644 --- a/scm-core/src/main/java/sonia/scm/util/LinkTextParser.java +++ b/scm-core/src/main/java/sonia/scm/util/LinkTextParser.java @@ -24,8 +24,6 @@ package sonia.scm.util; -//~--- JDK imports ------------------------------------------------------------ - import java.text.MessageFormat; import java.util.ArrayList; @@ -33,40 +31,20 @@ import java.util.List; import java.util.regex.Matcher; import java.util.regex.Pattern; -/** - * - * @author Sebastian Sdorra - */ + public final class LinkTextParser { - /** Field description */ private static final Pattern REGEX_URL = Pattern.compile( "\\(?\\b((?:https?://|ftps?://|mailto:|www[.])[-A-Za-z0-9+&@#/%?=~_()|!:,.;]*[-A-Za-z0-9+&@#/%=~_()|])"); - /** Field description */ private static final String REPLACE_URL = "{0}"; - //~--- constructors --------------------------------------------------------- - /** - * Constructs ... - * - */ private LinkTextParser() {} - //~--- methods -------------------------------------------------------------- - - /** - * Method description - * - * - * @param content - * - * @return - */ public static String parseText(String content) { Matcher m = REGEX_URL.matcher(content); @@ -114,72 +92,34 @@ public final class LinkTextParser return buffer.toString(); } - //~--- inner classes -------------------------------------------------------- - /** - * Class description - * - * - * @version Enter version here..., 11/11/06 - * @author Enter your name here... - */ + private static class Token { + private String replacement; + + private String value; - /** - * Constructs ... - * - * - * @param value - */ public Token(String value) { this.value = value; } - /** - * Constructs ... - * - * - * @param value - * @param replacement - */ public Token(String value, String replacement) { this.value = value; this.replacement = replacement; } - //~--- get methods -------------------------------------------------------- - /** - * Method description - * - * - * @return - */ public String getReplacement() { return replacement; } - /** - * Method description - * - * - * @return - */ public String getValue() { return value; } - - //~--- fields ------------------------------------------------------------- - - /** Field description */ - private String replacement; - - /** Field description */ - private String value; } } diff --git a/scm-core/src/main/java/sonia/scm/util/RegistryUtil.java b/scm-core/src/main/java/sonia/scm/util/RegistryUtil.java index df76af54c6..fefab1f412 100644 --- a/scm-core/src/main/java/sonia/scm/util/RegistryUtil.java +++ b/scm-core/src/main/java/sonia/scm/util/RegistryUtil.java @@ -24,7 +24,6 @@ package sonia.scm.util; -//~--- non-JDK imports -------------------------------------------------------- import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -32,62 +31,28 @@ import org.slf4j.LoggerFactory; import sonia.scm.io.SimpleCommand; import sonia.scm.io.SimpleCommandResult; -//~--- JDK imports ------------------------------------------------------------ - import java.io.IOException; import java.util.Scanner; -/** - * @author Sebastian Sdorra - */ public final class RegistryUtil { - /** - * the logger for RegistryUtil - */ private static final Logger logger = LoggerFactory.getLogger(RegistryUtil.class); - //~--- constructors --------------------------------------------------------- - /** - * Constructs ... - */ private RegistryUtil() { } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * @param key - * @return - */ public static String getRegistryValue(String key) { return getRegistryValue(key, null, null); } - /** - * Method description - * - * @param key - * @param defaultValue - * @return - */ public static String getRegistryValue(String key, String defaultValue) { return getRegistryValue(key, null, defaultValue); } - /** - * Method description - * - * @param key - * @param subKey - * @param defaultValue - * @return - */ public static String getRegistryValue(String key, String subKey, String defaultValue) { String value = defaultValue; diff --git a/scm-core/src/main/java/sonia/scm/util/ServiceUtil.java b/scm-core/src/main/java/sonia/scm/util/ServiceUtil.java index 643288c6cf..4c4e7d365c 100644 --- a/scm-core/src/main/java/sonia/scm/util/ServiceUtil.java +++ b/scm-core/src/main/java/sonia/scm/util/ServiceUtil.java @@ -24,38 +24,17 @@ package sonia.scm.util; -//~--- JDK imports ------------------------------------------------------------ - import java.util.ArrayList; import java.util.List; import java.util.NoSuchElementException; import java.util.ServiceLoader; -/** - * - * @author Sebastian Sdorra - */ + public final class ServiceUtil { - /** - * Constructs ... - * - */ private ServiceUtil() {} - //~--- get methods ---------------------------------------------------------- - - /** - * Method description - * - * - * @param type - * @param def - * @param - * - * @return - */ public static T getService(Class type, T def) { T result = getService(type); @@ -68,15 +47,6 @@ public final class ServiceUtil return result; } - /** - * Method description - * - * - * @param type - * @param - * - * @return - */ public static T getService(Class type) { T result = null; @@ -99,15 +69,6 @@ public final class ServiceUtil return result; } - /** - * Method description - * - * - * @param type - * @param - * - * @return - */ public static List getServices(Class type) { List result = new ArrayList<>(); diff --git a/scm-core/src/main/java/sonia/scm/util/SystemUtil.java b/scm-core/src/main/java/sonia/scm/util/SystemUtil.java index 33cda10260..2c183ec285 100644 --- a/scm-core/src/main/java/sonia/scm/util/SystemUtil.java +++ b/scm-core/src/main/java/sonia/scm/util/SystemUtil.java @@ -24,71 +24,41 @@ package sonia.scm.util; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.Platform; -/** - * - * @author Sebastian Sdorra - */ + public final class SystemUtil { - /** Field description */ public static final String PROPERTY_ARCH = "sun.arch.data.model"; - /** Field description */ public static final String PROPERTY_OSARCH = "os.arch"; - /** Field description */ public static final String PROPERTY_OSNAME = "os.name"; - /** Field description */ private static Platform platform = new Platform(System.getProperty(PROPERTY_OSNAME), System.getProperty(PROPERTY_ARCH), System.getProperty(PROPERTY_OSARCH)); - //~--- constructors --------------------------------------------------------- - /** - * Constructs ... - * - */ private SystemUtil() {} - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + public static boolean is32bit() { return platform.is32Bit(); } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + public static String getArch() { return platform.getArch(); } - /** - * Method description - * - * - * @return - */ + public static String getOS() { return platform.getName(); @@ -98,45 +68,25 @@ public final class SystemUtil return System.getProperty("java.version"); } - /** - * Method description - * - * - * @return - */ + public static Platform getPlatform() { return platform; } - /** - * Method description - * - * - * @return - */ + public static boolean isMac() { return platform.isMac(); } - /** - * Method description - * - * - * @return - */ + public static boolean isUnix() { return platform.isUnix(); } - /** - * Method description - * - * - * @return - */ + public static boolean isWindows() { return platform.isWindows(); diff --git a/scm-core/src/main/java/sonia/scm/util/UrlBuilder.java b/scm-core/src/main/java/sonia/scm/util/UrlBuilder.java index ef020f85ff..ea1000c263 100644 --- a/scm-core/src/main/java/sonia/scm/util/UrlBuilder.java +++ b/scm-core/src/main/java/sonia/scm/util/UrlBuilder.java @@ -24,25 +24,21 @@ package sonia.scm.util; -//~--- JDK imports ------------------------------------------------------------ - import com.google.common.net.UrlEscapers; import java.net.MalformedURLException; import java.net.URL; /** * @since 1.9 - * @author Sebastian Sdorra */ public class UrlBuilder { + private boolean parameterAdded = false; + + private String separator; + + private String url; - /** - * Constructs ... - * - * - * @param baseUrl - */ public UrlBuilder(String baseUrl) { this.url = baseUrl; @@ -58,16 +54,6 @@ public class UrlBuilder } } - //~--- methods -------------------------------------------------------------- - - /** - * Method description - * - * - * @param part - * - * @return - */ public UrlBuilder append(String part) { url = url.concat(part); @@ -75,57 +61,21 @@ public class UrlBuilder return this; } - /** - * Method description - * - * - * @param name - * @param value - * - * @return - */ public UrlBuilder appendParameter(String name, boolean value) { return appendParameter(name, String.valueOf(value)); } - /** - * Method description - * - * - * @param name - * @param value - * - * @return - */ public UrlBuilder appendParameter(String name, int value) { return appendParameter(name, String.valueOf(value)); } - /** - * Method description - * - * - * @param name - * @param value - * - * @return - */ public UrlBuilder appendParameter(String name, long value) { return appendParameter(name, String.valueOf(value)); } - /** - * Method description - * - * - * @param name - * @param value - * - * @return - */ public UrlBuilder appendParameter(String name, String value) { if (Util.isNotEmpty(name) && Util.isNotEmpty(value)) @@ -142,14 +92,6 @@ public class UrlBuilder return this; } - /** - * Method description - * - * - * @param part - * - * @return - */ public UrlBuilder appendUrlPart(String part) { if (parameterAdded) @@ -162,24 +104,14 @@ public class UrlBuilder return this; } - /** - * Method description - * - * - * @return - */ + @Override public String toString() { return url; } - /** - * Method description - * - * - * @return - */ + public URL toURL() { try @@ -192,14 +124,4 @@ public class UrlBuilder } } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private boolean parameterAdded = false; - - /** Field description */ - private String separator; - - /** Field description */ - private String url; } diff --git a/scm-core/src/main/java/sonia/scm/util/Util.java b/scm-core/src/main/java/sonia/scm/util/Util.java index 6338b08bec..2369be8a57 100644 --- a/scm-core/src/main/java/sonia/scm/util/Util.java +++ b/scm-core/src/main/java/sonia/scm/util/Util.java @@ -24,7 +24,6 @@ package sonia.scm.util; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Strings; import com.google.common.collect.Multimap; @@ -34,41 +33,17 @@ import java.text.ParseException; import java.text.SimpleDateFormat; import java.util.*; -//~--- JDK imports ------------------------------------------------------------ -/** - * - * @author Sebastian Sdorra - */ public final class Util { - /** Field description */ public static final String DATE_PATTERN = "yyyy-MM-dd HH-mm-ss"; - /** Field description */ public static final String EMPTY_STRING = ""; - //~--- constructors --------------------------------------------------------- - /** - * Constructs ... - * - */ private Util() {} - //~--- methods -------------------------------------------------------------- - - /** - * Method description - * - * - * @param object - * @param otherObject - * @param - * - * @return - */ @SuppressWarnings("unchecked") public static int compare(T object, T otherObject) { @@ -90,16 +65,6 @@ public final class Util return result; } - /** - * Method description - * - * - * @param collection - * @param other - * @param - * - * @return - */ public static boolean containsOne(Collection collection, Collection other) { @@ -118,14 +83,6 @@ public final class Util return result; } - /** - * Method description - * - * - * @param time - * - * @return - */ public static String convertTime(long time) { String suffix = "ms"; @@ -151,14 +108,6 @@ public final class Util return time + suffix; } - /** - * Method description - * - * - * @param timeString - * - * @return - */ public static long convertTime(String timeString) { char suffix = timeString.charAt(timeString.length() - 1); @@ -179,16 +128,6 @@ public final class Util } /** - * Method description - * - * - * @param values - * @param comparator - * @param start - * @param limit - * @param - * - * @return * @since 1.4 */ public static Collection createSubCollection(Collection values, @@ -198,15 +137,6 @@ public final class Util } /** - * Method description - * - * - * @param values - * @param start - * @param limit - * @param - * - * @return * @since 1.4 */ public static Collection createSubCollection(Collection values, @@ -216,16 +146,6 @@ public final class Util } /** - * Method description - * - * - * @param values - * @param appender - * @param start - * @param limit - * @param - * - * @return * @since 1.4 */ public static Collection createSubCollection(Collection values, @@ -235,18 +155,6 @@ public final class Util } /** - * Method description - * - * - * - * @param values - * @param comparator - * @param appender - * @param start - * @param limit - * @param - * - * @return * @since 1.4 */ public static Collection createSubCollection(Collection values, @@ -289,15 +197,6 @@ public final class Util return result; } - /** - * Method description - * - * - * @param date - * @param tz - * - * @return - */ public static String formatDate(Date date, TimeZone tz) { SimpleDateFormat sdf = new SimpleDateFormat(DATE_PATTERN); @@ -310,35 +209,19 @@ public final class Util return sdf.format(date); } - /** - * Method description - * - * - * @param date - * - * @return - */ public static String formatDate(Date date) { return formatDate(date, null); } - /** - * Method description - * - * - * @param value - * - * @return - */ public static byte[] fromHexString(String value) { return new BigInteger(value, 16).toByteArray(); } /** - * Returns an emtpy string, if the object is null. Otherwise the result of - * the toString method of the object is returned is returned. + * Returns an emtpy string, if the object is null. Otherwise, the result of + * the toString method of the object is returned. * * @param value object * @@ -354,7 +237,7 @@ public final class Util } /** - * Returns an emtpy string, if the string is null. Otherwise the string + * Returns an empty string, if the string is null. Otherwise, the string * is returned. The method is available to fix a possible linkage error which * was introduced with version 1.14. Please have a look at: * https://bitbucket.org/sdorra/scm-manager/issue/569/active-directory-plugin-not-working-in @@ -370,17 +253,6 @@ public final class Util return Strings.nullToEmpty(value); } - /** - * Method description - * - * - * @param dateString - * @param tz - * - * @return - * - * @throws ParseException - */ public static Date parseDate(String dateString, TimeZone tz) throws ParseException { @@ -394,16 +266,6 @@ public final class Util return sdf.parse(dateString); } - /** - * Method description - * - * - * @param dateString - * - * @return - * - * @throws ParseException - */ public static Date parseDate(String dateString) throws ParseException { return parseDate(dateString, null); @@ -428,14 +290,6 @@ public final class Util } /** - * Method description - * - * - * @param value - * @param start - * - * @return - * * @since 1.17 */ public static boolean startWithIgnoreCase(String value, String start) @@ -444,14 +298,6 @@ public final class Util && value.toUpperCase(Locale.ENGLISH).startsWith(start); } - /** - * Method description - * - * - * @param collection - * - * @return - */ public static String toString(Collection collection) { StringBuilder sb = new StringBuilder(); @@ -474,14 +320,6 @@ public final class Util return sb.toString(); } - /** - * Method description - * - * - * @param byteValue - * - * @return - */ public static String toString(byte[] byteValue) { StringBuilder buffer = new StringBuilder(); @@ -499,16 +337,8 @@ public final class Util return buffer.toString(); } - //~--- get methods ---------------------------------------------------------- /** - * Method description - * - * - * @param iterable - * @param - * - * @return * @since 1.5 */ public static T getFirst(Iterable iterable) @@ -524,13 +354,6 @@ public final class Util } /** - * Method description - * - * - * @param iterator - * @param - * - * @return * @since 1.5 */ public static T getFirst(Iterator iterator) @@ -545,68 +368,26 @@ public final class Util return result; } - /** - * Method description - * - * - * @param value - * - * @return - */ public static boolean isEmpty(String value) { return (value == null) || (value.trim().length() == 0); } - /** - * Method description - * - * - * @param collection - * - * @return - */ public static boolean isEmpty(Collection collection) { return (collection == null) || collection.isEmpty(); } - /** - * Method description - * - * - * - * @param map - * - * @return - */ public static boolean isEmpty(Map map) { return (map == null) || map.isEmpty(); } - /** - * Method description - * - * - * @param array - * - * @return - */ public static boolean isEmpty(Object[] array) { return (array == null) || (array.length == 0); } - /** - * Method description - * - * - * @param object - * @param other - * - * @return - */ public static boolean isEquals(Object object, Object other) { return (object == null) @@ -614,68 +395,26 @@ public final class Util : object.equals(other); } - /** - * Method description - * - * - * @param value - * - * @return - */ public static boolean isNotEmpty(String value) { return (value != null) && (value.trim().length() > 0); } - /** - * Method description - * - * - * @param collection - * - * @return - */ public static boolean isNotEmpty(Collection collection) { return (collection != null) &&!collection.isEmpty(); } - /** - * Method description - * - * - * - * @param map - * - * @return - */ public static boolean isNotEmpty(Map map) { return (map != null) &&!map.isEmpty(); } - /** - * Method description - * - * - * @param array - * - * @return - */ public static boolean isNotEmpty(Object[] array) { return (array != null) && (array.length > 0); } - /** - * Method description - * - * - * @param object - * @param other - * - * @return - */ public static boolean isNotEquals(Object object, Object other) { return !isEquals(object, other); diff --git a/scm-core/src/main/java/sonia/scm/util/ValidationUtil.java b/scm-core/src/main/java/sonia/scm/util/ValidationUtil.java index 91022a7fcd..ed9a03872a 100644 --- a/scm-core/src/main/java/sonia/scm/util/ValidationUtil.java +++ b/scm-core/src/main/java/sonia/scm/util/ValidationUtil.java @@ -42,12 +42,6 @@ public final class ValidationUtil { private ValidationUtil() { } - /** - * Returns {@code true} if the filename is valid. - * - * @param filename filename to be validated - * @return {@code true} if filename is valid - */ public static boolean isFilenameValid(String filename) { return Util.isNotEmpty(filename) && isNotContaining(filename, "/", "\\", ":"); } @@ -68,32 +62,14 @@ public final class ValidationUtil { && !path.equals(".."); } - /** - * Returns {@code true} if the mail is valid. - * - * @param mail email-address to be validated - * @return {@code true} if mail is valid - */ public static boolean isMailAddressValid(String mail) { return Util.isNotEmpty(mail) && mail.toLowerCase().matches(REGEX_MAIL); } - /** - * Returns {@code true} if the name is valid. - * - * @param name name to be validated - * @return {@code true} if name is valid - */ public static boolean isNameValid(String name) { return Util.isNotEmpty(name) && name.matches(REGEX_NAME) && !name.equals(".."); } - /** - * Returns {@code true} if the user password is valid. - * - * @param password password to be validated - * @return {@code true} if password is valid - */ public static boolean isPasswordValid(String password) { String pw = Strings.nullToEmpty(password); return pw.length() >= 6 && pw.length() <= 1024; @@ -123,10 +99,6 @@ public final class ValidationUtil { } /** - * Returns {@code true} if the repository name is valid. - * - * @param name repository name - * @return {@code true} if repository name is valid * @since 1.9 */ public static boolean isRepositoryNameValid(String name) { diff --git a/scm-core/src/main/java/sonia/scm/util/WebUtil.java b/scm-core/src/main/java/sonia/scm/util/WebUtil.java index 7f2db1c2b4..95ff895da2 100644 --- a/scm-core/src/main/java/sonia/scm/util/WebUtil.java +++ b/scm-core/src/main/java/sonia/scm/util/WebUtil.java @@ -24,7 +24,6 @@ package sonia.scm.util; -//~--- non-JDK imports -------------------------------------------------------- import jakarta.servlet.http.HttpServletRequest; import jakarta.servlet.http.HttpServletResponse; @@ -42,91 +41,56 @@ import java.util.function.Function; /** * - * @author Sebastian Sdorra * @since 1.15 */ public final class WebUtil { - /** Field description */ public static final String CACHE_CONTROL_PREVENT = "no-cache, must-revalidate"; - /** Field description */ public static final String DATE_PREVENT_CACHE = "Tue, 09 Apr 1985 10:00:00 GMT"; - /** Field description */ public static final String HEADER_ACCEPTENCODING = "Accept-Encoding"; - /** Field description */ public static final String HEADER_CACHECONTROL = "Cache-Control"; - /** Field description */ public static final String HEADER_ETAG = "Etag"; - /** Field description */ public static final String HEADER_EXPIRES = "Expires"; - /** Field description */ public static final String HEADER_IFMS = "If-Modified-Since"; - /** Field description */ public static final String HEADER_INM = "If-None-Match"; - /** Field description */ public static final String HEADER_LASTMODIFIED = "Last-Modified"; - /** Field description */ public static final String HEADER_PRAGMA = "Pragma"; - /** Field description */ public static final String PRAGMA_NOCACHE = "no-cache"; - /** Field description */ public static final long TIME_DAY = 60 * 60 * 24; - /** Field description */ public static final long TIME_MONTH = 60 * 60 * 24 * 30; - /** Field description */ public static final long TIME_YEAR = 60 * 60 * 24 * 365; - /** Field description */ private static final String HTTP_DATE_FORMAT = "EEE, dd MMM yyyy HH:mm:ss zzz"; - /** Field description */ private static final Logger logger = LoggerFactory.getLogger(WebUtil.class); - //~--- constructors --------------------------------------------------------- - /** - * Constructs ... - * - */ private WebUtil() {} - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param response - * @param file - */ public static void addETagHeader(HttpServletResponse response, File file) { response.addHeader(HEADER_ETAG, getETag(file)); } - /** - * Method description - * - * - * @param response - */ + public static void addPreventCacheHeaders(HttpServletResponse response) { response.addDateHeader(HEADER_LASTMODIFIED, new Date().getTime()); @@ -135,13 +99,6 @@ public final class WebUtil response.addHeader(HEADER_EXPIRES, DATE_PREVENT_CACHE); } - /** - * Method description - * - * - * @param response - * @param seconds - */ public static void addStaticCacheControls(HttpServletResponse response, long seconds) { @@ -155,56 +112,24 @@ public final class WebUtil response.addHeader(HEADER_CACHECONTROL, cc); } - /** - * Method description - * - * - * @param date - * - * @return - */ public static String formatHttpDate(Date date) { return getHttpDateFormat().format(date); } - /** - * Method description - * - * - * @param dateString - * - * @return - * - * @throws ParseException - */ public static Date parseHttpDate(String dateString) throws ParseException { return getHttpDateFormat().parse(dateString); } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param file - * - * @return - */ public static String getETag(File file) { return new StringBuilder("W/\"").append(file.length()).append( file.lastModified()).append("\"").toString(); } - /** - * Method description - * - * - * @return - */ + public static DateFormat getHttpDateFormat() { SimpleDateFormat dateFormat = new SimpleDateFormat(HTTP_DATE_FORMAT, @@ -215,14 +140,6 @@ public final class WebUtil return dateFormat; } - /** - * Method description - * - * - * @param request - * - * @return - */ public static Date getIfModifiedSinceDate(HttpServletRequest request) { Date date = null; @@ -243,14 +160,6 @@ public final class WebUtil return date; } - /** - * Method description - * - * - * @param request - * - * @return - */ public static boolean isGzipSupported(HttpServletRequest request) { return isGzipSupported(request::getHeader); @@ -263,15 +172,6 @@ public final class WebUtil return (enc != null) && enc.contains("gzip"); } - /** - * Method description - * - * - * @param request - * @param file - * - * @return - */ public static boolean isModified(HttpServletRequest request, File file) { boolean result = true; diff --git a/scm-core/src/main/java/sonia/scm/util/XmlUtil.java b/scm-core/src/main/java/sonia/scm/util/XmlUtil.java index c704f76668..3871b44bb8 100644 --- a/scm-core/src/main/java/sonia/scm/util/XmlUtil.java +++ b/scm-core/src/main/java/sonia/scm/util/XmlUtil.java @@ -24,7 +24,6 @@ package sonia.scm.util; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.collect.HashMultimap; import com.google.common.collect.Multimap; @@ -42,33 +41,14 @@ import java.io.InputStream; /** * Util methods to handle xml files. * - * @author Sebastian Sdorra * @since 2.0.0 */ public final class XmlUtil { - /** - * Constructs ... - * - */ private XmlUtil() {} - //~--- methods -------------------------------------------------------------- - /** - * Create {@link Document} from {@link InputStream}. - * - * - * @param stream input stream - * - * @return generated document - * - * - * @throws IOException - * @throws ParserConfigurationException - * @throws SAXException - */ public static Document createDocument(InputStream stream) throws ParserConfigurationException, SAXException, IOException { @@ -76,17 +56,6 @@ public final class XmlUtil stream); } - /** - * Method description - * - * - * @param input - * @param entries - * - * @return - * - * @throws IOException - */ public static Multimap values(InputStream input, String... entries) throws IOException @@ -110,17 +79,6 @@ public final class XmlUtil return values; } - /** - * Method description - * - * - * @param doc - * @param entries - * - * @return - * - * @throws IOException - */ public static Multimap values(Document doc, String... entries) throws IOException { @@ -134,16 +92,6 @@ public final class XmlUtil return values; } - /** - * Method description - * - * - * @param values - * @param doc - * @param entries - * - * @throws IOException - */ private static void values(Multimap values, Document doc, String... entries) throws IOException diff --git a/scm-core/src/main/java/sonia/scm/version/Version.java b/scm-core/src/main/java/sonia/scm/version/Version.java index a47a3ba9af..d832445a0d 100644 --- a/scm-core/src/main/java/sonia/scm/version/Version.java +++ b/scm-core/src/main/java/sonia/scm/version/Version.java @@ -24,7 +24,6 @@ package sonia.scm.version; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Objects; import com.google.common.base.Preconditions; @@ -34,25 +33,32 @@ import java.util.Locale; import java.util.regex.Matcher; import java.util.regex.Pattern; -//~--- JDK imports ------------------------------------------------------------ - /** * Version object for comparing and parsing versions. - * - * - * @author Sebastian Sdorra */ public final class Version implements Comparable { + private final String parsedVersion; + + private final String unparsedVersion; + + /** major part */ + private int major = 0; + + /** minor part */ + private int minor = 0; + + /** patch part */ + private int patch = 0; + + private boolean snapshot; + + private VersionType type; + + private int typeVersion = 1; private static final Pattern MAVEN_UNIQUE_SNAPSHOT = Pattern.compile("-[0-9]{8}\\.[0-9]{6}-[0-9]+"); - /** - * Constructs a new version object - * - * - * @param versionString string representation of the version - */ private Version(String versionString) { this.unparsedVersion = versionString; @@ -82,7 +88,6 @@ public final class Version implements Comparable parsedVersion = createParsedVersion(); } - //~--- methods -------------------------------------------------------------- /** * Creates a new version of the given string. @@ -108,9 +113,7 @@ public final class Version implements Comparable return version; } - /** - * {@inheritDoc} - */ + @Override public int compareTo(Version o) { @@ -128,9 +131,7 @@ public final class Version implements Comparable //J+ } - /** - * {@inheritDoc} - */ + @Override public boolean equals(Object obj) { @@ -154,9 +155,7 @@ public final class Version implements Comparable && Objects.equal(parsedVersion, other.parsedVersion); } - /** - * {@inheritDoc} - */ + @Override public int hashCode() { @@ -164,22 +163,16 @@ public final class Version implements Comparable parsedVersion); } - /** - * {@inheritDoc} - */ + @Override public String toString() { return parsedVersion; } - //~--- get methods ---------------------------------------------------------- /** * Returns the major part of the version. - * - * - * @return major part */ public int getMajor() { @@ -188,9 +181,6 @@ public final class Version implements Comparable /** * Returns the minor part of the version. - * - * - * @return minor part */ public int getMinor() { @@ -199,9 +189,6 @@ public final class Version implements Comparable /** * Returns the string representation of the parsed version. - * - * - * @return parsed version string */ public String getParsedVersion() { @@ -210,9 +197,6 @@ public final class Version implements Comparable /** * Returns the patch part of the version. - * - * - * @return patch part */ public int getPatch() { @@ -243,9 +227,6 @@ public final class Version implements Comparable /** * Returns the unparsed string representation of the version. - * - * - * @return unparsed version string */ public String getUnparsedVersion() { @@ -254,10 +235,6 @@ public final class Version implements Comparable /** * Returns true if the given version is newer. - * - * @param o other version - * - * @return true if newer */ public boolean isNewer(Version o) { @@ -266,11 +243,6 @@ public final class Version implements Comparable /** * Returns true if the given version is newer. - * - * - * @param versionString other version - * - * @return true if newer */ public boolean isNewer(String versionString) { return isNewer(Version.parse(versionString)); @@ -278,8 +250,7 @@ public final class Version implements Comparable /** * Returns true if the given version is newer or equal. - * @param versionString other version - * @return true if newer + * * @since 2.4.0 */ public boolean isNewerOrEqual(String versionString) { @@ -288,8 +259,7 @@ public final class Version implements Comparable /** * Returns true if the given version is newer or equal. - * @param o other version - * @return {@code true} if newer or equal + * * @since 2.4.0 */ public boolean isNewerOrEqual(Version o) { @@ -298,11 +268,6 @@ public final class Version implements Comparable /** * Returns true if the given version is older. - * - * - * @param o other version - * - * @return true if older */ public boolean isOlder(Version o) { @@ -311,11 +276,6 @@ public final class Version implements Comparable /** * Returns true if the given version is older. - * - * - * @param versionString other version - * - * @return true if older */ public boolean isOlder(String versionString) { return isOlder(Version.parse(versionString)); @@ -323,8 +283,7 @@ public final class Version implements Comparable /** * Returns true if the given version is older or equal. - * @param versionString other version - * @return {@code true} if older or equal + * * @since 2.4.0 */ public boolean isOlderOrEqual(String versionString) { @@ -333,8 +292,7 @@ public final class Version implements Comparable /** * Returns true if the given version is older or equal. - * @param o other version - * @return {@code true} if older or equal + * * @since 2.4.0 */ public boolean isOlderOrEqual(Version o) { @@ -344,22 +302,14 @@ public final class Version implements Comparable /** * Returns true if the version is a snapshot. - * - * - * @return true if version is a snapshot */ public boolean isSnapshot() { return snapshot; } - //~--- methods -------------------------------------------------------------- - /** * Created parsed string version. - * - * - * @return parsed version */ private String createParsedVersion() { @@ -384,9 +334,6 @@ public final class Version implements Comparable /** * Parses the qualifier part of the version. - * - * - * @param qualifierPart qualifier part */ private void parseQualifierPart(String qualifierPart) { @@ -426,12 +373,6 @@ public final class Version implements Comparable } } - /** - * Method description - * - * - * @param qualifier - */ private void parseTypeVersion(String qualifier) { String version = null; @@ -466,9 +407,6 @@ public final class Version implements Comparable /** * Parse version part - * - * - * @param versionPart version part */ private void parseVersionPart(String versionPart) { @@ -490,29 +428,4 @@ public final class Version implements Comparable } } - //~--- fields --------------------------------------------------------------- - - /** parsed version */ - private final String parsedVersion; - - /** unparsed version */ - private final String unparsedVersion; - - /** major part */ - private int major = 0; - - /** minor part */ - private int minor = 0; - - /** patch part */ - private int patch = 0; - - /** is a snapshot */ - private boolean snapshot; - - /** version type */ - private VersionType type; - - /** type version */ - private int typeVersion = 1; } diff --git a/scm-core/src/main/java/sonia/scm/version/VersionParseException.java b/scm-core/src/main/java/sonia/scm/version/VersionParseException.java index 8a15c8a5b6..b4e450f623 100644 --- a/scm-core/src/main/java/sonia/scm/version/VersionParseException.java +++ b/scm-core/src/main/java/sonia/scm/version/VersionParseException.java @@ -27,48 +27,24 @@ package sonia.scm.version; /** * The VersionParseException is thrown if a version could not be parsed. * - * @author Sebastian Sdorra - * + * * @since 2.0.0 */ public class VersionParseException extends RuntimeException { - /** - * Constructs a new VersionParseException. - * - */ public VersionParseException() {} - /** - * Constructs a new VersionParseException. - * - * - * @param message message of the exception - */ public VersionParseException(String message) { super(message); } - /** - * Constructs a new VersionParseException. - * - * - * @param cause cause of the exception - */ public VersionParseException(Throwable cause) { super(cause); } - /** - * Constructs a new VersionParseException. - * - * - * @param message message of the exception - * @param cause cause of the exception - */ public VersionParseException(String message, Throwable cause) { super(message, cause); diff --git a/scm-core/src/main/java/sonia/scm/version/VersionType.java b/scm-core/src/main/java/sonia/scm/version/VersionType.java index 363f13f931..cc8d88c365 100644 --- a/scm-core/src/main/java/sonia/scm/version/VersionType.java +++ b/scm-core/src/main/java/sonia/scm/version/VersionType.java @@ -24,43 +24,29 @@ package sonia.scm.version; -//~--- JDK imports ------------------------------------------------------------ - import java.util.ArrayList; import java.util.Arrays; import java.util.Collection; import java.util.List; -/** - * - * @author Sebastian Sdorra - */ + public enum VersionType { EARLY_ACESS("ea", 0, "early", "earlyaccess"), MILESTONE("M", 1, "milestone"), ALPHA("alpha", 2), BETA("beta", 3), RELEASE_CANDIDAT("RC", 4, "releasecandidate"), RELEASE(10); - /** - * Constructs ... - * - * - * @param value - */ + public String[] aliases; + + private String id; + + private int value; + private VersionType(int value) { this(null, value); } - /** - * Constructs ... - * - * - * - * @param id - * @param value - * @param aliases - */ private VersionType(String id, int value, String... aliases) { this.id = id; @@ -68,36 +54,20 @@ public enum VersionType this.aliases = aliases; } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + public String[] getAliases() { return aliases; } - /** - * Method description - * - * - * @return - */ + public String getId() { return id; } - /** - * Method description - * - * - * @return - */ + public Collection getNames() { List names = new ArrayList(); @@ -115,25 +85,9 @@ public enum VersionType return names; } - /** - * Method description - * - * - * @return - */ + public int getValue() { return value; } - - //~--- fields --------------------------------------------------------------- - - /** Field description */ - public String[] aliases; - - /** Field description */ - private String id; - - /** Field description */ - private int value; } diff --git a/scm-core/src/main/java/sonia/scm/web/SchemeBasedWebTokenGenerator.java b/scm-core/src/main/java/sonia/scm/web/SchemeBasedWebTokenGenerator.java index 2f600a8cfe..89ca10e5c5 100644 --- a/scm-core/src/main/java/sonia/scm/web/SchemeBasedWebTokenGenerator.java +++ b/scm-core/src/main/java/sonia/scm/web/SchemeBasedWebTokenGenerator.java @@ -24,7 +24,6 @@ package sonia.scm.web; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Strings; import jakarta.servlet.http.HttpServletRequest; @@ -34,7 +33,6 @@ import org.slf4j.LoggerFactory; /** * - * @author Sebastian Sdorra * @since 2.0.0 */ public abstract class SchemeBasedWebTokenGenerator implements WebTokenGenerator { @@ -42,9 +40,6 @@ public abstract class SchemeBasedWebTokenGenerator implements WebTokenGenerator /** authorization header */ private static final String HEADER_AUTHORIZATION = "Authorization"; - /** - * the logger for SchemeBasedWebTokenGenerator - */ private static final Logger LOG = LoggerFactory.getLogger(SchemeBasedWebTokenGenerator.class); protected abstract AuthenticationToken createToken(HttpServletRequest request, String scheme, String authorization); diff --git a/scm-core/src/main/java/sonia/scm/web/UserAgent.java b/scm-core/src/main/java/sonia/scm/web/UserAgent.java index bbcb9794bd..7d4550956d 100644 --- a/scm-core/src/main/java/sonia/scm/web/UserAgent.java +++ b/scm-core/src/main/java/sonia/scm/web/UserAgent.java @@ -36,19 +36,21 @@ import static com.google.common.base.Preconditions.checkNotNull; * The software agent that is acting on behalf of a user. The user agent * represents a browser or one of the repository client (svn, git or hg). * - * @author Sebastian Sdorra * @since 1.45 */ public final class UserAgent { + private final Charset basicAuthenticationCharset; + + /** indicator for browsers */ + private final boolean browser; + + /** indicator for scm clients (e.g. git, hg, svn) */ + private final boolean scmClient; + + /** name of UserAgent */ + private final String name; - /** - * Constructs a new user agent - * - * @param name - * @param basicAuthenticationCharset - * @param browser - */ private UserAgent(String name, Charset basicAuthenticationCharset, boolean browser, boolean scmClient) { this.name = checkNotNull(name); @@ -57,7 +59,6 @@ public final class UserAgent this.scmClient = scmClient; } - //~--- methods -------------------------------------------------------------- /** * Returns the {@link Builder} for the UserAgent. @@ -94,9 +95,7 @@ public final class UserAgent return new Builder(name); } - /** - * {@inheritDoc} - */ + @Override public boolean equals(Object obj) { @@ -117,18 +116,14 @@ public final class UserAgent && Objects.equal(basicAuthenticationCharset, other.basicAuthenticationCharset); } - /** - * {@inheritDoc} - */ + @Override public int hashCode() { return Objects.hashCode(name, browser, basicAuthenticationCharset); } - /** - * {@inheritDoc} - */ + @Override public String toString() { @@ -141,7 +136,6 @@ public final class UserAgent //J+ } - //~--- get methods ---------------------------------------------------------- /** * Returns the {@link Charset}, which is used to decode the basic @@ -167,9 +161,6 @@ public final class UserAgent /** * Returns {@code true} if UserAgent is a browser. - * - * - * @return {@code true} if UserAgent is a browser */ public boolean isBrowser() { @@ -186,13 +177,23 @@ public final class UserAgent return scmClient; } - //~--- inner classes -------------------------------------------------------- + /** * Builder class for {@link UserAgent}. */ public static class Builder { + /** name of UserAgent */ + private final String name; + + /** indicator for browsers */ + private boolean browser = false; + + /** indicator for browsers */ + private boolean scmClient = false; + + private Charset basicAuthenticationCharset = StandardCharsets.UTF_8; /** * Constructs a new UserAgent builder. @@ -205,7 +206,7 @@ public final class UserAgent this.name = name; } - //~--- methods ------------------------------------------------------------ + /** * Sets {@link Charset} which is used to decode the basic authentication. @@ -252,33 +253,6 @@ public final class UserAgent return new UserAgent(name, basicAuthenticationCharset, browser, scmClient); } - //~--- fields ------------------------------------------------------------- - - /** name of UserAgent */ - private final String name; - - /** indicator for browsers */ - private boolean browser = false; - - /** indicator for browsers */ - private boolean scmClient = false; - - /** basic authentication charset */ - private Charset basicAuthenticationCharset = StandardCharsets.UTF_8; } - - //~--- fields --------------------------------------------------------------- - - /** basic authentication charset */ - private final Charset basicAuthenticationCharset; - - /** indicator for browsers */ - private final boolean browser; - - /** indicator for scm clients (e.g. git, hg, svn) */ - private final boolean scmClient; - - /** name of UserAgent */ - private final String name; } diff --git a/scm-core/src/main/java/sonia/scm/web/UserAgentParser.java b/scm-core/src/main/java/sonia/scm/web/UserAgentParser.java index d62341d058..56dce51bee 100644 --- a/scm-core/src/main/java/sonia/scm/web/UserAgentParser.java +++ b/scm-core/src/main/java/sonia/scm/web/UserAgentParser.java @@ -24,7 +24,6 @@ package sonia.scm.web; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.annotations.VisibleForTesting; import com.google.common.base.Strings; @@ -44,14 +43,12 @@ import java.util.Set; * Parser for User-Agent header. The UserAgentParser parses the User-Agent * header and returns a {@link UserAgent} object. * - * @author Sebastian Sdorra * @since 1.45 */ @Singleton public final class UserAgentParser { - /** name of the cache */ @VisibleForTesting static final String CACHE_NAME = "sonia.scm.user-agent"; @@ -59,19 +56,15 @@ public final class UserAgentParser @VisibleForTesting static final UserAgent UNKNOWN = UserAgent.other("UNKNOWN").build(); - /** logger */ private static final Logger logger = LoggerFactory.getLogger(UserAgentParser.class); - //~--- constructors --------------------------------------------------------- + /** cache for parsed UserAgents */ + private final Cache cache; + + /** set of providers */ + private final Set providers; - /** - * Constructs a new UserAgentParser. - * - * - * @param providers set of providers - * @param cacheManager cache manager - */ @Inject public UserAgentParser(Set providers, CacheManager cacheManager) @@ -80,7 +73,6 @@ public final class UserAgentParser this.cache = cacheManager.getCache(CACHE_NAME); } - //~--- methods -------------------------------------------------------------- /** * Extracts the User-Agent header and returns an {@link UserAgent} object. @@ -100,8 +92,6 @@ public final class UserAgentParser * * * @param userAgent User-Agent header - * - * @return {@link UserAgent} object */ public UserAgent parse(String userAgent) { @@ -133,11 +123,4 @@ public final class UserAgentParser return ua; } - //~--- fields --------------------------------------------------------------- - - /** cache for parsed UserAgents */ - private final Cache cache; - - /** set of providers */ - private final Set providers; } diff --git a/scm-core/src/main/java/sonia/scm/web/UserAgentProvider.java b/scm-core/src/main/java/sonia/scm/web/UserAgentProvider.java index 3548df0b6f..a74d5aa88e 100644 --- a/scm-core/src/main/java/sonia/scm/web/UserAgentProvider.java +++ b/scm-core/src/main/java/sonia/scm/web/UserAgentProvider.java @@ -30,7 +30,6 @@ import sonia.scm.plugin.ExtensionPoint; * Provider to parse User-Agent header and returns an {@link UserAgent} object. * The {@link UserAgentProvider} is used by the {@link UserAgentParser}. * - * @author Sebastian Sdorra * @since 1.45 */ @ExtensionPoint(multi = true) diff --git a/scm-core/src/main/java/sonia/scm/web/WebTokenGenerator.java b/scm-core/src/main/java/sonia/scm/web/WebTokenGenerator.java index 000fe6bdeb..153866274b 100644 --- a/scm-core/src/main/java/sonia/scm/web/WebTokenGenerator.java +++ b/scm-core/src/main/java/sonia/scm/web/WebTokenGenerator.java @@ -24,7 +24,6 @@ package sonia.scm.web; -//~--- non-JDK imports -------------------------------------------------------- import jakarta.servlet.http.HttpServletRequest; import org.apache.shiro.authc.AuthenticationToken; @@ -33,7 +32,6 @@ import sonia.scm.plugin.ExtensionPoint; /** * Creates an {@link AuthenticationToken} from a {@link HttpServletRequest}. * - * @author Sebastian Sdorra * @since 2.0.0 */ @ExtensionPoint @@ -43,10 +41,7 @@ public interface WebTokenGenerator /** * Returns an {@link AuthenticationToken} or {@code null}. * - * * @param request http servlet request - * - * @return {@link AuthenticationToken} or {@code null} */ public AuthenticationToken createToken(HttpServletRequest request); } diff --git a/scm-core/src/main/java/sonia/scm/web/cgi/AbstractCGIExecutor.java b/scm-core/src/main/java/sonia/scm/web/cgi/AbstractCGIExecutor.java index 40913669d7..302d4ca7a0 100644 --- a/scm-core/src/main/java/sonia/scm/web/cgi/AbstractCGIExecutor.java +++ b/scm-core/src/main/java/sonia/scm/web/cgi/AbstractCGIExecutor.java @@ -24,37 +24,38 @@ package sonia.scm.web.cgi; -//~--- JDK imports ------------------------------------------------------------ - import java.io.File; import java.util.Collections; import java.util.List; -/** - * - * @author Sebastian Sdorra - */ + public abstract class AbstractCGIExecutor implements CGIExecutor { + protected List args = Collections.emptyList(); + + protected int bufferSize; + + protected EnvList environment; + + protected CGIExceptionHandler exceptionHandler; + + protected boolean ignoreExitCode = false; + + protected String interpreter; + + protected boolean passShellEnvironment = false; + + protected CGIStatusCodeHandler statusCodeHandler; + + protected File workDirectory; - /** - * Method description - * - * - * @return - */ @Override public int getBufferSize() { return bufferSize; } - /** - * Method description - * - * - * @return - */ + @Override public EnvList getEnvironment() { @@ -62,10 +63,6 @@ public abstract class AbstractCGIExecutor implements CGIExecutor } /** - * {@inheritDoc} - * - * - * @return * @since 1.15 */ @Override @@ -74,12 +71,7 @@ public abstract class AbstractCGIExecutor implements CGIExecutor return exceptionHandler; } - /** - * Method description - * - * - * @return - */ + @Override public String getInterpreter() { @@ -87,10 +79,6 @@ public abstract class AbstractCGIExecutor implements CGIExecutor } /** - * {@inheritDoc} - * - * - * @return * @since 1.15 */ @Override @@ -99,62 +87,33 @@ public abstract class AbstractCGIExecutor implements CGIExecutor return statusCodeHandler; } - /** - * Method description - * - * - * @return - */ + @Override public File getWorkDirectory() { return workDirectory; } - /** - * Method description - * - * - * @return - */ + @Override public boolean isIgnoreExitCode() { return ignoreExitCode; } - /** - * Method description - * - * - * @return - */ + @Override public boolean isPassShellEnvironment() { return passShellEnvironment; } - //~--- set methods ---------------------------------------------------------- - - /** - * Method description - * - * - * @param bufferSize - */ @Override public void setBufferSize(int bufferSize) { this.bufferSize = bufferSize; } - /** - * Method description - * - * - * @param environment - */ @Override public void setEnvironment(EnvList environment) { @@ -162,10 +121,6 @@ public abstract class AbstractCGIExecutor implements CGIExecutor } /** - * {@inheritDoc} - * - * - * @param exceptionHandler * @since 1.15 */ @Override @@ -174,36 +129,18 @@ public abstract class AbstractCGIExecutor implements CGIExecutor this.exceptionHandler = exceptionHandler; } - /** - * Method description - * - * - * @param ignoreExitCode - */ @Override public void setIgnoreExitCode(boolean ignoreExitCode) { this.ignoreExitCode = ignoreExitCode; } - /** - * Method description - * - * - * @param interpreter - */ @Override public void setInterpreter(String interpreter) { this.interpreter = interpreter; } - /** - * Method description - * - * - * @param passShellEnvironment - */ @Override public void setPassShellEnvironment(boolean passShellEnvironment) { @@ -211,10 +148,6 @@ public abstract class AbstractCGIExecutor implements CGIExecutor } /** - * {@inheritDoc} - * - * - * @param statusCodeHandler * @since 1.15 */ @Override @@ -223,12 +156,6 @@ public abstract class AbstractCGIExecutor implements CGIExecutor this.statusCodeHandler = statusCodeHandler; } - /** - * Method description - * - * - * @param workDirectory - */ @Override public void setWorkDirectory(File workDirectory) { @@ -245,31 +172,4 @@ public abstract class AbstractCGIExecutor implements CGIExecutor return args; } - //~--- fields --------------------------------------------------------------- - - protected List args = Collections.emptyList(); - - /** Field description */ - protected int bufferSize; - - /** Field description */ - protected EnvList environment; - - /** Field description */ - protected CGIExceptionHandler exceptionHandler; - - /** Field description */ - protected boolean ignoreExitCode = false; - - /** Field description */ - protected String interpreter; - - /** Field description */ - protected boolean passShellEnvironment = false; - - /** Field description */ - protected CGIStatusCodeHandler statusCodeHandler; - - /** Field description */ - protected File workDirectory; } diff --git a/scm-core/src/main/java/sonia/scm/web/cgi/CGIExceptionHandler.java b/scm-core/src/main/java/sonia/scm/web/cgi/CGIExceptionHandler.java index f858ea24f3..c10f904ebd 100644 --- a/scm-core/src/main/java/sonia/scm/web/cgi/CGIExceptionHandler.java +++ b/scm-core/src/main/java/sonia/scm/web/cgi/CGIExceptionHandler.java @@ -24,22 +24,19 @@ package sonia.scm.web.cgi; -//~--- JDK imports ------------------------------------------------------------ - import jakarta.servlet.http.HttpServletRequest; import jakarta.servlet.http.HttpServletResponse; /** * Handles exception thrown by an {@link CGIExecutor} * - * @author Sebastian Sdorra * @since 1.8 */ public interface CGIExceptionHandler { /** - * Handles a exception which is ocurred during cgi execution. + * Handles an exception which occurred during cgi execution. * * * @param request current http request diff --git a/scm-core/src/main/java/sonia/scm/web/cgi/CGIExecutor.java b/scm-core/src/main/java/sonia/scm/web/cgi/CGIExecutor.java index a9ecf51c27..fbb085f1cb 100644 --- a/scm-core/src/main/java/sonia/scm/web/cgi/CGIExecutor.java +++ b/scm-core/src/main/java/sonia/scm/web/cgi/CGIExecutor.java @@ -24,8 +24,6 @@ package sonia.scm.web.cgi; -//~--- JDK imports ------------------------------------------------------------ - import jakarta.servlet.ServletException; import java.io.File; @@ -33,80 +31,54 @@ import java.io.IOException; import java.util.Collections; import java.util.List; -/** - * - * @author Sebastian Sdorra - */ + public interface CGIExecutor { - /** Field description */ String ENV_AUTH_TYPE = "AUTH_TYPE"; - /** Field description */ String ENV_CONTENT_LENGTH = "CONTENT_LENGTH"; - /** Field description */ String ENV_CONTENT_TYPE = "CONTENT_TYPE"; - /** Field description */ String ENV_GATEWAY_INTERFACE = "GATEWAY_INTERFACE"; - /** Field description */ String ENV_HTTPS = "HTTPS"; - /** Field description */ String ENV_HTTPS_VALUE_OFF = "OFF"; - /** Field description */ String ENV_HTTPS_VALUE_ON = "ON"; - /** Field description */ String ENV_HTTP_HEADER_PREFIX = "HTTP_"; - /** Field description */ String ENV_PATH_INFO = "PATH_INFO"; - /** Field description */ String ENV_PATH_TRANSLATED = "PATH_TRANSLATED"; - /** Field description */ String ENV_QUERY_STRING = "QUERY_STRING"; - /** Field description */ String ENV_REMOTE_ADDR = "REMOTE_ADDR"; - /** Field description */ String ENV_REMOTE_HOST = "REMOTE_HOST"; - /** Field description */ String ENV_REMOTE_USER = "REMOTE_USER"; - /** Field description */ String ENV_REQUEST_METHOD = "REQUEST_METHOD"; - /** Field description */ String ENV_SCRIPT_FILENAME = "SCRIPT_FILENAME"; - /** Field description */ String ENV_SCRIPT_NAME = "SCRIPT_NAME"; - /** Field description */ String ENV_SERVER_NAME = "SERVER_NAME"; - /** Field description */ String ENV_SERVER_PORT = "SERVER_PORT"; - /** Field description */ String ENV_SERVER_PROTOCOL = "SERVER_PROTOCOL"; - /** Field description */ String ENV_SERVER_SOFTWARE = "SERVER_SOFTWARE"; - /** Field description */ String ENV_SYSTEM_ROOT = "SystemRoot"; /** - * Content type header of response. * @since 2.12.0 */ String RESPONSE_HEADER_CONTENT_TYPE = "Content-Type"; @@ -117,192 +89,85 @@ public interface CGIExecutor { @Deprecated String REPSONSE_HEADER_CONTENT_TYPE = RESPONSE_HEADER_CONTENT_TYPE; - /** Field description */ String RESPONSE_HEADER_CONTENT_LENGTH = "Content-Length"; - /** Field description */ String RESPONSE_HEADER_HTTP_PREFIX = "HTTP"; - /** Field description */ String RESPONSE_HEADER_LOCATION = "Location"; - /** Field description */ String RESPONSE_HEADER_STATUS = "Status"; - //~--- methods -------------------------------------------------------------- - - /** - * Method description - * - * - * @param cmd - * - * @throws IOException - * @throws ServletException - */ void execute(String cmd) throws IOException, ServletException; - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + int getBufferSize(); - /** - * Method description - * - * - * @return - */ + EnvList getEnvironment(); /** - * Returns the cgi exception handler. - * - * - * @return cgi exception handler * @since 1.8 */ CGIExceptionHandler getExceptionHandler(); - /** - * Method description - * - * - * @return - */ + String getInterpreter(); /** - * Returns the status code handler. - * - * - * @return status code handler * @since 1.15 */ CGIStatusCodeHandler getStatusCodeHandler(); - /** - * Method description - * - * - * @return - */ + File getWorkDirectory(); /** - * Method description - * - * - * @return * @since 1.12 */ boolean isContentLengthWorkaround(); - /** - * Method description - * - * - * @return - */ + boolean isIgnoreExitCode(); - /** - * Method description - * - * - * @return - */ + boolean isPassShellEnvironment(); /** * Returns command args as list. * - * @return list of command args * @since 2.12.0 */ default List getArgs() { return Collections.emptyList(); } - //~--- set methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param bufferSize - */ void setBufferSize(int bufferSize); /** - * Method description * @since 1.12 - * - * @param contentLengthWorkaround */ void setContentLengthWorkaround(boolean contentLengthWorkaround); - /** - * Method description - * - * - * @param environment - */ void setEnvironment(EnvList environment); /** - * Sets the cgi exception handler. - * - * - * @param exceptionHandler cgi exception handler * @since 1.8 */ void setExceptionHandler(CGIExceptionHandler exceptionHandler); - /** - * Method description - * - * - * @param ignoreExitCode - */ void setIgnoreExitCode(boolean ignoreExitCode); - /** - * Method description - * - * - * @param interpreter - */ void setInterpreter(String interpreter); - /** - * Method description - * - * - * @param passShellEnvironment - */ void setPassShellEnvironment(boolean passShellEnvironment); /** - * Sets the status code handler. - * - * - * @param statusCodeHandler the handler to set * @since 1.15 */ void setStatusCodeHandler(CGIStatusCodeHandler statusCodeHandler); - /** - * Method description - * - * - * @param workDirectory - */ void setWorkDirectory(File workDirectory); /** diff --git a/scm-core/src/main/java/sonia/scm/web/cgi/CGIExecutorFactory.java b/scm-core/src/main/java/sonia/scm/web/cgi/CGIExecutorFactory.java index 7d23ec12ca..3113e1fb84 100644 --- a/scm-core/src/main/java/sonia/scm/web/cgi/CGIExecutorFactory.java +++ b/scm-core/src/main/java/sonia/scm/web/cgi/CGIExecutorFactory.java @@ -24,32 +24,15 @@ package sonia.scm.web.cgi; -//~--- non-JDK imports -------------------------------------------------------- import jakarta.servlet.ServletContext; import jakarta.servlet.http.HttpServletRequest; import jakarta.servlet.http.HttpServletResponse; import sonia.scm.config.ScmConfiguration; -/** - * - * @author Sebastian Sdorra - */ + public interface CGIExecutorFactory { - - /** - * Method description - * - * - * - * @param configuration - * @param context - * @param request - * @param response - * - * @return - */ public CGIExecutor createExecutor(ScmConfiguration configuration, ServletContext context, HttpServletRequest request, diff --git a/scm-core/src/main/java/sonia/scm/web/cgi/CGIStatusCodeHandler.java b/scm-core/src/main/java/sonia/scm/web/cgi/CGIStatusCodeHandler.java index c6cbacb00c..f630119691 100644 --- a/scm-core/src/main/java/sonia/scm/web/cgi/CGIStatusCodeHandler.java +++ b/scm-core/src/main/java/sonia/scm/web/cgi/CGIStatusCodeHandler.java @@ -24,8 +24,6 @@ package sonia.scm.web.cgi; -//~--- JDK imports ------------------------------------------------------------ - import jakarta.servlet.http.HttpServletRequest; import jakarta.servlet.http.HttpServletResponse; @@ -36,7 +34,6 @@ import java.io.OutputStream; * Interface for handling return codes of processes * executed by the {@link CGIExecutor}. * - * @author Sebastian Sdorra * @since 1.15 */ public interface CGIStatusCodeHandler diff --git a/scm-core/src/main/java/sonia/scm/web/cgi/EnvList.java b/scm-core/src/main/java/sonia/scm/web/cgi/EnvList.java index ac731a5240..5573678a3b 100644 --- a/scm-core/src/main/java/sonia/scm/web/cgi/EnvList.java +++ b/scm-core/src/main/java/sonia/scm/web/cgi/EnvList.java @@ -31,10 +31,7 @@ import java.util.Collections; import java.util.HashMap; import java.util.Map; -/** - * - * @author Sebastian Sdorra - */ + public class EnvList { private static final ImmutableSet SENSITIVE = @@ -65,7 +62,6 @@ public class EnvList { * Return {@code true} if the list contains an environment variable with the given key. * * @param key name of environment variable - * @return {@code true} if contains environment variable */ public boolean containsKey(String key) { diff --git a/scm-core/src/main/java/sonia/scm/web/filter/AuthenticationFilter.java b/scm-core/src/main/java/sonia/scm/web/filter/AuthenticationFilter.java index 2cb132dedd..b5ac2448e5 100644 --- a/scm-core/src/main/java/sonia/scm/web/filter/AuthenticationFilter.java +++ b/scm-core/src/main/java/sonia/scm/web/filter/AuthenticationFilter.java @@ -24,7 +24,6 @@ package sonia.scm.web.filter; -//~--- non-JDK imports -------------------------------------------------------- import com.google.inject.Inject; import com.google.inject.Singleton; @@ -57,7 +56,6 @@ import java.util.Set; * Handles authentication, if a one of the {@link WebTokenGenerator} returns * an {@link AuthenticationToken}. * - * @author Sebastian Sdorra * @since 2.0.0 */ @Singleton @@ -211,8 +209,6 @@ public class AuthenticationFilter extends HttpFilter { * @param chain filter chain * @param subject subject * @param token authentication token - * @throws IOException - * @throws ServletException */ private void handleAuthentication(HttpServletRequest request, HttpServletResponse response, FilterChain chain, Subject subject, @@ -269,8 +265,6 @@ public class AuthenticationFilter extends HttpFilter { /** * Returns {@code true} if anonymous access is enabled. - * - * @return {@code true} if anonymous access is enabled */ protected boolean isAnonymousAccessEnabled() { return (configuration != null) && configuration.getAnonymousMode() != AnonymousMode.OFF; diff --git a/scm-core/src/main/java/sonia/scm/web/filter/BufferedHttpServletRequest.java b/scm-core/src/main/java/sonia/scm/web/filter/BufferedHttpServletRequest.java index e698cc5af8..0e941aa302 100644 --- a/scm-core/src/main/java/sonia/scm/web/filter/BufferedHttpServletRequest.java +++ b/scm-core/src/main/java/sonia/scm/web/filter/BufferedHttpServletRequest.java @@ -24,7 +24,6 @@ package sonia.scm.web.filter; -//~--- non-JDK imports -------------------------------------------------------- import jakarta.servlet.ReadListener; import jakarta.servlet.ServletInputStream; @@ -38,28 +37,21 @@ import java.io.ByteArrayOutputStream; import java.io.IOException; import java.io.InputStream; -/** - * - * @author Sebastian Sdorra - */ + public class BufferedHttpServletRequest extends HttpServletRequestWrapper { - - /** the logger for BufferedHttpServletRequest */ private static final Logger logger = LoggerFactory.getLogger(BufferedHttpServletRequest.class); - //~--- constructors --------------------------------------------------------- + private ByteArrayInputStream bais; + + private ByteArrayOutputStream baos; + + private BufferedServletInputStream bsis; + + private byte[] buffer; + - /** - * Constructs ... - * - * - * @param request - * @param logBody - * - * @throws IOException - */ public BufferedHttpServletRequest(HttpServletRequest request, boolean logBody) throws IOException { @@ -83,27 +75,14 @@ public class BufferedHttpServletRequest extends HttpServletRequestWrapper } } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + public byte[] getContentBuffer() { return buffer; } - /** - * Method description - * - * - * @return - * - * @throws IOException - */ + @Override public ServletInputStream getInputStream() throws IOException { @@ -130,65 +109,31 @@ public class BufferedHttpServletRequest extends HttpServletRequestWrapper return stream; } - //~--- inner classes -------------------------------------------------------- - /** - * Class description - * - * - * @version Enter version here..., 2011-04-12 - * @author Sebastian Sdorra - */ + + private static class BufferedServletInputStream extends ServletInputStream { - - /** - * Constructs ... - * - * - * @param bais - */ + private ByteArrayInputStream bais; + public BufferedServletInputStream(ByteArrayInputStream bais) { this.bais = bais; } - //~--- methods ------------------------------------------------------------ - - /** - * Method description - * - * - * @return - */ @Override public int available() { return bais.available(); } - /** - * Method description - * - * - * @return - */ + @Override public int read() { return bais.read(); } - /** - * Method description - * - * - * @param buf - * @param off - * @param len - * - * @return - */ @Override public int read(byte[] buf, int off, int len) { @@ -214,24 +159,5 @@ public class BufferedHttpServletRequest extends HttpServletRequestWrapper } } - //~--- fields ------------------------------------------------------------- - - /** Field description */ - private ByteArrayInputStream bais; } - - - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private ByteArrayInputStream bais; - - /** Field description */ - private ByteArrayOutputStream baos; - - /** Field description */ - private BufferedServletInputStream bsis; - - /** Field description */ - private byte[] buffer; } diff --git a/scm-core/src/main/java/sonia/scm/web/filter/BufferedHttpServletResponse.java b/scm-core/src/main/java/sonia/scm/web/filter/BufferedHttpServletResponse.java index df2eb080ba..63610135b1 100644 --- a/scm-core/src/main/java/sonia/scm/web/filter/BufferedHttpServletResponse.java +++ b/scm-core/src/main/java/sonia/scm/web/filter/BufferedHttpServletResponse.java @@ -24,8 +24,6 @@ package sonia.scm.web.filter; -//~--- JDK imports ------------------------------------------------------------ - import jakarta.servlet.ServletOutputStream; import jakarta.servlet.WriteListener; import jakarta.servlet.http.Cookie; @@ -43,22 +41,23 @@ import java.util.LinkedHashMap; import java.util.Map; import java.util.Set; -/** - * - * @author Sebastian Sdorra - */ + public class BufferedHttpServletResponse extends HttpServletResponseWrapper { + private int contentLength = -1; + + private ByteArrayPrintWriter pw = null; + + private Set cookies = new HashSet<>(); + + private int statusCode = HttpServletResponse.SC_OK; + + private Map headers = new LinkedHashMap<>(); + + private String statusMessage; private static final Logger LOG = LoggerFactory.getLogger(BufferedHttpServletResponse.class); - /** - * Constructs ... - * - * - * @param response - * @param logBody - */ public BufferedHttpServletResponse(HttpServletResponse response, boolean logBody) { @@ -70,14 +69,8 @@ public class BufferedHttpServletResponse extends HttpServletResponseWrapper } } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param cookie - */ + @Override public void addCookie(Cookie cookie) { @@ -85,13 +78,7 @@ public class BufferedHttpServletResponse extends HttpServletResponseWrapper super.addCookie(cookie); } - /** - * Method description - * - * - * @param name - * @param date - */ + @Override public void addDateHeader(String name, long date) { @@ -99,13 +86,7 @@ public class BufferedHttpServletResponse extends HttpServletResponseWrapper super.addDateHeader(name, date); } - /** - * Method description - * - * - * @param name - * @param value - */ + @Override public void addHeader(String name, String value) { @@ -113,13 +94,7 @@ public class BufferedHttpServletResponse extends HttpServletResponseWrapper super.addHeader(name, value); } - /** - * Method description - * - * - * @param name - * @param value - */ + @Override public void addIntHeader(String name, int value) { @@ -127,14 +102,7 @@ public class BufferedHttpServletResponse extends HttpServletResponseWrapper super.addIntHeader(name, value); } - /** - * Method description - * - * - * @param sc - * - * @throws IOException - */ + @Override public void sendError(int sc) throws IOException { @@ -142,15 +110,7 @@ public class BufferedHttpServletResponse extends HttpServletResponseWrapper super.sendError(sc); } - /** - * Method description - * - * - * @param sc - * @param msg - * - * @throws IOException - */ + @Override public void sendError(int sc, String msg) throws IOException { @@ -159,14 +119,8 @@ public class BufferedHttpServletResponse extends HttpServletResponseWrapper super.sendError(sc, msg); } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + public byte[] getContentBuffer() { byte[] content = null; @@ -179,47 +133,25 @@ public class BufferedHttpServletResponse extends HttpServletResponseWrapper return content; } - /** - * Method description - * - * - * @return - */ + public int getContentLength() { return contentLength; } - /** - * Method description - * - * - * @return - */ + public Set getCookies() { return cookies; } - /** - * Method description - * - * - * @return - */ + public Map getHeaders() { return headers; } - /** - * Method description - * - * - * @return - * - * @throws IOException - */ + @Override public ServletOutputStream getOutputStream() throws IOException { @@ -228,36 +160,19 @@ public class BufferedHttpServletResponse extends HttpServletResponseWrapper : super.getOutputStream(); } - /** - * Method description - * - * - * @return - */ + public int getStatusCode() { return statusCode; } - /** - * Method description - * - * - * @return - */ + public String getStatusMessage() { return statusMessage; } - /** - * Method description - * - * - * @return - * - * @throws IOException - */ + @Override public PrintWriter getWriter() throws IOException { @@ -266,14 +181,8 @@ public class BufferedHttpServletResponse extends HttpServletResponseWrapper : super.getWriter(); } - //~--- set methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param len - */ + @Override public void setContentLength(int len) { @@ -281,13 +190,7 @@ public class BufferedHttpServletResponse extends HttpServletResponseWrapper super.setContentLength(len); } - /** - * Method description - * - * - * @param name - * @param date - */ + @Override public void setDateHeader(String name, long date) { @@ -295,13 +198,7 @@ public class BufferedHttpServletResponse extends HttpServletResponseWrapper super.setDateHeader(name, date); } - /** - * Method description - * - * - * @param name - * @param value - */ + @Override public void setHeader(String name, String value) { @@ -309,13 +206,7 @@ public class BufferedHttpServletResponse extends HttpServletResponseWrapper super.setHeader(name, value); } - /** - * Method description - * - * - * @param name - * @param value - */ + @Override public void setIntHeader(String name, int value) { @@ -323,12 +214,7 @@ public class BufferedHttpServletResponse extends HttpServletResponseWrapper super.setIntHeader(name, value); } - /** - * Method description - * - * - * @param sc - */ + @Override public void setStatus(int sc) { @@ -336,13 +222,7 @@ public class BufferedHttpServletResponse extends HttpServletResponseWrapper super.setStatus(sc); } - /** - * Method description - * - * - * @param sc - * @param sm - */ + //// @Override // @SuppressWarnings("deprecation") //TODO What to do? @@ -353,97 +233,47 @@ public class BufferedHttpServletResponse extends HttpServletResponseWrapper // super.setStatus(sc); // } - //~--- inner classes -------------------------------------------------------- - /** - * Class description - * - * - * @version Enter version here..., 2011-04-12 - * @author Sebastian Sdorra - */ + + private static class ByteArrayPrintWriter { + private ByteArrayOutputStream baos = new ByteArrayOutputStream(); - /** - * Method description - * - * - * @return - */ + private PrintWriter pw = new PrintWriter(baos); + + private ServletOutputStream sos = new ByteArrayServletStream(baos); + + public byte[] toByteArray() { return baos.toByteArray(); } - //~--- get methods -------------------------------------------------------- - - /** - * Method description - * - * - * @return - */ public ServletOutputStream getStream() { return sos; } - /** - * Method description - * - * - * @return - */ + public PrintWriter getWriter() { return pw; } - //~--- fields ------------------------------------------------------------- - - /** Field description */ - private ByteArrayOutputStream baos = new ByteArrayOutputStream(); - - /** Field description */ - private PrintWriter pw = new PrintWriter(baos); - - /** Field description */ - private ServletOutputStream sos = new ByteArrayServletStream(baos); } - /** - * Class description - * - * - * @version Enter version here..., 2011-04-12 - * @author Sebastian Sdorra - */ + private static class ByteArrayServletStream extends ServletOutputStream { + private ByteArrayOutputStream baos; - /** - * Constructs ... - * - * - * @param baos - */ ByteArrayServletStream(ByteArrayOutputStream baos) { this.baos = baos; } - //~--- methods ------------------------------------------------------------ - - /** - * Method description - * - * - * @param param - * - * @throws IOException - */ @Override public void write(int param) throws IOException { @@ -464,30 +294,6 @@ public class BufferedHttpServletResponse extends HttpServletResponseWrapper } } - //~--- fields ------------------------------------------------------------- - - /** Field description */ - private ByteArrayOutputStream baos; } - - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private int contentLength = -1; - - /** Field description */ - private ByteArrayPrintWriter pw = null; - - /** Field description */ - private Set cookies = new HashSet<>(); - - /** Field description */ - private int statusCode = HttpServletResponse.SC_OK; - - /** Field description */ - private Map headers = new LinkedHashMap<>(); - - /** Field description */ - private String statusMessage; } diff --git a/scm-core/src/main/java/sonia/scm/web/filter/HttpFilter.java b/scm-core/src/main/java/sonia/scm/web/filter/HttpFilter.java index ec384d0fe3..5867b539f6 100644 --- a/scm-core/src/main/java/sonia/scm/web/filter/HttpFilter.java +++ b/scm-core/src/main/java/sonia/scm/web/filter/HttpFilter.java @@ -24,8 +24,6 @@ package sonia.scm.web.filter; -//~--- JDK imports ------------------------------------------------------------ - import jakarta.servlet.Filter; import jakarta.servlet.FilterChain; import jakarta.servlet.FilterConfig; @@ -37,51 +35,24 @@ import jakarta.servlet.http.HttpServletResponse; import java.io.IOException; -/** - * - * @author Sebastian Sdorra - */ + public abstract class HttpFilter implements Filter { - /** - * Method description - * - * - * @param request - * @param response - * @param chain - * - * @throws IOException - * @throws ServletException - */ + protected abstract void doFilter(HttpServletRequest request, HttpServletResponse response, FilterChain chain) throws IOException, ServletException; - /** - * Method description - * - */ - @Override + @Override public void destroy() { // do nothing } - /** - * Method description - * - * - * @param request - * @param response - * @param chain - * - * @throws IOException - * @throws ServletException - */ + @Override public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) @@ -99,14 +70,7 @@ public abstract class HttpFilter implements Filter } } - /** - * Method description - * - * - * @param filterConfig - * - * @throws ServletException - */ + @Override public void init(FilterConfig filterConfig) throws ServletException { diff --git a/scm-core/src/main/java/sonia/scm/web/filter/LoggingFilter.java b/scm-core/src/main/java/sonia/scm/web/filter/LoggingFilter.java index 5fc553d2aa..dfafd25314 100644 --- a/scm-core/src/main/java/sonia/scm/web/filter/LoggingFilter.java +++ b/scm-core/src/main/java/sonia/scm/web/filter/LoggingFilter.java @@ -24,7 +24,6 @@ package sonia.scm.web.filter; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Strings; import com.google.inject.Singleton; @@ -45,31 +44,15 @@ import java.util.Enumeration; import java.util.Locale; import java.util.Map.Entry; -/** - * - * @author Sebastian Sdorra - */ + @Singleton public class LoggingFilter extends HttpFilter { - /** Field description */ private static final Logger logger = LoggerFactory.getLogger(LoggingFilter.class); - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param request - * @param response - * @param chain - * - * @throws IOException - * @throws ServletException - */ @Override protected void doFilter(HttpServletRequest request, HttpServletResponse response, FilterChain chain) @@ -93,12 +76,7 @@ public class LoggingFilter extends HttpFilter } } - /** - * Method description - * - * - * @param request - */ + private void logRequest(BufferedHttpServletRequest request) { logger.debug("**************** request ****************"); @@ -189,16 +167,6 @@ public class LoggingFilter extends HttpFilter } } - /** - * Method description - * - * - * - * @param orgResponse - * @param response - * - * @throws IOException - */ private void logResponse(HttpServletResponse orgResponse, BufferedHttpServletResponse response) throws IOException @@ -246,42 +214,20 @@ public class LoggingFilter extends HttpFilter } } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param request - * - * @return - */ + private boolean isTextRequest(HttpServletRequest request) { return isTextRequest(request.getContentType()); } - /** - * Method description - * - * - * @param response - * - * @return - */ + private boolean isTextRequest(HttpServletResponse response) { return isTextRequest(response.getContentType()); } - /** - * Method description - * - * - * @param contentType - * - * @return - */ + private boolean isTextRequest(String contentType) { return !Strings.isNullOrEmpty(contentType) diff --git a/scm-core/src/main/java/sonia/scm/web/filter/PermissionFilter.java b/scm-core/src/main/java/sonia/scm/web/filter/PermissionFilter.java index 04f9f3d3f9..5478b296fd 100644 --- a/scm-core/src/main/java/sonia/scm/web/filter/PermissionFilter.java +++ b/scm-core/src/main/java/sonia/scm/web/filter/PermissionFilter.java @@ -47,7 +47,6 @@ import java.io.IOException; /** * Abstract http filter to check repository permissions. * - * @author Sebastian Sdorra */ public abstract class PermissionFilter extends ScmProviderHttpServletDecorator { @@ -55,9 +54,6 @@ public abstract class PermissionFilter extends ScmProviderHttpServletDecorator { private final ScmConfiguration configuration; /** - * Constructs a new permission filter - * - * @param configuration global scm-manager configuration * @since 1.21 */ protected PermissionFilter(ScmConfiguration configuration, ScmProviderHttpServlet delegate) { @@ -149,12 +145,6 @@ public abstract class PermissionFilter extends ScmProviderHttpServletDecorator { } } - /** - * Returns action as string. - * - * @param writeRequest true if the action is a write action - * @return action as string - */ private String getActionAsString(boolean writeRequest) { return writeRequest ? "write" @@ -165,7 +155,6 @@ public abstract class PermissionFilter extends ScmProviderHttpServletDecorator { * Returns the username from the given subject or anonymous. * * @param subject user subject - * @return username username from subject or anonymous */ private Object getUserName(Subject subject) { Object principal = subject.getPrincipal(); diff --git a/scm-core/src/main/java/sonia/scm/web/filter/PropagatePrincipleServletRequestWrapper.java b/scm-core/src/main/java/sonia/scm/web/filter/PropagatePrincipleServletRequestWrapper.java index ccfb6e1d97..daf33e49a5 100644 --- a/scm-core/src/main/java/sonia/scm/web/filter/PropagatePrincipleServletRequestWrapper.java +++ b/scm-core/src/main/java/sonia/scm/web/filter/PropagatePrincipleServletRequestWrapper.java @@ -24,8 +24,6 @@ package sonia.scm.web.filter; -//~--- JDK imports ------------------------------------------------------------ - import jakarta.servlet.http.HttpServletRequest; import jakarta.servlet.http.HttpServletRequestWrapper; diff --git a/scm-core/src/main/java/sonia/scm/web/proxy/ProxyConfiguration.java b/scm-core/src/main/java/sonia/scm/web/proxy/ProxyConfiguration.java index c8a1d00de4..fc750df140 100644 --- a/scm-core/src/main/java/sonia/scm/web/proxy/ProxyConfiguration.java +++ b/scm-core/src/main/java/sonia/scm/web/proxy/ProxyConfiguration.java @@ -24,7 +24,6 @@ package sonia.scm.web.proxy; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.MoreObjects; import com.google.common.base.Objects; @@ -38,35 +37,35 @@ import java.net.URL; import java.util.Collections; import java.util.Set; -//~--- JDK imports ------------------------------------------------------------ - /** * - * @author Sebastian Sdorra * @since 1.25 */ @XmlAccessorType(XmlAccessType.FIELD) @XmlRootElement(name = "proxy-configuration") public class ProxyConfiguration { + @XmlElement(name = "cache-enabled") + private boolean cacheEnabled = true; + + @XmlElement(name = "copy-request-headers") + private boolean copyRequestHeaders = true; + + @XmlElement(name = "copy-response-headers") + private boolean copyResponseHeaders = true; + + @XmlElement(name = "exclude") + @XmlElementWrapper(name = "request-header-excludes") + private Set requestHeaderExcludes; + + @XmlElement(name = "exclude") + @XmlElementWrapper(name = "response-header-excludes") + private Set responseHeaderExcludes; + + private URL url; - /** - * Constructs ... - * - */ public ProxyConfiguration() {} - /** - * Constructs ... - * - * - * @param url - * @param copyRequestHeaders - * @param requestHeaderExcludes - * @param copyResponseHeaders - * @param responseHeaderExcludes - * @param cacheEnabled - */ public ProxyConfiguration(URL url, boolean copyRequestHeaders, Set requestHeaderExcludes, boolean copyResponseHeaders, Set responseHeaderExcludes, boolean cacheEnabled) @@ -79,16 +78,7 @@ public class ProxyConfiguration this.cacheEnabled = cacheEnabled; } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param obj - * - * @return - */ @Override public boolean equals(Object obj) { @@ -112,12 +102,7 @@ public class ProxyConfiguration && Objects.equal(cacheEnabled, other.cacheEnabled); } - /** - * Method description - * - * - * @return - */ + @Override public int hashCode() { @@ -125,12 +110,7 @@ public class ProxyConfiguration copyResponseHeaders, responseHeaderExcludes, cacheEnabled); } - /** - * Method description - * - * - * @return - */ + @Override public String toString() { @@ -146,14 +126,8 @@ public class ProxyConfiguration //J+ } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + @SuppressWarnings("unchecked") public Set getRequestHeaderExcludes() { @@ -165,12 +139,7 @@ public class ProxyConfiguration return requestHeaderExcludes; } - /** - * Method description - * - * - * @return - */ + @SuppressWarnings("unchecked") public Set getResponseHeaderExcludes() { @@ -182,74 +151,28 @@ public class ProxyConfiguration return responseHeaderExcludes; } - /** - * Method description - * - * - * @return - */ + public URL getUrl() { return url; } - /** - * Method description - * - * - * @return - */ + public boolean isCacheEnabled() { return cacheEnabled; } - /** - * Method description - * - * - * @return - */ + public boolean isCopyRequestHeaders() { return copyRequestHeaders; } - /** - * Method description - * - * - * @return - */ + public boolean isCopyResponseHeaders() { return copyResponseHeaders; } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - @XmlElement(name = "cache-enabled") - private boolean cacheEnabled = true; - - /** Field description */ - @XmlElement(name = "copy-request-headers") - private boolean copyRequestHeaders = true; - - /** Field description */ - @XmlElement(name = "copy-response-headers") - private boolean copyResponseHeaders = true; - - /** Field description */ - @XmlElement(name = "exclude") - @XmlElementWrapper(name = "request-header-excludes") - private Set requestHeaderExcludes; - - /** Field description */ - @XmlElement(name = "exclude") - @XmlElementWrapper(name = "response-header-excludes") - private Set responseHeaderExcludes; - - /** Field description */ - private URL url; } diff --git a/scm-core/src/main/java/sonia/scm/web/proxy/ProxyConfigurationProvider.java b/scm-core/src/main/java/sonia/scm/web/proxy/ProxyConfigurationProvider.java index f72f998ef9..696e9aebd5 100644 --- a/scm-core/src/main/java/sonia/scm/web/proxy/ProxyConfigurationProvider.java +++ b/scm-core/src/main/java/sonia/scm/web/proxy/ProxyConfigurationProvider.java @@ -24,25 +24,13 @@ package sonia.scm.web.proxy; -//~--- JDK imports ------------------------------------------------------------ - import jakarta.servlet.http.HttpServletRequest; /** * - * @author Sebastian Sdorra * @since 1.25 */ public interface ProxyConfigurationProvider { - - /** - * Method description - * - * - * @param request - * - * @return - */ public ProxyConfiguration getConfiguration(HttpServletRequest request); } diff --git a/scm-core/src/main/java/sonia/scm/web/proxy/ProxyServlet.java b/scm-core/src/main/java/sonia/scm/web/proxy/ProxyServlet.java index 1908e6f2a6..62225dc37a 100644 --- a/scm-core/src/main/java/sonia/scm/web/proxy/ProxyServlet.java +++ b/scm-core/src/main/java/sonia/scm/web/proxy/ProxyServlet.java @@ -24,7 +24,6 @@ package sonia.scm.web.proxy; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Preconditions; import com.google.common.io.ByteStreams; @@ -48,49 +47,27 @@ import java.util.List; import java.util.Map; import java.util.Map.Entry; -//~--- JDK imports ------------------------------------------------------------ - /** * - * @author Sebastian Sdorra * @since 1.25 */ @Singleton public class ProxyServlet extends HttpServlet { - /** - * the logger for ProxyServlet - */ + private final ProxyConfigurationProvider configurationProvider; + private static final Logger logger = LoggerFactory.getLogger(ProxyServlet.class); - /** Field description */ private static final long serialVersionUID = 5589963595604482849L; - //~--- constructors --------------------------------------------------------- - - /** - * Constructs ... - * - * - * @param configurationProvider - */ @Inject public ProxyServlet(ProxyConfigurationProvider configurationProvider) { this.configurationProvider = configurationProvider; } - //~--- methods -------------------------------------------------------------- - - /** - * Method description - * - * - * @param request - * @param response - */ @Override public void service(HttpServletRequest request, HttpServletResponse response) { @@ -150,15 +127,6 @@ public class ProxyServlet extends HttpServlet } - /** - * Method description - * - * - * @param con - * @param response - * - * @throws IOException - */ private void copyContent(HttpURLConnection con, HttpServletResponse response) throws IOException { @@ -175,15 +143,6 @@ public class ProxyServlet extends HttpServlet } } - /** - * Method description - * - * - * - * @param configuration - * @param request - * @param con - */ @SuppressWarnings("unchecked") private void copyRequestHeaders(ProxyConfiguration configuration, HttpServletRequest request, HttpURLConnection con) @@ -218,15 +177,6 @@ public class ProxyServlet extends HttpServlet } } - /** - * Method description - * - * - * - * @param configuration - * @param con - * @param response - */ private void copyResponseHeaders(ProxyConfiguration configuration, HttpURLConnection con, HttpServletResponse response) { @@ -263,17 +213,6 @@ public class ProxyServlet extends HttpServlet } } - /** - * Method description - * - * - * @param configuration - * @param request - * - * @return - * - * @throws IOException - */ private HttpURLConnection createConnection(ProxyConfiguration configuration, HttpServletRequest request) throws IOException @@ -289,8 +228,4 @@ public class ProxyServlet extends HttpServlet return con; } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private final ProxyConfigurationProvider configurationProvider; } diff --git a/scm-core/src/main/java/sonia/scm/web/security/AdministrationContext.java b/scm-core/src/main/java/sonia/scm/web/security/AdministrationContext.java index c521e516ca..cd592ad8ba 100644 --- a/scm-core/src/main/java/sonia/scm/web/security/AdministrationContext.java +++ b/scm-core/src/main/java/sonia/scm/web/security/AdministrationContext.java @@ -27,7 +27,6 @@ package sonia.scm.web.security; /** * Execute actions with administration privileges. * - * @author Sebastian Sdorra * @since 1.6 */ public interface AdministrationContext diff --git a/scm-core/src/main/java/sonia/scm/web/security/PrivilegedAction.java b/scm-core/src/main/java/sonia/scm/web/security/PrivilegedAction.java index e3f6432e8a..7dee2fdbe1 100644 --- a/scm-core/src/main/java/sonia/scm/web/security/PrivilegedAction.java +++ b/scm-core/src/main/java/sonia/scm/web/security/PrivilegedAction.java @@ -26,7 +26,6 @@ package sonia.scm.web.security; /** * - * @author Sebastian Sdorra * @since 1.6 */ public interface PrivilegedAction extends Runnable {} diff --git a/scm-core/src/main/java/sonia/scm/work/CentralWorkQueue.java b/scm-core/src/main/java/sonia/scm/work/CentralWorkQueue.java index bc8609ff3d..82474450a9 100644 --- a/scm-core/src/main/java/sonia/scm/work/CentralWorkQueue.java +++ b/scm-core/src/main/java/sonia/scm/work/CentralWorkQueue.java @@ -101,8 +101,6 @@ public interface CentralWorkQueue { /** * Returns the count of pending or running tasks. - * - * @return count of pending or running tasks */ int getSize(); diff --git a/scm-core/src/main/java/sonia/scm/xml/IndentXMLStreamWriter.java b/scm-core/src/main/java/sonia/scm/xml/IndentXMLStreamWriter.java index 9d02cec176..1cc2334bcc 100644 --- a/scm-core/src/main/java/sonia/scm/xml/IndentXMLStreamWriter.java +++ b/scm-core/src/main/java/sonia/scm/xml/IndentXMLStreamWriter.java @@ -24,8 +24,6 @@ package sonia.scm.xml; -//~--- JDK imports ------------------------------------------------------------ - import com.google.common.annotations.VisibleForTesting; import javax.xml.namespace.NamespaceContext; import javax.xml.stream.XMLStreamException; @@ -34,18 +32,15 @@ import javax.xml.stream.XMLStreamWriter; /** * This class is a pretty print wrapper for XMLStreamWriter. * - * @author Sebastian Sdorra * @since 1.31 */ public final class IndentXMLStreamWriter implements XMLStreamWriter, AutoCloseable { - /** line separator */ @VisibleForTesting static final String LINE_SEPARATOR = System.getProperty("line.separator"); - //~--- constructors --------------------------------------------------------- /** * Constructs a new IndentXMLStreamWriter. @@ -69,29 +64,22 @@ public final class IndentXMLStreamWriter implements XMLStreamWriter, AutoCloseab this.indent = indent; } - //~--- methods -------------------------------------------------------------- - /** - * {@inheritDoc} - */ + @Override public void close() throws XMLStreamException { writer.close(); } - /** - * {@inheritDoc} - */ + @Override public void flush() throws XMLStreamException { writer.flush(); } - /** - * {@inheritDoc} - */ + @Override public void writeAttribute(String localName, String value) throws XMLStreamException @@ -99,9 +87,7 @@ public final class IndentXMLStreamWriter implements XMLStreamWriter, AutoCloseab writer.writeAttribute(localName, value); } - /** - * {@inheritDoc} - */ + @Override public void writeAttribute(String prefix, String namespaceURI, String localName, String value) @@ -110,9 +96,7 @@ public final class IndentXMLStreamWriter implements XMLStreamWriter, AutoCloseab writer.writeAttribute(prefix, namespaceURI, localName, value); } - /** - * {@inheritDoc} - */ + @Override public void writeAttribute(String namespaceURI, String localName, String value) @@ -121,27 +105,21 @@ public final class IndentXMLStreamWriter implements XMLStreamWriter, AutoCloseab writer.writeAttribute(namespaceURI, localName, value); } - /** - * {@inheritDoc} - */ + @Override public void writeCData(String data) throws XMLStreamException { writer.writeCData(data); } - /** - * {@inheritDoc} - */ + @Override public void writeCharacters(String text) throws XMLStreamException { writer.writeCharacters(text); } - /** - * {@inheritDoc} - */ + @Override public void writeCharacters(char[] text, int start, int len) throws XMLStreamException @@ -149,9 +127,7 @@ public final class IndentXMLStreamWriter implements XMLStreamWriter, AutoCloseab writer.writeCharacters(text, start, len); } - /** - * {@inheritDoc} - */ + @Override public void writeComment(String data) throws XMLStreamException { @@ -160,18 +136,14 @@ public final class IndentXMLStreamWriter implements XMLStreamWriter, AutoCloseab unindent(); } - /** - * {@inheritDoc} - */ + @Override public void writeDTD(String dtd) throws XMLStreamException { writer.writeDTD(dtd); } - /** - * {@inheritDoc} - */ + @Override public void writeDefaultNamespace(String namespaceURI) throws XMLStreamException @@ -179,9 +151,7 @@ public final class IndentXMLStreamWriter implements XMLStreamWriter, AutoCloseab writer.writeDefaultNamespace(namespaceURI); } - /** - * {@inheritDoc} - */ + @Override public void writeEmptyElement(String namespaceURI, String localName) throws XMLStreamException @@ -191,9 +161,7 @@ public final class IndentXMLStreamWriter implements XMLStreamWriter, AutoCloseab unindent(); } - /** - * {@inheritDoc} - */ + @Override public void writeEmptyElement(String prefix, String localName, String namespaceURI) @@ -204,9 +172,7 @@ public final class IndentXMLStreamWriter implements XMLStreamWriter, AutoCloseab unindent(); } - /** - * {@inheritDoc} - */ + @Override public void writeEmptyElement(String localName) throws XMLStreamException { @@ -215,9 +181,7 @@ public final class IndentXMLStreamWriter implements XMLStreamWriter, AutoCloseab unindent(); } - /** - * {@inheritDoc} - */ + @Override public void writeEndDocument() throws XMLStreamException { @@ -225,9 +189,7 @@ public final class IndentXMLStreamWriter implements XMLStreamWriter, AutoCloseab writeLineSeparator(); } - /** - * {@inheritDoc} - */ + @Override public void writeEndElement() throws XMLStreamException { @@ -235,18 +197,14 @@ public final class IndentXMLStreamWriter implements XMLStreamWriter, AutoCloseab writer.writeEndElement(); } - /** - * {@inheritDoc} - */ + @Override public void writeEntityRef(String name) throws XMLStreamException { writer.writeEntityRef(name); } - /** - * {@inheritDoc} - */ + @Override public void writeNamespace(String prefix, String namespaceURI) throws XMLStreamException @@ -254,9 +212,7 @@ public final class IndentXMLStreamWriter implements XMLStreamWriter, AutoCloseab writer.writeNamespace(prefix, namespaceURI); } - /** - * {@inheritDoc} - */ + @Override public void writeProcessingInstruction(String target) throws XMLStreamException @@ -264,9 +220,7 @@ public final class IndentXMLStreamWriter implements XMLStreamWriter, AutoCloseab writer.writeProcessingInstruction(target); } - /** - * {@inheritDoc} - */ + @Override public void writeProcessingInstruction(String target, String data) throws XMLStreamException @@ -274,9 +228,7 @@ public final class IndentXMLStreamWriter implements XMLStreamWriter, AutoCloseab writer.writeProcessingInstruction(target, data); } - /** - * {@inheritDoc} - */ + @Override public void writeStartDocument() throws XMLStreamException { @@ -284,9 +236,7 @@ public final class IndentXMLStreamWriter implements XMLStreamWriter, AutoCloseab writeLineSeparator(); } - /** - * {@inheritDoc} - */ + @Override public void writeStartDocument(String version) throws XMLStreamException { @@ -294,9 +244,7 @@ public final class IndentXMLStreamWriter implements XMLStreamWriter, AutoCloseab writeLineSeparator(); } - /** - * {@inheritDoc} - */ + @Override public void writeStartDocument(String encoding, String version) throws XMLStreamException @@ -305,9 +253,7 @@ public final class IndentXMLStreamWriter implements XMLStreamWriter, AutoCloseab writeLineSeparator(); } - /** - * {@inheritDoc} - */ + @Override public void writeStartElement(String localName) throws XMLStreamException { @@ -315,9 +261,7 @@ public final class IndentXMLStreamWriter implements XMLStreamWriter, AutoCloseab writer.writeStartElement(localName); } - /** - * {@inheritDoc} - */ + @Override public void writeStartElement(String namespaceURI, String localName) throws XMLStreamException @@ -326,9 +270,7 @@ public final class IndentXMLStreamWriter implements XMLStreamWriter, AutoCloseab writer.writeStartElement(namespaceURI, localName); } - /** - * {@inheritDoc} - */ + @Override public void writeStartElement(String prefix, String localName, String namespaceURI) @@ -338,49 +280,37 @@ public final class IndentXMLStreamWriter implements XMLStreamWriter, AutoCloseab writer.writeStartElement(prefix, localName, namespaceURI); } - //~--- get methods ---------------------------------------------------------- - /** - * {@inheritDoc} - */ + @Override public NamespaceContext getNamespaceContext() { return writer.getNamespaceContext(); } - /** - * {@inheritDoc} - */ + @Override public String getPrefix(String uri) throws XMLStreamException { return writer.getPrefix(uri); } - /** - * {@inheritDoc} - */ + @Override public Object getProperty(String name) throws IllegalArgumentException { return writer.getProperty(name); } - //~--- set methods ---------------------------------------------------------- - /** - * {@inheritDoc} - */ + @Override public void setDefaultNamespace(String uri) throws XMLStreamException { writer.setDefaultNamespace(uri); } - /** - * {@inheritDoc} - */ + @Override public void setNamespaceContext(NamespaceContext context) throws XMLStreamException @@ -388,9 +318,7 @@ public final class IndentXMLStreamWriter implements XMLStreamWriter, AutoCloseab writer.setNamespaceContext(context); } - /** - * {@inheritDoc} - */ + @Override public void setPrefix(String prefix, String uri) throws XMLStreamException { @@ -401,7 +329,6 @@ public final class IndentXMLStreamWriter implements XMLStreamWriter, AutoCloseab writer.writeCharacters(LINE_SEPARATOR); } - //~--- methods -------------------------------------------------------------- /** * Write indent spaces for start elements. diff --git a/scm-core/src/main/java/sonia/scm/xml/XmlArrayStringAdapter.java b/scm-core/src/main/java/sonia/scm/xml/XmlArrayStringAdapter.java index 7331f76100..d9f777056b 100644 --- a/scm-core/src/main/java/sonia/scm/xml/XmlArrayStringAdapter.java +++ b/scm-core/src/main/java/sonia/scm/xml/XmlArrayStringAdapter.java @@ -24,7 +24,6 @@ package sonia.scm.xml; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Joiner; import com.google.common.base.Splitter; @@ -34,7 +33,6 @@ import jakarta.xml.bind.annotation.adapters.XmlAdapter; * Converts a string to a string array and vice versa. The string is divided by * a comma. * - * @author Sebastian Sdorra * @since 2.0.0 */ public class XmlArrayStringAdapter extends XmlAdapter @@ -43,7 +41,6 @@ public class XmlArrayStringAdapter extends XmlAdapter /** separator char */ private static final char SEPARATOR = ','; - //~--- methods -------------------------------------------------------------- /** * Converts the array to a single string divided by commas. diff --git a/scm-core/src/main/java/sonia/scm/xml/XmlCipherStringAdapter.java b/scm-core/src/main/java/sonia/scm/xml/XmlCipherStringAdapter.java index 004a238a4e..4fa2d834bb 100644 --- a/scm-core/src/main/java/sonia/scm/xml/XmlCipherStringAdapter.java +++ b/scm-core/src/main/java/sonia/scm/xml/XmlCipherStringAdapter.java @@ -24,45 +24,25 @@ package sonia.scm.xml; -//~--- non-JDK imports -------------------------------------------------------- import jakarta.xml.bind.annotation.adapters.XmlAdapter; import sonia.scm.security.CipherUtil; /** * - * @author Sebastian Sdorra * @since 1.7 */ public class XmlCipherStringAdapter extends XmlAdapter { - /** - * Method description - * - * - * @param v - * - * @return - * - * @throws Exception - */ + @Override public String marshal(String v) throws Exception { return CipherUtil.getInstance().encode(v); } - /** - * Method description - * - * - * @param v - * - * @return - * - * @throws Exception - */ + @Override public String unmarshal(String v) throws Exception { diff --git a/scm-core/src/main/java/sonia/scm/xml/XmlDateAdapter.java b/scm-core/src/main/java/sonia/scm/xml/XmlDateAdapter.java index 0ff8c195db..5c9b57e2ed 100644 --- a/scm-core/src/main/java/sonia/scm/xml/XmlDateAdapter.java +++ b/scm-core/src/main/java/sonia/scm/xml/XmlDateAdapter.java @@ -24,46 +24,24 @@ package sonia.scm.xml; -//~--- non-JDK imports -------------------------------------------------------- import jakarta.xml.bind.annotation.adapters.XmlAdapter; import sonia.scm.util.Util; import java.util.Date; -/** - * - * @author Sebastian Sdorra - */ + public class XmlDateAdapter extends XmlAdapter { - /** - * Method description - * - * - * @param date - * - * @return - * - * @throws Exception - */ + @Override public String marshal(Date date) throws Exception { return Util.formatDate(date); } - /** - * Method description - * - * - * @param value - * - * @return - * - * @throws Exception - */ + @Override public Date unmarshal(String value) throws Exception { diff --git a/scm-core/src/main/java/sonia/scm/xml/XmlIntervalAdapter.java b/scm-core/src/main/java/sonia/scm/xml/XmlIntervalAdapter.java index 2746c4a90c..08b3da8e6e 100644 --- a/scm-core/src/main/java/sonia/scm/xml/XmlIntervalAdapter.java +++ b/scm-core/src/main/java/sonia/scm/xml/XmlIntervalAdapter.java @@ -24,44 +24,20 @@ package sonia.scm.xml; -//~--- non-JDK imports -------------------------------------------------------- import jakarta.xml.bind.annotation.adapters.XmlAdapter; import sonia.scm.util.Util; -/** - * - * @author Sebastian Sdorra - */ + public class XmlIntervalAdapter extends XmlAdapter { - /** - * Method description - * - * - * @param longValue - * - * @return - * - * @throws Exception - */ @Override public String marshal(Long longValue) throws Exception { return Util.convertTime(longValue); } - /** - * Method description - * - * - * @param stringValue - * - * @return - * - * @throws Exception - */ @Override public Long unmarshal(String stringValue) throws Exception { diff --git a/scm-core/src/main/java/sonia/scm/xml/XmlMapStringAdapter.java b/scm-core/src/main/java/sonia/scm/xml/XmlMapStringAdapter.java index bc5062244e..0894f4dcd5 100644 --- a/scm-core/src/main/java/sonia/scm/xml/XmlMapStringAdapter.java +++ b/scm-core/src/main/java/sonia/scm/xml/XmlMapStringAdapter.java @@ -24,7 +24,6 @@ package sonia.scm.xml; -//~--- non-JDK imports -------------------------------------------------------- import jakarta.xml.bind.annotation.adapters.XmlAdapter; import sonia.scm.util.Util; @@ -32,24 +31,11 @@ import sonia.scm.util.Util; import java.util.HashMap; import java.util.Map; -/** - * - * @author Sebastian Sdorra - */ + public class XmlMapStringAdapter extends XmlAdapter> { - /** - * Method description - * - * - * @param map - * - * @return - * - * @throws Exception - */ @Override public XmlMapStringElement[] marshal(Map map) throws Exception { @@ -76,16 +62,6 @@ public class XmlMapStringAdapter return elements; } - /** - * Method description - * - * - * @param elements - * - * @return - * - * @throws Exception - */ @Override public Map unmarshal(XmlMapStringElement[] elements) throws Exception diff --git a/scm-core/src/main/java/sonia/scm/xml/XmlMapStringElement.java b/scm-core/src/main/java/sonia/scm/xml/XmlMapStringElement.java index 473418d32a..a48694f983 100644 --- a/scm-core/src/main/java/sonia/scm/xml/XmlMapStringElement.java +++ b/scm-core/src/main/java/sonia/scm/xml/XmlMapStringElement.java @@ -24,93 +24,52 @@ package sonia.scm.xml; -//~--- JDK imports ------------------------------------------------------------ - import jakarta.xml.bind.annotation.XmlAccessType; import jakarta.xml.bind.annotation.XmlAccessorType; import jakarta.xml.bind.annotation.XmlRootElement; -/** - * - * @author Sebastian Sdorra - */ + @XmlRootElement(name = "element") @XmlAccessorType(XmlAccessType.FIELD) public class XmlMapStringElement { + private String key; + + private String value; - /** - * Constructs ... - * - */ public XmlMapStringElement() {} - /** - * Constructs ... - * - * - * @param key - * @param value - */ + public XmlMapStringElement(String key, String value) { this.key = key; this.value = value; } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + public String getKey() { return key; } - /** - * Method description - * - * - * @return - */ + public String getValue() { return value; } - //~--- set methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param key - */ + public void setKey(String key) { this.key = key; } - /** - * Method description - * - * - * @param value - */ + public void setValue(String value) { this.value = value; } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private String key; - - /** Field description */ - private String value; } diff --git a/scm-core/src/main/java/sonia/scm/xml/XmlSetStringAdapter.java b/scm-core/src/main/java/sonia/scm/xml/XmlSetStringAdapter.java index 92044380e7..7285f7555d 100644 --- a/scm-core/src/main/java/sonia/scm/xml/XmlSetStringAdapter.java +++ b/scm-core/src/main/java/sonia/scm/xml/XmlSetStringAdapter.java @@ -24,31 +24,17 @@ package sonia.scm.xml; -//~--- JDK imports ------------------------------------------------------------ - import jakarta.xml.bind.annotation.adapters.XmlAdapter; import java.util.HashSet; import java.util.Iterator; import java.util.Set; -/** - * - * @author Sebastian Sdorra - */ + public class XmlSetStringAdapter extends XmlAdapter> { - /** - * Method description - * - * - * @param value - * - * @return - * - * @throws Exception - */ + @Override public String marshal(Set value) throws Exception { @@ -68,16 +54,6 @@ public class XmlSetStringAdapter extends XmlAdapter> return buffer.toString(); } - /** - * Method description - * - * - * @param rawString - * - * @return - * - * @throws Exception - */ @Override public Set unmarshal(String rawString) throws Exception { diff --git a/scm-core/src/main/java/sonia/scm/xml/XmlTimestampDateAdapter.java b/scm-core/src/main/java/sonia/scm/xml/XmlTimestampDateAdapter.java index e3f3236507..5a9890ab19 100644 --- a/scm-core/src/main/java/sonia/scm/xml/XmlTimestampDateAdapter.java +++ b/scm-core/src/main/java/sonia/scm/xml/XmlTimestampDateAdapter.java @@ -24,46 +24,24 @@ package sonia.scm.xml; -//~--- non-JDK imports -------------------------------------------------------- import jakarta.xml.bind.annotation.adapters.XmlAdapter; import sonia.scm.util.Util; import java.util.Date; -/** - * - * @author Sebastian Sdorra - */ + public class XmlTimestampDateAdapter extends XmlAdapter { - /** - * Method description - * - * - * @param value - * - * @return - * - * @throws Exception - */ + @Override public String marshal(Long value) throws Exception { return Util.formatDate(new Date(value)); } - /** - * Method description - * - * - * @param value - * - * @return - * - * @throws Exception - */ + @Override public Long unmarshal(String value) throws Exception { diff --git a/scm-core/src/test/java/sonia/scm/PrioritiesTest.java b/scm-core/src/test/java/sonia/scm/PrioritiesTest.java index cb2bb71f33..f23219ad22 100644 --- a/scm-core/src/test/java/sonia/scm/PrioritiesTest.java +++ b/scm-core/src/test/java/sonia/scm/PrioritiesTest.java @@ -24,7 +24,6 @@ package sonia.scm; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.collect.ImmutableList; @@ -34,14 +33,9 @@ import static org.hamcrest.Matchers.*; import static org.junit.Assert.*; -//~--- JDK imports ------------------------------------------------------------ - import java.util.List; -/** - * - * @author Sebastian Sdorra - */ + public class PrioritiesTest { @@ -55,19 +49,10 @@ public class PrioritiesTest public static final int PRE_AUTHENTICATION = 4500; - /** - * Constructs ... - * - */ public PrioritiesTest() {} - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - */ - @Test + @Test public void testGetPriority() { assertEquals(POST_AUTHENTICATION, @@ -75,11 +60,7 @@ public class PrioritiesTest assertEquals(Priorities.DEFAULT, Priorities.getPriority(D.class)); } - /** - * Method description - * - */ - @Test + @Test @SuppressWarnings("unchecked") public void testSort() { @@ -104,47 +85,23 @@ public class PrioritiesTest assertThat(instances, contains(b, c, a, d)); } - //~--- inner classes -------------------------------------------------------- - /** - * Class description - * - * - * @version Enter version here..., 14/12/20 - * @author Enter your name here... - */ + + @Priority(POST_AUTHENTICATION) public static class A {} - /** - * Class description - * - * - * @version Enter version here..., 14/12/20 - * @author Enter your name here... - */ + @Priority(PRE_AUTHENTICATION) public static class B {} - /** - * Class description - * - * - * @version Enter version here..., 14/12/20 - * @author Enter your name here... - */ + @Priority(AUTHENTICATION) public static class C {} - /** - * Class description - * - * - * @version Enter version here..., 14/12/20 - * @author Enter your name here... - */ + public static class D {} } diff --git a/scm-core/src/test/java/sonia/scm/cache/CacheStatisticsTest.java b/scm-core/src/test/java/sonia/scm/cache/CacheStatisticsTest.java index ebf3ad8015..3355dea58e 100644 --- a/scm-core/src/test/java/sonia/scm/cache/CacheStatisticsTest.java +++ b/scm-core/src/test/java/sonia/scm/cache/CacheStatisticsTest.java @@ -24,24 +24,16 @@ package sonia.scm.cache; -//~--- non-JDK imports -------------------------------------------------------- import org.junit.Test; import static org.junit.Assert.*; -/** - * - * @author Sebastian Sdorra - */ + public class CacheStatisticsTest { - /** - * Method description - * - */ - @Test + @Test public void testCounters() { CacheStatistics stats = new CacheStatistics("", 12, 3); @@ -51,11 +43,7 @@ public class CacheStatisticsTest assertEquals(15, stats.getRequestCount()); } - /** - * Method description - * - */ - @Test + @Test public void testRates() { CacheStatistics stats = new CacheStatistics("", 12, 3); diff --git a/scm-core/src/test/java/sonia/scm/collect/IterableQueueTest.java b/scm-core/src/test/java/sonia/scm/collect/IterableQueueTest.java index 9d30aa90e1..7672918eb2 100644 --- a/scm-core/src/test/java/sonia/scm/collect/IterableQueueTest.java +++ b/scm-core/src/test/java/sonia/scm/collect/IterableQueueTest.java @@ -21,10 +21,9 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ - + package sonia.scm.collect; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.collect.Lists; @@ -32,8 +31,6 @@ import org.junit.Test; import static org.junit.Assert.*; -//~--- JDK imports ------------------------------------------------------------ - import java.util.List; import java.util.Random; import java.util.concurrent.ExecutionException; @@ -41,17 +38,10 @@ import java.util.concurrent.ExecutorService; import java.util.concurrent.Executors; import java.util.concurrent.Future; -/** - * - * @author Sebastian Sdorra - */ + public class IterableQueueTest { - /** - * Method description - * - */ @Test(expected = IllegalStateException.class) public void testDuplicatedEndReached() { @@ -61,10 +51,6 @@ public class IterableQueueTest queue.endReached(); } - /** - * Method description - * - */ @Test public void testIterator() { @@ -75,40 +61,18 @@ public class IterableQueueTest assertNotEquals(QueueIterator.class, queue.iterator().getClass()); } - /** - * Method description - * - * - * @throws ExecutionException - * @throws InterruptedException - * - * @throws Exception - */ @Test public void testMultiThreaded() throws Exception { testMultiThreaded(5, 10, false, 1000); } - /** - * Method description - * - * - * @throws ExecutionException - * @throws InterruptedException - * - * @throws Exception - */ @Test public void testMultiThreadedWithRandomSleep() throws Exception { testMultiThreaded(5, 10, true, 50); } - /** - * Method description - * - */ @Test(expected = IllegalStateException.class) public void testPushEndReached() { @@ -119,10 +83,6 @@ public class IterableQueueTest queue.push("b"); } - /** - * Method description - * - */ @Test public void testSingleConsumer() { @@ -132,13 +92,7 @@ public class IterableQueueTest assertResult(Lists.newArrayList(queue), 100); } - /** - * Method description - * - * - * @param result - * @param itemCount - */ + private void assertResult(List result, int itemCount) { assertNotNull(result); @@ -150,17 +104,6 @@ public class IterableQueueTest } } - /** - * Method description - * - * - * @param threads - * @param consumer - * @param randomSleep - * @param itemCount - * - * @throws Exception - */ private void testMultiThreaded(int threads, int consumer, boolean randomSleep, int itemCount) throws Exception @@ -186,26 +129,9 @@ public class IterableQueueTest } } - //~--- inner classes -------------------------------------------------------- - - /** - * Class description - * - * - * @version Enter version here..., 13/03/01 - * @author Enter your name here... - */ private static class IntegerProducer implements Runnable { - /** - * Constructs ... - * - * - * @param queue - * @param randomSleep - * @param itemCount - */ public IntegerProducer(IterableQueue queue, boolean randomSleep, int itemCount) { @@ -214,12 +140,6 @@ public class IterableQueueTest this.itemCount = itemCount; } - //~--- methods ------------------------------------------------------------ - - /** - * Method description - * - */ @Override public void run() { @@ -245,15 +165,10 @@ public class IterableQueueTest queue.endReached(); } - //~--- fields ------------------------------------------------------------- - - /** Field description */ IterableQueue queue; - /** Field description */ private int itemCount; - /** Field description */ private boolean randomSleep; } } diff --git a/scm-core/src/test/java/sonia/scm/i18n/I18nMessagesTest.java b/scm-core/src/test/java/sonia/scm/i18n/I18nMessagesTest.java index 94e33fe127..a54d44ba7f 100644 --- a/scm-core/src/test/java/sonia/scm/i18n/I18nMessagesTest.java +++ b/scm-core/src/test/java/sonia/scm/i18n/I18nMessagesTest.java @@ -24,7 +24,6 @@ package sonia.scm.i18n; -//~--- non-JDK imports -------------------------------------------------------- import org.junit.Test; @@ -32,23 +31,14 @@ import sonia.scm.repository.Changeset; import static org.junit.Assert.*; -//~--- JDK imports ------------------------------------------------------------ - import java.util.Locale; import java.util.MissingResourceException; -/** - * - * @author Sebastian Sdorra - */ + public class I18nMessagesTest { - /** - * Method description - * - */ - @Test + @Test public void testI18n() { /* @@ -71,11 +61,7 @@ public class I18nMessagesTest assertEquals(Locale.ENGLISH, msg.locale); } - /** - * Method description - * - */ - @Test + @Test public void testI18nOtherLanguage() { TestMessages msg = I18nMessages.get(TestMessages.class, Locale.GERMANY); @@ -87,11 +73,7 @@ public class I18nMessagesTest assertEquals(Locale.GERMANY, msg.locale); } - /** - * Method description - * - */ - @Test(expected = MissingResourceException.class) + @Test(expected = MissingResourceException.class) public void testMissingBundle() { Changeset msg = I18nMessages.get(Changeset.class); diff --git a/scm-core/src/test/java/sonia/scm/i18n/TestMessages.java b/scm-core/src/test/java/sonia/scm/i18n/TestMessages.java index e7a9ac7aec..a74c0a20a3 100644 --- a/scm-core/src/test/java/sonia/scm/i18n/TestMessages.java +++ b/scm-core/src/test/java/sonia/scm/i18n/TestMessages.java @@ -24,30 +24,20 @@ package sonia.scm.i18n; -//~--- JDK imports ------------------------------------------------------------ - import java.util.Locale; -/** - * - * @author Sebastian Sdorra - */ + public class TestMessages { - /** Field description */ public Bundle bundle; - /** Field description */ @I18n("key_with_annotation") public String keyWithAnnotation; - /** Field description */ public Locale locale; - /** Field description */ public String normalKey; - /** Field description */ public Integer someObject; } diff --git a/scm-core/src/test/java/sonia/scm/io/DeepCopyTest.java b/scm-core/src/test/java/sonia/scm/io/DeepCopyTest.java index 6644a845b6..d1951d08ee 100644 --- a/scm-core/src/test/java/sonia/scm/io/DeepCopyTest.java +++ b/scm-core/src/test/java/sonia/scm/io/DeepCopyTest.java @@ -24,7 +24,6 @@ package sonia.scm.io; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Objects; import org.junit.Test; @@ -35,12 +34,9 @@ import java.io.Serializable; import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertNotSame; -//~--- JDK imports ------------------------------------------------------------ - /** * Unit tests for {@link DeepCopy}. * - * @author Sebastian Sdorra */ public class DeepCopyTest { @@ -68,7 +64,7 @@ public class DeepCopyTest { DeepCopy.copy(new NonSerializable()); } - //~--- inner classes -------------------------------------------------------- + private static class Address implements Serializable { @@ -102,7 +98,7 @@ public class DeepCopyTest { return Objects.hashCode(city, street); } - //~--- get methods -------------------------------------------------------- + public String getCity() { return city; @@ -125,7 +121,7 @@ public class DeepCopyTest { private static final long serialVersionUID = -2098386757802626539L; - //~--- constructors ------------------------------------------------------- + public Person() {} @@ -135,7 +131,7 @@ public class DeepCopyTest { this.address = address; } - //~--- methods ------------------------------------------------------------ + @Override public boolean equals(Object obj) { @@ -159,7 +155,7 @@ public class DeepCopyTest { return Objects.hashCode(firstname, lastname, address); } - //~--- get methods -------------------------------------------------------- + public Address getAddress() { return address; diff --git a/scm-core/src/test/java/sonia/scm/io/RegexResourceProcessorTest.java b/scm-core/src/test/java/sonia/scm/io/RegexResourceProcessorTest.java index ad493d8e3b..186df5c116 100644 --- a/scm-core/src/test/java/sonia/scm/io/RegexResourceProcessorTest.java +++ b/scm-core/src/test/java/sonia/scm/io/RegexResourceProcessorTest.java @@ -24,19 +24,11 @@ package sonia.scm.io; -/** - * - * @author Sebastian Sdorra - */ + public class RegexResourceProcessorTest extends ResourceProcessorTestBase { - /** - * Method description - * - * - * @return - */ + @Override protected ResourceProcessor createNewResourceProcessor() { diff --git a/scm-core/src/test/java/sonia/scm/io/ResourceProcessorTestBase.java b/scm-core/src/test/java/sonia/scm/io/ResourceProcessorTestBase.java index 0af69acf6e..19655eaa54 100644 --- a/scm-core/src/test/java/sonia/scm/io/ResourceProcessorTestBase.java +++ b/scm-core/src/test/java/sonia/scm/io/ResourceProcessorTestBase.java @@ -24,65 +24,40 @@ package sonia.scm.io; -//~--- non-JDK imports -------------------------------------------------------- import org.junit.Test; import static org.junit.Assert.*; -//~--- JDK imports ------------------------------------------------------------ - import java.io.IOException; import java.io.StringReader; import java.io.StringWriter; -/** - * - * @author Sebastian Sdorra - */ + public abstract class ResourceProcessorTestBase { - /** Field description */ public static final String TEXT_1 = "Hello Tricia McMillan!"; - /** Field description */ public static final String TEXT_2 = "Hello ${person}!"; - /** Field description */ public static final String TEXT_3 = "Hello ${person} and ${secondPerson}!"; - /** Field description */ public static final String TEXT_4 = "

Hello ${person}

"; - /** Field description */ public static final String VAR_PERSON = "person"; - /** Field description */ public static final String VAR_PERSON_VALUE = "Tricia McMillan"; - /** Field description */ public static final String VAR_SECONDPERSON = "secondPerson"; - /** Field description */ public static final String VAR_SECONDPERSON_VALUE = "Zaphod Beeblebrox"; - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + protected abstract ResourceProcessor createNewResourceProcessor(); - /** - * Method description - * - * - * @throws IOException - */ + @Test public void testHtml() throws IOException { @@ -96,12 +71,7 @@ public abstract class ResourceProcessorTestBase assertEquals("

Hello Tricia McMillan

", output.toString()); } - /** - * Method description - * - * - * @throws IOException - */ + @Test public void testWithNonExistingVar() throws IOException { @@ -112,12 +82,7 @@ public abstract class ResourceProcessorTestBase assertEquals(TEXT_2, output.toString()); } - /** - * Method description - * - * - * @throws IOException - */ + @Test public void testWithVar() throws IOException { @@ -131,12 +96,7 @@ public abstract class ResourceProcessorTestBase assertEquals(TEXT_1, output.toString()); } - /** - * Method description - * - * - * @throws IOException - */ + @Test public void testWithVars() throws IOException { @@ -152,12 +112,7 @@ public abstract class ResourceProcessorTestBase output.toString()); } - /** - * Method description - * - * - * @throws IOException - */ + @Test public void testWithoutVars() throws IOException { diff --git a/scm-core/src/test/java/sonia/scm/net/ahc/AdvancedHttpClientTest.java b/scm-core/src/test/java/sonia/scm/net/ahc/AdvancedHttpClientTest.java index 1dc904c6c7..93f563b41a 100644 --- a/scm-core/src/test/java/sonia/scm/net/ahc/AdvancedHttpClientTest.java +++ b/scm-core/src/test/java/sonia/scm/net/ahc/AdvancedHttpClientTest.java @@ -31,10 +31,7 @@ import org.mockito.Answers; import org.mockito.Mock; import org.mockito.junit.MockitoJUnitRunner; -/** - * - * @author Sebastian Sdorra - */ + @RunWith(MockitoJUnitRunner.class) public class AdvancedHttpClientTest { diff --git a/scm-core/src/test/java/sonia/scm/net/ahc/AdvancedHttpRequestTest.java b/scm-core/src/test/java/sonia/scm/net/ahc/AdvancedHttpRequestTest.java index f9bbe1ab54..48aa28e8a1 100644 --- a/scm-core/src/test/java/sonia/scm/net/ahc/AdvancedHttpRequestTest.java +++ b/scm-core/src/test/java/sonia/scm/net/ahc/AdvancedHttpRequestTest.java @@ -30,10 +30,7 @@ import org.junit.runner.RunWith; import org.mockito.Mock; import org.mockito.junit.MockitoJUnitRunner; -/** - * - * @author Sebastian Sdorra - */ + @RunWith(MockitoJUnitRunner.class) public class AdvancedHttpRequestTest { diff --git a/scm-core/src/test/java/sonia/scm/net/ahc/AdvancedHttpRequestWithBodyTest.java b/scm-core/src/test/java/sonia/scm/net/ahc/AdvancedHttpRequestWithBodyTest.java index e9622d92c3..6721635045 100644 --- a/scm-core/src/test/java/sonia/scm/net/ahc/AdvancedHttpRequestWithBodyTest.java +++ b/scm-core/src/test/java/sonia/scm/net/ahc/AdvancedHttpRequestWithBodyTest.java @@ -41,10 +41,7 @@ import java.nio.file.Path; import static org.assertj.core.api.Assertions.assertThat; import static org.mockito.Mockito.when; -/** - * - * @author Sebastian Sdorra - */ + @ExtendWith(MockitoExtension.class) class AdvancedHttpRequestWithBodyTest { diff --git a/scm-core/src/test/java/sonia/scm/net/ahc/AdvancedHttpResponseTest.java b/scm-core/src/test/java/sonia/scm/net/ahc/AdvancedHttpResponseTest.java index b1448aa31f..a939c38223 100644 --- a/scm-core/src/test/java/sonia/scm/net/ahc/AdvancedHttpResponseTest.java +++ b/scm-core/src/test/java/sonia/scm/net/ahc/AdvancedHttpResponseTest.java @@ -39,10 +39,7 @@ import org.mockito.Mock; import static org.mockito.Mockito.*; import org.mockito.junit.MockitoJUnitRunner; -/** - * - * @author Sebastian Sdorra - */ + @RunWith(MockitoJUnitRunner.class) public class AdvancedHttpResponseTest { diff --git a/scm-core/src/test/java/sonia/scm/net/ahc/BaseHttpRequestTest.java b/scm-core/src/test/java/sonia/scm/net/ahc/BaseHttpRequestTest.java index d4f98663f6..bb94f87619 100644 --- a/scm-core/src/test/java/sonia/scm/net/ahc/BaseHttpRequestTest.java +++ b/scm-core/src/test/java/sonia/scm/net/ahc/BaseHttpRequestTest.java @@ -38,10 +38,7 @@ import static org.assertj.core.api.Assertions.assertThat; import static org.mockito.Mockito.*; import org.mockito.junit.jupiter.MockitoExtension; -/** - * - * @author Sebastian Sdorra - */ + @ExtendWith(MockitoExtension.class) class BaseHttpRequestTest { diff --git a/scm-core/src/test/java/sonia/scm/net/ahc/ByteSourceContentTest.java b/scm-core/src/test/java/sonia/scm/net/ahc/ByteSourceContentTest.java index a807f3045c..e80404e874 100644 --- a/scm-core/src/test/java/sonia/scm/net/ahc/ByteSourceContentTest.java +++ b/scm-core/src/test/java/sonia/scm/net/ahc/ByteSourceContentTest.java @@ -35,10 +35,7 @@ import org.mockito.Mock; import static org.mockito.Mockito.*; import org.mockito.junit.MockitoJUnitRunner; -/** - * - * @author Sebastian Sdorra - */ + @RunWith(MockitoJUnitRunner.class) public class ByteSourceContentTest { diff --git a/scm-core/src/test/java/sonia/scm/net/ahc/FileContentTest.java b/scm-core/src/test/java/sonia/scm/net/ahc/FileContentTest.java index d5bc826f4b..53f6e3b139 100644 --- a/scm-core/src/test/java/sonia/scm/net/ahc/FileContentTest.java +++ b/scm-core/src/test/java/sonia/scm/net/ahc/FileContentTest.java @@ -24,7 +24,6 @@ package sonia.scm.net.ahc; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Charsets; import com.google.common.io.Files; @@ -41,26 +40,16 @@ import static org.junit.Assert.*; import static org.mockito.Mockito.*; -//~--- JDK imports ------------------------------------------------------------ - import java.io.ByteArrayOutputStream; import java.io.File; import java.io.IOException; -/** - * - * @author Sebastian Sdorra - */ + @RunWith(MockitoJUnitRunner.class) public class FileContentTest { - /** - * Method description - * - * - * @throws IOException - */ + @Test public void testPrepareRequest() throws IOException { @@ -70,12 +59,7 @@ public class FileContentTest verify(request).contentLength(3l); } - /** - * Method description - * - * - * @throws IOException - */ + @Test public void testProcess() throws IOException { @@ -97,11 +81,9 @@ public class FileContentTest //~--- fields --------------------------------------------------------------- - /** Field description */ @Rule public TemporaryFolder temp = new TemporaryFolder(); - /** Field description */ @Mock private AdvancedHttpRequestWithBody request; } diff --git a/scm-core/src/test/java/sonia/scm/net/ahc/FormContentBuilderTest.java b/scm-core/src/test/java/sonia/scm/net/ahc/FormContentBuilderTest.java index f5cdf0366a..4d2714aafc 100644 --- a/scm-core/src/test/java/sonia/scm/net/ahc/FormContentBuilderTest.java +++ b/scm-core/src/test/java/sonia/scm/net/ahc/FormContentBuilderTest.java @@ -43,9 +43,7 @@ import java.nio.charset.StandardCharsets; import static org.assertj.core.api.Assertions.assertThat; import static org.mockito.Mockito.verify; -/** - * @author Sebastian Sdorra - */ + @ExtendWith(MockitoExtension.class) class FormContentBuilderTest { diff --git a/scm-core/src/test/java/sonia/scm/net/ahc/RawContentTest.java b/scm-core/src/test/java/sonia/scm/net/ahc/RawContentTest.java index 845c04664c..2e45779f96 100644 --- a/scm-core/src/test/java/sonia/scm/net/ahc/RawContentTest.java +++ b/scm-core/src/test/java/sonia/scm/net/ahc/RawContentTest.java @@ -34,10 +34,7 @@ import org.mockito.Mock; import static org.mockito.Mockito.*; import org.mockito.junit.MockitoJUnitRunner; -/** - * - * @author Sebastian Sdorra - */ + @RunWith(MockitoJUnitRunner.class) public class RawContentTest { diff --git a/scm-core/src/test/java/sonia/scm/net/ahc/StringContentTest.java b/scm-core/src/test/java/sonia/scm/net/ahc/StringContentTest.java index 4ba809d264..dcc656bd6a 100644 --- a/scm-core/src/test/java/sonia/scm/net/ahc/StringContentTest.java +++ b/scm-core/src/test/java/sonia/scm/net/ahc/StringContentTest.java @@ -28,10 +28,7 @@ import com.google.common.base.Charsets; import org.junit.Test; import static org.junit.Assert.*; -/** - * - * @author Sebastian Sdorra - */ + public class StringContentTest { @@ -49,4 +46,4 @@ public class StringContentTest { assertEquals("üäö", new String(sc.getData(), Charsets.ISO_8859_1)); } -} \ No newline at end of file +} diff --git a/scm-core/src/test/java/sonia/scm/plugin/PluginConditionTest.java b/scm-core/src/test/java/sonia/scm/plugin/PluginConditionTest.java index 32d4043412..6b3521f36e 100644 --- a/scm-core/src/test/java/sonia/scm/plugin/PluginConditionTest.java +++ b/scm-core/src/test/java/sonia/scm/plugin/PluginConditionTest.java @@ -24,20 +24,14 @@ package sonia.scm.plugin; -//~--- non-JDK imports -------------------------------------------------------- import org.junit.Test; import static org.junit.Assert.*; -//~--- JDK imports ------------------------------------------------------------ - import java.util.Arrays; -/** - * - * @author Sebastian Sdorra - */ + public class PluginConditionTest { @@ -46,11 +40,7 @@ public class PluginConditionTest assertTrue(new PluginCondition().isSupported()); } - /** - * Method description - * - */ - @Test + @Test public void testArchIsSupported() { assertTrue(new PluginCondition(null, null, "32").isSupported(null, null, @@ -59,11 +49,7 @@ public class PluginConditionTest "64")); } - /** - * Method description - * - */ - @Test + @Test public void testIsOsSupported() { assertTrue(new PluginCondition(null, Arrays.asList("linux"), @@ -81,22 +67,14 @@ public class PluginConditionTest null).isSupported(null, "Mac OS X", null)); } - /** - * Method description - * - */ - @Test + @Test public void testIsSupported() { assertTrue(new PluginCondition("1.2", Arrays.asList("Mac"), "64").isSupported("1.4", "Mac OS X", "64")); } - /** - * Method description - * - */ - @Test + @Test public void testVersionIsSupported() { assertTrue(new PluginCondition("1.1", null, null).isSupported("1.2", null, diff --git a/scm-core/src/test/java/sonia/scm/plugin/ScmModuleTest.java b/scm-core/src/test/java/sonia/scm/plugin/ScmModuleTest.java index 770a601b7a..21f8701b1c 100644 --- a/scm-core/src/test/java/sonia/scm/plugin/ScmModuleTest.java +++ b/scm-core/src/test/java/sonia/scm/plugin/ScmModuleTest.java @@ -24,7 +24,6 @@ package sonia.scm.plugin; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.collect.Iterables; import com.google.common.io.Resources; @@ -37,18 +36,11 @@ import static org.hamcrest.Matchers.containsInAnyOrder; import static org.hamcrest.Matchers.instanceOf; import static org.junit.Assert.assertThat; -/** - * - * @author Sebastian Sdorra - */ + public class ScmModuleTest { - /** - * Method description - * - */ - @Test + @Test @SuppressWarnings("unchecked") public void testUnmarshall() { diff --git a/scm-core/src/test/java/sonia/scm/plugin/SmpArchiveTest.java b/scm-core/src/test/java/sonia/scm/plugin/SmpArchiveTest.java index 4153328bec..cc94eaca6f 100644 --- a/scm-core/src/test/java/sonia/scm/plugin/SmpArchiveTest.java +++ b/scm-core/src/test/java/sonia/scm/plugin/SmpArchiveTest.java @@ -54,9 +54,7 @@ import static org.junit.jupiter.api.Assertions.assertThrows; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; -/** - * @author Sebastian Sdorra - */ + class SmpArchiveTest { @Test diff --git a/scm-core/src/test/java/sonia/scm/repository/api/HookContextTest.java b/scm-core/src/test/java/sonia/scm/repository/api/HookContextTest.java index b3ddd95279..7d1e07c652 100644 --- a/scm-core/src/test/java/sonia/scm/repository/api/HookContextTest.java +++ b/scm-core/src/test/java/sonia/scm/repository/api/HookContextTest.java @@ -53,7 +53,6 @@ import static org.mockito.Mockito.when; /** * Unit tests for {@link HookContext}. * - * @author Sebastian Sdorra */ @RunWith(MockitoJUnitRunner.class) public class HookContextTest { diff --git a/scm-core/src/test/java/sonia/scm/repository/spi/HookContextProviderTest.java b/scm-core/src/test/java/sonia/scm/repository/spi/HookContextProviderTest.java index 77ce33ed78..ad44a3f9c1 100644 --- a/scm-core/src/test/java/sonia/scm/repository/spi/HookContextProviderTest.java +++ b/scm-core/src/test/java/sonia/scm/repository/spi/HookContextProviderTest.java @@ -38,7 +38,6 @@ import sonia.scm.repository.api.HookFeatureIsNotSupportedException; /** * Unit tests for {@link HookContextProvider}. * - * @author Sebastian Sdorra */ public class HookContextProviderTest { @@ -126,4 +125,4 @@ public class HookContextProviderTest { expectedException.expectMessage(containsString(feature.toString())); } -} \ No newline at end of file +} diff --git a/scm-core/src/test/java/sonia/scm/security/DefaultCipherHandlerTest.java b/scm-core/src/test/java/sonia/scm/security/DefaultCipherHandlerTest.java index 4a2b2d6689..83bcdfc0fe 100644 --- a/scm-core/src/test/java/sonia/scm/security/DefaultCipherHandlerTest.java +++ b/scm-core/src/test/java/sonia/scm/security/DefaultCipherHandlerTest.java @@ -43,7 +43,6 @@ import static org.mockito.Mockito.when; /** * Unit tests for {@link DefaultCipherHandler}. * - * @author Sebastian Sdorra */ @ExtendWith({MockitoExtension.class}) class DefaultCipherHandlerTest { diff --git a/scm-core/src/test/java/sonia/scm/security/SyncingRealmHelperTest.java b/scm-core/src/test/java/sonia/scm/security/SyncingRealmHelperTest.java index 81bf6d1a09..dbcbd6749b 100644 --- a/scm-core/src/test/java/sonia/scm/security/SyncingRealmHelperTest.java +++ b/scm-core/src/test/java/sonia/scm/security/SyncingRealmHelperTest.java @@ -24,7 +24,6 @@ package sonia.scm.security; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Throwables; import com.google.common.collect.ImmutableSet; @@ -57,12 +56,9 @@ import static org.mockito.Mockito.times; import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; -//~--- JDK imports ------------------------------------------------------------ - /** * Unit tests for {@link SyncingRealmHelper}. * - * @author Sebastian Sdorra */ @RunWith(MockitoJUnitRunner.class) public class SyncingRealmHelperTest { diff --git a/scm-core/src/test/java/sonia/scm/template/TemplateEngineFactoryTest.java b/scm-core/src/test/java/sonia/scm/template/TemplateEngineFactoryTest.java index bc07be341e..263e74b5a4 100644 --- a/scm-core/src/test/java/sonia/scm/template/TemplateEngineFactoryTest.java +++ b/scm-core/src/test/java/sonia/scm/template/TemplateEngineFactoryTest.java @@ -24,7 +24,6 @@ package sonia.scm.template; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.collect.Sets; @@ -32,8 +31,6 @@ import org.junit.Test; import static org.junit.Assert.*; -//~--- JDK imports ------------------------------------------------------------ - import java.io.IOException; import java.io.Reader; @@ -41,18 +38,11 @@ import java.util.Collection; import java.util.HashSet; import java.util.Set; -/** - * - * @author Sebastian Sdorra - */ + public class TemplateEngineFactoryTest { - /** - * Method description - * - */ - @Test + @Test public void testGetDefaultEngine() { @@ -65,11 +55,7 @@ public class TemplateEngineFactoryTest assertSame(engine2, factory.getDefaultEngine()); } - /** - * Method description - * - */ - @Test + @Test public void testGetEngine() { FakeTemplateEngine1 engine1 = new FakeTemplateEngine1(); @@ -82,11 +68,7 @@ public class TemplateEngineFactoryTest assertSame(engine2, factory.getEngine("fake2")); } - /** - * Method description - * - */ - @Test + @Test public void testGetEngineByExtension() { FakeTemplateEngine1 engine1 = new FakeTemplateEngine1(); @@ -100,11 +82,7 @@ public class TemplateEngineFactoryTest assertSame(engine1, factory.getEngineByExtension("fake")); } - /** - * Method description - * - */ - @Test + @Test public void testGetEngines() { FakeTemplateEngine1 engine1 = new FakeTemplateEngine1(); @@ -131,15 +109,9 @@ public class TemplateEngineFactoryTest assertTrue(engines.contains(engine2)); } - //~--- inner classes -------------------------------------------------------- - /** - * Class description - * - * - * @version Enter version here..., 12/08/18 - * @author Enter your name here... - */ + + private static class FakeTemplateEngine1 implements TemplateEngine { @@ -177,12 +149,7 @@ public class TemplateEngineFactoryTest throw new UnsupportedOperationException("Not supported yet."); } - /** - * Method description - * - * - * @return - */ + @Override public TemplateType getType() { @@ -191,13 +158,7 @@ public class TemplateEngineFactoryTest } - /** - * Class description - * - * - * @version Enter version here..., 12/08/18 - * @author Enter your name here... - */ + private static class FakeTemplateEngine2 implements TemplateEngine { @@ -235,12 +196,7 @@ public class TemplateEngineFactoryTest throw new UnsupportedOperationException("Not supported yet."); } - /** - * Method description - * - * - * @return - */ + @Override public TemplateType getType() { diff --git a/scm-core/src/test/java/sonia/scm/util/Base32Test.java b/scm-core/src/test/java/sonia/scm/util/Base32Test.java index 7ae80d3cd7..325319dc45 100644 --- a/scm-core/src/test/java/sonia/scm/util/Base32Test.java +++ b/scm-core/src/test/java/sonia/scm/util/Base32Test.java @@ -24,35 +24,18 @@ package sonia.scm.util; -/** - * - * @author Sebastian Sdorra - */ + public class Base32Test extends BaseXTestBase { - /** - * Method description - * - * - * @param value - * - * @return - */ + @Override protected long decode(String value) { return Base32.decode(value); } - /** - * Method description - * - * - * @param value - * - * @return - */ + @Override protected String encode(long value) { diff --git a/scm-core/src/test/java/sonia/scm/util/Base62Test.java b/scm-core/src/test/java/sonia/scm/util/Base62Test.java index 853eec0d45..c1fc6081a4 100644 --- a/scm-core/src/test/java/sonia/scm/util/Base62Test.java +++ b/scm-core/src/test/java/sonia/scm/util/Base62Test.java @@ -24,35 +24,18 @@ package sonia.scm.util; -/** - * - * @author Sebastian Sdorra - */ + public class Base62Test extends BaseXTestBase { - /** - * Method description - * - * - * @param value - * - * @return - */ + @Override protected long decode(String value) { return Base62.decode(value); } - /** - * Method description - * - * - * @param value - * - * @return - */ + @Override protected String encode(long value) { diff --git a/scm-core/src/test/java/sonia/scm/util/BaseXTestBase.java b/scm-core/src/test/java/sonia/scm/util/BaseXTestBase.java index 44c57207f3..1c8c8425b8 100644 --- a/scm-core/src/test/java/sonia/scm/util/BaseXTestBase.java +++ b/scm-core/src/test/java/sonia/scm/util/BaseXTestBase.java @@ -24,7 +24,6 @@ package sonia.scm.util; -//~--- non-JDK imports -------------------------------------------------------- import org.junit.Test; @@ -32,38 +31,17 @@ import static org.hamcrest.Matchers.*; import static org.junit.Assert.*; -/** - * - * @author Sebastian Sdorra - */ + public abstract class BaseXTestBase { - /** - * Method description - * - * - * @param value - * - * @return - */ + protected abstract long decode(String value); - /** - * Method description - * - * - * @param value - * - * @return - */ + protected abstract String encode(long value); - /** - * Method description - * - */ - @Test + @Test public void testEncodeAndDecode() { long value = 1234; diff --git a/scm-core/src/test/java/sonia/scm/util/GlobUtilTest.java b/scm-core/src/test/java/sonia/scm/util/GlobUtilTest.java index 850ffb7f79..08097db6df 100644 --- a/scm-core/src/test/java/sonia/scm/util/GlobUtilTest.java +++ b/scm-core/src/test/java/sonia/scm/util/GlobUtilTest.java @@ -24,24 +24,16 @@ package sonia.scm.util; -//~--- non-JDK imports -------------------------------------------------------- import org.junit.Test; import static org.junit.Assert.*; -/** - * - * @author Sebastian Sdorra - */ + public class GlobUtilTest { - /** - * Method description - * - */ - @Test + @Test public void convertGlobToRegExTest() { assertEquals("/test/path/.*", GlobUtil.convertGlobToRegEx("/test/path/*")); @@ -50,11 +42,7 @@ public class GlobUtilTest assertEquals("a.d", GlobUtil.convertGlobToRegEx("a?d")); } - /** - * Method description - * - */ - @Test + @Test public void matchesTest() { assertTrue(GlobUtil.matches("/test/path/*", "/test/path/somefile.txt")); diff --git a/scm-core/src/test/java/sonia/scm/util/HttpUtilTest.java b/scm-core/src/test/java/sonia/scm/util/HttpUtilTest.java index a8c99625d1..b2d8c9524f 100644 --- a/scm-core/src/test/java/sonia/scm/util/HttpUtilTest.java +++ b/scm-core/src/test/java/sonia/scm/util/HttpUtilTest.java @@ -24,7 +24,6 @@ package sonia.scm.util; -//~--- non-JDK imports -------------------------------------------------------- import jakarta.servlet.http.HttpServletRequest; import jakarta.servlet.http.HttpServletResponse; @@ -43,10 +42,7 @@ import static org.mockito.Mockito.mock; import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; -/** - * - * @author Sebastian Sdorra - */ + public class HttpUtilTest { @@ -87,11 +83,7 @@ public class HttpUtilTest ); } - /** - * Method description - * - */ - @Test + @Test public void appendTest() { //J- @@ -114,11 +106,7 @@ public class HttpUtilTest //J+ } - /** - * Method description - * - */ - @Test + @Test public void normalizeUrlTest() { assertEquals("http://www.scm-manager/scm", @@ -139,61 +127,37 @@ public class HttpUtilTest HttpUtil.normalizeUrl("http://www.scm-manager:8080")); } - /** - * Method description - * - */ - @Test(expected = IllegalArgumentException.class) + @Test(expected = IllegalArgumentException.class) public void testCheckForCRLFInjectionFailure1() { HttpUtil.checkForCRLFInjection("any%0D%0A"); } - /** - * Method description - * - */ - @Test(expected = IllegalArgumentException.class) + @Test(expected = IllegalArgumentException.class) public void testCheckForCRLFInjectionFailure2() { HttpUtil.checkForCRLFInjection("123\nabc"); } - /** - * Method description - * - */ - @Test(expected = IllegalArgumentException.class) + @Test(expected = IllegalArgumentException.class) public void testCheckForCRLFInjectionFailure3() { HttpUtil.checkForCRLFInjection("123\rabc"); } - /** - * Method description - * - */ - @Test(expected = IllegalArgumentException.class) + @Test(expected = IllegalArgumentException.class) public void testCheckForCRLFInjectionFailure4() { HttpUtil.checkForCRLFInjection("123\r\nabc"); } - /** - * Method description - * - */ - @Test(expected = IllegalArgumentException.class) + @Test(expected = IllegalArgumentException.class) public void testCheckForCRLFInjectionFailure5() { HttpUtil.checkForCRLFInjection("123%abc"); } - /** - * Method description - * - */ - @Test + @Test public void testCheckForCRLFInjectionSuccess() { HttpUtil.checkForCRLFInjection("123"); @@ -201,11 +165,7 @@ public class HttpUtilTest HttpUtil.checkForCRLFInjection("abcka"); } - /** - * Method description - * - */ - @Test + @Test public void testCreateBaseUrl() { HttpServletRequest request = mock(HttpServletRequest.class); @@ -218,11 +178,7 @@ public class HttpUtilTest HttpUtil.createBaseUrl(request)); } - /** - * Method description - * - */ - @Test + @Test public void testCreateForwardedUrl() { HttpServletRequest request = mock(HttpServletRequest.class); @@ -243,11 +199,7 @@ public class HttpUtilTest HttpUtil.createForwardedBaseUrl(request); } - /** - * Method description - * - */ - @Test + @Test public void testCreateForwardedUrlWithPortAndProtoFromRequest() { HttpServletRequest request = mock(HttpServletRequest.class); @@ -261,11 +213,7 @@ public class HttpUtilTest HttpUtil.createForwardedBaseUrl(request)); } - /** - * Method description - * - */ - @Test + @Test public void testCreateForwardedUrlWithPortInHost() { HttpServletRequest request = mock(HttpServletRequest.class); @@ -279,11 +227,7 @@ public class HttpUtilTest HttpUtil.createForwardedBaseUrl(request)); } - /** - * Method description - * - */ - @Test + @Test public void testCreateForwardedUrlWithPortInHostAndPortHeader() { HttpServletRequest request = mock(HttpServletRequest.class); @@ -298,11 +242,7 @@ public class HttpUtilTest HttpUtil.createForwardedBaseUrl(request)); } - /** - * Method description - * - */ - @Test + @Test public void testGetCompleteUrl() { HttpServletRequest request = mock(HttpServletRequest.class); @@ -321,11 +261,7 @@ public class HttpUtilTest HttpUtil.getCompleteUrl(request)); } - /** - * Method description - * - */ - @Test + @Test public void testIsForwarded() { HttpServletRequest request = mock(HttpServletRequest.class); @@ -337,11 +273,7 @@ public class HttpUtilTest assertTrue(HttpUtil.isForwarded(request)); } - /** - * Method description - * - */ - @Test + @Test public void testRemoveCRLFInjectionChars() { assertEquals("any0D0A", HttpUtil.removeCRLFInjectionChars("any%0D%0A")); @@ -353,11 +285,7 @@ public class HttpUtilTest } - /** - * Method description - * - */ - @Test + @Test public void userAgentStartsWithTest() { HttpServletRequest request = mock(HttpServletRequest.class); @@ -370,13 +298,8 @@ public class HttpUtilTest assertFalse(HttpUtil.userAgentStartsWith(request, "sobbo/")); } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - */ - @Test + @Test public void getCompleteUrlTest() { ScmConfiguration config = new ScmConfiguration(); @@ -392,11 +315,7 @@ public class HttpUtilTest HttpUtil.getCompleteUrl(config, "/test/path")); } - /** - * Method description - * - */ - @Test + @Test public void getPortFromUrlTest() { assertThat(HttpUtil.getPortFromUrl("http://www.scm-manager.org")).isEqualTo(80); @@ -405,11 +324,7 @@ public class HttpUtilTest assertThat(HttpUtil.getPortFromUrl("http://www.scm-manager.org:8181/test/folder")).isEqualTo(8181); } - /** - * Method description - * - */ - @Test + @Test public void getServerPortTest() { HttpServletRequest request = mock(HttpServletRequest.class); @@ -423,11 +338,7 @@ public class HttpUtilTest assertThat(HttpUtil.getServerPort(config, request)).isEqualTo(8080); } - /** - * Method description - * - */ - @Test + @Test public void getStrippedURITest() { HttpServletRequest request = mock(HttpServletRequest.class); @@ -439,11 +350,7 @@ public class HttpUtilTest assertEquals("/test/path", HttpUtil.getStrippedURI(request)); } - /** - * Method description - * - */ - @Test + @Test public void getUriWithoutEndSeperatorTest() { assertEquals("/test", HttpUtil.getUriWithoutEndSeperator("/test/")); @@ -452,11 +359,7 @@ public class HttpUtilTest HttpUtil.getUriWithoutEndSeperator("/test/two/three")); } - /** - * Method description - * - */ - @Test + @Test public void getUriWithoutStartSeperator() { assertEquals("test/", HttpUtil.getUriWithoutStartSeperator("/test/")); diff --git a/scm-core/src/test/java/sonia/scm/util/IOUtilTest.java b/scm-core/src/test/java/sonia/scm/util/IOUtilTest.java index f94c3c879d..a857277a39 100644 --- a/scm-core/src/test/java/sonia/scm/util/IOUtilTest.java +++ b/scm-core/src/test/java/sonia/scm/util/IOUtilTest.java @@ -24,7 +24,6 @@ package sonia.scm.util; -//~--- non-JDK imports -------------------------------------------------------- import org.junit.Test; @@ -32,24 +31,14 @@ import static org.junit.Assert.*; import static org.mockito.Mockito.*; -//~--- JDK imports ------------------------------------------------------------ - import java.io.File; import java.io.IOException; -/** - * - * @author Sebastian Sdorra - */ + public class IOUtilTest { - /** - * Method description - * - * - * @throws IOException - */ + @Test public void testIsChild() throws IOException { @@ -63,16 +52,7 @@ public class IOUtilTest assertFalse(isChild("/tmp/test", "/asd/a/b")); } - /** - * Method description - * - * - * @param canonicalPath - * - * @return - * - * @throws IOException - */ + private File createMockFile(String canonicalPath) throws IOException { File file = mock(File.class); @@ -82,7 +62,6 @@ public class IOUtilTest return file; } - //~--- get methods ---------------------------------------------------------- /** * Method description diff --git a/scm-core/src/test/java/sonia/scm/util/LinkTextParserTest.java b/scm-core/src/test/java/sonia/scm/util/LinkTextParserTest.java index 8bd841c803..74660ec6fc 100644 --- a/scm-core/src/test/java/sonia/scm/util/LinkTextParserTest.java +++ b/scm-core/src/test/java/sonia/scm/util/LinkTextParserTest.java @@ -24,28 +24,18 @@ package sonia.scm.util; -//~--- non-JDK imports -------------------------------------------------------- import org.junit.Test; import static org.junit.Assert.*; -//~--- JDK imports ------------------------------------------------------------ - import java.text.MessageFormat; -/** - * - * @author Sebastian Sdorra - */ + public class LinkTextParserTest { - /** - * Method description - * - */ - @Test + @Test public void complexUrlParseTextTest() { assertEquals(createLink("http://www.scm-manager.org/test/"), @@ -73,11 +63,7 @@ public class LinkTextParserTest "http://www.scm-manager.org/test/index.html#hashparam;otherHash")); } - /** - * Method description - * - */ - @Test + @Test public void simpleParseTextTest() { assertEquals( @@ -104,29 +90,14 @@ public class LinkTextParserTest "The page www.scm-manager.org is the home of scm-manager")); } - /** - * Method description - * - * - * @param href - * - * @return - */ + private String createLink(String href) { return MessageFormat.format("{0}", href, href); } - /** - * Method description - * - * - * @param href - * @param content - * - * @return - */ + private String createLink(String href, String content) { return MessageFormat.format("{0}", diff --git a/scm-core/src/test/java/sonia/scm/util/UrlBuilderTest.java b/scm-core/src/test/java/sonia/scm/util/UrlBuilderTest.java index f23bae02a9..a4b52026cc 100644 --- a/scm-core/src/test/java/sonia/scm/util/UrlBuilderTest.java +++ b/scm-core/src/test/java/sonia/scm/util/UrlBuilderTest.java @@ -24,24 +24,16 @@ package sonia.scm.util; -//~--- non-JDK imports -------------------------------------------------------- import org.junit.Test; import static org.junit.Assert.*; -/** - * - * @author Sebastian Sdorra - */ + public class UrlBuilderTest { - /** - * Method description - * - */ - @Test + @Test public void testAppendParameter() { UrlBuilder builder = new UrlBuilder("http://www.short.de"); @@ -53,11 +45,7 @@ public class UrlBuilderTest assertEquals("http://www.short.de?i=123&s=abc&b=true&l=321&c=a%20b", builder.toString()); } - /** - * Method description - * - */ - @Test + @Test public void testAppendUrlPart() { UrlBuilder builder = new UrlBuilder("http://www.short.de"); @@ -66,11 +54,7 @@ public class UrlBuilderTest assertEquals("http://www.short.de/test", builder.toString()); } - /** - * Method description - * - */ - @Test(expected = IllegalStateException.class) + @Test(expected = IllegalStateException.class) public void testState() { UrlBuilder builder = new UrlBuilder("http://www.short.de"); diff --git a/scm-core/src/test/java/sonia/scm/util/ValidationUtilTest.java b/scm-core/src/test/java/sonia/scm/util/ValidationUtilTest.java index 1d6a51e048..53ccc4b6a8 100644 --- a/scm-core/src/test/java/sonia/scm/util/ValidationUtilTest.java +++ b/scm-core/src/test/java/sonia/scm/util/ValidationUtilTest.java @@ -31,9 +31,7 @@ import org.junit.jupiter.params.provider.ValueSource; import static org.junit.jupiter.api.Assertions.assertFalse; import static org.junit.jupiter.api.Assertions.assertTrue; -/** - * @author Sebastian Sdorra - */ + class ValidationUtilTest { @ParameterizedTest diff --git a/scm-core/src/test/java/sonia/scm/util/XmlUtilTest.java b/scm-core/src/test/java/sonia/scm/util/XmlUtilTest.java index b27c5e1ccd..66bead0bd9 100644 --- a/scm-core/src/test/java/sonia/scm/util/XmlUtilTest.java +++ b/scm-core/src/test/java/sonia/scm/util/XmlUtilTest.java @@ -24,7 +24,6 @@ package sonia.scm.util; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.collect.Multimap; import com.google.common.io.Resources; @@ -35,26 +34,16 @@ import static org.hamcrest.Matchers.*; import static org.junit.Assert.*; -//~--- JDK imports ------------------------------------------------------------ - import java.io.IOException; import java.io.InputStream; import java.net.URL; -/** - * - * @author Sebastian Sdorra - */ + public class XmlUtilTest { - /** - * Method description - * - * - * @throws IOException - */ + @Test public void testValues() throws IOException { diff --git a/scm-core/src/test/java/sonia/scm/version/VersionTest.java b/scm-core/src/test/java/sonia/scm/version/VersionTest.java index db96e76163..8ae02e1d77 100644 --- a/scm-core/src/test/java/sonia/scm/version/VersionTest.java +++ b/scm-core/src/test/java/sonia/scm/version/VersionTest.java @@ -32,9 +32,7 @@ import java.util.Arrays; import static org.assertj.core.api.Assertions.assertThat; import static org.junit.jupiter.api.Assertions.assertThrows; -/** - * @author Sebastian Sdorra - */ + class VersionTest { @Test diff --git a/scm-core/src/test/java/sonia/scm/web/UserAgentParserTest.java b/scm-core/src/test/java/sonia/scm/web/UserAgentParserTest.java index 42147873da..a7d95ee4a9 100644 --- a/scm-core/src/test/java/sonia/scm/web/UserAgentParserTest.java +++ b/scm-core/src/test/java/sonia/scm/web/UserAgentParserTest.java @@ -24,7 +24,6 @@ package sonia.scm.web; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Charsets; import com.google.common.collect.Sets; @@ -53,19 +52,12 @@ import static org.mockito.Mockito.when; public class UserAgentParserTest { - /** Field description */ private static final String UA_1 = "mozilla/5.0"; - /** Field description */ private static final String UA_2 = "wget/1.5.3"; - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - */ - @Before + @Before public void prepare() { Set providers = Sets.newHashSet(provider1, provider2); @@ -73,11 +65,7 @@ public class UserAgentParserTest parser = new UserAgentParser(providers, cacheManager); } - /** - * Method description - * - */ - @Test + @Test public void testDefaultValues() { UserAgent ua = parser.parse(UA_1); @@ -86,11 +74,7 @@ public class UserAgentParserTest assertFalse(ua.isBrowser()); } - /** - * Method description - * - */ - @Test + @Test public void testParse() { UserAgent ua = UserAgent.other("UA1").build(); @@ -105,11 +89,7 @@ public class UserAgentParserTest assertEquals(ua2, parser.parse(UA_2)); } - /** - * Method description - * - */ - @Test + @Test public void testParseHttpServletRequest() { when(request.getHeader(HttpUtil.HEADER_USERAGENT)).thenReturn(UA_2); @@ -120,22 +100,14 @@ public class UserAgentParserTest assertEquals(ua, parser.parse(request)); } - /** - * Method description - * - */ - @Test + @Test public void testParseNotFound() { assertEquals(UserAgentParser.UNKNOWN, parser.parse(UA_1)); assertEquals(UserAgentParser.UNKNOWN, parser.parse(UA_2)); } - /** - * Method description - * - */ - @Test + @Test public void testParseWithCache() { UserAgent ua = UserAgent.other("UA").build(); @@ -147,26 +119,20 @@ public class UserAgentParserTest //~--- fields --------------------------------------------------------------- - /** Field description */ @Mock private Cache cache; - /** Field description */ @Mock private CacheManager cacheManager; - /** Field description */ private UserAgentParser parser; - /** Field description */ @Mock private UserAgentProvider provider1; - /** Field description */ @Mock private UserAgentProvider provider2; - /** Field description */ @Mock private HttpServletRequest request; } diff --git a/scm-core/src/test/java/sonia/scm/xml/IndentXMLStreamWriterTest.java b/scm-core/src/test/java/sonia/scm/xml/IndentXMLStreamWriterTest.java index 1ba8f05cb5..26513ae166 100644 --- a/scm-core/src/test/java/sonia/scm/xml/IndentXMLStreamWriterTest.java +++ b/scm-core/src/test/java/sonia/scm/xml/IndentXMLStreamWriterTest.java @@ -24,7 +24,6 @@ package sonia.scm.xml; -//~--- non-JDK imports -------------------------------------------------------- import org.junit.Assert; import org.junit.Test; @@ -34,19 +33,11 @@ import javax.xml.stream.XMLStreamException; import javax.xml.stream.XMLStreamWriter; import java.io.ByteArrayOutputStream; -/** - * - * @author Sebastian Sdorra - */ + public class IndentXMLStreamWriterTest { - /** - * Method description - * - * - * @throws XMLStreamException - */ + @Test public void testIndent() throws XMLStreamException { diff --git a/scm-dao-xml/src/main/java/sonia/scm/group/xml/XmlGroupDAO.java b/scm-dao-xml/src/main/java/sonia/scm/group/xml/XmlGroupDAO.java index af4a307375..2f150a1ad7 100644 --- a/scm-dao-xml/src/main/java/sonia/scm/group/xml/XmlGroupDAO.java +++ b/scm-dao-xml/src/main/java/sonia/scm/group/xml/XmlGroupDAO.java @@ -24,7 +24,6 @@ package sonia.scm.group.xml; -//~--- non-JDK imports -------------------------------------------------------- import com.google.inject.Inject; import com.google.inject.Singleton; @@ -35,26 +34,16 @@ import sonia.scm.xml.AbstractXmlDAO; import sonia.scm.store.ConfigurationStoreFactory; -/** - * - * @author Sebastian Sdorra - */ + @Singleton public class XmlGroupDAO extends AbstractXmlDAO implements GroupDAO { - /** Field description */ public static final String STORE_NAME = "groups"; - //~--- constructors --------------------------------------------------------- - /** - * Constructs ... - * - * - * @param storeFactory - */ + @Inject public XmlGroupDAO(ConfigurationStoreFactory storeFactory) { super(storeFactory @@ -63,28 +52,15 @@ public class XmlGroupDAO extends AbstractXmlDAO .build()); } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param group - * - * @return - */ + @Override protected Group clone(Group group) { return group.clone(); } - /** - * Method description - * - * - * @return - */ + @Override protected XmlGroupDatabase createNewDatabase() { diff --git a/scm-dao-xml/src/main/java/sonia/scm/group/xml/XmlGroupDatabase.java b/scm-dao-xml/src/main/java/sonia/scm/group/xml/XmlGroupDatabase.java index 7f482a9c93..63fabdc5e9 100644 --- a/scm-dao-xml/src/main/java/sonia/scm/group/xml/XmlGroupDatabase.java +++ b/scm-dao-xml/src/main/java/sonia/scm/group/xml/XmlGroupDatabase.java @@ -37,20 +37,20 @@ import java.util.Collection; import java.util.Map; import java.util.TreeMap; -/** - * - * @author Sebastian Sdorra - */ + @AuditEntry(ignore = true) @XmlRootElement(name = "group-db") @XmlAccessorType(XmlAccessType.FIELD) public class XmlGroupDatabase implements XmlDatabase { + private Long creationTime; + + @XmlJavaTypeAdapter(XmlGroupMapAdapter.class) + @XmlElement(name = "groups") + private Map groupMap = new TreeMap<>(); + + private Long lastModified; - /** - * Constructs ... - * - */ public XmlGroupDatabase() { long c = System.currentTimeMillis(); @@ -59,136 +59,70 @@ public class XmlGroupDatabase implements XmlDatabase lastModified = c; } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param group - */ + @Override public void add(Group group) { groupMap.put(group.getName(), group); } - /** - * Method description - * - * - * @param groupname - * - * @return - */ + @Override public boolean contains(String groupname) { return groupMap.containsKey(groupname); } - /** - * Method description - * - * - * @param groupname - * - * @return - */ + @Override public Group remove(String groupname) { return groupMap.remove(groupname); } - /** - * Method description - * - * - * @return - */ + @Override public Collection values() { return groupMap.values(); } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param groupname - * - * @return - */ + @Override public Group get(String groupname) { return groupMap.get(groupname); } - /** - * Method description - * - * - * @return - */ + @Override public long getCreationTime() { return creationTime; } - /** - * Method description - * - * - * @return - */ + @Override public long getLastModified() { return lastModified; } - //~--- set methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param creationTime - */ + @Override public void setCreationTime(long creationTime) { this.creationTime = creationTime; } - /** - * Method description - * - * - * @param lastModified - */ + @Override public void setLastModified(long lastModified) { this.lastModified = lastModified; } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private Long creationTime; - - /** Field description */ - @XmlJavaTypeAdapter(XmlGroupMapAdapter.class) - @XmlElement(name = "groups") - private Map groupMap = new TreeMap<>(); - - /** Field description */ - private Long lastModified; } diff --git a/scm-dao-xml/src/main/java/sonia/scm/group/xml/XmlGroupList.java b/scm-dao-xml/src/main/java/sonia/scm/group/xml/XmlGroupList.java index eb780bdd28..efedcc6e4c 100644 --- a/scm-dao-xml/src/main/java/sonia/scm/group/xml/XmlGroupList.java +++ b/scm-dao-xml/src/main/java/sonia/scm/group/xml/XmlGroupList.java @@ -24,7 +24,6 @@ package sonia.scm.group.xml; -//~--- non-JDK imports -------------------------------------------------------- import jakarta.xml.bind.annotation.XmlAccessType; import jakarta.xml.bind.annotation.XmlAccessorType; @@ -36,76 +35,42 @@ import java.util.Iterator; import java.util.LinkedList; import java.util.Map; -/** - * - * @author Sebastian Sdorra - */ + @XmlRootElement(name = "groups") @XmlAccessorType(XmlAccessType.FIELD) public class XmlGroupList implements Iterable { + @XmlElement(name = "group") + private LinkedList groups; - /** - * Constructs ... - * - */ public XmlGroupList() {} - /** - * Constructs ... - * - * - * - * @param groupMap - */ + public XmlGroupList(Map groupMap) { this.groups = new LinkedList<>(groupMap.values()); } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + @Override public Iterator iterator() { return groups.iterator(); } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + public LinkedList getGroups() { return groups; } - //~--- set methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param groups - */ + public void setGroups(LinkedList groups) { this.groups = groups; } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - @XmlElement(name = "group") - private LinkedList groups; } diff --git a/scm-dao-xml/src/main/java/sonia/scm/group/xml/XmlGroupMapAdapter.java b/scm-dao-xml/src/main/java/sonia/scm/group/xml/XmlGroupMapAdapter.java index 85e7d2ed63..afd428e993 100644 --- a/scm-dao-xml/src/main/java/sonia/scm/group/xml/XmlGroupMapAdapter.java +++ b/scm-dao-xml/src/main/java/sonia/scm/group/xml/XmlGroupMapAdapter.java @@ -30,40 +30,19 @@ import sonia.scm.group.Group; import java.util.Map; import java.util.TreeMap; -/** - * - * @author Sebastian Sdorra - */ + public class XmlGroupMapAdapter extends XmlAdapter> { - /** - * Method description - * - * - * @param groupMap - * - * @return - * - * @throws Exception - */ + @Override public XmlGroupList marshal(Map groupMap) throws Exception { return new XmlGroupList(groupMap); } - /** - * Method description - * - * - * @param groups - * - * @return - * - * @throws Exception - */ + @Override public Map unmarshal(XmlGroupList groups) throws Exception { diff --git a/scm-dao-xml/src/main/java/sonia/scm/repository/xml/XmlRepositoryDAO.java b/scm-dao-xml/src/main/java/sonia/scm/repository/xml/XmlRepositoryDAO.java index ff9e646a5c..702c0bee1d 100644 --- a/scm-dao-xml/src/main/java/sonia/scm/repository/xml/XmlRepositoryDAO.java +++ b/scm-dao-xml/src/main/java/sonia/scm/repository/xml/XmlRepositoryDAO.java @@ -24,7 +24,6 @@ package sonia.scm.repository.xml; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.collect.ImmutableList; import com.google.inject.Singleton; @@ -54,9 +53,7 @@ import java.util.concurrent.locks.ReentrantReadWriteLock; import java.util.function.Supplier; import java.util.stream.Collectors; -/** - * @author Sebastian Sdorra - */ + @Singleton @Slf4j public class XmlRepositoryDAO implements RepositoryDAO { diff --git a/scm-dao-xml/src/main/java/sonia/scm/store/FileBasedStore.java b/scm-dao-xml/src/main/java/sonia/scm/store/FileBasedStore.java index 480b74f31b..b4db4c03a3 100644 --- a/scm-dao-xml/src/main/java/sonia/scm/store/FileBasedStore.java +++ b/scm-dao-xml/src/main/java/sonia/scm/store/FileBasedStore.java @@ -24,7 +24,6 @@ package sonia.scm.store; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Preconditions; import com.google.common.base.Strings; @@ -32,34 +31,18 @@ import com.google.common.base.Strings; import org.slf4j.Logger; import org.slf4j.LoggerFactory; -//~--- JDK imports ------------------------------------------------------------ - import java.io.File; -/** - * - * @author Sebastian Sdorra - * - * @param - */ + public abstract class FileBasedStore implements MultiEntryStore { - /** - * the logger for FileBasedStore - */ + private static final Logger logger = LoggerFactory.getLogger(FileBasedStore.class); - //~--- constructors --------------------------------------------------------- - /** - * Constructs ... - * - * - * @param directory - * @param suffix - */ + public FileBasedStore(File directory, String suffix, boolean readOnly) { this.directory = directory; @@ -67,23 +50,11 @@ public abstract class FileBasedStore implements MultiEntryStore this.readOnly = readOnly; } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param file - * - * @return - */ + protected abstract T read(File file); - /** - * Method description - * - */ - @Override + @Override public void clear() { logger.debug("clear store"); @@ -94,12 +65,7 @@ public abstract class FileBasedStore implements MultiEntryStore } } - /** - * Method description - * - * - * @param id - */ + @Override public void remove(String id) { @@ -112,16 +78,8 @@ public abstract class FileBasedStore implements MultiEntryStore remove(file); } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param id - * - * @return - */ + @Override public T get(String id) { @@ -134,14 +92,8 @@ public abstract class FileBasedStore implements MultiEntryStore return read(file); } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param file - */ + protected void remove(File file) { logger.trace("delete store entry {}", file); @@ -155,16 +107,8 @@ public abstract class FileBasedStore implements MultiEntryStore } } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param id - * - * @return - */ + protected File getFile(String id) { Preconditions.checkArgument(!Strings.isNullOrEmpty(id), @@ -173,14 +117,7 @@ public abstract class FileBasedStore implements MultiEntryStore return new File(directory, id.concat(suffix)); } - /** - * Method description - * - * - * @param file - * - * @return - */ + protected String getId(File file) { String name = file.getName(); @@ -196,10 +133,8 @@ public abstract class FileBasedStore implements MultiEntryStore //~--- fields --------------------------------------------------------------- - /** Field description */ protected File directory; - /** Field description */ private final String suffix; private final boolean readOnly; diff --git a/scm-dao-xml/src/main/java/sonia/scm/store/FileBasedStoreFactory.java b/scm-dao-xml/src/main/java/sonia/scm/store/FileBasedStoreFactory.java index 46796181fc..91a4f11647 100644 --- a/scm-dao-xml/src/main/java/sonia/scm/store/FileBasedStoreFactory.java +++ b/scm-dao-xml/src/main/java/sonia/scm/store/FileBasedStoreFactory.java @@ -24,7 +24,6 @@ package sonia.scm.store; -//~--- non-JDK imports -------------------------------------------------------- import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -36,12 +35,9 @@ import sonia.scm.util.IOUtil; import java.io.File; import java.nio.file.Path; -//~--- JDK imports ------------------------------------------------------------ - /** * Abstract store factory for file based stores. * - * @author Sebastian Sdorra */ public abstract class FileBasedStoreFactory { diff --git a/scm-dao-xml/src/main/java/sonia/scm/store/FileBlob.java b/scm-dao-xml/src/main/java/sonia/scm/store/FileBlob.java index 3570fa0eeb..f2a0ada07f 100644 --- a/scm-dao-xml/src/main/java/sonia/scm/store/FileBlob.java +++ b/scm-dao-xml/src/main/java/sonia/scm/store/FileBlob.java @@ -24,7 +24,7 @@ package sonia.scm.store; -//~--- JDK imports ------------------------------------------------------------ + import java.io.File; import java.io.FileInputStream; import java.io.FileNotFoundException; @@ -36,7 +36,6 @@ import java.io.OutputStream; /** * File base implementation of {@link Blob}. * - * @author Sebastian Sdorra */ public final class FileBlob implements Blob { diff --git a/scm-dao-xml/src/main/java/sonia/scm/store/FileBlobStore.java b/scm-dao-xml/src/main/java/sonia/scm/store/FileBlobStore.java index 9345cdbde9..ab97ec408b 100644 --- a/scm-dao-xml/src/main/java/sonia/scm/store/FileBlobStore.java +++ b/scm-dao-xml/src/main/java/sonia/scm/store/FileBlobStore.java @@ -24,7 +24,6 @@ package sonia.scm.store; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Preconditions; import com.google.common.base.Strings; import com.google.common.collect.ImmutableList; @@ -35,7 +34,7 @@ import org.slf4j.LoggerFactory; import sonia.scm.security.KeyGenerator; -//~--- JDK imports ------------------------------------------------------------ + import java.io.File; import java.io.IOException; @@ -44,13 +43,10 @@ import java.util.List; /** * File based implementation of {@link BlobStore}. * - * @author Sebastian Sdorra */ public class FileBlobStore extends FileBasedStore implements BlobStore { - /** - * the logger for FileBlobStore - */ + private static final Logger LOG = LoggerFactory.getLogger(FileBlobStore.class); diff --git a/scm-dao-xml/src/main/java/sonia/scm/store/FileBlobStoreFactory.java b/scm-dao-xml/src/main/java/sonia/scm/store/FileBlobStoreFactory.java index 70d4e33943..68bc04bff8 100644 --- a/scm-dao-xml/src/main/java/sonia/scm/store/FileBlobStoreFactory.java +++ b/scm-dao-xml/src/main/java/sonia/scm/store/FileBlobStoreFactory.java @@ -24,7 +24,6 @@ package sonia.scm.store; -//~--- non-JDK imports -------------------------------------------------------- import com.google.inject.Inject; import com.google.inject.Singleton; @@ -39,19 +38,12 @@ import java.io.File; /** * File based store factory. * - * @author Sebastian Sdorra */ @Singleton public class FileBlobStoreFactory extends FileBasedStoreFactory implements BlobStoreFactory { private final KeyGenerator keyGenerator; - /** - * Constructs a new instance. - * - * @param repositoryLocationResolver location resolver - * @param keyGenerator key generator - */ @Inject public FileBlobStoreFactory(SCMContextProvider contextProvider , RepositoryLocationResolver repositoryLocationResolver, KeyGenerator keyGenerator, RepositoryReadOnlyChecker readOnlyChecker) { super(contextProvider, repositoryLocationResolver, Store.BLOB, readOnlyChecker); diff --git a/scm-dao-xml/src/main/java/sonia/scm/store/JAXBConfigurationEntryStore.java b/scm-dao-xml/src/main/java/sonia/scm/store/JAXBConfigurationEntryStore.java index 865c7033ed..fdae9714f9 100644 --- a/scm-dao-xml/src/main/java/sonia/scm/store/JAXBConfigurationEntryStore.java +++ b/scm-dao-xml/src/main/java/sonia/scm/store/JAXBConfigurationEntryStore.java @@ -50,9 +50,7 @@ public class JAXBConfigurationEntryStore implements ConfigurationEntryStore - * @author Sebastian Sdorra */ public class JAXBConfigurationStore extends AbstractStore { - /** - * the logger for JAXBConfigurationStore - */ + private static final Logger LOG = LoggerFactory.getLogger(JAXBConfigurationStore.class); private final TypedStoreContext context; @@ -59,11 +56,6 @@ public class JAXBConfigurationStore extends AbstractStore { this.configFile = configFile; } - /** - * Returns type of stored object. - * - * @return type - */ public Class getType() { return type; } diff --git a/scm-dao-xml/src/main/java/sonia/scm/store/JAXBConfigurationStoreFactory.java b/scm-dao-xml/src/main/java/sonia/scm/store/JAXBConfigurationStoreFactory.java index bee8708f79..12886f3780 100644 --- a/scm-dao-xml/src/main/java/sonia/scm/store/JAXBConfigurationStoreFactory.java +++ b/scm-dao-xml/src/main/java/sonia/scm/store/JAXBConfigurationStoreFactory.java @@ -35,7 +35,6 @@ import java.util.Set; /** * JAXB implementation of {@link ConfigurationStoreFactory}. * - * @author Sebastian Sdorra */ @Singleton public class JAXBConfigurationStoreFactory extends FileBasedStoreFactory implements ConfigurationStoreFactory { @@ -44,11 +43,6 @@ public class JAXBConfigurationStoreFactory extends FileBasedStoreFactory impleme private final StoreCache> storeCache; - /** - * Constructs a new instance. - * - * @param repositoryLocationResolver Resolver to get the repository Directory - */ @Inject public JAXBConfigurationStoreFactory( SCMContextProvider contextProvider, diff --git a/scm-dao-xml/src/main/java/sonia/scm/store/JAXBDataStore.java b/scm-dao-xml/src/main/java/sonia/scm/store/JAXBDataStore.java index af7a27a647..409f4d97e2 100644 --- a/scm-dao-xml/src/main/java/sonia/scm/store/JAXBDataStore.java +++ b/scm-dao-xml/src/main/java/sonia/scm/store/JAXBDataStore.java @@ -43,13 +43,10 @@ import static sonia.scm.store.CopyOnWrite.compute; * Jaxb implementation of {@link DataStore}. * * @param type of stored data. - * @author Sebastian Sdorra */ public class JAXBDataStore extends FileBasedStore implements DataStore { - /** - * the logger for JAXBDataStore - */ + private static final Logger LOG = LoggerFactory.getLogger(JAXBDataStore.class); private final KeyGenerator keyGenerator; diff --git a/scm-dao-xml/src/main/java/sonia/scm/store/JAXBDataStoreFactory.java b/scm-dao-xml/src/main/java/sonia/scm/store/JAXBDataStoreFactory.java index 2ada93ed81..9f27698095 100644 --- a/scm-dao-xml/src/main/java/sonia/scm/store/JAXBDataStoreFactory.java +++ b/scm-dao-xml/src/main/java/sonia/scm/store/JAXBDataStoreFactory.java @@ -34,10 +34,7 @@ import sonia.scm.util.IOUtil; import java.io.File; -/** - * - * @author Sebastian Sdorra - */ + @Singleton public class JAXBDataStoreFactory extends FileBasedStoreFactory implements DataStoreFactory { diff --git a/scm-dao-xml/src/main/java/sonia/scm/store/StoreConstants.java b/scm-dao-xml/src/main/java/sonia/scm/store/StoreConstants.java index 759e9b98bc..2c5038cec8 100644 --- a/scm-dao-xml/src/main/java/sonia/scm/store/StoreConstants.java +++ b/scm-dao-xml/src/main/java/sonia/scm/store/StoreConstants.java @@ -27,7 +27,6 @@ package sonia.scm.store; /** * Store constants for xml implementations. * - * @author Sebastian Sdorra */ public class StoreConstants { diff --git a/scm-dao-xml/src/main/java/sonia/scm/user/xml/XmlUserDAO.java b/scm-dao-xml/src/main/java/sonia/scm/user/xml/XmlUserDAO.java index 75e71a25f4..8735de776b 100644 --- a/scm-dao-xml/src/main/java/sonia/scm/user/xml/XmlUserDAO.java +++ b/scm-dao-xml/src/main/java/sonia/scm/user/xml/XmlUserDAO.java @@ -24,7 +24,6 @@ package sonia.scm.user.xml; -//~--- non-JDK imports -------------------------------------------------------- import com.google.inject.Inject; import com.google.inject.Singleton; @@ -33,26 +32,16 @@ import sonia.scm.user.User; import sonia.scm.user.UserDAO; import sonia.scm.xml.AbstractXmlDAO; -/** - * - * @author Sebastian Sdorra - */ + @Singleton public class XmlUserDAO extends AbstractXmlDAO implements UserDAO { - /** Field description */ public static final String STORE_NAME = "users"; - //~--- constructors --------------------------------------------------------- - /** - * Constructs ... - * - * - * @param storeFactory - */ + @Inject public XmlUserDAO(ConfigurationStoreFactory storeFactory) { @@ -62,28 +51,15 @@ public class XmlUserDAO extends AbstractXmlDAO .build()); } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param user - * - * @return - */ + @Override protected User clone(User user) { return user.clone(); } - /** - * Method description - * - * - * @return - */ + @Override protected XmlUserDatabase createNewDatabase() { diff --git a/scm-dao-xml/src/main/java/sonia/scm/user/xml/XmlUserDatabase.java b/scm-dao-xml/src/main/java/sonia/scm/user/xml/XmlUserDatabase.java index 156935c13a..c78af4a4b2 100644 --- a/scm-dao-xml/src/main/java/sonia/scm/user/xml/XmlUserDatabase.java +++ b/scm-dao-xml/src/main/java/sonia/scm/user/xml/XmlUserDatabase.java @@ -37,20 +37,20 @@ import java.util.Collection; import java.util.Map; import java.util.TreeMap; -/** - * - * @author Sebastian Sdorra - */ + @AuditEntry(ignore = true) @XmlRootElement(name = "user-db") @XmlAccessorType(XmlAccessType.FIELD) public class XmlUserDatabase implements XmlDatabase { + private Long creationTime; + + private Long lastModified; + + @XmlJavaTypeAdapter(XmlUserMapAdapter.class) + @XmlElement(name = "users") + private Map userMap = new TreeMap<>(); - /** - * Constructs ... - * - */ public XmlUserDatabase() { long c = System.currentTimeMillis(); @@ -59,136 +59,70 @@ public class XmlUserDatabase implements XmlDatabase lastModified = c; } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param user - */ + @Override public void add(User user) { userMap.put(user.getName(), user); } - /** - * Method description - * - * - * @param username - * - * @return - */ + @Override public boolean contains(String username) { return userMap.containsKey(username); } - /** - * Method description - * - * - * @param username - * - * @return - */ + @Override public User remove(String username) { return userMap.remove(username); } - /** - * Method description - * - * - * @return - */ + @Override public Collection values() { return userMap.values(); } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param username - * - * @return - */ + @Override public User get(String username) { return userMap.get(username); } - /** - * Method description - * - * - * @return - */ + @Override public long getCreationTime() { return creationTime; } - /** - * Method description - * - * - * @return - */ + @Override public long getLastModified() { return lastModified; } - //~--- set methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param creationTime - */ + @Override public void setCreationTime(long creationTime) { this.creationTime = creationTime; } - /** - * Method description - * - * - * @param lastModified - */ + @Override public void setLastModified(long lastModified) { this.lastModified = lastModified; } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private Long creationTime; - - /** Field description */ - private Long lastModified; - - /** Field description */ - @XmlJavaTypeAdapter(XmlUserMapAdapter.class) - @XmlElement(name = "users") - private Map userMap = new TreeMap<>(); } diff --git a/scm-dao-xml/src/main/java/sonia/scm/user/xml/XmlUserList.java b/scm-dao-xml/src/main/java/sonia/scm/user/xml/XmlUserList.java index aeb771162f..3ef8cb35a1 100644 --- a/scm-dao-xml/src/main/java/sonia/scm/user/xml/XmlUserList.java +++ b/scm-dao-xml/src/main/java/sonia/scm/user/xml/XmlUserList.java @@ -24,7 +24,6 @@ package sonia.scm.user.xml; -//~--- non-JDK imports -------------------------------------------------------- import jakarta.xml.bind.annotation.XmlAccessType; import jakarta.xml.bind.annotation.XmlAccessorType; @@ -36,76 +35,42 @@ import java.util.Iterator; import java.util.LinkedList; import java.util.Map; -/** - * - * @author Sebastian Sdorra - */ + @XmlRootElement(name = "users") @XmlAccessorType(XmlAccessType.FIELD) public class XmlUserList implements Iterable { + @XmlElement(name = "user") + private LinkedList users; - /** - * Constructs ... - * - */ public XmlUserList() {} - /** - * Constructs ... - * - * - * - * @param userMap - */ + public XmlUserList(Map userMap) { this.users = new LinkedList<>(userMap.values()); } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + @Override public Iterator iterator() { return users.iterator(); } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + public LinkedList getUsers() { return users; } - //~--- set methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param users - */ + public void setUsers(LinkedList users) { this.users = users; } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - @XmlElement(name = "user") - private LinkedList users; } diff --git a/scm-dao-xml/src/main/java/sonia/scm/user/xml/XmlUserMapAdapter.java b/scm-dao-xml/src/main/java/sonia/scm/user/xml/XmlUserMapAdapter.java index e6756ab597..898a7bad7b 100644 --- a/scm-dao-xml/src/main/java/sonia/scm/user/xml/XmlUserMapAdapter.java +++ b/scm-dao-xml/src/main/java/sonia/scm/user/xml/XmlUserMapAdapter.java @@ -30,40 +30,19 @@ import sonia.scm.user.User; import java.util.Map; import java.util.TreeMap; -/** - * - * @author Sebastian Sdorra - */ + public class XmlUserMapAdapter extends XmlAdapter> { - /** - * Method description - * - * - * @param userMap - * - * @return - * - * @throws Exception - */ + @Override public XmlUserList marshal(Map userMap) throws Exception { return new XmlUserList(userMap); } - /** - * Method description - * - * - * @param users - * - * @return - * - * @throws Exception - */ + @Override public Map unmarshal(XmlUserList users) throws Exception { diff --git a/scm-dao-xml/src/main/java/sonia/scm/xml/AbstractXmlDAO.java b/scm-dao-xml/src/main/java/sonia/scm/xml/AbstractXmlDAO.java index 9d69fe6d3e..aa97fb16cf 100644 --- a/scm-dao-xml/src/main/java/sonia/scm/xml/AbstractXmlDAO.java +++ b/scm-dao-xml/src/main/java/sonia/scm/xml/AbstractXmlDAO.java @@ -24,7 +24,6 @@ package sonia.scm.xml; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.collect.ImmutableList; import org.slf4j.Logger; @@ -35,37 +34,20 @@ import sonia.scm.store.ConfigurationStore; import java.util.Collection; -//~--- JDK imports ------------------------------------------------------------ - -/** - * - * @author Sebastian Sdorra - * - * @param - * @param - */ public abstract class AbstractXmlDAO> implements GenericDAO { - /** Field description */ public static final String TYPE = "xml"; - /** - * the logger for XmlGroupDAO - */ + private static final Logger logger = LoggerFactory.getLogger(AbstractXmlDAO.class); - //~--- constructors --------------------------------------------------------- + protected final ConfigurationStore store; + + protected T db; - /** - * Constructs ... - * - * - * - * @param store - */ public AbstractXmlDAO(ConfigurationStore store) { this.store = store; @@ -77,33 +59,14 @@ public abstract class AbstractXmlDAO getAll() { @@ -226,49 +147,29 @@ public abstract class AbstractXmlDAO store; - - /** Field description */ - protected T db; } diff --git a/scm-dao-xml/src/main/java/sonia/scm/xml/XmlDatabase.java b/scm-dao-xml/src/main/java/sonia/scm/xml/XmlDatabase.java index 2cf1cdb4ed..c9bb2138a8 100644 --- a/scm-dao-xml/src/main/java/sonia/scm/xml/XmlDatabase.java +++ b/scm-dao-xml/src/main/java/sonia/scm/xml/XmlDatabase.java @@ -24,102 +24,38 @@ package sonia.scm.xml; -//~--- JDK imports ------------------------------------------------------------ - import java.util.Collection; -/** - * - * @author Sebastian Sdorra - * - * @param - */ + public interface XmlDatabase { - /** - * Method description - * - * - * - * @param item - */ + public void add(T item); - /** - * Method description - * - * - * - * @param id - * - * @return - */ + public boolean contains(String id); - /** - * Method description - * - * - * - * @param id - * - * @return - */ + public T remove(String id); - /** - * Method description - * - * - * @return - */ + public Collection values(); - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * - * @param id - * - * @return - */ + public T get(String id); - /** - * Method description - * - * - * @return - */ + public long getCreationTime(); - /** - * Method description - * - * - * @return - */ + public long getLastModified(); - //~--- set methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param creationTime - */ + public void setCreationTime(long creationTime); - /** - * Method description - * - * - * @param lastModified - */ + public void setLastModified(long lastModified); } diff --git a/scm-dao-xml/src/test/java/sonia/scm/store/JAXBConfigurationEntryStoreTest.java b/scm-dao-xml/src/test/java/sonia/scm/store/JAXBConfigurationEntryStoreTest.java index f520872aef..a4023229cd 100644 --- a/scm-dao-xml/src/test/java/sonia/scm/store/JAXBConfigurationEntryStoreTest.java +++ b/scm-dao-xml/src/test/java/sonia/scm/store/JAXBConfigurationEntryStoreTest.java @@ -24,7 +24,6 @@ package sonia.scm.store; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.io.Closeables; import com.google.common.io.Resources; @@ -42,32 +41,19 @@ import java.util.UUID; import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertNotNull; -//~--- JDK imports ------------------------------------------------------------ -/** - * - * @author Sebastian Sdorra - */ public class JAXBConfigurationEntryStoreTest extends ConfigurationEntryStoreTestBase { - /** Field description */ private static final String RESOURCE_FIXED = "sonia/scm/store/fixed.format.xml"; - /** Field description */ private static final String RESOURCE_WRONG = "sonia/scm/store/wrong.format.xml"; - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @throws IOException - */ + @Test public void testLoad() throws IOException { @@ -86,12 +72,7 @@ public class JAXBConfigurationEntryStoreTest assertEquals("tuser3", a3.getName()); } - /** - * Method description - * - * - * @throws IOException - */ + @Test public void testLoadWrongFormat() throws IOException { @@ -145,27 +126,14 @@ public class JAXBConfigurationEntryStoreTest assertEquals("abc_value", storeObject.getValue()); } - /** - * Method description - * - * - * @return - */ + @Override protected ConfigurationEntryStoreFactory createConfigurationStoreFactory() { return new JAXBConfigurationEntryStoreFactory(contextProvider, repositoryLocationResolver, new UUIDKeyGenerator(), null, new StoreCacheConfigProvider(false)); } - /** - * Method description - * - * - * @param resource - * @param name - * - * @throws IOException - */ + private void copy(String resource, String name) throws IOException { URL url = Resources.getResource(resource); @@ -184,16 +152,7 @@ public class JAXBConfigurationEntryStoreTest } } - /** - * Method description - * - * - * @param resource - * - * @return - * - * @throws IOException - */ + private ConfigurationEntryStore createPermissionStore( String resource) throws IOException diff --git a/scm-dao-xml/src/test/java/sonia/scm/store/JAXBConfigurationStoreTest.java b/scm-dao-xml/src/test/java/sonia/scm/store/JAXBConfigurationStoreTest.java index af917a4f05..50855dc6b7 100644 --- a/scm-dao-xml/src/test/java/sonia/scm/store/JAXBConfigurationStoreTest.java +++ b/scm-dao-xml/src/test/java/sonia/scm/store/JAXBConfigurationStoreTest.java @@ -39,7 +39,6 @@ import static org.mockito.Mockito.when; /** * Unit tests for {@link JAXBConfigurationStore}. * - * @author Sebastian Sdorra */ public class JAXBConfigurationStoreTest extends StoreTestBase { diff --git a/scm-dao-xml/src/test/java/sonia/scm/store/JAXBDataStoreTest.java b/scm-dao-xml/src/test/java/sonia/scm/store/JAXBDataStoreTest.java index dcb78c1614..0b84460d68 100644 --- a/scm-dao-xml/src/test/java/sonia/scm/store/JAXBDataStoreTest.java +++ b/scm-dao-xml/src/test/java/sonia/scm/store/JAXBDataStoreTest.java @@ -38,10 +38,7 @@ import static org.junit.Assert.assertNotNull; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; -/** - * - * @author Sebastian Sdorra - */ + public class JAXBDataStoreTest extends DataStoreTestBase { private final RepositoryReadOnlyChecker readOnlyChecker = mock(RepositoryReadOnlyChecker.class); diff --git a/scm-it/src/test/java/sonia/scm/it/RepositoriesITCase.java b/scm-it/src/test/java/sonia/scm/it/RepositoriesITCase.java index b42cce258f..80b81d77b1 100644 --- a/scm-it/src/test/java/sonia/scm/it/RepositoriesITCase.java +++ b/scm-it/src/test/java/sonia/scm/it/RepositoriesITCase.java @@ -24,7 +24,6 @@ package sonia.scm.it; -//~--- non-JDK imports -------------------------------------------------------- import org.apache.http.HttpStatus; import org.assertj.core.api.Assertions; diff --git a/scm-it/src/test/java/sonia/scm/it/webapp/AbstractAdminITCaseBase.java b/scm-it/src/test/java/sonia/scm/it/webapp/AbstractAdminITCaseBase.java index 2d6d7e74ab..ce3686af81 100644 --- a/scm-it/src/test/java/sonia/scm/it/webapp/AbstractAdminITCaseBase.java +++ b/scm-it/src/test/java/sonia/scm/it/webapp/AbstractAdminITCaseBase.java @@ -24,16 +24,10 @@ package sonia.scm.it.webapp; -//~--- non-JDK imports -------------------------------------------------------- import static sonia.scm.it.webapp.IntegrationTestUtil.createAdminClient; -//~--- JDK imports ------------------------------------------------------------ -/** - * - * @author Sebastian Sdorra - */ public class AbstractAdminITCaseBase { public AbstractAdminITCaseBase() { @@ -42,6 +36,5 @@ public class AbstractAdminITCaseBase //~--- fields --------------------------------------------------------------- - /** Field description */ protected final ScmClient client; } diff --git a/scm-it/src/test/java/sonia/scm/it/webapp/AbstractPermissionITCaseBase.java b/scm-it/src/test/java/sonia/scm/it/webapp/AbstractPermissionITCaseBase.java index 94518e2b1d..00e20ab04b 100644 --- a/scm-it/src/test/java/sonia/scm/it/webapp/AbstractPermissionITCaseBase.java +++ b/scm-it/src/test/java/sonia/scm/it/webapp/AbstractPermissionITCaseBase.java @@ -24,7 +24,6 @@ package sonia.scm.it.webapp; -//~--- non-JDK imports -------------------------------------------------------- import jakarta.ws.rs.client.Entity; import jakarta.ws.rs.client.Invocation; @@ -46,24 +45,11 @@ import static sonia.scm.it.webapp.IntegrationTestUtil.createAdminClient; import static sonia.scm.it.webapp.IntegrationTestUtil.createResource; import static sonia.scm.it.webapp.IntegrationTestUtil.post; -//~--- JDK imports ------------------------------------------------------------ -/** - * - * @author Sebastian Sdorra - * - * @param - */ public abstract class AbstractPermissionITCaseBase { - /** - * Constructs ... - * - * - * - * @param credentials - */ + public AbstractPermissionITCaseBase(Credentials credentials) { this.credentials = credentials; @@ -75,13 +61,8 @@ public abstract class AbstractPermissionITCaseBase TestData.cleanup(); } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + + @Parameters(name = "{1}") public static Collection createParameters() { @@ -91,12 +72,7 @@ public abstract class AbstractPermissionITCaseBase ); } - /** - * Method description - * - * - */ - @BeforeClass + @BeforeClass public static void createTestUser() { User trillian = UserTestData.createTrillian(); @@ -112,86 +88,35 @@ public abstract class AbstractPermissionITCaseBase response.close(); } - /** - * Method description - * - */ @AfterClass public static void removeTestUser() { ScmClient client = createAdminClient(); createResource(client, "users/trillian").delete(); } - - - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + protected abstract String getBasePath(); - /** - * Method description - * - * - * @return - */ protected abstract T getCreateItem(); - /** - * Method description - * - * - * @return - */ protected abstract String getDeletePath(); - - /** - * Method description - * - * - * @return - */ + protected abstract String getGetPath(); - - /** - * Method description - * - * - * @return - */ + protected abstract T getModifyItem(); - - /** - * Method description - * - * - * @return - */ + protected abstract String getModifyPath(); protected abstract String getMediaType(); - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - */ - @Test + @Test public void create() { checkResponse(post(client, getBasePath(), getMediaType(), getCreateItem())); } - /** - * Method description - * - */ - @Test + @Test public void delete() { Invocation.Builder wr = createResource(client, getDeletePath()); @@ -199,11 +124,7 @@ public abstract class AbstractPermissionITCaseBase checkResponse(wr.delete(Response.class)); } - /** - * Method description - * - */ - @Test + @Test public void modify() { Invocation.Builder wr = createResource(client, getModifyPath(), getMediaType()); @@ -211,13 +132,8 @@ public abstract class AbstractPermissionITCaseBase checkResponse(wr.put(Entity.entity(getModifyItem(), getMediaType()), Response.class)); } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - */ - @Test + @Test public void get() { Invocation.Builder wr = createResource(client, getGetPath()); @@ -225,11 +141,7 @@ public abstract class AbstractPermissionITCaseBase checkGetResponse(wr.buildGet().invoke()); } - /** - * Method description - * - */ - @Test + @Test public void getAll() { Invocation.Builder wr = createResource(client, getBasePath()); @@ -237,36 +149,20 @@ public abstract class AbstractPermissionITCaseBase checkGetAllResponse(wr.buildGet().invoke()); } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param response - */ + protected void checkGetAllResponse(Response response) { checkResponse(response); } - /** - * Method description - * - * - * @param response - */ + protected void checkGetResponse(Response response) { checkResponse(response); } - /** - * Method description - * - * - * @param response - */ + private void checkResponse(Response response) { assertNotNull(response); diff --git a/scm-it/src/test/java/sonia/scm/it/webapp/Credentials.java b/scm-it/src/test/java/sonia/scm/it/webapp/Credentials.java index 6388238242..505f6a92fe 100644 --- a/scm-it/src/test/java/sonia/scm/it/webapp/Credentials.java +++ b/scm-it/src/test/java/sonia/scm/it/webapp/Credentials.java @@ -24,66 +24,36 @@ package sonia.scm.it.webapp; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.util.Util; -/** - * - * @author Sebastian Sdorra - */ + public class Credentials { - /** - * Constructs ... - * - */ public Credentials() {} - /** - * Constructs ... - * - * - * @param username - * @param password - */ + public Credentials(String username, String password) { this.password = password; this.username = username; } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + public String getPassword() { return password; } - /** - * Method description - * - * - * @return - */ + public String getUsername() { return username; } - /** - * Method description - * - * - * @return - */ + public boolean isAnonymous() { return Util.isEmpty(username) && Util.isEmpty(password); @@ -91,9 +61,7 @@ public class Credentials //~--- fields --------------------------------------------------------------- - /** Field description */ private String password; - /** Field description */ private String username; } diff --git a/scm-it/src/test/java/sonia/scm/it/webapp/GitLfsITCase.java b/scm-it/src/test/java/sonia/scm/it/webapp/GitLfsITCase.java index 64b4591ca0..7691c5c5b3 100644 --- a/scm-it/src/test/java/sonia/scm/it/webapp/GitLfsITCase.java +++ b/scm-it/src/test/java/sonia/scm/it/webapp/GitLfsITCase.java @@ -67,7 +67,6 @@ import static sonia.scm.it.webapp.RepositoryITUtil.deleteRepository; /** * Integration tests for git lfs. * - * @author Sebastian Sdorra */ public class GitLfsITCase { diff --git a/scm-it/src/test/java/sonia/scm/it/webapp/GitRepositoryPathMatcherITCase.java b/scm-it/src/test/java/sonia/scm/it/webapp/GitRepositoryPathMatcherITCase.java index 5fe017ca86..df5c64fc75 100644 --- a/scm-it/src/test/java/sonia/scm/it/webapp/GitRepositoryPathMatcherITCase.java +++ b/scm-it/src/test/java/sonia/scm/it/webapp/GitRepositoryPathMatcherITCase.java @@ -55,7 +55,6 @@ import static sonia.scm.it.webapp.RepositoryITUtil.deleteRepository; /** * Integration test for RepositoryPathMatching with ".git" and without ".git". * - * @author Sebastian Sdorra * @since 1.54 */ public class GitRepositoryPathMatcherITCase { diff --git a/scm-it/src/test/java/sonia/scm/it/webapp/IntegrationTestUtil.java b/scm-it/src/test/java/sonia/scm/it/webapp/IntegrationTestUtil.java index a32767a9a1..c271091920 100644 --- a/scm-it/src/test/java/sonia/scm/it/webapp/IntegrationTestUtil.java +++ b/scm-it/src/test/java/sonia/scm/it/webapp/IntegrationTestUtil.java @@ -24,7 +24,6 @@ package sonia.scm.it.webapp; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.io.Resources; import de.otto.edison.hal.HalRepresentation; @@ -44,21 +43,14 @@ import java.nio.charset.Charset; import java.util.ArrayList; import java.util.Collection; -//~--- JDK imports ------------------------------------------------------------ -/** - * - * @author Sebastian Sdorra - */ public final class IntegrationTestUtil { public static final Person AUTHOR = new Person("SCM Administrator", "scmadmin@scm-manager.org"); - /** Field description */ public static final String ADMIN_PASSWORD = "scmadmin"; - /** Field description */ public static final String ADMIN_USERNAME = "scmadmin"; /** scm-manager base url */ @@ -67,15 +59,9 @@ public final class IntegrationTestUtil /** scm-manager base url for the rest api */ public static final String REST_BASE_URL = BASE_URL.concat("api/v2/"); - //~--- constructors --------------------------------------------------------- - /** - * Constructs ... - * - */ private IntegrationTestUtil() {} - //~--- methods -------------------------------------------------------------- public static ScmClient createAdminClient() @@ -83,11 +69,7 @@ public final class IntegrationTestUtil return new ScmClient("scmadmin", "scmadmin"); } - /** - * Method description - * - * @return - */ + public static Client createClient() { return ClientBuilder.newBuilder().register(new CustomJacksonMapperProvider()).build(); @@ -134,14 +116,7 @@ public final class IntegrationTestUtil .post(serialize(o, mediaType)); } - /** - * Method description - * - * - * @param url - * - * @return - */ + public static URI createResourceUrl(String url) { return URI.create(REST_BASE_URL).resolve(url); diff --git a/scm-it/src/test/java/sonia/scm/it/webapp/RepositoryHookITCase.java b/scm-it/src/test/java/sonia/scm/it/webapp/RepositoryHookITCase.java index c20b5f69de..565c921a00 100644 --- a/scm-it/src/test/java/sonia/scm/it/webapp/RepositoryHookITCase.java +++ b/scm-it/src/test/java/sonia/scm/it/webapp/RepositoryHookITCase.java @@ -63,7 +63,6 @@ import static sonia.scm.it.webapp.RepositoryITUtil.deleteRepository; /** * Integration tests for repository hooks. * - * @author Sebastian Sdorra */ @RunWith(Parameterized.class) public class RepositoryHookITCase extends AbstractAdminITCaseBase diff --git a/scm-it/src/test/java/sonia/scm/it/webapp/RepositoryITUtil.java b/scm-it/src/test/java/sonia/scm/it/webapp/RepositoryITUtil.java index a0615b7867..822d9ecf8c 100644 --- a/scm-it/src/test/java/sonia/scm/it/webapp/RepositoryITUtil.java +++ b/scm-it/src/test/java/sonia/scm/it/webapp/RepositoryITUtil.java @@ -24,7 +24,6 @@ package sonia.scm.it.webapp; -//~--- non-JDK imports -------------------------------------------------------- import jakarta.ws.rs.client.Entity; import jakarta.ws.rs.client.Invocation; @@ -43,8 +42,6 @@ import static sonia.scm.it.webapp.IntegrationTestUtil.BASE_URL; import static sonia.scm.it.webapp.IntegrationTestUtil.createResource; import static sonia.scm.it.webapp.IntegrationTestUtil.getLink; -//~--- JDK imports ------------------------------------------------------------ - public final class RepositoryITUtil { diff --git a/scm-it/src/test/java/sonia/scm/it/webapp/RepositorySimplePermissionITCase.java b/scm-it/src/test/java/sonia/scm/it/webapp/RepositorySimplePermissionITCase.java index 22cad62277..b0bd2f9ade 100644 --- a/scm-it/src/test/java/sonia/scm/it/webapp/RepositorySimplePermissionITCase.java +++ b/scm-it/src/test/java/sonia/scm/it/webapp/RepositorySimplePermissionITCase.java @@ -24,7 +24,6 @@ package sonia.scm.it.webapp; -//~--- non-JDK imports -------------------------------------------------------- import de.otto.edison.hal.HalRepresentation; import jakarta.ws.rs.core.Response; @@ -44,40 +43,23 @@ import static sonia.scm.it.webapp.IntegrationTestUtil.createAdminClient; import static sonia.scm.it.webapp.IntegrationTestUtil.createResource; import static sonia.scm.it.webapp.IntegrationTestUtil.post; -//~--- JDK imports ------------------------------------------------------------ -/** - * - * @author Sebastian Sdorra - */ @RunWith(Parameterized.class) public class RepositorySimplePermissionITCase extends AbstractPermissionITCaseBase { - /** Field description */ private static String REPOSITORY_PATH; - //~--- constructors --------------------------------------------------------- - /** - * Constructs ... - * - * - * @param credentials - */ + public RepositorySimplePermissionITCase(Credentials credentials, String ignore_testCaseName) { super(credentials); } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - */ - @BeforeClass + @BeforeClass public static void createTestRepository() throws IOException { RepositoryDto repository = new RepositoryDto(); @@ -106,22 +88,13 @@ public class RepositorySimplePermissionITCase clientResponse.close(); } - /** - * Method description - * - */ - @AfterClass + @AfterClass public static void removeTestRepository() { createResource(createAdminClient(), "repositories/" + REPOSITORY_PATH).delete(); } - /** - * Method description - * - * - * @param response - */ + @Override protected void checkGetAllResponse(Response response) { @@ -138,12 +111,7 @@ public class RepositorySimplePermissionITCase } } - /** - * Method description - * - * - * @param response - */ + @Override protected void checkGetResponse(Response response) { @@ -155,26 +123,15 @@ public class RepositorySimplePermissionITCase } } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + @Override protected String getBasePath() { return "repositories"; } - /** - * Method description - * - * - * @return - */ + @Override protected RepositoryDto getCreateItem() { @@ -186,36 +143,21 @@ public class RepositorySimplePermissionITCase return repository; } - /** - * Method description - * - * - * @return - */ + @Override protected String getDeletePath() { return "repositories/".concat(REPOSITORY_PATH); } - /** - * Method description - * - * - * @return - */ + @Override protected String getGetPath() { return "repositories/".concat(REPOSITORY_PATH); } - /** - * Method description - * - * - * @return - */ + @Override protected RepositoryDto getModifyItem() { @@ -229,12 +171,7 @@ public class RepositorySimplePermissionITCase return repository; } - /** - * Method description - * - * - * @return - */ + @Override protected String getModifyPath() { diff --git a/scm-it/src/test/java/sonia/scm/it/webapp/UserPermissionITCase.java b/scm-it/src/test/java/sonia/scm/it/webapp/UserPermissionITCase.java index 1cf9be8315..aee2e4d1bb 100644 --- a/scm-it/src/test/java/sonia/scm/it/webapp/UserPermissionITCase.java +++ b/scm-it/src/test/java/sonia/scm/it/webapp/UserPermissionITCase.java @@ -24,7 +24,6 @@ package sonia.scm.it.webapp; -//~--- non-JDK imports -------------------------------------------------------- import de.otto.edison.hal.HalRepresentation; import jakarta.ws.rs.core.Response; @@ -39,81 +38,47 @@ import sonia.scm.web.VndMediaType; import static org.junit.Assert.assertNotNull; import static org.junit.Assert.assertTrue; -/** - * - * @author Sebastian Sdorra - */ + @RunWith(Parameterized.class) public class UserPermissionITCase extends AbstractPermissionITCaseBase { - /** - * Constructs ... - * - * - * @param credentials - */ + public UserPermissionITCase(Credentials credentials, String ignore_testCaseName) { super(credentials); } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + @Override protected String getBasePath() { return "users"; } - /** - * Method description - * - * - * @return - */ + @Override protected User getCreateItem() { return UserTestData.createZaphod(); } - /** - * Method description - * - * - * @return - */ + @Override protected String getDeletePath() { return "users/scmadmin"; } - /** - * Method description - * - * - * @return - */ + @Override protected String getGetPath() { return "users/scmadmin"; } - /** - * Method description - * - * - * @return - */ + @Override protected User getModifyItem() { @@ -126,12 +91,7 @@ public class UserPermissionITCase extends AbstractPermissionITCaseBase return user; } - /** - * Method description - * - * - * @return - */ + @Override protected String getModifyPath() { diff --git a/scm-plugins/scm-git-plugin/src/main/java/org/eclipse/jgit/transport/ScmTransportProtocol.java b/scm-plugins/scm-git-plugin/src/main/java/org/eclipse/jgit/transport/ScmTransportProtocol.java index 049071c538..a42b36a08c 100644 --- a/scm-plugins/scm-git-plugin/src/main/java/org/eclipse/jgit/transport/ScmTransportProtocol.java +++ b/scm-plugins/scm-git-plugin/src/main/java/org/eclipse/jgit/transport/ScmTransportProtocol.java @@ -24,7 +24,6 @@ package org.eclipse.jgit.transport; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.collect.ImmutableSet; import com.google.inject.Inject; @@ -43,11 +42,7 @@ import sonia.scm.web.GitReceiveHook; import java.io.File; import java.util.Set; -//~--- JDK imports ------------------------------------------------------------ -/** - * @author Sebastian Sdorra - */ public class ScmTransportProtocol extends TransportProtocol { public static final String NAME = "scm"; diff --git a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/GitChangesetConverter.java b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/GitChangesetConverter.java index cf7e56f9a0..75b8db2440 100644 --- a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/GitChangesetConverter.java +++ b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/GitChangesetConverter.java @@ -24,7 +24,6 @@ package sonia.scm.repository; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Strings; import com.google.common.collect.Lists; @@ -48,11 +47,7 @@ import java.util.Collections; import java.util.List; import java.util.Optional; -//~--- JDK imports ------------------------------------------------------------ -/** - * @author Sebastian Sdorra - */ public class GitChangesetConverter implements Closeable { private final GPGSignatureResolver gpg; diff --git a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/GitConfig.java b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/GitConfig.java index f3fd00538b..444873c648 100644 --- a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/GitConfig.java +++ b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/GitConfig.java @@ -24,8 +24,6 @@ package sonia.scm.repository; -//~--- JDK imports ------------------------------------------------------------ - import com.google.common.base.Strings; import jakarta.xml.bind.annotation.XmlAccessType; import jakarta.xml.bind.annotation.XmlAccessorType; @@ -34,9 +32,7 @@ import jakarta.xml.bind.annotation.XmlRootElement; import jakarta.xml.bind.annotation.XmlTransient; import sonia.scm.auditlog.AuditEntry; -/** - * @author Sebastian Sdorra - */ + @XmlRootElement(name = "config") @XmlAccessorType(XmlAccessType.FIELD) @AuditEntry(labels = {"git", "config"}) diff --git a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/GitGcTask.java b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/GitGcTask.java index ec13f05d92..493cf01729 100644 --- a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/GitGcTask.java +++ b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/GitGcTask.java @@ -41,7 +41,6 @@ import org.slf4j.LoggerFactory; * Executes git gc on every git repository. Statistics of the gc process are logged to the info level. The task is * disabled by default and must be enabled through the global git configuration. * - * @author Sebastian Sdorra * @since 1.47 */ public class GitGcTask implements Runnable { diff --git a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/GitHeadModifier.java b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/GitHeadModifier.java index ce629100c4..45a9e93883 100644 --- a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/GitHeadModifier.java +++ b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/GitHeadModifier.java @@ -38,7 +38,6 @@ import java.util.Objects; /** * The GitHeadModifier is able to modify the head of a git repository. * - * @author Sebastian Sdorra * @since 1.61 */ public class GitHeadModifier { diff --git a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/GitHealthCheck.java b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/GitHealthCheck.java index 148cb124af..9f0b074c82 100644 --- a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/GitHealthCheck.java +++ b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/GitHealthCheck.java @@ -24,63 +24,41 @@ package sonia.scm.repository; -//~--- non-JDK imports -------------------------------------------------------- import com.google.inject.Inject; import sonia.scm.plugin.Extension; -//~--- JDK imports ------------------------------------------------------------ - import java.io.File; /** * Simple {@link HealthCheck} for git repositories. * - * @author Sebastian Sdorra * @since 1.39 */ @Extension public final class GitHealthCheck extends DirectoryHealthCheck { - /** Field description */ private static final HealthCheckFailure COULD_NOT_FIND_GIT_DIRECTORIES = new HealthCheckFailure("AKOdhQ0pw1", "Could not find .git or refs directory", "The git repository does not contain a .git or a refs directory."); - /** Field description */ private static final String DIRECTORY_DOT_GIT = ".git"; - /** Field description */ private static final String DIRECTORY_REFS = "refs"; - //~--- constructors --------------------------------------------------------- - /** - * Constructs ... - * - * - * @param repositoryManager - */ + @Inject public GitHealthCheck(RepositoryManager repositoryManager) { super(repositoryManager); } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param repository - * @param directory - * - * @return - */ + @Override protected HealthCheckResult check(Repository repository, File directory) { @@ -94,7 +72,6 @@ public final class GitHealthCheck extends DirectoryHealthCheck return result; } - //~--- get methods ---------------------------------------------------------- /** * Returns {@code true} if the repository is from type git. diff --git a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/GitImportHandler.java b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/GitImportHandler.java index 068ce13720..bbd8618daa 100644 --- a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/GitImportHandler.java +++ b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/GitImportHandler.java @@ -24,71 +24,43 @@ package sonia.scm.repository; -//~--- non-JDK imports -------------------------------------------------------- import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * @author Sebastian Sdorra * @deprecated */ @Deprecated public class GitImportHandler extends AbstactImportHandler { - /** - * Field description - */ + public static final String GIT_DIR = ".git"; - /** - * Field description - */ + public static final String GIT_DIR_REFS = "refs"; - /** - * the logger for GitImportHandler - */ + private static final Logger logger = LoggerFactory.getLogger(GitImportHandler.class); - //~--- constructors --------------------------------------------------------- + private GitRepositoryHandler handler; - /** - * Constructs ... - * - * @param handler - */ public GitImportHandler(GitRepositoryHandler handler) { this.handler = handler; } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * @return - */ + @Override protected String[] getDirectoryNames() { return new String[]{GIT_DIR, GIT_DIR_REFS}; } - /** - * Method description - * - * @return - */ + @Override protected AbstractRepositoryHandler getRepositoryHandler() { return handler; } - //~--- fields --------------------------------------------------------------- - - /** - * Field description - */ - private GitRepositoryHandler handler; } diff --git a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/GitRepositoryHandler.java b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/GitRepositoryHandler.java index aeacf2c9a6..63a7eff3c6 100644 --- a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/GitRepositoryHandler.java +++ b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/GitRepositoryHandler.java @@ -24,7 +24,6 @@ package sonia.scm.repository; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Strings; import com.google.inject.Inject; @@ -44,29 +43,20 @@ import sonia.scm.store.ConfigurationStoreFactory; import java.io.File; import java.io.IOException; -//~--- JDK imports ------------------------------------------------------------ -/** - * - * @author Sebastian Sdorra - */ @Singleton @Extension public class GitRepositoryHandler extends AbstractSimpleRepositoryHandler { - /** Field description */ public static final String DIRECTORY_REFS = "refs"; - /** Field description */ public static final String RESOURCE_VERSION = "sonia/scm/version/scm-git-plugin"; - /** Field description */ public static final String TYPE_DISPLAYNAME = "Git"; - /** Field description */ public static final String TYPE_NAME = "git"; @@ -74,7 +64,6 @@ public class GitRepositoryHandler private static final Logger logger = LoggerFactory.getLogger(GitRepositoryHandler.class); - /** Field description */ public static final RepositoryType TYPE = new RepositoryType(TYPE_NAME, TYPE_DISPLAYNAME, GitRepositoryServiceProvider.COMMANDS); @@ -87,7 +76,6 @@ public class GitRepositoryHandler private Task task; - //~--- constructors --------------------------------------------------------- @Inject public GitRepositoryHandler(ConfigurationStoreFactory storeFactory, @@ -101,7 +89,6 @@ public class GitRepositoryHandler this.workingCopyFactory = workingCopyFactory; } - //~--- get methods ---------------------------------------------------------- @Override public void init(SCMContextProvider context) @@ -133,36 +120,21 @@ public class GitRepositoryHandler } } - /** - * Method description - * - * - * @return - */ + @Override public ImportHandler getImportHandler() { return new GitImportHandler(this); } - /** - * Method description - * - * - * @return - */ + @Override public RepositoryType getType() { return TYPE; } - /** - * Method description - * - * - * @return - */ + @Override public String getVersionInformation() { @@ -177,7 +149,6 @@ public class GitRepositoryHandler return new GitConfigHelper().getRepositoryId(gitConfig); } - //~--- methods -------------------------------------------------------------- @Override protected void create(Repository repository, File directory) throws IOException { @@ -196,26 +167,15 @@ public class GitRepositoryHandler .build(); } - /** - * Method description - * - * - * @return - */ + @Override protected GitConfig createInitialConfig() { return new GitConfig(); } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + @Override protected Class getConfigClass() { diff --git a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/GitRepositoryModifyListener.java b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/GitRepositoryModifyListener.java index 851a480cda..38fd806b21 100644 --- a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/GitRepositoryModifyListener.java +++ b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/GitRepositoryModifyListener.java @@ -34,7 +34,6 @@ import sonia.scm.plugin.Extension; /** * Repository listener which handles git related repository events. * - * @author Sebastian Sdorra * @since 1.50 */ @Extension diff --git a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/GitRepositoryPathMatcher.java b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/GitRepositoryPathMatcher.java index 4030c64ecf..5ce3e639b4 100644 --- a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/GitRepositoryPathMatcher.java +++ b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/GitRepositoryPathMatcher.java @@ -31,7 +31,6 @@ import sonia.scm.util.Util; /** * Matches git repositories with ".git" and without ".git". * - * @author Sebastian Sdorra * @since 1.54 */ @Extension diff --git a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/GitSubModuleParser.java b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/GitSubModuleParser.java index f7c4b03a66..789cbd634c 100644 --- a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/GitSubModuleParser.java +++ b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/GitSubModuleParser.java @@ -30,9 +30,7 @@ import java.util.HashMap; import java.util.Map; import java.util.Scanner; -/** - * @author Sebastian Sdorra - */ + public final class GitSubModuleParser { private GitSubModuleParser() { diff --git a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/GitUtil.java b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/GitUtil.java index 4f5fe7701a..bfeb7dc9ec 100644 --- a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/GitUtil.java +++ b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/GitUtil.java @@ -24,7 +24,6 @@ package sonia.scm.repository; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.annotations.VisibleForTesting; import com.google.common.base.Strings; @@ -77,11 +76,7 @@ import static java.util.Optional.empty; import static java.util.Optional.of; import static java.util.Optional.ofNullable; -//~--- JDK imports ------------------------------------------------------------ -/** - * @author Sebastian Sdorra - */ public final class GitUtil { private static final GitUserAgentProvider GIT_USER_AGENT_PROVIDER = new GitUserAgentProvider(); @@ -97,18 +92,14 @@ public final class GitUtil { private static final String REMOTE_REF = "refs/remote/scm/%s/%s"; private static final int TIMEOUT = 5; - /** - * the logger for GitUtil - */ + private static final Logger logger = LoggerFactory.getLogger(GitUtil.class); private static final String REF_SPEC = "refs/heads/*:refs/heads/*"; - //~--- constructors --------------------------------------------------------- private GitUtil() { } - //~--- methods -------------------------------------------------------------- public static void close(org.eclipse.jgit.lib.Repository repo) { if (repo != null) { @@ -118,10 +109,6 @@ public final class GitUtil { /** * TODO cache - * - * @param repository - * @param revWalk - * @return */ public static Multimap createTagMap(org.eclipse.jgit.lib.Repository repository, @@ -202,7 +189,6 @@ public final class GitUtil { } } - //~--- get methods ---------------------------------------------------------- public static String getBranch(Ref ref) { String branch = null; @@ -256,14 +242,7 @@ public final class GitUtil { } } - /** - * Method description - * - * @param repo - * @param branchName - * @return - * @throws IOException - */ + public static Ref getBranchId(org.eclipse.jgit.lib.Repository repo, String branchName) throws IOException { @@ -354,12 +333,7 @@ public final class GitUtil { return tag; } - /** - * Method description - * - * @param commit - * @return - */ + public static long getCommitTime(RevCommit commit) { long date = commit.getCommitTime(); @@ -368,12 +342,7 @@ public final class GitUtil { return date; } - /** - * Method description - * - * @param objectId - * @return - */ + public static String getId(AnyObjectId objectId) { String id = Util.EMPTY_STRING; @@ -384,14 +353,7 @@ public final class GitUtil { return id; } - /** - * Method description - * - * @param repository - * @param id - * @return - * @throws IOException - */ + public static Ref getRefForCommit(org.eclipse.jgit.lib.Repository repository, ObjectId id) throws IOException { @@ -456,14 +418,7 @@ public final class GitUtil { .findFirst(); } - /** - * Method description - * - * @param repo - * @param revision - * @return - * @throws IOException - */ + public static ObjectId getRevisionId(org.eclipse.jgit.lib.Repository repo, String revision) throws IOException { @@ -478,25 +433,12 @@ public final class GitUtil { return revId; } - /** - * Method description - * - * @param repository - * @param localBranch - * @return - */ + public static String getScmRemoteRefName(Repository repository, Ref localBranch) { return getScmRemoteRefName(repository, localBranch.getName()); } - /** - * Method description - * - * @param repository - * @param localBranch - * @return - */ public static String getScmRemoteRefName(Repository repository, String localBranch) { String branch = localBranch; @@ -524,12 +466,7 @@ public final class GitUtil { return tagName; } - /** - * Method description - * - * @param ref - * @return - */ + public static String getTagName(Ref ref) { String name = ref.getName(); @@ -580,33 +517,15 @@ public final class GitUtil { return Optional.empty(); } - /** - * Returns true if the request comes from a git client. - * - * @param request servlet request - * @return true if the client is git - */ public static boolean isGitClient(HttpServletRequest request) { return GIT_USER_AGENT_PROVIDER.parseUserAgent(request.getHeader(HttpUtil.HEADER_USERAGENT)) != null; } - /** - * Method description - * - * @param dir - * @return - */ + public static boolean isGitDirectory(File dir) { return isGitDirectory(FS.DETECTED, dir); } - /** - * Method description - * - * @param fs - * @param dir - * @return - */ public static boolean isGitDirectory(FS fs, File dir) { //J- return fs.resolve(dir, DIRECTORY_OBJETCS).exists() @@ -615,22 +534,12 @@ public final class GitUtil { //J+ } - /** - * Method description - * - * @param ref - * @return - */ + public static boolean isHead(String ref) { return ref.startsWith(REF_HEAD_PREFIX); } - /** - * Method description - * - * @param id - * @return - */ + public static boolean isValidObjectId(ObjectId id) { return (id != null) && !id.equals(ObjectId.zeroId()); } @@ -669,15 +578,7 @@ public final class GitUtil { } } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * @param repo - * @param branchName - * @throws IOException - */ @VisibleForTesting static void checkBranchName(org.eclipse.jgit.lib.Repository repo, String branchName) @@ -698,12 +599,7 @@ public final class GitUtil { } } - /** - * Method description - * - * @param repository - * @return - */ + private static RefSpec createRefSpec(Repository repository) { return new RefSpec(String.format(REFSPEC, repository.getId())); } diff --git a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/api/GitHookBranchProvider.java b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/api/GitHookBranchProvider.java index cc7da5adf1..217a973064 100644 --- a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/api/GitHookBranchProvider.java +++ b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/api/GitHookBranchProvider.java @@ -24,7 +24,6 @@ package sonia.scm.repository.api; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Strings; import com.google.common.collect.ImmutableList; @@ -35,8 +34,6 @@ import org.eclipse.jgit.transport.ReceiveCommand.Type; import sonia.scm.repository.GitUtil; -//~--- JDK imports ------------------------------------------------------------ - import java.util.List; import org.slf4j.Logger; @@ -45,19 +42,16 @@ import org.slf4j.LoggerFactory; /** * Collects created, modified and deleted git branches during a hook. * - * @author Sebastian Sdorra */ public class GitHookBranchProvider implements HookBranchProvider { private static final Logger logger = LoggerFactory.getLogger(GitHookBranchProvider.class); - /** - * Constructs a new instance. - * - * - * @param commands received git commands - */ + private final List createdOrModified; + + private final List deletedOrClosed; + public GitHookBranchProvider(List commands) { Builder createdOrModifiedBuilder = ImmutableList.builder(); @@ -91,7 +85,6 @@ public class GitHookBranchProvider implements HookBranchProvider return type == Type.CREATE || type == Type.UPDATE || type == Type.UPDATE_NONFASTFORWARD; } - //~--- get methods ---------------------------------------------------------- @Override public List getCreatedOrModified() @@ -105,9 +98,4 @@ public class GitHookBranchProvider implements HookBranchProvider return deletedOrClosed; } - //~--- fields --------------------------------------------------------------- - - private final List createdOrModified; - - private final List deletedOrClosed; } diff --git a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/api/GitHookMessageProvider.java b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/api/GitHookMessageProvider.java index b7ca70fac9..b48465b451 100644 --- a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/api/GitHookMessageProvider.java +++ b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/api/GitHookMessageProvider.java @@ -24,50 +24,30 @@ package sonia.scm.repository.api; -//~--- non-JDK imports -------------------------------------------------------- import org.eclipse.jgit.transport.ReceivePack; import sonia.scm.web.GitHooks; -/** - * - * @author Sebastian Sdorra - */ + public final class GitHookMessageProvider implements HookMessageProvider { - - /** - * Constructs ... - * - * - * @param receivePack - */ + private ReceivePack receivePack; + public GitHookMessageProvider(ReceivePack receivePack) { this.receivePack = receivePack; } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param message - */ + @Override public void sendError(String message) { GitHooks.sendPrefixedError(receivePack, message); } - /** - * Method description - * - * - * @param message - */ + @Override public void sendMessage(String message) { @@ -76,8 +56,4 @@ public final class GitHookMessageProvider implements HookMessageProvider } } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private ReceivePack receivePack; } diff --git a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/api/GitHookTagProvider.java b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/api/GitHookTagProvider.java index 0e1176e0d3..cece887173 100644 --- a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/api/GitHookTagProvider.java +++ b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/api/GitHookTagProvider.java @@ -46,7 +46,6 @@ import static sonia.scm.repository.GitUtil.getId; /** * Git provider implementation of {@link HookTagProvider}. * - * @author Sebastian Sdorra * @since 1.50 */ public class GitHookTagProvider implements HookTagProvider { @@ -56,11 +55,6 @@ public class GitHookTagProvider implements HookTagProvider { private final List createdTags; private final List deletedTags; - /** - * Constructs new instance. - * - * @param commands received commands - */ public GitHookTagProvider(List commands, Repository repository) { ImmutableList.Builder createdTagBuilder = ImmutableList.builder(); ImmutableList.Builder deletedTagBuilder = ImmutableList.builder(); diff --git a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/AbstractGitCommand.java b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/AbstractGitCommand.java index 8e29829238..4f7ede4cac 100644 --- a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/AbstractGitCommand.java +++ b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/AbstractGitCommand.java @@ -24,7 +24,6 @@ package sonia.scm.repository.spi; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Strings; import org.apache.shiro.SecurityUtils; @@ -71,37 +70,22 @@ import static sonia.scm.NotFoundException.notFound; import static sonia.scm.repository.GitUtil.getBranchIdOrCurrentHead; import static sonia.scm.repository.spi.IntegrateChangesFromWorkdirException.forMessage; -//~--- JDK imports ------------------------------------------------------------ -/** - * @author Sebastian Sdorra - */ class AbstractGitCommand { - /** - * the logger for AbstractGitCommand - */ + private static final Logger logger = LoggerFactory.getLogger(AbstractGitCommand.class); private static final Collection ACCEPTED_UPDATE_STATUS = asList(OK, UP_TO_DATE, NON_EXISTING); - /** - * Constructs ... - * - * @param context - */ + protected GitContext context; + + protected sonia.scm.repository.Repository repository; + AbstractGitCommand(GitContext context) { this.repository = context.getRepository(); this.context = context; } - //~--- methods -------------------------------------------------------------- - - /** - * Method description - * - * @return - * @throws IOException - */ Repository open() throws IOException { return context.open(); } @@ -311,16 +295,4 @@ class AbstractGitCommand { } } } - - //~--- fields --------------------------------------------------------------- - - /** - * Field description - */ - protected GitContext context; - - /** - * Field description - */ - protected sonia.scm.repository.Repository repository; } diff --git a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/AbstractGitIncomingOutgoingCommand.java b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/AbstractGitIncomingOutgoingCommand.java index 94b1451d68..f554f077d7 100644 --- a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/AbstractGitIncomingOutgoingCommand.java +++ b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/AbstractGitIncomingOutgoingCommand.java @@ -24,7 +24,6 @@ package sonia.scm.repository.spi; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.collect.Lists; import com.google.common.io.Closeables; @@ -46,55 +45,31 @@ import java.io.IOException; import java.util.List; import java.util.Map.Entry; -//~--- JDK imports ------------------------------------------------------------ -/** - * - * @author Sebastian Sdorra - */ public abstract class AbstractGitIncomingOutgoingCommand extends AbstractGitCommand { - /** Field description */ private static final String REMOTE_REF_PREFIX = "refs/remote/scm/%s/"; + private GitRepositoryHandler handler; + private final GitChangesetConverterFactory converterFactory; + AbstractGitIncomingOutgoingCommand(GitContext context, GitRepositoryHandler handler, GitChangesetConverterFactory converterFactory) { super(context); this.handler = handler; this.converterFactory = converterFactory; } - //~--- methods -------------------------------------------------------------- - - /** - * Method description - * - * - * @param logCommand - * @param localId - * @param remoteId - * - * @throws IOException - */ protected abstract void prepareLogCommand( org.eclipse.jgit.api.LogCommand logCommand, ObjectId localId, ObjectId remoteId) throws IOException; - /** - * Method description - * - * - * @param localId - * @param remoteId - * - * @return - */ + protected abstract boolean retrieveChangesets(ObjectId localId, ObjectId remoteId); - //~--- get methods ---------------------------------------------------------- protected ChangesetPagingResult getIncomingOrOutgoingChangesets(PagedRemoteCommandRequest request) throws IOException { Repository remoteRepository = request.getRemoteRepository(); @@ -192,9 +167,4 @@ public abstract class AbstractGitIncomingOutgoingCommand return ref; } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private GitRepositoryHandler handler; - private final GitChangesetConverterFactory converterFactory; } diff --git a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/GitBlameCommand.java b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/GitBlameCommand.java index 8785cad613..449ac1c58d 100644 --- a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/GitBlameCommand.java +++ b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/GitBlameCommand.java @@ -24,7 +24,6 @@ package sonia.scm.repository.spi; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Preconditions; import com.google.common.base.Strings; @@ -49,22 +48,14 @@ import java.util.List; import static sonia.scm.ContextEntry.ContextBuilder.entity; -//~--- JDK imports ------------------------------------------------------------ -/** - * - * @author Sebastian Sdorra - */ public class GitBlameCommand extends AbstractGitCommand implements BlameCommand { - /** - * the logger for GitBlameCommand - */ + private static final Logger logger = LoggerFactory.getLogger(GitBlameCommand.class); - //~--- constructors --------------------------------------------------------- @Inject public GitBlameCommand(@Assisted GitContext context) @@ -72,7 +63,6 @@ public class GitBlameCommand extends AbstractGitCommand implements BlameCommand super(context); } - //~--- get methods ---------------------------------------------------------- @Override public BlameResult getBlameResult(BlameCommandRequest request) diff --git a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/GitBrowseCommand.java b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/GitBrowseCommand.java index fbd6946079..77806841ba 100644 --- a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/GitBrowseCommand.java +++ b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/GitBrowseCommand.java @@ -76,25 +76,16 @@ import static sonia.scm.ContextEntry.ContextBuilder.entity; import static sonia.scm.NotFoundException.notFound; import static sonia.scm.repository.spi.SyncAsyncExecutor.ExecutionType.ASYNCHRONOUS; -/** - * @author Sebastian Sdorra - */ + public class GitBrowseCommand extends AbstractGitCommand implements BrowseCommand { - /** - * Field description - */ + public static final String PATH_MODULES = ".gitmodules"; - /** - * the logger for GitBrowseCommand - */ + private static final Logger logger = LoggerFactory.getLogger(GitBrowseCommand.class); - /** - * sub repository cache - */ private final Map> subrepositoryCache = Maps.newHashMap(); private final Object asyncMonitor = new Object(); diff --git a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/GitContext.java b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/GitContext.java index 175ed878b3..acf98df67a 100644 --- a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/GitContext.java +++ b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/GitContext.java @@ -38,19 +38,19 @@ import java.io.Closeable; import java.io.File; import java.io.IOException; -/** - * - * @author Sebastian Sdorra - */ + public class GitContext implements Closeable, RepositoryProvider { - - /** - * the logger for GitContext - */ private static final Logger logger = LoggerFactory.getLogger(GitContext.class); + private final File directory; + private final Repository repository; + private final GitRepositoryConfigStoreProvider storeProvider; + private final GitConfig config; + + private org.eclipse.jgit.lib.Repository gitRepository; + public GitContext(File directory, Repository repository, GitRepositoryConfigStoreProvider storeProvider, GitConfig config) { this.directory = directory; @@ -59,13 +59,8 @@ public class GitContext implements Closeable, RepositoryProvider this.config = config; } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - */ - @Override + @Override public void close() { logger.trace("close git repository {}", directory); @@ -74,14 +69,7 @@ public class GitContext implements Closeable, RepositoryProvider gitRepository = null; } - /** - * Method description - * - * - * @return - * - * @throws IOException - */ + public org.eclipse.jgit.lib.Repository open() throws IOException { if (gitRepository == null) @@ -129,14 +117,4 @@ public class GitContext implements Closeable, RepositoryProvider return config; } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private final File directory; - private final Repository repository; - private final GitRepositoryConfigStoreProvider storeProvider; - private final GitConfig config; - - /** Field description */ - private org.eclipse.jgit.lib.Repository gitRepository; } diff --git a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/GitDiffCommand.java b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/GitDiffCommand.java index a57366ada3..a4b85eab1f 100644 --- a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/GitDiffCommand.java +++ b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/GitDiffCommand.java @@ -38,9 +38,7 @@ import java.io.OutputStream; import static java.nio.charset.StandardCharsets.UTF_8; -/** - * @author Sebastian Sdorra - */ + public class GitDiffCommand extends AbstractGitCommand implements DiffCommand { @Inject diff --git a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/GitHookChangesetCollector.java b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/GitHookChangesetCollector.java index b6be9b4454..06b1d3eed3 100644 --- a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/GitHookChangesetCollector.java +++ b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/GitHookChangesetCollector.java @@ -46,9 +46,7 @@ import java.util.Map; import static java.util.Collections.unmodifiableCollection; -/** - * @author Sebastian Sdorra - */ + class GitHookChangesetCollector { private static final Logger LOG = LoggerFactory.getLogger(GitHookChangesetCollector.class); diff --git a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/GitHookChangesetProvider.java b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/GitHookChangesetProvider.java index fba8cd2cab..5f9f29d093 100644 --- a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/GitHookChangesetProvider.java +++ b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/GitHookChangesetProvider.java @@ -31,10 +31,7 @@ import sonia.scm.repository.api.HookChangesetProvider; import java.util.List; -/** - * - * @author Sebastian Sdorra - */ + public class GitHookChangesetProvider implements HookChangesetProvider { private final GitChangesetConverterFactory converterFactory; diff --git a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/GitHookContextProvider.java b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/GitHookContextProvider.java index 00f640d29f..a64e4f7e4c 100644 --- a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/GitHookContextProvider.java +++ b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/GitHookContextProvider.java @@ -24,7 +24,6 @@ package sonia.scm.repository.spi; -//~--- non-JDK imports -------------------------------------------------------- import org.eclipse.jgit.lib.Repository; import org.eclipse.jgit.transport.ReceiveCommand; @@ -46,16 +45,11 @@ import java.util.EnumSet; import java.util.List; import java.util.Set; -/** - * - * @author Sebastian Sdorra - */ + public class GitHookContextProvider extends HookContextProvider { - /** - * Field description - */ + private static final Set SUPPORTED_FEATURES = EnumSet.of( HookFeature.MESSAGE_PROVIDER, HookFeature.CHANGESET_PROVIDER, @@ -65,15 +59,9 @@ public class GitHookContextProvider extends HookContextProvider HookFeature.MERGE_DETECTION_PROVIDER ); - //~--- constructors --------------------------------------------------------- private final GitChangesetConverterFactory converterFactory; - /** - * Constructs a new instance - * @param receivePack git receive pack - * @param receiveCommands received commands - */ public GitHookContextProvider( GitChangesetConverterFactory converterFactory, ReceivePack receivePack, List receiveCommands, @@ -89,7 +77,6 @@ public class GitHookContextProvider extends HookContextProvider this.converterFactory = converterFactory; } - //~--- methods -------------------------------------------------------------- @Override public HookMessageProvider createMessageProvider() @@ -97,7 +84,6 @@ public class GitHookContextProvider extends HookContextProvider return new GitHookMessageProvider(receivePack); } - //~--- get methods ---------------------------------------------------------- @Override public HookBranchProvider getBranchProvider() diff --git a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/GitIncomingCommand.java b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/GitIncomingCommand.java index cfe54d4b39..0bd6d17148 100644 --- a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/GitIncomingCommand.java +++ b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/GitIncomingCommand.java @@ -24,7 +24,6 @@ package sonia.scm.repository.spi; -//~--- non-JDK imports -------------------------------------------------------- import com.google.inject.assistedinject.Assisted; import jakarta.inject.Inject; @@ -36,12 +35,7 @@ import sonia.scm.repository.GitRepositoryHandler; import java.io.IOException; -//~--- JDK imports ------------------------------------------------------------ -/** - * - * @author Sebastian Sdorra - */ public class GitIncomingCommand extends AbstractGitIncomingOutgoingCommand implements IncomingCommand { @@ -50,25 +44,12 @@ public class GitIncomingCommand extends AbstractGitIncomingOutgoingCommand super(context, handler, converterFactory); } - //~--- get methods ---------------------------------------------------------- @Override public ChangesetPagingResult getIncomingChangesets(IncomingCommandRequest request) throws IOException { return getIncomingOrOutgoingChangesets(request); } - //~--- methods -------------------------------------------------------------- - - /** - * Method description - * - * - * @param logCommand - * @param localId - * @param remoteId - * - * @throws IOException - */ @Override protected void prepareLogCommand(LogCommand logCommand, ObjectId localId, ObjectId remoteId) @@ -82,15 +63,7 @@ public class GitIncomingCommand extends AbstractGitIncomingOutgoingCommand logCommand.add(remoteId); } - /** - * Method description - * - * - * @param localId - * @param remoteId - * - * @return - */ + @Override protected boolean retrieveChangesets(ObjectId localId, ObjectId remoteId) { diff --git a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/GitLogCommand.java b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/GitLogCommand.java index 5470964260..f26e1430a0 100644 --- a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/GitLogCommand.java +++ b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/GitLogCommand.java @@ -24,7 +24,6 @@ package sonia.scm.repository.spi; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Strings; import com.google.inject.assistedinject.Assisted; @@ -48,32 +47,17 @@ import java.io.IOException; import static sonia.scm.ContextEntry.ContextBuilder.entity; import static sonia.scm.NotFoundException.notFound; -//~--- JDK imports ------------------------------------------------------------ -/** - * - * @author Sebastian Sdorra - */ public class GitLogCommand extends AbstractGitCommand implements LogCommand { - /** - * the logger for GitLogCommand - */ + private static final Logger logger = LoggerFactory.getLogger(GitLogCommand.class); public static final String REVISION = "Revision"; private final GitChangesetConverterFactory converterFactory; - //~--- constructors --------------------------------------------------------- - /** - * Constructs ... - * - * - * @param context - * - */ @Inject GitLogCommand(@Assisted GitContext context, GitChangesetConverterFactory converterFactory) { @@ -81,16 +65,8 @@ public class GitLogCommand extends AbstractGitCommand implements LogCommand this.converterFactory = converterFactory; } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param revision - * - * @return - */ + @Override @SuppressWarnings("java:S2093") public Changeset getChangeset(String revision, LogCommandRequest request) @@ -166,16 +142,7 @@ public class GitLogCommand extends AbstractGitCommand implements LogCommand return revWalk.parseCommit(GitUtil.getCommit(repository, revWalk, repository.findRef(branchName))); } - /** - * Method description - * - * - * @param request - * - * @return - * - * @throws IOException - */ + @Override @SuppressWarnings("java:S2093") public ChangesetPagingResult getChangesets(LogCommandRequest request) { diff --git a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/GitOutgoingCommand.java b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/GitOutgoingCommand.java index 867bdbf98d..c678818f48 100644 --- a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/GitOutgoingCommand.java +++ b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/GitOutgoingCommand.java @@ -24,7 +24,6 @@ package sonia.scm.repository.spi; -//~--- non-JDK imports -------------------------------------------------------- import com.google.inject.assistedinject.Assisted; import jakarta.inject.Inject; @@ -36,12 +35,7 @@ import sonia.scm.repository.GitRepositoryHandler; import java.io.IOException; -//~--- JDK imports ------------------------------------------------------------ -/** - * - * @author Sebastian Sdorra - */ public class GitOutgoingCommand extends AbstractGitIncomingOutgoingCommand implements OutgoingCommand { @@ -51,18 +45,8 @@ public class GitOutgoingCommand extends AbstractGitIncomingOutgoingCommand super(context, handler, converterFactory); } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param request - * - * @return - * - * @throws IOException - */ + @Override public ChangesetPagingResult getOutgoingChangesets( OutgoingCommandRequest request) @@ -71,18 +55,6 @@ public class GitOutgoingCommand extends AbstractGitIncomingOutgoingCommand return getIncomingOrOutgoingChangesets(request); } - //~--- methods -------------------------------------------------------------- - - /** - * Method description - * - * - * @param logCommand - * @param localId - * @param remoteId - * - * @throws IOException - */ @Override protected void prepareLogCommand(LogCommand logCommand, ObjectId localId, ObjectId remoteId) @@ -96,15 +68,7 @@ public class GitOutgoingCommand extends AbstractGitIncomingOutgoingCommand } } - /** - * Method description - * - * - * @param localId - * @param remoteId - * - * @return - */ + @Override protected boolean retrieveChangesets(ObjectId localId, ObjectId remoteId) { diff --git a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/GitPullCommand.java b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/GitPullCommand.java index 25c7957a5e..290ad629c6 100644 --- a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/GitPullCommand.java +++ b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/GitPullCommand.java @@ -52,9 +52,7 @@ import sonia.scm.repository.api.PullResponse; import java.io.File; import java.io.IOException; -/** - * @author Sebastian Sdorra - */ + public class GitPullCommand extends AbstractGitPushOrPullCommand implements PullCommand { diff --git a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/GitRepositoryServiceProvider.java b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/GitRepositoryServiceProvider.java index f28f9fdf7b..e26e6b3f1b 100644 --- a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/GitRepositoryServiceProvider.java +++ b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/GitRepositoryServiceProvider.java @@ -32,9 +32,7 @@ import sonia.scm.repository.api.Command; import java.util.EnumSet; import java.util.Set; -/** - * @author Sebastian Sdorra - */ + public class GitRepositoryServiceProvider extends RepositoryServiceProvider { public static final Set COMMANDS = ImmutableSet.of( @@ -71,7 +69,6 @@ public class GitRepositoryServiceProvider extends RepositoryServiceProvider { private final Injector injector; private final GitContext context; - //~--- constructors --------------------------------------------------------- GitRepositoryServiceProvider(Injector injector, GitContext context) { this.injector = injector; diff --git a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/GitRepositoryServiceResolver.java b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/GitRepositoryServiceResolver.java index 7ff06dd140..c583c58078 100644 --- a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/GitRepositoryServiceResolver.java +++ b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/GitRepositoryServiceResolver.java @@ -24,7 +24,6 @@ package sonia.scm.repository.spi; -//~--- non-JDK imports -------------------------------------------------------- import com.google.inject.Inject; import com.google.inject.Injector; @@ -32,10 +31,7 @@ import sonia.scm.plugin.Extension; import sonia.scm.repository.GitRepositoryHandler; import sonia.scm.repository.Repository; -/** - * - * @author Sebastian Sdorra - */ + @Extension public class GitRepositoryServiceResolver implements RepositoryServiceResolver { diff --git a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/GitTagsCommand.java b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/GitTagsCommand.java index 69df34b30a..98df010c0e 100644 --- a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/GitTagsCommand.java +++ b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/GitTagsCommand.java @@ -24,7 +24,6 @@ package sonia.scm.repository.spi; -//~--- non-JDK imports -------------------------------------------------------- import com.google.inject.assistedinject.Assisted; import jakarta.inject.Inject; @@ -40,27 +39,18 @@ import java.util.List; import static java.util.stream.Collectors.toList; -//~--- JDK imports ------------------------------------------------------------ -/** - * @author Sebastian Sdorra - */ public class GitTagsCommand extends AbstractGitCommand implements TagsCommand { private final GitTagConverter gitTagConverter; - /** - * Constructs ... - * - * @param context - */ + @Inject public GitTagsCommand(@Assisted GitContext context, GitTagConverter gitTagConverter) { super(context); this.gitTagConverter = gitTagConverter; } - //~--- get methods ---------------------------------------------------------- @Override public List getTags() throws IOException { diff --git a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/web/CollectingPackParserListener.java b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/web/CollectingPackParserListener.java index 0cbda8c4ef..a4988f0daa 100644 --- a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/web/CollectingPackParserListener.java +++ b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/web/CollectingPackParserListener.java @@ -24,7 +24,6 @@ package sonia.scm.web; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Preconditions; import com.google.common.collect.ImmutableSet; @@ -39,8 +38,6 @@ import org.eclipse.jgit.transport.PackParser; import org.slf4j.Logger; import org.slf4j.LoggerFactory; -//~--- JDK imports ------------------------------------------------------------ - import java.util.Set; /** @@ -48,23 +45,20 @@ import java.util.Set; * pushed with the reveive pack. The listener is used to find out which object * is new and which was already pushed. * - * @author Sebastian Sdorra */ public class CollectingPackParserListener implements PackParserListener { - /** - * the logger for CollectingPackParserListener - */ private static final Logger logger = LoggerFactory.getLogger(CollectingPackParserListener.class); private final GitReceiveHook hook; + private Set newObjectIds; + public CollectingPackParserListener(GitReceiveHook hook) { this.hook = hook; } - //~--- get methods ---------------------------------------------------------- /** * Returns the listener from the receive pack. @@ -91,7 +85,6 @@ public class CollectingPackParserListener implements PackParserListener return (CollectingPackParserListener) listener; } - //~--- set methods ---------------------------------------------------------- /** * Applies the listener to the receive pack. @@ -105,7 +98,6 @@ public class CollectingPackParserListener implements PackParserListener pack.setPackParserListener(new CollectingPackParserListener(hook)); } - //~--- methods -------------------------------------------------------------- /** * Collects all new object ids. @@ -134,9 +126,6 @@ public class CollectingPackParserListener implements PackParserListener /** * Prepares the pack parser to retrieve the new object ids. - * - * - * @param parser pack parser */ @Override public void before(PackParser parser) @@ -150,14 +139,9 @@ public class CollectingPackParserListener implements PackParserListener hook.afterReceive(); } - //~--- get methods ---------------------------------------------------------- /** * Returns {@code true} if the object is a new object. - * - * @param object rev object - * - * @return {@code true} if the object is new */ public boolean isNew(RevObject object) { @@ -166,7 +150,6 @@ public class CollectingPackParserListener implements PackParserListener return newObjectIds.contains(object.getId()); } - //~--- methods -------------------------------------------------------------- /** * Throws an {@link IllegalStateException} if the after method was not called. @@ -180,8 +163,4 @@ public class CollectingPackParserListener implements PackParserListener } } - //~--- fields --------------------------------------------------------------- - - /** set of new object ids */ - private Set newObjectIds; } diff --git a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/web/GitContextListener.java b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/web/GitContextListener.java index 8fb0787999..9d4736d595 100644 --- a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/web/GitContextListener.java +++ b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/web/GitContextListener.java @@ -24,7 +24,6 @@ package sonia.scm.web; -//~--- non-JDK imports -------------------------------------------------------- import com.google.inject.Inject; import jakarta.servlet.ServletContextEvent; @@ -35,42 +34,23 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; import sonia.scm.plugin.Extension; -/** - * - * @author Sebastian Sdorra - */ + @Extension public class GitContextListener implements ServletContextListener { - - /** - * the logger for GitContextListener - */ private static final Logger logger = LoggerFactory.getLogger(GitContextListener.class); - //~--- constructors --------------------------------------------------------- - - /** - * Constructs ... - * - * - * @param transportProtocol - */ + private ScmTransportProtocol transportProtocol; + @Inject public GitContextListener(ScmTransportProtocol transportProtocol) { this.transportProtocol = transportProtocol; } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param sce - */ + @Override public void contextDestroyed(ServletContextEvent sce) { @@ -78,12 +58,7 @@ public class GitContextListener implements ServletContextListener // do nothing } - /** - * Method description - * - * - * @param sce - */ + @Override public void contextInitialized(ServletContextEvent sce) { @@ -91,8 +66,4 @@ public class GitContextListener implements ServletContextListener Transport.register(transportProtocol); } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private ScmTransportProtocol transportProtocol; } diff --git a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/web/GitFileHook.java b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/web/GitFileHook.java index 67bc756111..1148c9b344 100644 --- a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/web/GitFileHook.java +++ b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/web/GitFileHook.java @@ -24,7 +24,6 @@ package sonia.scm.web; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Stopwatch; import com.google.common.io.Closer; @@ -39,49 +38,32 @@ import sonia.scm.repository.GitUtil; import sonia.scm.repository.RepositoryHookType; import sonia.scm.util.IOUtil; -//~--- JDK imports ------------------------------------------------------------ - import java.io.BufferedReader; import java.io.File; import java.io.IOException; import java.io.InputStreamReader; import java.io.PrintWriter; -/** - * - * @author Sebastian Sdorra - */ + public class GitFileHook { - /** Field description */ public static final String FILE_HOOKDIRECTORY = "hooks"; - /** Field description */ public static final String FILE_HOOK_POST_RECEIVE = "post-receive"; - /** Field description */ public static final String FILE_HOOK_PRE_RECEIVE = "pre-receive"; - /** - * the logger for GitFileHook - */ + private static final Logger logger = LoggerFactory.getLogger(GitFileHook.class); - //~--- constructors --------------------------------------------------------- + private final Iterable commands; + + private final ReceivePack rpack; + + private final RepositoryHookType type; - /** - * Constructs ... - * - * - * - * - * @param executor - * @param type - * @param rpack - * @param commands - */ private GitFileHook(RepositoryHookType type, ReceivePack rpack, Iterable commands) { @@ -90,33 +72,13 @@ public class GitFileHook this.commands = commands; } - //~--- methods -------------------------------------------------------------- - - /** - * Method description - * - * - * - * @param type - * @param rpack - * @param commands - */ public static void execute(RepositoryHookType type, ReceivePack rpack, Iterable commands) { new GitFileHook(type, rpack, commands).execute(); } - /** - * Method description - * - * - * @param hook - * - * @return - * - * @throws IOException - */ + private Process createProcess(File hook) throws IOException { ProcessBuilder pb = new ProcessBuilder(hook.getAbsolutePath()); @@ -132,14 +94,7 @@ public class GitFileHook return pb.redirectErrorStream(true).start(); } - /** - * Method description - * - * - * @param rc - * - * @return - */ + private String createReceiveCommandOutput(ReceiveCommand rc) { StringBuilder sb = new StringBuilder(); @@ -153,12 +108,7 @@ public class GitFileHook return sb.toString(); } - /** - * Method description - * - * - * @param type - */ + private void execute() { File hook = getHookFile(); @@ -189,12 +139,7 @@ public class GitFileHook } } - /** - * Method description - * - * - * @param hook - */ + private void execute(File hook) { Process p; @@ -254,16 +199,8 @@ public class GitFileHook } } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param type - * - * @return - */ + private File getHookFile() { File hook = null; @@ -287,15 +224,7 @@ public class GitFileHook return hook; } - /** - * Method description - * - * - * @param directory - * @param name - * - * @return - */ + private File getHookFile(File directory, String name) { //J- @@ -308,14 +237,4 @@ public class GitFileHook //J+ } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private final Iterable commands; - - /** Field description */ - private final ReceivePack rpack; - - /** Field description */ - private final RepositoryHookType type; } diff --git a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/web/GitHooks.java b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/web/GitHooks.java index ad520fceee..8b20b53e17 100644 --- a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/web/GitHooks.java +++ b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/web/GitHooks.java @@ -24,7 +24,6 @@ package sonia.scm.web; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Strings; import com.google.common.collect.Lists; @@ -37,50 +36,23 @@ import org.slf4j.LoggerFactory; import sonia.scm.repository.RepositoryHookType; -//~--- JDK imports ------------------------------------------------------------ - import java.util.List; -/** - * - * @author Sebastian Sdorra - */ + public final class GitHooks { - /** Field description */ public static final String PREFIX_MSG = "[SCM] "; - /** - * the logger for GitHooks - */ + private static final Logger logger = LoggerFactory.getLogger(GitHooks.class); - //~--- methods -------------------------------------------------------------- - - /** - * Method description - * - * - * @param type - * @param rpack - * @param commands - */ public static void abortIfPossible(RepositoryHookType type, ReceivePack rpack, Iterable commands) { abortIfPossible(type, rpack, commands, null); } - /** - * Method description - * - * - * @param type - * @param rpack - * @param commands - * @param message - */ public static void abortIfPossible(RepositoryHookType type, ReceivePack rpack, Iterable commands, String message) { @@ -98,15 +70,7 @@ public final class GitHooks } } - /** - * Method description - * - * - * @param type - * @param commands - * - * @return - */ + public static List filterReceiveable(RepositoryHookType type, Iterable commands) { @@ -128,54 +92,26 @@ public final class GitHooks return receiveable; } - /** - * Method description - * - * - * @param rpack - * @param message - */ + public static void sendPrefixedError(ReceivePack rpack, String message) { rpack.sendError(createPrefixedMessage(message)); } - /** - * Method description - * - * - * @param rpack - * @param message - */ + public static void sendPrefixedMessage(ReceivePack rpack, String message) { rpack.sendMessage(createPrefixedMessage(message)); } - /** - * Method description - * - * - * @param message - * - * @return - */ + private static String createPrefixedMessage(String message) { return PREFIX_MSG.concat(Strings.nullToEmpty(message)); } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param rc - * @param type - * - * @return - */ + private static boolean isReceiveable(RepositoryHookType type, ReceiveCommand rc) { diff --git a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/web/GitPermissionFilter.java b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/web/GitPermissionFilter.java index e086a3f177..186bfc7414 100644 --- a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/web/GitPermissionFilter.java +++ b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/web/GitPermissionFilter.java @@ -39,7 +39,6 @@ import java.io.IOException; /** * GitPermissionFilter decides if a git request requires write or read privileges. * - * @author Sebastian Sdorra */ public class GitPermissionFilter extends PermissionFilter { @@ -54,7 +53,6 @@ public class GitPermissionFilter extends PermissionFilter private static final String METHOD_LFS_UPLOAD = "PUT"; - //~--- constructors --------------------------------------------------------- /** * Constructs a new instance of the GitPermissionFilter. diff --git a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/web/GitReceiveHook.java b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/web/GitReceiveHook.java index aa89f1cd87..c34ac01ec9 100644 --- a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/web/GitReceiveHook.java +++ b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/web/GitReceiveHook.java @@ -24,7 +24,6 @@ package sonia.scm.web; -//~--- non-JDK imports -------------------------------------------------------- import org.eclipse.jgit.lib.Repository; import org.eclipse.jgit.lib.StoredConfig; @@ -44,12 +43,7 @@ import java.io.IOException; import java.util.Collection; import java.util.List; -//~--- JDK imports ------------------------------------------------------------ -/** - * - * @author Sebastian Sdorra - */ public class GitReceiveHook implements PreReceiveHook, PostReceiveHook { private static final Logger LOG = LoggerFactory.getLogger(GitReceiveHook.class); diff --git a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/web/GitReceivePackFactory.java b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/web/GitReceivePackFactory.java index ae9457cfe7..18b4848fa2 100644 --- a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/web/GitReceivePackFactory.java +++ b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/web/GitReceivePackFactory.java @@ -24,7 +24,6 @@ package sonia.scm.web; -//~--- non-JDK imports -------------------------------------------------------- import com.google.inject.Inject; import jakarta.servlet.http.HttpServletRequest; @@ -40,13 +39,10 @@ import sonia.scm.repository.GitChangesetConverterFactory; import sonia.scm.repository.GitRepositoryHandler; import sonia.scm.repository.spi.HookEventFacade; -//~--- JDK imports ------------------------------------------------------------ - /** * GitReceivePackFactory creates {@link ReceivePack} objects and assigns the required * Hook components. * - * @author Sebastian Sdorra */ public class GitReceivePackFactory extends BaseReceivePackFactory { diff --git a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/web/GitRepositoryResolver.java b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/web/GitRepositoryResolver.java index dd053f951b..3054ba3954 100644 --- a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/web/GitRepositoryResolver.java +++ b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/web/GitRepositoryResolver.java @@ -24,7 +24,6 @@ package sonia.scm.web; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Preconditions; import com.google.inject.Inject; @@ -43,19 +42,13 @@ import sonia.scm.repository.RepositoryProvider; import java.io.File; import java.io.IOException; -//~--- JDK imports ------------------------------------------------------------ -/** - * - * @author Sebastian Sdorra - */ public class GitRepositoryResolver implements RepositoryResolver { - - /** the logger for GitRepositoryResolver */ private static final Logger logger = LoggerFactory.getLogger(GitRepositoryResolver.class); - //~--- constructors --------------------------------------------------------- + private final GitRepositoryHandler handler; + private final RepositoryProvider repositoryProvider; @Inject public GitRepositoryResolver(GitRepositoryHandler handler, RepositoryProvider repositoryProvider) @@ -64,19 +57,10 @@ public class GitRepositoryResolver implements RepositoryResolver changesets; + + private final String name; + public BranchModel(String name, Iterable changesets) { this.name = name; this.changesets = changesets; } - //~--- get methods -------------------------------------------------------- + - /** - * Method description - * - * - * @return - */ + public Iterable getChangesets() { return changesets; } - /** - * Method description - * - * - * @return - */ + public String getName() { return name; } - //~--- fields ------------------------------------------------------------- - - /** Field description */ - private final Iterable changesets; - - /** Field description */ - private final String name; } - /** - * Class description - * - * - * @version Enter version here..., 13/02/27 - * @author Enter your name here... - */ + private static class BranchModelTransformer implements Function { - - /** - * Constructs ... - * - * - * @param service - */ + private final RepositoryService service; + public BranchModelTransformer(RepositoryService service) { this.service = service; } - //~--- methods ------------------------------------------------------------ + - /** - * Method description - * - * - * @param branch - * - * @return - */ + @Override public BranchModel apply(Branch branch) { @@ -294,95 +224,49 @@ public class GitRepositoryViewer return model; } - //~--- fields ------------------------------------------------------------- - - /** Field description */ - private final RepositoryService service; } - /** - * Class description - * - * - * @version Enter version here..., 13/02/27 - * @author Enter your name here... - */ + private static class BranchesModel implements Iterable { - - /** - * Constructs ... - * - * - * @param branches - */ + private final Iterable branches; + public BranchesModel(Iterable branches) { this.branches = branches; } - //~--- methods ------------------------------------------------------------ + - /** - * Method description - * - * - * @return - */ + @Override public Iterator iterator() { return branches.iterator(); } - //~--- fields ------------------------------------------------------------- - - /** Field description */ - private final Iterable branches; } - /** - * Class description - * - * - * @version Enter version here..., 13/02/27 - * @author Enter your name here... - */ + private static class ChangesetModel { - /** - * Constructs ... - * - * - * @param changeset - */ + private final Changeset changeset; + public ChangesetModel(Changeset changeset) { this.changeset = changeset; } - //~--- get methods -------------------------------------------------------- - /** - * Method description - * - * - * @return - */ public Person getAuthor() { return changeset.getAuthor(); } - /** - * Method description - * - * - * @return - */ + public String getDate() { String date = Util.EMPTY_STRING; @@ -396,29 +280,12 @@ public class GitRepositoryViewer return date; } - /** - * Method description - * - * - * @return - */ + public String getDescription() { return changeset.getDescription(); } - //~--- fields ------------------------------------------------------------- - - /** Field description */ - private final Changeset changeset; } - - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private final RepositoryServiceFactory repositoryServiceFactory; - - /** Field description */ - private final TemplateEngineFactory templateEngineFactory; } diff --git a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/web/GitServletModule.java b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/web/GitServletModule.java index c2c4967480..54f98bc6fd 100644 --- a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/web/GitServletModule.java +++ b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/web/GitServletModule.java @@ -24,7 +24,6 @@ package sonia.scm.web; -//~--- non-JDK imports -------------------------------------------------------- import com.google.inject.assistedinject.FactoryModuleBuilder; import com.google.inject.servlet.ServletModule; @@ -85,9 +84,7 @@ import sonia.scm.repository.spi.TagsCommand; import sonia.scm.repository.spi.UnbundleCommand; import sonia.scm.web.lfs.LfsBlobStoreFactory; -/** - * @author Sebastian Sdorra - */ + @Extension public class GitServletModule extends ServletModule { diff --git a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/web/GitUserAgentProvider.java b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/web/GitUserAgentProvider.java index e93c5a3ecc..fa2e96e4e4 100644 --- a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/web/GitUserAgentProvider.java +++ b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/web/GitUserAgentProvider.java @@ -24,7 +24,6 @@ package sonia.scm.web; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.annotations.VisibleForTesting; import com.google.common.base.Charsets; @@ -35,7 +34,6 @@ import sonia.scm.plugin.Extension; /** * UserAgent provider for git related clients. - * @author Sebastian Sdorra * @since 1.45 */ @Extension @@ -71,7 +69,6 @@ public class GitUserAgentProvider implements UserAgentProvider { - //~--- methods -------------------------------------------------------------- @Override public UserAgent parseUserAgent(String userAgentString) { diff --git a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/web/ScmGitServlet.java b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/web/ScmGitServlet.java index 649a5c5012..b8343c68d9 100644 --- a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/web/ScmGitServlet.java +++ b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/web/ScmGitServlet.java @@ -47,10 +47,7 @@ import java.util.regex.Pattern; import static org.eclipse.jgit.lfs.lib.Constants.CONTENT_TYPE_GIT_LFS_JSON; import static org.slf4j.LoggerFactory.getLogger; -/** - * - * @author Sebastian Sdorra - */ + @Singleton public class ScmGitServlet extends GitServlet implements ScmProviderHttpServlet { @@ -61,14 +58,18 @@ public class ScmGitServlet extends GitServlet implements ScmProviderHttpServlet "(?x)^/repo/(.*/(HEAD|info/refs|objects/(info/[^/]+|[0-9a-f]{2}/[0-9a-f]{38}|pack/pack-[0-9a-f]{40}\\.(pack|idx))|git-(upload|receive)-pack))$" ); - /** Field description */ private static final long serialVersionUID = -7712897339207470674L; - /** the logger for ScmGitServlet */ + private static final Logger logger = getLogger(ScmGitServlet.class); public static final MediaType LFS_LOCKING_MEDIA_TYPE = MediaType.valueOf("application/vnd.git-lfs+json"); - //~--- constructors --------------------------------------------------------- + private final RepositoryRequestListenerUtil repositoryRequestListenerUtil; + + + private final GitRepositoryViewer repositoryViewer; + + private final LfsServletFactory lfsServletFactory; @Inject public ScmGitServlet(GitRepositoryResolver repositoryResolver, @@ -85,18 +86,7 @@ public class ScmGitServlet extends GitServlet implements ScmProviderHttpServlet setReceivePackFactory(receivePackFactory); } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param request - * @param response - * - * @throws IOException - * @throws ServletException - */ @Override public void service(HttpServletRequest request, HttpServletResponse response, Repository repository) throws ServletException, IOException @@ -253,15 +243,4 @@ public class ScmGitServlet extends GitServlet implements ScmProviderHttpServlet return false; } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private final RepositoryRequestListenerUtil repositoryRequestListenerUtil; - - /** - * Field description - */ - private final GitRepositoryViewer repositoryViewer; - - private final LfsServletFactory lfsServletFactory; } diff --git a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/web/lfs/LfsBlobStoreFactory.java b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/web/lfs/LfsBlobStoreFactory.java index 4d87ea188a..86de02135a 100644 --- a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/web/lfs/LfsBlobStoreFactory.java +++ b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/web/lfs/LfsBlobStoreFactory.java @@ -33,7 +33,6 @@ import sonia.scm.store.BlobStoreFactory; /** * Creates {@link BlobStore} objects to store lfs objects. * - * @author Sebastian Sdorra * @since 1.54 */ @Singleton @@ -43,11 +42,6 @@ public class LfsBlobStoreFactory { private final BlobStoreFactory blobStoreFactory; - /** - * Create a new instance. - * - * @param blobStoreFactory blob store factory - */ @Inject public LfsBlobStoreFactory(BlobStoreFactory blobStoreFactory) { this.blobStoreFactory = blobStoreFactory; diff --git a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/GitRepositoryHandlerTest.java b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/GitRepositoryHandlerTest.java index 68b2e28a34..703fb04fb8 100644 --- a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/GitRepositoryHandlerTest.java +++ b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/GitRepositoryHandlerTest.java @@ -40,9 +40,7 @@ import static org.junit.Assert.assertTrue; import static org.mockito.ArgumentMatchers.any; import static org.mockito.Mockito.when; -/** - * @author Sebastian Sdorra - */ + @RunWith(MockitoJUnitRunner.Silent.class) public class GitRepositoryHandlerTest extends SimpleRepositoryHandlerTestBase { diff --git a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/GitRepositoryPathMatcherTest.java b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/GitRepositoryPathMatcherTest.java index 5ef061653d..117f1916f1 100644 --- a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/GitRepositoryPathMatcherTest.java +++ b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/GitRepositoryPathMatcherTest.java @@ -32,7 +32,6 @@ import static org.junit.Assert.assertTrue; /** * Unit tests for {@link GitRepositoryPathMatcher}. * - * @author Sebastian Sdorra * @since 1.54 */ public class GitRepositoryPathMatcherTest { diff --git a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/GitSubModuleParserTest.java b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/GitSubModuleParserTest.java index 6c3fd054b0..624bfe06e4 100644 --- a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/GitSubModuleParserTest.java +++ b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/GitSubModuleParserTest.java @@ -24,38 +24,25 @@ package sonia.scm.repository; -//~--- non-JDK imports -------------------------------------------------------- import org.junit.Test; import static org.junit.Assert.*; -//~--- JDK imports ------------------------------------------------------------ - import java.io.IOException; import java.io.InputStream; import java.util.Map; -/** - * - * @author Sebastian Sdorra - */ + public class GitSubModuleParserTest { - /** Field description */ public static final String GITMODULES_001 = "/sonia/scm/repository/gitmodules-001"; - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @throws IOException - */ + @Test public void testParse() throws IOException { @@ -74,18 +61,8 @@ public class GitSubModuleParserTest repository.getRepositoryUrl()); } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param resource - * - * @return - * - * @throws IOException - */ + private String getContent(String resource) throws IOException { InputStream input = @@ -97,16 +74,7 @@ public class GitSubModuleParserTest return new String(buffer); } - /** - * Method description - * - * - * @param resource - * - * @return - * - * @throws IOException - */ + private Map getSubRepositories(String resource) throws IOException { diff --git a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/GitUtilTest.java b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/GitUtilTest.java index afe8b812cf..2b0f9554ef 100644 --- a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/GitUtilTest.java +++ b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/GitUtilTest.java @@ -24,7 +24,6 @@ package sonia.scm.repository; -//~--- non-JDK imports -------------------------------------------------------- import jakarta.servlet.http.HttpServletRequest; import org.assertj.core.api.Assertions; @@ -54,7 +53,6 @@ import static org.mockito.Mockito.when; /** * Unit tests for {@link GitUtil}. * - * @author Sebastian Sdorra */ public class GitUtilTest { diff --git a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/api/GitHookBranchProviderTest.java b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/api/GitHookBranchProviderTest.java index ad7a4bf7cc..738d1f2190 100644 --- a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/api/GitHookBranchProviderTest.java +++ b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/api/GitHookBranchProviderTest.java @@ -41,7 +41,6 @@ import org.mockito.junit.MockitoJUnitRunner; /** * Unit tests for {@link GitHookBranchProvider}. * - * @author Sebastian Sdorra */ @RunWith(MockitoJUnitRunner.class) public class GitHookBranchProviderTest { diff --git a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/api/GitHookTagProviderTest.java b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/api/GitHookTagProviderTest.java index 7b05363532..b0c72af16a 100644 --- a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/api/GitHookTagProviderTest.java +++ b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/api/GitHookTagProviderTest.java @@ -58,7 +58,6 @@ import static org.mockito.Mockito.when; /** * Unit tests for {@link GitHookTagProvider}. * - * @author Sebastian Sdorra */ @RunWith(MockitoJUnitRunner.class) public class GitHookTagProviderTest { diff --git a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/client/spi/GitAddCommand.java b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/client/spi/GitAddCommand.java index 8de33b3d8d..a4f9594baf 100644 --- a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/client/spi/GitAddCommand.java +++ b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/client/spi/GitAddCommand.java @@ -24,45 +24,26 @@ package sonia.scm.repository.client.spi; -//~--- non-JDK imports -------------------------------------------------------- import org.eclipse.jgit.api.Git; import org.eclipse.jgit.api.errors.GitAPIException; import sonia.scm.repository.client.api.RepositoryClientException; -//~--- JDK imports ------------------------------------------------------------ - import java.io.IOException; -/** - * - * @author Sebastian Sdorra - */ + public class GitAddCommand implements AddCommand { - /** - * Constructs ... - * - * - * @param git - */ + GitAddCommand(Git git) { this.git = git; } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param path - * - * @throws IOException - */ + @Override public void add(String path) throws IOException { @@ -78,6 +59,5 @@ public class GitAddCommand implements AddCommand //~--- fields --------------------------------------------------------------- - /** Field description */ private Git git; } diff --git a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/client/spi/GitBranchCommand.java b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/client/spi/GitBranchCommand.java index 7e224fd0c0..c8a11b5dab 100644 --- a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/client/spi/GitBranchCommand.java +++ b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/client/spi/GitBranchCommand.java @@ -24,7 +24,6 @@ package sonia.scm.repository.client.spi; -//~--- non-JDK imports -------------------------------------------------------- import org.eclipse.jgit.api.Git; import org.eclipse.jgit.api.errors.GitAPIException; @@ -32,31 +31,20 @@ import org.eclipse.jgit.api.errors.GitAPIException; import sonia.scm.repository.Branch; import sonia.scm.repository.client.api.RepositoryClientException; -//~--- JDK imports ------------------------------------------------------------ - import java.io.IOException; import org.eclipse.jgit.lib.Ref; import sonia.scm.repository.GitUtil; -/** - * - * @author Sebastian Sdorra - */ + public class GitBranchCommand implements BranchCommand { - /** - * Constructs ... - * - * - * @param git - */ + GitBranchCommand(Git git) { this.git = git; } - //~--- methods -------------------------------------------------------------- @Override public Branch branch(String name) throws IOException @@ -74,6 +62,5 @@ public class GitBranchCommand implements BranchCommand //~--- fields --------------------------------------------------------------- - /** Field description */ private Git git; } diff --git a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/client/spi/GitCommitCommand.java b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/client/spi/GitCommitCommand.java index d17267b056..aa272689f5 100644 --- a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/client/spi/GitCommitCommand.java +++ b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/client/spi/GitCommitCommand.java @@ -24,7 +24,6 @@ package sonia.scm.repository.client.spi; -//~--- non-JDK imports -------------------------------------------------------- import org.eclipse.jgit.api.Git; import org.eclipse.jgit.api.errors.GitAPIException; @@ -36,40 +35,20 @@ import sonia.scm.repository.GitChangesetConverterFactory; import sonia.scm.repository.GitTestHelper; import sonia.scm.repository.client.api.RepositoryClientException; -//~--- JDK imports ------------------------------------------------------------ - import java.io.IOException; -/** - * - * @author Sebastian Sdorra - */ + public class GitCommitCommand implements CommitCommand { - /** - * Constructs ... - * - * - * @param git - */ + GitCommitCommand(Git git) { this.git = git; } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param request - * - * @return - * - * @throws IOException - */ + @Override public Changeset commit(CommitRequest request) throws IOException { @@ -89,6 +68,5 @@ public class GitCommitCommand implements CommitCommand //~--- fields --------------------------------------------------------------- - /** Field description */ private final Git git; } diff --git a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/client/spi/GitPushCommand.java b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/client/spi/GitPushCommand.java index 2b8ad90fbc..cba23668cb 100644 --- a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/client/spi/GitPushCommand.java +++ b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/client/spi/GitPushCommand.java @@ -24,7 +24,6 @@ package sonia.scm.repository.client.spi; -//~--- non-JDK imports -------------------------------------------------------- import org.eclipse.jgit.api.Git; import org.eclipse.jgit.api.errors.GitAPIException; @@ -34,36 +33,19 @@ import sonia.scm.repository.client.api.RepositoryClientException; import java.io.IOException; import java.util.function.Supplier; -//~--- JDK imports ------------------------------------------------------------ -/** - * - * @author Sebastian Sdorra - */ public class GitPushCommand implements PushCommand { - /** - * Constructs ... - * - * - * @param git - * @param credentialsProvider - */ + public GitPushCommand(Git git, CredentialsProvider credentialsProvider) { this.git = git; this.credentialsProvider = credentialsProvider; } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @throws IOException - */ + @Override public void push() throws IOException { push(() -> git.push().setPushAll()); @@ -96,9 +78,7 @@ public class GitPushCommand implements PushCommand //~--- fields --------------------------------------------------------------- - /** Field description */ private CredentialsProvider credentialsProvider; - /** Field description */ private Git git; } diff --git a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/client/spi/GitRemoveCommand.java b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/client/spi/GitRemoveCommand.java index eb8dec8926..600d4a00f8 100644 --- a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/client/spi/GitRemoveCommand.java +++ b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/client/spi/GitRemoveCommand.java @@ -24,45 +24,26 @@ package sonia.scm.repository.client.spi; -//~--- non-JDK imports -------------------------------------------------------- import org.eclipse.jgit.api.Git; import org.eclipse.jgit.api.errors.GitAPIException; import sonia.scm.repository.client.api.RepositoryClientException; -//~--- JDK imports ------------------------------------------------------------ - import java.io.IOException; -/** - * - * @author Sebastian Sdorra - */ + public class GitRemoveCommand implements RemoveCommand { - /** - * Constructs ... - * - * - * @param git - */ + GitRemoveCommand(Git git) { this.git = git; } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param path - * - * @throws IOException - */ + @Override public void remove(String path) throws IOException { @@ -78,6 +59,5 @@ public class GitRemoveCommand implements RemoveCommand //~--- fields --------------------------------------------------------------- - /** Field description */ private Git git; } diff --git a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/client/spi/GitRepositoryClientFactoryProvider.java b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/client/spi/GitRepositoryClientFactoryProvider.java index b531e226cd..6707019f38 100644 --- a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/client/spi/GitRepositoryClientFactoryProvider.java +++ b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/client/spi/GitRepositoryClientFactoryProvider.java @@ -24,7 +24,6 @@ package sonia.scm.repository.client.spi; -//~--- non-JDK imports -------------------------------------------------------- import org.eclipse.jgit.api.Git; import org.eclipse.jgit.api.errors.GitAPIException; @@ -34,15 +33,10 @@ import org.eclipse.jgit.transport.UsernamePasswordCredentialsProvider; import sonia.scm.repository.GitRepositoryHandler; import sonia.scm.repository.client.api.RepositoryClientException; -//~--- JDK imports ------------------------------------------------------------ - import java.io.File; import java.io.IOException; -/** - * - * @author Sebastian Sdorra - */ + public class GitRepositoryClientFactoryProvider implements RepositoryClientFactoryProvider { @@ -118,14 +112,8 @@ public class GitRepositoryClientFactoryProvider return new GitRepositoryClientProvider(git, credentialsProvider); } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + @Override public String getType() { diff --git a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/client/spi/GitRepositoryClientProvider.java b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/client/spi/GitRepositoryClientProvider.java index 1cb11dbe2c..5e9dfc0439 100644 --- a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/client/spi/GitRepositoryClientProvider.java +++ b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/client/spi/GitRepositoryClientProvider.java @@ -24,7 +24,6 @@ package sonia.scm.repository.client.spi; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.collect.ImmutableSet; import org.eclipse.jgit.api.Git; @@ -36,82 +35,46 @@ import java.io.File; import java.io.IOException; import java.util.Set; -//~--- JDK imports ------------------------------------------------------------ -/** - * - * @author Sebastian Sdorra - */ public class GitRepositoryClientProvider extends RepositoryClientProvider { - /** Field description */ private static final Set SUPPORTED_COMMANDS = ImmutableSet.of(ClientCommand.ADD, ClientCommand.REMOVE, ClientCommand.COMMIT, ClientCommand.TAG, ClientCommand.BRANCH, ClientCommand.DELETE_REMOTE_BRANCH, ClientCommand.MERGE, ClientCommand.PUSH); - //~--- constructors --------------------------------------------------------- - /** - * Constructs ... - * - * - * @param git - * @param credentialsProvider - */ + GitRepositoryClientProvider(Git git) { this(git, null); } - /** - * Constructs ... - * - * - * @param git - * @param credentialsProvider - */ + GitRepositoryClientProvider(Git git, CredentialsProvider credentialsProvider) { this.git = git; this.credentialsProvider = credentialsProvider; } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @throws IOException - */ + @Override public void close() throws IOException { GitUtil.close(git.getRepository()); } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + @Override public AddCommand getAddCommand() { return new GitAddCommand(git); } - /** - * Method description - * - * - * @return - */ + @Override public BranchCommand getBranchCommand() { @@ -128,60 +91,35 @@ public class GitRepositoryClientProvider extends RepositoryClientProvider return new GitCheckoutCommand(git); } - /** - * Method description - * - * - * @return - */ + @Override public CommitCommand getCommitCommand() { return new GitCommitCommand(git); } - /** - * Method description - * - * - * @return - */ + @Override public PushCommand getPushCommand() { return new GitPushCommand(git, credentialsProvider); } - /** - * Method description - * - * - * @return - */ + @Override public RemoveCommand getRemoveCommand() { return new GitRemoveCommand(git); } - /** - * Method description - * - * - * @return - */ + @Override public Set getSupportedClientCommands() { return SUPPORTED_COMMANDS; } - /** - * Method description - * - * - * @return - */ + @Override public TagCommand getTagCommand() { @@ -200,9 +138,7 @@ public class GitRepositoryClientProvider extends RepositoryClientProvider //~--- fields --------------------------------------------------------------- - /** Field description */ private CredentialsProvider credentialsProvider; - /** Field description */ private Git git; } diff --git a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/client/spi/GitTagCommand.java b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/client/spi/GitTagCommand.java index 8c4eb3f89f..152e3190f3 100644 --- a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/client/spi/GitTagCommand.java +++ b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/client/spi/GitTagCommand.java @@ -24,7 +24,6 @@ package sonia.scm.repository.client.spi; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Strings; import org.eclipse.jgit.api.Git; @@ -39,38 +38,18 @@ import sonia.scm.repository.client.api.RepositoryClientException; import java.io.IOException; -//~--- JDK imports ------------------------------------------------------------ -/** - * - * @author Sebastian Sdorra - */ public class GitTagCommand implements TagCommand { - /** - * Constructs ... - * - * - * @param git - */ + GitTagCommand(Git git) { this.git = git; } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param request - * - * @return - * - * @throws IOException - */ + @Override public Tag tag(TagRequest request) throws IOException { @@ -128,6 +107,5 @@ public class GitTagCommand implements TagCommand //~--- fields --------------------------------------------------------------- - /** Field description */ private Git git; } diff --git a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/spi/AbstractGitCommandTestBase.java b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/spi/AbstractGitCommandTestBase.java index 2c2ee26f80..d10179e291 100644 --- a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/spi/AbstractGitCommandTestBase.java +++ b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/spi/AbstractGitCommandTestBase.java @@ -24,7 +24,6 @@ package sonia.scm.repository.spi; -//~--- non-JDK imports -------------------------------------------------------- import org.junit.After; import sonia.scm.api.v2.resources.GitRepositoryConfigStoreProvider; @@ -32,18 +31,11 @@ import sonia.scm.repository.GitConfig; import sonia.scm.repository.GitRepositoryConfig; import sonia.scm.store.InMemoryConfigurationStoreFactory; -/** - * - * @author Sebastian Sdorra - */ + public class AbstractGitCommandTestBase extends ZippedRepositoryTestBase { - /** - * Method description - * - */ - @After + @After public void close() { if (context != null) { @@ -52,12 +44,7 @@ public class AbstractGitCommandTestBase extends ZippedRepositoryTestBase } } - /** - * Method description - * - * - * @return - */ + protected GitContext createContext() { if (context == null) @@ -68,26 +55,15 @@ public class AbstractGitCommandTestBase extends ZippedRepositoryTestBase return context; } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + @Override protected String getType() { return "git"; } - /** - * Method description - * - * - * @return - */ + @Override protected String getZippedRepositoryResource() { @@ -96,6 +72,5 @@ public class AbstractGitCommandTestBase extends ZippedRepositoryTestBase //~--- fields --------------------------------------------------------------- - /** Field description */ private GitContext context; } diff --git a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/spi/AbstractRemoteCommandTestBase.java b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/spi/AbstractRemoteCommandTestBase.java index d2abb6318e..85f04a3698 100644 --- a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/spi/AbstractRemoteCommandTestBase.java +++ b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/spi/AbstractRemoteCommandTestBase.java @@ -24,7 +24,6 @@ package sonia.scm.repository.spi; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Charsets; import com.google.common.io.Files; @@ -53,11 +52,7 @@ import static org.junit.Assert.assertEquals; import static org.mockito.Mockito.lenient; import static org.mockito.Mockito.mock; -//~--- JDK imports ------------------------------------------------------------ -/** - * @author Sebastian Sdorra - */ public class AbstractRemoteCommandTestBase { /** @@ -97,7 +92,6 @@ public class AbstractRemoteCommandTestBase { Transport.unregister(proto); } - //~--- set methods ---------------------------------------------------------- /** * Method description @@ -110,7 +104,6 @@ public class AbstractRemoteCommandTestBase { Transport.register(proto); } - //~--- methods -------------------------------------------------------------- /** * Method description @@ -127,14 +120,7 @@ public class AbstractRemoteCommandTestBase { assertEquals(expected.getShortMessage(), actual.getDescription()); } - /** - * Method description - * - * @param git - * @param message - * @return - * @throws GitAPIException - */ + protected RevCommit commit(Git git, String message) throws GitAPIException { User trillian = UserTestData.createTrillian(); CommitCommand cc = git.commit(); @@ -165,50 +151,32 @@ public class AbstractRemoteCommandTestBase { //~--- fields --------------------------------------------------------------- - /** - * Field description - */ + @Rule public TemporaryFolder tempFolder = new TemporaryFolder(); - /** - * Field description - */ + protected GitRepositoryHandler handler; - /** - * Field description - */ + protected Repository incomingRepository; - /** - * Field description - */ + protected Git incoming; - /** - * Field description - */ + protected File incomingDirectory; - /** - * Field description - */ + protected Git outgoing; - /** - * Field description - */ + protected File outgoingDirectory; - /** - * Field description - */ + protected Repository outgoingRepository; - /** - * Field description - */ + private ScmTransportProtocol proto; protected ScmEventBus eventBus; diff --git a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/spi/GitBlameCommandTest.java b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/spi/GitBlameCommandTest.java index 8943be1867..0534f0d190 100644 --- a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/spi/GitBlameCommandTest.java +++ b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/spi/GitBlameCommandTest.java @@ -24,7 +24,6 @@ package sonia.scm.repository.spi; -//~--- non-JDK imports -------------------------------------------------------- import org.junit.Test; import sonia.scm.repository.BlameLine; @@ -36,12 +35,9 @@ import java.io.IOException; import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertNotNull; -//~--- JDK imports ------------------------------------------------------------ - /** * Unit tests for {@link GitBlameCommand}. * - * @author Sebastian Sdorra */ public class GitBlameCommandTest extends AbstractGitCommandTestBase { @@ -72,12 +68,7 @@ public class GitBlameCommandTest extends AbstractGitCommandTestBase assertEquals("3f76a12f08a6ba0dc988c68b7f0b2cd190efc3c4", result.getLine(0).getRevision()); } - /** - * Method description - * - * - * @throws IOException - */ + @Test public void testGetBlameResult() throws IOException { @@ -105,12 +96,7 @@ public class GitBlameCommandTest extends AbstractGitCommandTestBase line.getAuthor().getMail()); } - /** - * Method description - * - * - * @throws IOException - */ + @Test public void testGetBlameResultWithRevision() throws IOException @@ -130,12 +116,7 @@ public class GitBlameCommandTest extends AbstractGitCommandTestBase checkFirstLine(line); } - /** - * Method description - * - * - * @param line - */ + private void checkFirstLine(BlameLine line) { assertEquals(1, line.getLineNumber()); @@ -148,12 +129,7 @@ public class GitBlameCommandTest extends AbstractGitCommandTestBase assertEquals("douglas.adams@hitchhiker.com", line.getAuthor().getMail()); } - /** - * Method description - * - * - * @return - */ + private GitBlameCommand createCommand() { return new GitBlameCommand(createContext()); diff --git a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/spi/GitBrowseCommandTest.java b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/spi/GitBrowseCommandTest.java index 43433c7652..2081348f78 100644 --- a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/spi/GitBrowseCommandTest.java +++ b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/spi/GitBrowseCommandTest.java @@ -52,7 +52,6 @@ import static sonia.scm.repository.spi.SyncAsyncExecutors.synchronousExecutor; /** * Unit tests for {@link GitBrowseCommand}. * - * @author Sebastian Sdorra */ public class GitBrowseCommandTest extends AbstractGitCommandTestBase { diff --git a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/spi/GitBrowseCommand_RecursiveDirectoryNameTest.java b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/spi/GitBrowseCommand_RecursiveDirectoryNameTest.java index 9dee9930c6..5d52e281ff 100644 --- a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/spi/GitBrowseCommand_RecursiveDirectoryNameTest.java +++ b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/spi/GitBrowseCommand_RecursiveDirectoryNameTest.java @@ -38,7 +38,6 @@ import static sonia.scm.repository.spi.SyncAsyncExecutors.synchronousExecutor; /** * Unit tests for {@link GitBrowseCommand}. * - * @author Sebastian Sdorra */ public class GitBrowseCommand_RecursiveDirectoryNameTest extends AbstractGitCommandTestBase { diff --git a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/spi/GitCatCommandTest.java b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/spi/GitCatCommandTest.java index 5e9e716173..da58863c22 100644 --- a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/spi/GitCatCommandTest.java +++ b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/spi/GitCatCommandTest.java @@ -49,7 +49,6 @@ import static org.mockito.Mockito.when; * * TODO add not found test * - * @author Sebastian Sdorra */ public class GitCatCommandTest extends AbstractGitCommandTestBase { diff --git a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/spi/GitIncomingCommandTest.java b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/spi/GitIncomingCommandTest.java index 20c2c31f0e..696bb3faed 100644 --- a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/spi/GitIncomingCommandTest.java +++ b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/spi/GitIncomingCommandTest.java @@ -41,9 +41,7 @@ import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertNotNull; import static org.mockito.Mockito.mock; -/** - * @author Sebastian Sdorra - */ + public class GitIncomingCommandTest extends AbstractRemoteCommandTestBase { diff --git a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/spi/GitLogCommandAncestorTest.java b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/spi/GitLogCommandAncestorTest.java index 38c1516187..748022b3e4 100644 --- a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/spi/GitLogCommandAncestorTest.java +++ b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/spi/GitLogCommandAncestorTest.java @@ -55,7 +55,6 @@ import static org.junit.Assert.assertNotNull; * * 36b19e4 b * * c2190a9 a * - * @author Sebastian Sdorra */ public class GitLogCommandAncestorTest extends AbstractGitCommandTestBase { diff --git a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/spi/GitLogCommandTest.java b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/spi/GitLogCommandTest.java index e920e81dac..ffa6d11895 100644 --- a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/spi/GitLogCommandTest.java +++ b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/spi/GitLogCommandTest.java @@ -55,7 +55,6 @@ import static org.mockito.Mockito.when; /** * Unit tests for {@link GitLogCommand}. * - * @author Sebastian Sdorra */ @RunWith(MockitoJUnitRunner.class) public class GitLogCommandTest extends AbstractGitCommandTestBase diff --git a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/spi/GitOutgoingCommandTest.java b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/spi/GitOutgoingCommandTest.java index 5609a222f9..a6a6245fb5 100644 --- a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/spi/GitOutgoingCommandTest.java +++ b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/spi/GitOutgoingCommandTest.java @@ -24,7 +24,6 @@ package sonia.scm.repository.spi; -//~--- non-JDK imports -------------------------------------------------------- import org.eclipse.jgit.api.errors.GitAPIException; import org.eclipse.jgit.revwalk.RevCommit; @@ -40,12 +39,9 @@ import java.io.IOException; import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertNotNull; -//~--- JDK imports ------------------------------------------------------------ - /** * Unit tests for {@link OutgoingCommand}. * - * @author Sebastian Sdorra */ public class GitOutgoingCommandTest extends AbstractRemoteCommandTestBase { @@ -123,12 +119,7 @@ public class GitOutgoingCommandTest extends AbstractRemoteCommandTestBase assertCommitsEquals(c2, cpr.getChangesets().get(0)); } - /** - * Method description - * - * - * @throws IOException - */ + @Test public void testGetOutgoingChangesetsWithEmptyRepository() throws IOException @@ -145,12 +136,7 @@ public class GitOutgoingCommandTest extends AbstractRemoteCommandTestBase assertEquals(0, cpr.getTotal()); } - /** - * Method description - * - * - * @return - */ + private GitOutgoingCommand createCommand() { return new GitOutgoingCommand( diff --git a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/spi/GitPushCommandTest.java b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/spi/GitPushCommandTest.java index 0fb91c5fe8..05e5d96fc7 100644 --- a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/spi/GitPushCommandTest.java +++ b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/spi/GitPushCommandTest.java @@ -24,7 +24,6 @@ package sonia.scm.repository.spi; -//~--- non-JDK imports -------------------------------------------------------- import org.eclipse.jgit.api.errors.GitAPIException; import org.eclipse.jgit.revwalk.RevCommit; @@ -41,12 +40,7 @@ import static org.assertj.core.api.Assertions.assertThatThrownBy; import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertNotNull; -//~--- JDK imports ------------------------------------------------------------ -/** - * - * @author Sebastian Sdorra - */ public class GitPushCommandTest extends AbstractRemoteCommandTestBase { @@ -130,12 +124,7 @@ public class GitPushCommandTest extends AbstractRemoteCommandTestBase assertThat(commits.hasNext()).isFalse(); } - /** - * Method description - * - * - * @return - */ + private GitPushCommand createCommand() { return new GitPushCommand(handler, new GitContext(outgoingDirectory, outgoingRepository, null, new GitConfig())); diff --git a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/web/GitUserAgentProviderTest.java b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/web/GitUserAgentProviderTest.java index 506b8d5522..2a2c152937 100644 --- a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/web/GitUserAgentProviderTest.java +++ b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/web/GitUserAgentProviderTest.java @@ -24,14 +24,11 @@ package sonia.scm.web; -//~--- non-JDK imports -------------------------------------------------------- import org.junit.Test; import static org.junit.Assert.*; -//~--- JDK imports ------------------------------------------------------------ - /** * Unit tests for {@link GitUserAgentProvider}. * diff --git a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/web/lfs/LfsBlobStoreFactoryTest.java b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/web/lfs/LfsBlobStoreFactoryTest.java index 143f60caa6..42c33ac575 100644 --- a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/web/lfs/LfsBlobStoreFactoryTest.java +++ b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/web/lfs/LfsBlobStoreFactoryTest.java @@ -42,7 +42,6 @@ import static org.mockito.Mockito.when; /** * Unit tests for {@link LfsBlobStoreFactory}. * - * @author Sebastian Sdorra */ @RunWith(MockitoJUnitRunner.class) public class LfsBlobStoreFactoryTest { diff --git a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/log/HgLogger.java b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/log/HgLogger.java index 0935eea882..8512441860 100644 --- a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/log/HgLogger.java +++ b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/log/HgLogger.java @@ -24,234 +24,131 @@ package sonia.scm.log; -//~--- non-JDK imports -------------------------------------------------------- import org.slf4j.Logger; -/** - * - * @author Sebastian Sdorra - */ + public class HgLogger implements org.javahg.log.Logger { - - /** - * Constructs ... - * - * - * @param logger - */ + private Logger logger; + public HgLogger(Logger logger) { this.logger = logger; } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param msg - */ + @Override public void debug(String msg) { logger.debug(msg); } - /** - * Method description - * - * - * @param msg - * @param args - */ + @Override public void debug(String msg, Object... args) { logger.debug(msg, args); } - /** - * Method description - * - * - * @param msg - * @param thrown - */ + @Override public void debug(String msg, Throwable thrown) { logger.debug(msg, thrown); } - /** - * Method description - * - * - * @param msg - */ + @Override public void error(String msg) { logger.error(msg); } - /** - * Method description - * - * - * @param msg - * @param args - */ + @Override public void error(String msg, Object... args) { logger.error(msg, args); } - /** - * Method description - * - * - * @param msg - * @param thrown - */ + @Override public void error(String msg, Throwable thrown) { logger.error(msg, thrown); } - /** - * Method description - * - * - * @param msg - */ + @Override public void info(String msg) { logger.info(msg); } - /** - * Method description - * - * - * @param msg - * @param args - */ + @Override public void info(String msg, Object... args) { logger.info(msg, args); } - /** - * Method description - * - * - * @param msg - * @param thrown - */ + @Override public void info(String msg, Throwable thrown) { logger.info(msg, thrown); } - /** - * Method description - * - * - * @param msg - */ + @Override public void warn(String msg) { logger.warn(msg); } - /** - * Method description - * - * - * @param msg - * @param args - */ + @Override public void warn(String msg, Object... args) { logger.warn(msg, args); } - /** - * Method description - * - * - * @param msg - * @param thrown - */ + @Override public void warn(String msg, Throwable thrown) { logger.warn(msg, thrown); } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + @Override public boolean isDebugEnabled() { return logger.isDebugEnabled(); } - /** - * Method description - * - * - * @return - */ + @Override public boolean isErrorEnabled() { return logger.isErrorEnabled(); } - /** - * Method description - * - * - * @return - */ + @Override public boolean isInfoEnabled() { return logger.isInfoEnabled(); } - /** - * Method description - * - * - * @return - */ + @Override public boolean isWarnEnabled() { return logger.isWarnEnabled(); } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private Logger logger; } diff --git a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/log/HgLoggerFactory.java b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/log/HgLoggerFactory.java index 656cb3caee..97ad0f1337 100644 --- a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/log/HgLoggerFactory.java +++ b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/log/HgLoggerFactory.java @@ -24,27 +24,16 @@ package sonia.scm.log; -//~--- non-JDK imports -------------------------------------------------------- import org.javahg.log.Logger; import org.slf4j.LoggerFactory; -/** - * - * @author Sebastian Sdorra - */ + public class HgLoggerFactory extends org.javahg.log.LoggerFactory { - /** - * Method description - * - * - * @param cls - * - * @return - */ + @Override protected Logger getLoggerInstance(Class cls) { diff --git a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/HgExtensions.java b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/HgExtensions.java index 9d613fe07c..34c2852784 100644 --- a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/HgExtensions.java +++ b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/HgExtensions.java @@ -24,19 +24,13 @@ package sonia.scm.repository; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.SCMContext; import sonia.scm.SCMContextProvider; -//~--- JDK imports ------------------------------------------------------------ - import java.io.File; -/** - * - * @author Sebastian Sdorra - */ + public enum HgExtensions { HOOK("scmhooks.py"), diff --git a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/HgGlobalConfig.java b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/HgGlobalConfig.java index e96eaa4f29..451cb90470 100644 --- a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/HgGlobalConfig.java +++ b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/HgGlobalConfig.java @@ -31,16 +31,21 @@ import sonia.scm.auditlog.AuditEntry; import sonia.scm.util.Util; -/** - * - * @author Sebastian Sdorra - */ + @XmlRootElement(name = "config") @AuditEntry(labels = {"hg", "config"}) public class HgGlobalConfig extends RepositoryConfig { public static final String PERMISSION = "hg"; + private String encoding = "UTF-8"; + + private String hgBinary; + + private boolean showRevisionInId = false; + + private boolean enableHttpPostArgs = false; + @Override @XmlTransient // Only for permission checks, don't serialize to XML public String getId() { @@ -48,34 +53,19 @@ public class HgGlobalConfig extends RepositoryConfig { return PERMISSION; } - /** - * Method description - * - * - * @return - */ + public String getEncoding() { return encoding; } - /** - * Method description - * - * - * @return - */ + public String getHgBinary() { return hgBinary; } - /** - * Method description - * - * - * @return - */ + public boolean isShowRevisionInId() { return showRevisionInId; @@ -85,48 +75,27 @@ public class HgGlobalConfig extends RepositoryConfig { return enableHttpPostArgs; } - /** - * Method description - * - * - * @return - */ + @Override public boolean isValid() { return super.isValid() && Util.isNotEmpty(hgBinary); } - //~--- set methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param encoding - */ + public void setEncoding(String encoding) { this.encoding = encoding; } - /** - * Method description - * - * - * @param hgBinary - */ + public void setHgBinary(String hgBinary) { this.hgBinary = hgBinary; } - /** - * Method description - * - * - * @param showRevisionInId - */ + public void setShowRevisionInId(boolean showRevisionInId) { this.showRevisionInId = showRevisionInId; @@ -136,17 +105,4 @@ public class HgGlobalConfig extends RepositoryConfig { this.enableHttpPostArgs = enableHttpPostArgs; } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private String encoding = "UTF-8"; - - /** Field description */ - private String hgBinary; - - /** Field description */ - private boolean showRevisionInId = false; - - private boolean enableHttpPostArgs = false; - } diff --git a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/HgHealthCheck.java b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/HgHealthCheck.java index 17876401e0..3f4529d142 100644 --- a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/HgHealthCheck.java +++ b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/HgHealthCheck.java @@ -24,59 +24,38 @@ package sonia.scm.repository; -//~--- non-JDK imports -------------------------------------------------------- import com.google.inject.Inject; import sonia.scm.plugin.Extension; -//~--- JDK imports ------------------------------------------------------------ - import java.io.File; /** * Simple {@link HealthCheck} for mercurial repositories. * - * @author Sebastian Sdorra * @since 1.39 */ @Extension public final class HgHealthCheck extends DirectoryHealthCheck { - /** Field description */ private static final HealthCheckFailure COULD_NOT_FIND_DOT_HG_DIRECTORY = new HealthCheckFailure("6bOdhOXpB1", "Could not find .hg directory", "The mercurial repository does not contain .hg directory."); - /** Field description */ private static final String DOT_HG = ".hg"; - //~--- constructors --------------------------------------------------------- - /** - * Constructs ... - * - * - * @param repositoryManager - */ + @Inject public HgHealthCheck(RepositoryManager repositoryManager) { super(repositoryManager); } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param repository - * @param directory - * - * @return - */ + @Override protected HealthCheckResult check(Repository repository, File directory) { @@ -91,7 +70,6 @@ public final class HgHealthCheck extends DirectoryHealthCheck return result; } - //~--- get methods ---------------------------------------------------------- /** * Returns {@code true} if the repository is from type mercurial. diff --git a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/HgImportHandler.java b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/HgImportHandler.java index 9f7c0d60e8..a6288c039b 100644 --- a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/HgImportHandler.java +++ b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/HgImportHandler.java @@ -24,7 +24,6 @@ package sonia.scm.repository; -//~--- non-JDK imports -------------------------------------------------------- import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -36,40 +35,27 @@ import sonia.scm.util.ValidationUtil; import java.io.File; import java.io.IOException; -//~--- JDK imports ------------------------------------------------------------ - /** * - * @author Sebastian Sdorra * @deprecated */ @Deprecated public class HgImportHandler extends AbstactImportHandler { - /** Field description */ public static final String HG_DIR = ".hg"; - /** - * the logger for HgImportHandler - */ + private static final Logger logger = LoggerFactory.getLogger(HgImportHandler.class); - //~--- constructors --------------------------------------------------------- - - /** - * Constructs ... - * - * - * @param handler - */ + private HgRepositoryHandler handler; + public HgImportHandler(HgRepositoryHandler handler) { this.handler = handler; } - //~--- methods -------------------------------------------------------------- @Override protected Repository createRepository(File repositoryDirectory, @@ -109,34 +95,19 @@ public class HgImportHandler extends AbstactImportHandler return repository; } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + @Override protected String[] getDirectoryNames() { return new String[] { HG_DIR }; } - /** - * Method description - * - * - * @return - */ + @Override protected AbstractRepositoryHandler getRepositoryHandler() { return handler; } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private HgRepositoryHandler handler; } diff --git a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/HgRepositoryHandler.java b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/HgRepositoryHandler.java index 3710ffbaa1..f11c5a5e22 100644 --- a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/HgRepositoryHandler.java +++ b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/HgRepositoryHandler.java @@ -150,10 +150,6 @@ public class HgRepositoryHandler /** * Writes repository to .hg/hgrc. - * - * @param repository - * @param directory - * @throws IOException */ @Override protected void postCreate(Repository repository, File directory) diff --git a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/api/HgHookBranchProvider.java b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/api/HgHookBranchProvider.java index a0705922b8..9601ee67ed 100644 --- a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/api/HgHookBranchProvider.java +++ b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/api/HgHookBranchProvider.java @@ -38,7 +38,6 @@ import java.util.List; /** * Mercurial hook branch provider implementation. * - * @author Sebastian Sdorra */ public class HgHookBranchProvider implements HookBranchProvider { @@ -48,20 +47,17 @@ public class HgHookBranchProvider implements HookBranchProvider private static final HookChangesetRequest REQUEST = new HookChangesetRequest(); - //~--- constructors --------------------------------------------------------- + private final HookChangesetProvider changesetProvider; + + private List createdOrModified; + + private List deletedOrClosed; - /** - * Constructs a new instance. - * - * - * @param changesetProvider changeset provider - */ public HgHookBranchProvider(HookChangesetProvider changesetProvider) { this.changesetProvider = changesetProvider; } - //~--- get methods ---------------------------------------------------------- @Override public List getCreatedOrModified() @@ -85,7 +81,6 @@ public class HgHookBranchProvider implements HookBranchProvider return deletedOrClosed; } - //~--- methods -------------------------------------------------------------- private List appendBranches(Builder builder, Changeset c) { @@ -131,11 +126,4 @@ public class HgHookBranchProvider implements HookBranchProvider deletedOrClosed = deletedOrClosedBuilder.build(); } - //~--- fields --------------------------------------------------------------- - - private final HookChangesetProvider changesetProvider; - - private List createdOrModified; - - private List deletedOrClosed; } diff --git a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/api/HgHookMessage.java b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/api/HgHookMessage.java index 0cd78ac932..9d8592c482 100644 --- a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/api/HgHookMessage.java +++ b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/api/HgHookMessage.java @@ -24,8 +24,6 @@ package sonia.scm.repository.api; -//~--- JDK imports ------------------------------------------------------------ - import lombok.AccessLevel; import lombok.AllArgsConstructor; import lombok.Getter; @@ -33,10 +31,7 @@ import lombok.NoArgsConstructor; import java.io.Serializable; -/** - * - * @author Sebastian Sdorra - */ + @Getter @AllArgsConstructor @NoArgsConstructor(access = AccessLevel.PROTECTED) diff --git a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/api/HgHookMessageProvider.java b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/api/HgHookMessageProvider.java index 549bd83211..5f2d33aee6 100644 --- a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/api/HgHookMessageProvider.java +++ b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/api/HgHookMessageProvider.java @@ -24,55 +24,33 @@ package sonia.scm.repository.api; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.collect.Lists; import sonia.scm.repository.api.HgHookMessage.Severity; -//~--- JDK imports ------------------------------------------------------------ - import java.util.List; -/** - * - * @author Sebastian Sdorra - */ + public class HgHookMessageProvider implements HookMessageProvider { + private List messages; - /** - * Method description - * - * - * @param message - */ @Override public void sendError(String message) { getMessages().add(new HgHookMessage(Severity.ERROR, message)); } - /** - * Method description - * - * - * @param message - */ + @Override public void sendMessage(String message) { getMessages().add(new HgHookMessage(Severity.NOTE, message)); } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + public List getMessages() { if (messages == null) @@ -83,8 +61,4 @@ public class HgHookMessageProvider implements HookMessageProvider return messages; } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private List messages; } diff --git a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/api/HgHookTagProvider.java b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/api/HgHookTagProvider.java index 2fc48140be..6c21666708 100644 --- a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/api/HgHookTagProvider.java +++ b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/api/HgHookTagProvider.java @@ -37,7 +37,6 @@ import sonia.scm.repository.spi.HookChangesetResponse; /** * Mercurial tag provider implementation. * - * @author Sebastian Sdorra * @since 1.50 */ public class HgHookTagProvider implements HookTagProvider { @@ -51,11 +50,6 @@ public class HgHookTagProvider implements HookTagProvider { private List createdTags; private final List deletedTags = Collections.emptyList(); - /** - * Constructs a new instance. - * - * @param changesetProvider changeset provider - */ public HgHookTagProvider(HookChangesetProvider changesetProvider) { this.changesetProvider = changesetProvider; } diff --git a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/AbstractCommand.java b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/AbstractCommand.java index 929e73ae8b..40c16a21b8 100644 --- a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/AbstractCommand.java +++ b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/AbstractCommand.java @@ -24,14 +24,10 @@ package sonia.scm.repository.spi; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.repository.Repository; -/** - * - * @author Sebastian Sdorra - */ + public class AbstractCommand { diff --git a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/AbstractHgPushOrPullCommand.java b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/AbstractHgPushOrPullCommand.java index 02c4ae1b1d..05f7f12cee 100644 --- a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/AbstractHgPushOrPullCommand.java +++ b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/AbstractHgPushOrPullCommand.java @@ -24,40 +24,22 @@ package sonia.scm.repository.spi; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.repository.HgRepositoryHandler; import sonia.scm.repository.Repository; -/** - * - * @author Sebastian Sdorra - */ public class AbstractHgPushOrPullCommand extends AbstractCommand { + protected final HgRepositoryHandler handler; - /** - * Constructs ... - * - * @param handler - * @param context - */ protected AbstractHgPushOrPullCommand(HgRepositoryHandler handler, HgCommandContext context) { super(context); this.handler = handler; } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param request - * - * @return - */ + protected String getRemoteUrl(RemoteCommandRequest request) { String url; @@ -80,8 +62,4 @@ public class AbstractHgPushOrPullCommand extends AbstractCommand return url; } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - protected final HgRepositoryHandler handler; } diff --git a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/HgBlameCommand.java b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/HgBlameCommand.java index 8705e6f606..5d22e0cc32 100644 --- a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/HgBlameCommand.java +++ b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/HgBlameCommand.java @@ -24,7 +24,6 @@ package sonia.scm.repository.spi; -//~--- non-JDK imports -------------------------------------------------------- import com.google.inject.assistedinject.Assisted; import jakarta.inject.Inject; @@ -43,29 +42,15 @@ import sonia.scm.web.HgUtil; import java.io.IOException; import java.util.List; -//~--- JDK imports ------------------------------------------------------------ -/** - * - * @author Sebastian Sdorra - */ public class HgBlameCommand extends AbstractCommand implements BlameCommand { - /** - * the logger for HgBlameCommand - */ + private static final Logger logger = LoggerFactory.getLogger(HgBlameCommand.class); - //~--- constructors --------------------------------------------------------- - /** - * Constructs ... - * - * @param context - * - */ @Inject HgBlameCommand(@Assisted HgCommandContext context) @@ -73,7 +58,6 @@ public class HgBlameCommand extends AbstractCommand implements BlameCommand super(context); } - //~--- get methods ---------------------------------------------------------- @Override public BlameResult getBlameResult(BlameCommandRequest request) @@ -100,17 +84,8 @@ public class HgBlameCommand extends AbstractCommand implements BlameCommand return new BlameResult(blameLines); } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param line - * @param counter - * - * @return - */ + private BlameLine convert(AnnotateLine line, int counter) { BlameLine blameLine = new BlameLine(); diff --git a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/HgBranchesCommand.java b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/HgBranchesCommand.java index 7ee7260f8e..600a04a39d 100644 --- a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/HgBranchesCommand.java +++ b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/HgBranchesCommand.java @@ -24,7 +24,6 @@ package sonia.scm.repository.spi; -//~--- non-JDK imports -------------------------------------------------------- import com.google.inject.assistedinject.Assisted; import jakarta.inject.Inject; @@ -35,31 +34,19 @@ import sonia.scm.repository.Person; import java.util.List; -//~--- JDK imports ------------------------------------------------------------ -/** - * - * @author Sebastian Sdorra - */ public class HgBranchesCommand extends AbstractCommand implements BranchesCommand { private static final String DEFAULT_BRANCH_NAME = "default"; - /** - * Constructs ... - * - * @param context - * - */ @Inject public HgBranchesCommand(@Assisted HgCommandContext context) { super(context); } - //~--- get methods ---------------------------------------------------------- @Override public List getBranches() { diff --git a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/HgBrowseCommand.java b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/HgBrowseCommand.java index 58a38d0a28..c7c621d1c2 100644 --- a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/HgBrowseCommand.java +++ b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/HgBrowseCommand.java @@ -24,7 +24,6 @@ package sonia.scm.repository.spi; -//~--- non-JDK imports -------------------------------------------------------- import com.google.inject.assistedinject.Assisted; import jakarta.inject.Inject; @@ -41,30 +40,19 @@ import java.io.IOException; import static sonia.scm.ContextEntry.ContextBuilder.entity; import static sonia.scm.NotFoundException.notFound; -//~--- JDK imports ------------------------------------------------------------ - /** * Utilizes the mercurial fileview extension in order to support mercurial repository browsing. * - * @author Sebastian Sdorra */ public class HgBrowseCommand extends AbstractCommand implements BrowseCommand { - /** - * Constructs ... - * - * @param context - * - */ - @Inject public HgBrowseCommand(@Assisted HgCommandContext context) { super(context); } - //~--- get methods ---------------------------------------------------------- @Override public BrowserResult getBrowserResult(BrowseCommandRequest request) throws IOException { diff --git a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/HgCommandContext.java b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/HgCommandContext.java index e9284371f8..1f0465ec03 100644 --- a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/HgCommandContext.java +++ b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/HgCommandContext.java @@ -24,7 +24,6 @@ package sonia.scm.repository.spi; -//~--- non-JDK imports -------------------------------------------------------- import org.javahg.Repository; import sonia.scm.repository.HgConfig; @@ -35,12 +34,7 @@ import sonia.scm.repository.RepositoryProvider; import java.io.Closeable; import java.io.File; -//~--- JDK imports ------------------------------------------------------------ -/** - * - * @author Sebastian Sdorra - */ public class HgCommandContext implements Closeable, RepositoryProvider { private final HgConfigResolver configResolver; diff --git a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/HgDiffCommand.java b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/HgDiffCommand.java index 8166d41577..b707d778c9 100644 --- a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/HgDiffCommand.java +++ b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/HgDiffCommand.java @@ -39,9 +39,7 @@ import java.io.IOException; import java.io.InputStream; import java.io.OutputStream; -/** - * @author Sebastian Sdorra - */ + public class HgDiffCommand extends AbstractCommand implements DiffCommand { @Inject diff --git a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/HgHookChangesetProvider.java b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/HgHookChangesetProvider.java index 6570b34863..d015301a6a 100644 --- a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/HgHookChangesetProvider.java +++ b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/HgHookChangesetProvider.java @@ -34,10 +34,7 @@ import sonia.scm.repository.api.HookChangesetProvider; import sonia.scm.repository.spi.javahg.HgLogChangesetCommand; import sonia.scm.web.HgUtil; -/** - * - * @author Sebastian Sdorra - */ + public class HgHookChangesetProvider implements HookChangesetProvider { private static final Logger LOG = LoggerFactory.getLogger(HgHookChangesetProvider.class); diff --git a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/HgHookContextProvider.java b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/HgHookContextProvider.java index 5119b0dd2e..a27595590d 100644 --- a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/HgHookContextProvider.java +++ b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/HgHookContextProvider.java @@ -39,12 +39,9 @@ import sonia.scm.repository.api.HookTagProvider; import java.util.EnumSet; import java.util.Set; -//~--- JDK imports ------------------------------------------------------------ - /** * Mercurial implementation of {@link HookContextProvider}. * - * @author Sebastian Sdorra */ public class HgHookContextProvider extends HookContextProvider { diff --git a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/HgIncomingCommand.java b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/HgIncomingCommand.java index da4ddee2bf..6bc1c4d940 100644 --- a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/HgIncomingCommand.java +++ b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/HgIncomingCommand.java @@ -24,7 +24,6 @@ package sonia.scm.repository.spi; -//~--- non-JDK imports -------------------------------------------------------- import com.google.inject.assistedinject.Assisted; import jakarta.inject.Inject; @@ -39,27 +38,15 @@ import java.io.File; import java.util.Collections; import java.util.List; -//~--- JDK imports ------------------------------------------------------------ -/** - * - * @author Sebastian Sdorra - */ public class HgIncomingCommand extends AbstractCommand implements IncomingCommand { - /** Field description */ private static final int NO_INCOMING_CHANGESETS = 1; - //~--- constructors --------------------------------------------------------- + private HgRepositoryHandler handler; - /** - * Constructs ... - * - * @param context - * @param handler - */ @Inject HgIncomingCommand(@Assisted HgCommandContext context, HgRepositoryHandler handler) { @@ -67,7 +54,6 @@ public class HgIncomingCommand extends AbstractCommand this.handler = handler; } - //~--- get methods ---------------------------------------------------------- @Override @SuppressWarnings("unchecked") @@ -101,27 +87,14 @@ public class HgIncomingCommand extends AbstractCommand return new ChangesetPagingResult(changesets.size(), changesets); } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param repository - * - * @return - */ + private HgIncomingChangesetCommand on( org.javahg.Repository repository) { return HgIncomingChangesetCommand.on(repository, getContext().getConfig()); } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private HgRepositoryHandler handler; - public interface Factory { HgIncomingCommand create(HgCommandContext context); } diff --git a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/HgOutgoingCommand.java b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/HgOutgoingCommand.java index f9eab06eff..a282671233 100644 --- a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/HgOutgoingCommand.java +++ b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/HgOutgoingCommand.java @@ -24,7 +24,6 @@ package sonia.scm.repository.spi; -//~--- non-JDK imports -------------------------------------------------------- import com.google.inject.assistedinject.Assisted; import jakarta.inject.Inject; @@ -39,27 +38,16 @@ import java.io.File; import java.util.Collections; import java.util.List; -//~--- JDK imports ------------------------------------------------------------ -/** - * - * @author Sebastian Sdorra - */ public class HgOutgoingCommand extends AbstractCommand implements OutgoingCommand { - /** Field description */ private static final int NO_OUTGOING_CHANGESETS = 1; - //~--- constructors --------------------------------------------------------- + private HgRepositoryHandler handler; + - /** - * Constructs ... - * - * @param context - * @param handler - */ @Inject HgOutgoingCommand(@Assisted HgCommandContext context, HgRepositoryHandler handler) { @@ -67,7 +55,6 @@ public class HgOutgoingCommand extends AbstractCommand this.handler = handler; } - //~--- get methods ---------------------------------------------------------- @Override @SuppressWarnings("unchecked") @@ -101,27 +88,14 @@ public class HgOutgoingCommand extends AbstractCommand return new ChangesetPagingResult(changesets.size(), changesets); } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param repository - * - * @return - */ + private HgOutgoingChangesetCommand on( org.javahg.Repository repository) { return HgOutgoingChangesetCommand.on(repository, getContext().getConfig()); } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private HgRepositoryHandler handler; - public interface Factory { HgOutgoingCommand create(HgCommandContext context); } diff --git a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/HgPushCommand.java b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/HgPushCommand.java index d0378fb7e3..da817c9432 100644 --- a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/HgPushCommand.java +++ b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/HgPushCommand.java @@ -24,7 +24,6 @@ package sonia.scm.repository.spi; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Strings; import com.google.inject.assistedinject.Assisted; @@ -40,11 +39,7 @@ import sonia.scm.repository.api.PushResponse; import java.io.IOException; import java.util.List; -//~--- JDK imports ------------------------------------------------------------ -/** - * @author Sebastian Sdorra - */ public class HgPushCommand extends AbstractHgPushOrPullCommand implements PushCommand { private static final Logger LOG = LoggerFactory.getLogger(HgPushCommand.class); diff --git a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/HgRepositoryServiceProvider.java b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/HgRepositoryServiceProvider.java index fd836beb25..539ddc744d 100644 --- a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/HgRepositoryServiceProvider.java +++ b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/HgRepositoryServiceProvider.java @@ -33,9 +33,7 @@ import java.io.IOException; import java.util.EnumSet; import java.util.Set; -/** - * @author Sebastian Sdorra - */ + public class HgRepositoryServiceProvider extends RepositoryServiceProvider { public static final Set COMMANDS = EnumSet.of( diff --git a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/HgRepositoryServiceResolver.java b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/HgRepositoryServiceResolver.java index 6627b86413..61723a059b 100644 --- a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/HgRepositoryServiceResolver.java +++ b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/HgRepositoryServiceResolver.java @@ -30,9 +30,7 @@ import sonia.scm.plugin.Extension; import sonia.scm.repository.HgRepositoryHandler; import sonia.scm.repository.Repository; -/** - * @author Sebastian Sdorra - */ + @Extension public class HgRepositoryServiceResolver implements RepositoryServiceResolver { diff --git a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/HgTagsCommand.java b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/HgTagsCommand.java index 6f43d874ff..a8646cb8c8 100644 --- a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/HgTagsCommand.java +++ b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/HgTagsCommand.java @@ -24,7 +24,6 @@ package sonia.scm.repository.spi; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Function; import com.google.common.base.Strings; @@ -36,31 +35,20 @@ import sonia.scm.util.Util; import java.util.List; -/** - * @author Sebastian Sdorra - */ + public class HgTagsCommand extends AbstractCommand implements TagsCommand { public static final String DEFAULT_TAG_NAME = "tip"; - /** - * Constructs ... - * - * @param context - */ + @Inject public HgTagsCommand(@Assisted HgCommandContext context) { super(context); } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * @return - */ + @Override public List getTags() { org.javahg.commands.TagsCommand cmd = @@ -82,23 +70,9 @@ public class HgTagsCommand extends AbstractCommand implements TagsCommand { return tags; } - //~--- inner classes -------------------------------------------------------- - - /** - * Class description - * - * @author Enter your name here... - * @version Enter version here..., 12/08/03 - */ private static class TagTransformer implements Function { - /** - * Method description - * - * @param f - * @return - */ @Override public Tag apply(org.javahg.Tag f) { Tag t = null; diff --git a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/javahg/AbstractChangesetCommand.java b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/javahg/AbstractChangesetCommand.java index 0a848e2f16..1ba7a129ba 100644 --- a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/javahg/AbstractChangesetCommand.java +++ b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/javahg/AbstractChangesetCommand.java @@ -24,7 +24,6 @@ package sonia.scm.repository.spi.javahg; -//~--- non-JDK imports -------------------------------------------------------- import org.javahg.DateTime; import org.javahg.Repository; @@ -43,16 +42,10 @@ import java.io.IOException; import java.util.Collection; import java.util.List; -//~--- JDK imports ------------------------------------------------------------ -/** - * - * @author Sebastian Sdorra - */ public abstract class AbstractChangesetCommand extends AbstractCommand { - /** Field description */ public static final String BRANCH_DEFAULT = "default"; /** @@ -63,17 +56,14 @@ public abstract class AbstractChangesetCommand extends AbstractCommand */ private static final byte[] CHANGESET_PATTERN = Utils.randomBytes(); - /** Field description */ public static final String CHANGESET_LAZY_STYLE_PATH = Utils.resourceAsFile("/sonia/scm/styles/changesets-lazy.style", ImmutableMap.of("pattern", CHANGESET_PATTERN)).getPath(); - /** Field description */ protected static final String CHANGESET_EAGER_STYLE_PATH = Utils.resourceAsFile("/sonia/scm/styles/changesets-eager.style", ImmutableMap.of("pattern", CHANGESET_PATTERN)).getPath(); - /** Field description */ private static final String NULL_ID = "0000000000000000000000000000000000000000"; @@ -89,15 +79,8 @@ public abstract class AbstractChangesetCommand extends AbstractCommand /** changeset property for node revision */ private static final String PROPERTY_REVISION = "hg.rev"; - //~--- constructors --------------------------------------------------------- - - /** - * Constructs ... - * - * - * @param repository - * @param config - */ + private HgConfig config; + AbstractChangesetCommand(Repository repository, HgConfig config) { super(repository); @@ -105,16 +88,8 @@ public abstract class AbstractChangesetCommand extends AbstractCommand withDebugFlag(); } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param stream - * - * @return - */ + protected List loadRevisionsFromStream(HgInputStream stream) { List revisions = Lists.newArrayList(); @@ -140,14 +115,7 @@ public abstract class AbstractChangesetCommand extends AbstractCommand return revisions; } - /** - * Method description - * - * - * @param in - * - * @return - */ + protected List readListFromStream(HgInputStream in) { List changesets = Lists.newArrayList(); @@ -182,16 +150,7 @@ public abstract class AbstractChangesetCommand extends AbstractCommand return changesets; } - /** - * Method description - * - * - * @param in - * - * @return - * - * @throws IOException - */ + private Changeset createFromInputStream(HgInputStream in) throws IOException { Changeset changeset = new Changeset(); @@ -276,18 +235,6 @@ public abstract class AbstractChangesetCommand extends AbstractCommand return hgModificationParser.getModifications(); } - /** - * Method description - * - * - * @param in - * @param changeset - * @param propertyKey - * - * @return - * - * @throws IOException - */ private String readId(HgInputStream in, Changeset changeset, String propertyKey) throws IOException @@ -307,24 +254,12 @@ public abstract class AbstractChangesetCommand extends AbstractCommand return in.nextAsText(40); } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param id - * - * @return - */ + private boolean isNullId(String id) { return ((id != null) && id.equals("-1:".concat(NULL_ID))) || NULL_ID.equals(id); } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private HgConfig config; } diff --git a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/javahg/HgDiffInternalCommand.java b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/javahg/HgDiffInternalCommand.java index 0e977dbf3c..d7cb25e3f7 100644 --- a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/javahg/HgDiffInternalCommand.java +++ b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/javahg/HgDiffInternalCommand.java @@ -24,63 +24,35 @@ package sonia.scm.repository.spi.javahg; -//~--- non-JDK imports -------------------------------------------------------- import org.javahg.Repository; import org.javahg.internals.AbstractCommand; import org.javahg.internals.HgInputStream; import org.javahg.internals.Utils; -//~--- JDK imports ------------------------------------------------------------ - import java.io.File; -/** - * - * @author Sebastian Sdorra - */ + public final class HgDiffInternalCommand extends AbstractCommand { - /** Field description */ private static final String NAME = "diff"; - //~--- constructors --------------------------------------------------------- - /** - * Constructs ... - * - * - * @param repository - */ + private HgDiffInternalCommand(Repository repository) { super(repository, NAME); } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param repository - * - * @return - */ + public static HgDiffInternalCommand on(Repository repository) { return new HgDiffInternalCommand(repository); } - /** - * Method description - * - * - * @param rev - * - * @return - */ + public HgDiffInternalCommand change(String rev) { cmdAppend("--change", rev); @@ -88,25 +60,13 @@ public final class HgDiffInternalCommand extends AbstractCommand return this; } - /** - * Method description - * - * - * @param files - * - * @return - */ + public String execute(String... files) { return launchString(files); } - /** - * Method description - * - * - * @return - */ + public HgDiffInternalCommand git() { cmdAppend("--git"); @@ -114,27 +74,14 @@ public final class HgDiffInternalCommand extends AbstractCommand return this; } - /** - * Method description - * - * - * @param files - * - * @return - */ + public HgInputStream stream(File... files) { return launchStream(Utils.fileArray2StringArray(files)); } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + @Override public String getCommandName() { diff --git a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/javahg/HgFileviewCommand.java b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/javahg/HgFileviewCommand.java index 64877a1aa7..c7cf04b462 100644 --- a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/javahg/HgFileviewCommand.java +++ b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/javahg/HgFileviewCommand.java @@ -24,22 +24,18 @@ package sonia.scm.repository.spi.javahg; -//~--- non-JDK imports -------------------------------------------------------- import org.javahg.Repository; import org.javahg.internals.AbstractCommand; import org.javahg.internals.HgInputStream; import sonia.scm.repository.FileObject; -//~--- JDK imports ------------------------------------------------------------ - import java.io.IOException; import java.util.Optional; /** * Mercurial command to list files of a repository. * - * @author Sebastian Sdorra */ public class HgFileviewCommand extends AbstractCommand { @@ -65,8 +61,6 @@ public class HgFileviewCommand extends AbstractCommand /** * Disable last commit fetching for file objects. - * - * @return {@code this} */ public HgFileviewCommand disableLastCommit() { disableLastCommit = true; @@ -77,8 +71,6 @@ public class HgFileviewCommand extends AbstractCommand /** * Disables sub repository detection - * - * @return {@code this} */ public HgFileviewCommand disableSubRepositoryDetection() { cmdAppend("-s"); @@ -176,8 +168,6 @@ public class HgFileviewCommand extends AbstractCommand /** * Returns the name of the mercurial command. - * - * @return command name */ @Override public String getCommandName() diff --git a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/javahg/HgFileviewExtension.java b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/javahg/HgFileviewExtension.java index df72fe0687..c2565da48e 100644 --- a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/javahg/HgFileviewExtension.java +++ b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/javahg/HgFileviewExtension.java @@ -24,15 +24,11 @@ package sonia.scm.repository.spi.javahg; -//~--- non-JDK imports -------------------------------------------------------- import org.javahg.MercurialExtension; import sonia.scm.repository.HgExtensions; -/** - * - * @author Sebastian Sdorra - */ + public class HgFileviewExtension extends MercurialExtension { static final String NAME = "fileview"; diff --git a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/javahg/HgIncomingChangesetCommand.java b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/javahg/HgIncomingChangesetCommand.java index 6046e20c49..99b2ab3df6 100644 --- a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/javahg/HgIncomingChangesetCommand.java +++ b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/javahg/HgIncomingChangesetCommand.java @@ -24,55 +24,30 @@ package sonia.scm.repository.spi.javahg; -//~--- non-JDK imports -------------------------------------------------------- import org.javahg.Repository; import sonia.scm.repository.HgConfig; -/** - * - * @author Sebastian Sdorra - */ + public class HgIncomingChangesetCommand extends HgIncomingOutgoingChangesetCommand { - /** - * Constructs ... - * - * - * @param repository - * @param config - */ + private HgIncomingChangesetCommand(Repository repository, HgConfig config) { super(repository, config); } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param repository - * @param config - * - * @return - */ + public static HgIncomingChangesetCommand on(Repository repository, HgConfig config) { return new HgIncomingChangesetCommand(repository, config); } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + @Override public String getCommandName() { diff --git a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/javahg/HgIncomingOutgoingChangesetCommand.java b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/javahg/HgIncomingOutgoingChangesetCommand.java index 87d234952b..b21bb47078 100644 --- a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/javahg/HgIncomingOutgoingChangesetCommand.java +++ b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/javahg/HgIncomingOutgoingChangesetCommand.java @@ -24,7 +24,6 @@ package sonia.scm.repository.spi.javahg; -//~--- non-JDK imports -------------------------------------------------------- import org.javahg.Repository; import org.javahg.internals.HgInputStream; @@ -33,39 +32,20 @@ import sonia.scm.repository.Changeset; import sonia.scm.repository.HgConfig; import sonia.scm.util.IOUtil; -//~--- JDK imports ------------------------------------------------------------ - import java.util.List; -/** - * - * @author Sebastian Sdorra - */ + public abstract class HgIncomingOutgoingChangesetCommand extends AbstractChangesetCommand { - /** - * Constructs ... - * - * - * @param repository - * @param config - */ + public HgIncomingOutgoingChangesetCommand(Repository repository, HgConfig config) { super(repository, config); } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param remoteRepository - * - * @return - */ + public List execute(String remoteRepository) { cmdAppend("--style", CHANGESET_EAGER_STYLE_PATH); diff --git a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/javahg/HgLogChangesetCommand.java b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/javahg/HgLogChangesetCommand.java index 77659c5139..96f04377a2 100644 --- a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/javahg/HgLogChangesetCommand.java +++ b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/javahg/HgLogChangesetCommand.java @@ -37,9 +37,7 @@ import java.io.IOException; import java.util.Collection; import java.util.List; -/** - * @author Sebastian Sdorra - */ + public class HgLogChangesetCommand extends AbstractChangesetCommand { private static final Logger LOG = LoggerFactory.getLogger(HgLogChangesetCommand.class); diff --git a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/javahg/HgOutgoingChangesetCommand.java b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/javahg/HgOutgoingChangesetCommand.java index 2b6c52837c..6a7417c9c6 100644 --- a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/javahg/HgOutgoingChangesetCommand.java +++ b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/javahg/HgOutgoingChangesetCommand.java @@ -24,56 +24,31 @@ package sonia.scm.repository.spi.javahg; -//~--- non-JDK imports -------------------------------------------------------- import org.javahg.Repository; import sonia.scm.repository.HgConfig; -/** - * - * @author Sebastian Sdorra - */ + public class HgOutgoingChangesetCommand extends HgIncomingOutgoingChangesetCommand { - /** - * Constructs ... - * - * - * @param repository - * @param config - */ + public HgOutgoingChangesetCommand(Repository repository, HgConfig config) { super(repository, config); } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param repository - * @param config - * - * @return - */ + public static HgOutgoingChangesetCommand on(Repository repository, HgConfig config) { return new HgOutgoingChangesetCommand(repository, config); } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + @Override public String getCommandName() { diff --git a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/web/HgCGIExceptionHandler.java b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/web/HgCGIExceptionHandler.java index 3336252fdf..f7afc976be 100644 --- a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/web/HgCGIExceptionHandler.java +++ b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/web/HgCGIExceptionHandler.java @@ -24,7 +24,6 @@ package sonia.scm.web; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Charsets; import com.google.common.base.Strings; @@ -43,63 +42,39 @@ import java.io.OutputStream; import java.io.PrintWriter; import java.util.Locale; -/** - * - * @author Sebastian Sdorra - */ + public class HgCGIExceptionHandler implements CGIExceptionHandler, CGIStatusCodeHandler { - /** Field description */ public static final String BUNDLE_PATH = "sonia.scm.web.cgimessages"; - /** Field description */ public static final String CONTENT_TYPE_ERROR = "application/hg-error"; - /** Field description */ public static final String CONTENT_TYPE_HTML = "text/html"; /** TODO create a bundle for error messages */ public static final String ERROR_NOT_CONFIGURED = "error.notConfigured"; - /** Field description */ public static final String ERROR_STATUSCODE = "error.statusCode"; - /** Field description */ public static final String ERROR_UNEXPECTED = "error.unexpected"; - /** Field description */ private static final String HEADER_ACCEPT = "Accept"; - /** - * the logger for HgCGIExceptionHandler - */ + private static final Logger logger = LoggerFactory.getLogger(HgCGIExceptionHandler.class); - //~--- constructors --------------------------------------------------------- - /** - * Constructs ... - * - */ public HgCGIExceptionHandler() { this.bundle = Bundle.getBundle(BUNDLE_PATH, Locale.ENGLISH, HgCGIExceptionHandler.class.getClassLoader()); } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param request - * @param response - * @param ex - */ + @Override public void handleException(HttpServletRequest request, HttpServletResponse response, Throwable ex) @@ -118,17 +93,7 @@ public class HgCGIExceptionHandler //J+ } - /** - * Method description - * - * - * @param request - * @param response - * @param output - * @param statusCode - * - * @throws IOException - */ + @Override public void handleStatusCode(HttpServletRequest request, HttpServletResponse response, OutputStream output, int statusCode) @@ -153,13 +118,7 @@ public class HgCGIExceptionHandler } } - /** - * Method description - * - * - * @param request - * @param statusCode - */ + @Override public void handleStatusCode(HttpServletRequest request, int statusCode) { @@ -223,15 +182,8 @@ public class HgCGIExceptionHandler sendError(request, response, bundle.getString(key)); } - //~--- set methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param request - * @param response - */ + private void setContentType(HttpServletRequest request, HttpServletResponse response) { @@ -249,6 +201,5 @@ public class HgCGIExceptionHandler //~--- fields --------------------------------------------------------------- - /** Field description */ private Bundle bundle; } diff --git a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/web/HgCGIServlet.java b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/web/HgCGIServlet.java index bee43b84e5..9f4220f4b9 100644 --- a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/web/HgCGIServlet.java +++ b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/web/HgCGIServlet.java @@ -53,16 +53,13 @@ import java.io.IOException; import java.util.ArrayList; import java.util.List; -/** - * - * @author Sebastian Sdorra - */ + @Singleton public class HgCGIServlet extends HttpServlet implements ScmProviderHttpServlet { private static final long serialVersionUID = -3492811300905099810L; - /** the logger for HgCGIServlet */ + private static final Logger logger = LoggerFactory.getLogger(HgCGIServlet.class); diff --git a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/web/HgPermissionFilter.java b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/web/HgPermissionFilter.java index 0c51d8f581..0826042b18 100644 --- a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/web/HgPermissionFilter.java +++ b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/web/HgPermissionFilter.java @@ -39,7 +39,6 @@ import java.io.IOException; /** * Permission filter for mercurial repositories. * - * @author Sebastian Sdorra */ public class HgPermissionFilter extends PermissionFilter { diff --git a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/web/HgServletModule.java b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/web/HgServletModule.java index 8994edd624..2fb38c2d63 100644 --- a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/web/HgServletModule.java +++ b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/web/HgServletModule.java @@ -24,7 +24,6 @@ package sonia.scm.web; -//~--- non-JDK imports -------------------------------------------------------- import com.google.inject.assistedinject.FactoryModuleBuilder; import com.google.inject.servlet.ServletModule; @@ -35,10 +34,7 @@ import sonia.scm.api.v2.resources.HgRepositoryConfigMapper; import sonia.scm.plugin.Extension; import sonia.scm.repository.spi.*; -/** - * - * @author Sebastian Sdorra - */ + @Extension public class HgServletModule extends ServletModule { diff --git a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/web/HgUserAgentProvider.java b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/web/HgUserAgentProvider.java index 109c80a09a..288d1fd592 100644 --- a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/web/HgUserAgentProvider.java +++ b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/web/HgUserAgentProvider.java @@ -24,14 +24,11 @@ package sonia.scm.web; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.annotations.VisibleForTesting; import sonia.scm.plugin.Extension; -//~--- JDK imports ------------------------------------------------------------ - import java.nio.charset.Charset; /** @@ -48,19 +45,10 @@ public class HgUserAgentProvider implements UserAgentProvider static UserAgent HG = UserAgent.scmClient("Mercurial").basicAuthenticationCharset( Charset.defaultCharset()).build(); - /** Field description */ private static final String PREFIX = "mercurial"; - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param userAgentString - * - * @return - */ + @Override public UserAgent parseUserAgent(String userAgentString) { diff --git a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/web/HgUtil.java b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/web/HgUtil.java index 4353ec74e9..c7d5bb31e9 100644 --- a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/web/HgUtil.java +++ b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/web/HgUtil.java @@ -26,10 +26,7 @@ package sonia.scm.web; import sonia.scm.util.Util; -/** - * - * @author Sebastian Sdorra - */ + public final class HgUtil { public static final String REVISION_TIP = "tip"; diff --git a/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/HgRepositoryHandlerTest.java b/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/HgRepositoryHandlerTest.java index 5f3f8b8821..7e5a0a73ef 100644 --- a/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/HgRepositoryHandlerTest.java +++ b/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/HgRepositoryHandlerTest.java @@ -24,7 +24,6 @@ package sonia.scm.repository; -//~--- non-JDK imports -------------------------------------------------------- import jakarta.annotation.Nonnull; @@ -47,11 +46,7 @@ import static org.mockito.ArgumentMatchers.any; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; -//~--- JDK imports ------------------------------------------------------------ -/** - * @author Sebastian Sdorra - */ @RunWith(MockitoJUnitRunner.Silent.class) public class HgRepositoryHandlerTest extends SimpleRepositoryHandlerTestBase { diff --git a/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/HgTestUtil.java b/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/HgTestUtil.java index 975c713cec..0efe7b426e 100644 --- a/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/HgTestUtil.java +++ b/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/HgTestUtil.java @@ -24,7 +24,6 @@ package sonia.scm.repository; -//~--- non-JDK imports -------------------------------------------------------- import org.junit.Assume; import sonia.scm.SCMContext; @@ -38,26 +37,14 @@ import java.io.File; import static org.mockito.Mockito.any; import static org.mockito.Mockito.mock; -//~--- JDK imports ------------------------------------------------------------ -/** - * @author Sebastian Sdorra - */ public final class HgTestUtil { - /** - * Constructs ... - */ private HgTestUtil() { } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * @param handler - */ + public static void checkForSkip(HgRepositoryHandler handler) { // skip tests if hg not in path diff --git a/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/TempSCMContextProvider.java b/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/TempSCMContextProvider.java index db56bcc78f..f2dcadf478 100644 --- a/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/TempSCMContextProvider.java +++ b/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/TempSCMContextProvider.java @@ -24,80 +24,48 @@ package sonia.scm.repository; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.SCMContextProvider; import sonia.scm.Stage; -//~--- JDK imports ------------------------------------------------------------ - import java.io.File; import java.io.IOException; import java.nio.file.Path; -/** - * - * @author Sebastian Sdorra - */ + public class TempSCMContextProvider implements SCMContextProvider { - /** - * Method description - * - * - * @return - */ + @Override public File getBaseDirectory() { return baseDirectory; } - /** - * Method description - * - * - * @return - */ + @Override public Stage getStage() { return Stage.DEVELOPMENT; } - /** - * Method description - * - * - * @return - */ + @Override public Throwable getStartupError() { return null; } - /** - * Method description - * - * - * @return - */ + @Override public String getVersion() { return "900.0.1-SNAPSHOT"; } - //~--- set methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param baseDirectory - */ + public void setBaseDirectory(File baseDirectory) { this.baseDirectory = baseDirectory; @@ -110,6 +78,5 @@ public class TempSCMContextProvider implements SCMContextProvider //~--- fields --------------------------------------------------------------- - /** Field description */ private File baseDirectory; } diff --git a/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/api/HgHookTagProviderTest.java b/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/api/HgHookTagProviderTest.java index 2429aff18f..c3891e5c4c 100644 --- a/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/api/HgHookTagProviderTest.java +++ b/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/api/HgHookTagProviderTest.java @@ -46,7 +46,6 @@ import static org.mockito.Mockito.when; /** * Unit tests for {@link HgHookTagProvider}. * - * @author Sebastian Sdorra */ @RunWith(MockitoJUnitRunner.class) public class HgHookTagProviderTest { diff --git a/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/client/spi/HgAddCommand.java b/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/client/spi/HgAddCommand.java index 51edcd49d6..dd5882c221 100644 --- a/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/client/spi/HgAddCommand.java +++ b/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/client/spi/HgAddCommand.java @@ -30,7 +30,6 @@ import java.io.IOException; /** * Mercurial implementation of the {@link AddCommand}. * - * @author Sebastian Sdorra */ public final class HgAddCommand implements AddCommand { diff --git a/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/client/spi/HgBranchCommand.java b/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/client/spi/HgBranchCommand.java index 31b855b681..aa9dbc4ec4 100644 --- a/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/client/spi/HgBranchCommand.java +++ b/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/client/spi/HgBranchCommand.java @@ -31,7 +31,6 @@ import sonia.scm.repository.Branch; /** * Mercurial implementation of the {@link BranchCommand}. * - * @author Sebastian Sdorra */ public class HgBranchCommand implements BranchCommand { diff --git a/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/client/spi/HgCommitCommand.java b/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/client/spi/HgCommitCommand.java index a55c50af5e..4d554a6368 100644 --- a/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/client/spi/HgCommitCommand.java +++ b/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/client/spi/HgCommitCommand.java @@ -34,7 +34,6 @@ import java.io.IOException; /** * Mercurial implementation of the {@link CommitCommand}. * - * @author Sebastian Sdorra */ public class HgCommitCommand implements CommitCommand { diff --git a/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/client/spi/HgPushCommand.java b/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/client/spi/HgPushCommand.java index 0e2b8d557d..2a95a85f4f 100644 --- a/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/client/spi/HgPushCommand.java +++ b/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/client/spi/HgPushCommand.java @@ -33,7 +33,6 @@ import java.io.IOException; /** * Mercurial implementation of the {@link PushCommand}. * - * @author Sebastian Sdorra */ public class HgPushCommand implements PushCommand { diff --git a/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/client/spi/HgRemoveCommand.java b/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/client/spi/HgRemoveCommand.java index dae808b67c..ce280578b3 100644 --- a/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/client/spi/HgRemoveCommand.java +++ b/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/client/spi/HgRemoveCommand.java @@ -30,7 +30,6 @@ import java.io.IOException; /** * Mercurial implementation of the {@link RemoveCommand}. * - * @author Sebastian Sdorra */ public class HgRemoveCommand implements RemoveCommand { diff --git a/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/client/spi/HgRepositoryClientFactoryProvider.java b/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/client/spi/HgRepositoryClientFactoryProvider.java index 4f269cb1f8..8d8c3674c4 100644 --- a/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/client/spi/HgRepositoryClientFactoryProvider.java +++ b/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/client/spi/HgRepositoryClientFactoryProvider.java @@ -41,7 +41,6 @@ import sonia.scm.util.IOUtil; /** * Mercurial implementation of the {@link RepositoryClientFactoryProvider}. * - * @author Sebastian Sdorra */ public class HgRepositoryClientFactoryProvider implements RepositoryClientFactoryProvider { diff --git a/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/client/spi/HgRepositoryClientProvider.java b/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/client/spi/HgRepositoryClientProvider.java index ef50c6ee43..6080a9713b 100644 --- a/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/client/spi/HgRepositoryClientProvider.java +++ b/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/client/spi/HgRepositoryClientProvider.java @@ -35,7 +35,6 @@ import java.util.Set; /** * Mercurial implementation of the {@link RepositoryClientProvider}. * - * @author Sebastian Sdorra */ public class HgRepositoryClientProvider extends RepositoryClientProvider { diff --git a/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/client/spi/HgTagCommand.java b/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/client/spi/HgTagCommand.java index 0684ff008f..aca4db4a8d 100644 --- a/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/client/spi/HgTagCommand.java +++ b/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/client/spi/HgTagCommand.java @@ -31,7 +31,6 @@ import sonia.scm.repository.Tag; /** * Mercurial implementation of the {@link TagCommand}. * - * @author Sebastian Sdorra */ public class HgTagCommand implements TagCommand { diff --git a/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/spi/AbstractHgCommandTestBase.java b/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/spi/AbstractHgCommandTestBase.java index c80e807dbf..0b2a6a5971 100644 --- a/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/spi/AbstractHgCommandTestBase.java +++ b/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/spi/AbstractHgCommandTestBase.java @@ -24,7 +24,6 @@ package sonia.scm.repository.spi; -//~--- non-JDK imports -------------------------------------------------------- import org.junit.After; import org.junit.Before; @@ -36,23 +35,13 @@ import sonia.scm.repository.HgTestUtil; import sonia.scm.repository.RepositoryTestData; import sonia.scm.util.MockUtil; -//~--- JDK imports ------------------------------------------------------------ - import java.io.IOException; -/** - * - * @author Sebastian Sdorra - */ + public class AbstractHgCommandTestBase extends ZippedRepositoryTestBase { - /** - * Method description - * - * - */ - @After + @After public void close() { if (cmdContext != null) { @@ -71,38 +60,22 @@ public class AbstractHgCommandTestBase extends ZippedRepositoryTestBase cmdContext = new HgCommandContext(resolver, factory, RepositoryTestData.createHeartOfGold()); } - //~--- set methods ---------------------------------------------------------- - /** - * Method description - * - */ - @Before + @Before public void setUp() { setSubject(MockUtil.createAdminSubject()); } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + @Override protected String getType() { return "hg"; } - /** - * Method description - * - * - * @return - */ + @Override protected String getZippedRepositoryResource() { @@ -111,9 +84,7 @@ public class AbstractHgCommandTestBase extends ZippedRepositoryTestBase //~--- fields --------------------------------------------------------------- - /** Field description */ protected HgCommandContext cmdContext; - /** Field description */ protected HgRepositoryHandler handler; } diff --git a/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/spi/HgBlameCommandTest.java b/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/spi/HgBlameCommandTest.java index 7662867e13..e423d4147c 100644 --- a/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/spi/HgBlameCommandTest.java +++ b/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/spi/HgBlameCommandTest.java @@ -24,7 +24,6 @@ package sonia.scm.repository.spi; -//~--- non-JDK imports -------------------------------------------------------- import org.junit.Test; import sonia.scm.repository.BlameLine; @@ -35,12 +34,7 @@ import java.io.IOException; import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertNotNull; -//~--- JDK imports ------------------------------------------------------------ -/** - * - * @author Sebastian Sdorra - */ public class HgBlameCommandTest extends AbstractHgCommandTestBase { @@ -86,12 +80,7 @@ public class HgBlameCommandTest extends AbstractHgCommandTestBase checkFirstLine(line); } - /** - * Method description - * - * - * @param line - */ + private void checkFirstLine(BlameLine line) { assertEquals(1, line.getLineNumber()); @@ -103,12 +92,7 @@ public class HgBlameCommandTest extends AbstractHgCommandTestBase assertEquals("douglas.adams@hitchhiker.com", line.getAuthor().getMail()); } - /** - * Method description - * - * - * @return - */ + private BlameCommand createCommand() { return new HgBlameCommand(cmdContext); diff --git a/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/spi/HgBrowseCommandTest.java b/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/spi/HgBrowseCommandTest.java index f52ac9a67b..1ae1f04bcf 100644 --- a/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/spi/HgBrowseCommandTest.java +++ b/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/spi/HgBrowseCommandTest.java @@ -38,10 +38,7 @@ import static org.junit.Assert.assertFalse; import static org.junit.Assert.assertNotNull; import static org.junit.Assert.assertTrue; -/** - * - * @author Sebastian Sdorra - */ + public class HgBrowseCommandTest extends AbstractHgCommandTestBase { @Test @@ -293,17 +290,8 @@ public class HgBrowseCommandTest extends AbstractHgCommandTestBase { .containsExactly("e.txt"); } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param foList - * @param name - * - * @return - */ + private FileObject getFileObject(Collection foList, String name) { return foList.stream() diff --git a/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/spi/HgIncomingCommandTest.java b/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/spi/HgIncomingCommandTest.java index 37698f4d89..864a522b36 100644 --- a/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/spi/HgIncomingCommandTest.java +++ b/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/spi/HgIncomingCommandTest.java @@ -24,7 +24,6 @@ package sonia.scm.repository.spi; -//~--- non-JDK imports -------------------------------------------------------- import org.javahg.Changeset; import org.junit.Test; @@ -38,21 +37,11 @@ import java.io.IOException; import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertNotNull; -//~--- JDK imports ------------------------------------------------------------ -/** - * - * @author Sebastian Sdorra - */ public class HgIncomingCommandTest extends IncomingOutgoingTestBase { - /** - * Method description - * - * - * @throws IOException - */ + @Test public void testGetIncomingChangesets() throws IOException { writeNewFile(outgoing, outgoingDirectory, "a.txt", "Content of file a.txt"); diff --git a/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/spi/HgLogCommandTest.java b/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/spi/HgLogCommandTest.java index ecfecc01bf..7893c91f86 100644 --- a/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/spi/HgLogCommandTest.java +++ b/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/spi/HgLogCommandTest.java @@ -24,7 +24,6 @@ package sonia.scm.repository.spi; -//~--- non-JDK imports -------------------------------------------------------- import org.junit.Test; import sonia.scm.repository.Changeset; @@ -39,12 +38,7 @@ import static org.junit.Assert.assertFalse; import static org.junit.Assert.assertNotNull; import static org.junit.Assert.assertTrue; -//~--- JDK imports ------------------------------------------------------------ -/** - * - * @author Sebastian Sdorra - */ public class HgLogCommandTest extends AbstractHgCommandTestBase { @@ -188,12 +182,7 @@ public class HgLogCommandTest extends AbstractHgCommandTestBase assertEquals("a9bacaf1b7fa0cebfca71fed4e59ed69a6319427", c2.getId()); } - /** - * Method description - * - * - * @return - */ + private HgLogCommand createCommand() { return new HgLogCommand(cmdContext); diff --git a/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/spi/HgOutgoingCommandTest.java b/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/spi/HgOutgoingCommandTest.java index 3ff9d18b6e..6981123104 100644 --- a/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/spi/HgOutgoingCommandTest.java +++ b/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/spi/HgOutgoingCommandTest.java @@ -24,7 +24,6 @@ package sonia.scm.repository.spi; -//~--- non-JDK imports -------------------------------------------------------- import org.javahg.Changeset; import org.junit.Test; @@ -38,12 +37,7 @@ import java.io.IOException; import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertNotNull; -//~--- JDK imports ------------------------------------------------------------ -/** - * - * @author Sebastian Sdorra - */ public class HgOutgoingCommandTest extends IncomingOutgoingTestBase { diff --git a/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/spi/IncomingOutgoingTestBase.java b/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/spi/IncomingOutgoingTestBase.java index 483d3ffb04..d66ae59135 100644 --- a/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/spi/IncomingOutgoingTestBase.java +++ b/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/spi/IncomingOutgoingTestBase.java @@ -24,7 +24,6 @@ package sonia.scm.repository.spi; -//~--- non-JDK imports -------------------------------------------------------- import org.javahg.BaseRepository; import org.javahg.Changeset; @@ -52,12 +51,7 @@ import static org.junit.Assert.assertEquals; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; -//~--- JDK imports ------------------------------------------------------------ -/** - * - * @author Sebastian Sdorra - */ public abstract class IncomingOutgoingTestBase extends AbstractTestBase { @@ -89,27 +83,15 @@ public abstract class IncomingOutgoingTestBase extends AbstractTestBase when(handler.getConfig()).thenReturn(temp.getConfig()); } - //~--- set methods ---------------------------------------------------------- - /** - * Method description - * - */ - @Before + @Before public void setUp() { setSubject(MockUtil.createAdminSubject()); } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param expected - * @param actual - */ + protected void assertChangesetsEqual(Changeset expected, sonia.scm.repository.Changeset actual) { @@ -118,15 +100,7 @@ public abstract class IncomingOutgoingTestBase extends AbstractTestBase assertEquals(expected.getUser(), actual.getAuthor().toString()); } - /** - * Method description - * - * - * @param repository - * @param message - * - * @return - */ + protected Changeset commit(BaseRepository repository, String message) { CommitCommand c = CommitCommand.on(repository); @@ -137,14 +111,7 @@ public abstract class IncomingOutgoingTestBase extends AbstractTestBase return c.execute(); } - /** - * Method description - * - * - * @param user - * - * @return - */ + protected String createUser(User user) { return user.getDisplayName().concat(" <").concat(user.getMail()).concat( @@ -192,28 +159,20 @@ public abstract class IncomingOutgoingTestBase extends AbstractTestBase //~--- fields --------------------------------------------------------------- - /** Field description */ @Rule public TemporaryFolder tempFolder = new TemporaryFolder(); - /** Field description */ protected HgRepositoryHandler handler; - /** Field description */ protected BaseRepository incoming; - /** Field description */ protected File incomingDirectory; - /** Field description */ protected sonia.scm.repository.Repository incomingRepository; - /** Field description */ protected BaseRepository outgoing; - /** Field description */ protected File outgoingDirectory; - /** Field description */ protected sonia.scm.repository.Repository outgoingRepository; } diff --git a/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/web/HgUserAgentProviderTest.java b/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/web/HgUserAgentProviderTest.java index 966401c79b..6819c837d7 100644 --- a/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/web/HgUserAgentProviderTest.java +++ b/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/web/HgUserAgentProviderTest.java @@ -24,7 +24,6 @@ package sonia.scm.web; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Strings; @@ -32,8 +31,6 @@ import org.junit.Test; import static org.junit.Assert.*; -//~--- JDK imports ------------------------------------------------------------ - import java.util.Locale; /** @@ -43,34 +40,20 @@ import java.util.Locale; public class HgUserAgentProviderTest { - /** Field description */ private static final String UA_1 = "mercurial/proto-1.0"; - /** Field description */ private static final String UA_2 = "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/37.0.2062.124 Safari/537.36"; - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - */ - @Test + @Test public void testParseUserAgent() { assertEquals(HgUserAgentProvider.HG, parse(UA_1)); assertNull(parse(UA_2)); } - /** - * Method description - * - * - * @param v - * - * @return - */ + private UserAgent parse(String v) { return provider.parseUserAgent( @@ -79,6 +62,5 @@ public class HgUserAgentProviderTest //~--- fields --------------------------------------------------------------- - /** Field description */ private final HgUserAgentProvider provider = new HgUserAgentProvider(); } diff --git a/scm-plugins/scm-legacy-plugin/src/main/java/sonia/scm/legacy/LegacyRealm.java b/scm-plugins/scm-legacy-plugin/src/main/java/sonia/scm/legacy/LegacyRealm.java index 4787f68a65..e8c3a843b7 100644 --- a/scm-plugins/scm-legacy-plugin/src/main/java/sonia/scm/legacy/LegacyRealm.java +++ b/scm-plugins/scm-legacy-plugin/src/main/java/sonia/scm/legacy/LegacyRealm.java @@ -44,7 +44,6 @@ import sonia.scm.security.DAORealmHelperFactory; /** * Support for SCM-Manager 1.x password hashes. * - * @author Sebastian Sdorra * @since 2.0.0 */ @Extension @@ -60,18 +59,11 @@ public class LegacyRealm extends AuthenticatingRealm { .or(CharMatcher.inRange('A', 'F') ); - /** - * the logger for LegacyRealm - */ + private static final Logger LOG = LoggerFactory.getLogger(LegacyRealm.class); private final DAORealmHelper helper; - /** - * Constructs a new instance. - * - * @param helperFactory dao realm helper factory - */ @Inject public LegacyRealm(DAORealmHelperFactory helperFactory) { this.helper = helperFactory.create(REALM); diff --git a/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/logging/SVNKitLogger.java b/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/logging/SVNKitLogger.java index 0da9ef9e20..745e8ca426 100644 --- a/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/logging/SVNKitLogger.java +++ b/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/logging/SVNKitLogger.java @@ -24,7 +24,6 @@ package sonia.scm.logging; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.collect.Maps; @@ -34,58 +33,33 @@ import org.slf4j.LoggerFactory; import org.tmatesoft.svn.util.SVNDebugLogAdapter; import org.tmatesoft.svn.util.SVNLogType; -//~--- JDK imports ------------------------------------------------------------ - import java.util.Map; import java.util.logging.Level; -/** - * - * @author Sebastian Sdorra - */ + public class SVNKitLogger extends SVNDebugLogAdapter { - /** Field description */ private static final int MAX_SIZE = 128 * 1024; - /** Field description */ private static final int TRACE_LEVEL_THRESHOLD = Level.FINEST.intValue(); - /** Field description */ private static final int INFO_LEVEL_THRESHOLD = Level.INFO.intValue(); - /** Field description */ private static final int DEBUG_LEVEL_THRESHOLD = Level.FINE.intValue(); - /** Field description */ private static final int WARN_LEVEL_THRESHOLD = Level.WARNING.intValue(); - /** Field description */ private static final String LINE_SEPARATOR = System.getProperty("line.separator"); - //~--- constructors --------------------------------------------------------- + private Map loggerMap; - /** - * Constructs ... - * - */ public SVNKitLogger() { loggerMap = Maps.newHashMap(); } - //~--- methods -------------------------------------------------------------- - - /** - * Method description - * - * - * @param logType - * @param th - * @param logLevel - */ @Override public void log(SVNLogType logType, Throwable th, Level logLevel) { @@ -113,14 +87,7 @@ public class SVNKitLogger extends SVNDebugLogAdapter } } - /** - * Method description - * - * - * @param logType - * @param message - * @param logLevel - */ + @Override public void log(SVNLogType logType, String message, Level logLevel) { @@ -148,14 +115,7 @@ public class SVNKitLogger extends SVNDebugLogAdapter } } - /** - * Method description - * - * - * @param logType - * @param message - * @param data - */ + @Override public void log(SVNLogType logType, String message, byte[] data) { @@ -178,36 +138,17 @@ public class SVNKitLogger extends SVNDebugLogAdapter } } - /** - * Method description - * - * - * @param name - * - * @return - */ + private String parseName(String name) { return name.replace('-', '.'); } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param type - * - * @return - */ + private Logger getLogger(SVNLogType type) { return loggerMap.computeIfAbsent(type, t -> LoggerFactory.getLogger(parseName(t.getName()))); } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private Map loggerMap; } diff --git a/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/Compatibility.java b/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/Compatibility.java index 438023d370..16fa623f1e 100644 --- a/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/Compatibility.java +++ b/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/Compatibility.java @@ -24,10 +24,7 @@ package sonia.scm.repository; -/** - * - * @author Sebastian Sdorra - */ + public enum Compatibility { NONE(false, false, false, false, false), @@ -36,15 +33,16 @@ public enum Compatibility PRE17(false, false, false, true, false), WITH17(false, false, false, false, true); - /** - * Field description - * - * @param pre14Compatible - * @param pre15Compatible - * @param pre16Compatible - * @param pre17Compatible - * @param with17Compatible - */ + private boolean pre14Compatible; + + private boolean pre15Compatible; + + private boolean pre16Compatible; + + private boolean pre17Compatible; + + private boolean with17Compatible; + private Compatibility(boolean pre14Compatible, boolean pre15Compatible, boolean pre16Compatible, boolean pre17Compatible, boolean with17Compatible) @@ -56,77 +54,35 @@ public enum Compatibility this.with17Compatible = with17Compatible; } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + public boolean isPre14Compatible() { return pre14Compatible; } - /** - * Method description - * - * - * @return - */ + public boolean isPre15Compatible() { return pre15Compatible; } - /** - * Method description - * - * - * @return - */ + public boolean isPre16Compatible() { return pre16Compatible; } - /** - * Method description - * - * - * @return - */ + public boolean isPre17Compatible() { return pre17Compatible; } - /** - * Method description - * - * - * @return - */ + public boolean isWith17Compatible() { return with17Compatible; } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private boolean pre14Compatible; - - /** Field description */ - private boolean pre15Compatible; - - /** Field description */ - private boolean pre16Compatible; - - /** Field description */ - private boolean pre17Compatible; - - /** Field description */ - private boolean with17Compatible; } diff --git a/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/DBFormatHealthCheck.java b/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/DBFormatHealthCheck.java index 301274e7b0..40dc309d00 100644 --- a/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/DBFormatHealthCheck.java +++ b/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/DBFormatHealthCheck.java @@ -24,7 +24,6 @@ package sonia.scm.repository; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Charsets; import com.google.common.collect.ImmutableSet; @@ -42,81 +41,53 @@ import org.tmatesoft.svn.core.io.SVNRepositoryFactory; import sonia.scm.plugin.Extension; -//~--- JDK imports ------------------------------------------------------------ - import java.io.File; import java.io.IOException; import java.util.List; import java.util.Set; -/** - * - * @author Sebastian Sdorra - */ + @Extension public class DBFormatHealthCheck extends DirectoryHealthCheck { - /** - * the logger for DBFormatHealthCheck - */ + private static final Logger logger = LoggerFactory.getLogger(DBFormatHealthCheck.class); - /** Field description */ private static final Set INVALID_DBFORMAT = ImmutableSet.of("5"); - /** Field description */ private static final HealthCheckFailure INCOMPATIBLE_DB_FORMAT = new HealthCheckFailure("AnOTx99ex1", "Incompatible DB Format", "https://github.com/scm-manager/scm-manager/blob/develop/docs/healthchecks/svn-incompatible-dbformat.md", "The subversion db format is incompatible with the svn version used within scm-manager."); - /** Field description */ private static final String DBFORMAT = "db".concat(File.separator).concat("format"); - /** Field description */ private static final HealthCheckFailure COULD_NOT_READ_DB_FILE = new HealthCheckFailure("4IOTx8pvv1", "Could not read db/format file", "The db/format file of the repository was not readable."); - /** Field description */ private static final HealthCheckFailure COULD_NOT_OPEN_REPOSITORY = new HealthCheckFailure("6TOTx9RLD1", "Could not open svn repository", "The repository is not openable."); - /** Field description */ private static final HealthCheckFailure COULD_NOT_FIND_DB_FILE = new HealthCheckFailure("A9OTx8leC1", "Could not find db/format file", "The subversion repository does not contain the db/format file."); - //~--- constructors --------------------------------------------------------- - /** - * Constructs ... - * - * - * @param repositoryManager - */ + @Inject public DBFormatHealthCheck(RepositoryManager repositoryManager) { super(repositoryManager); } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param repository - * @param directory - * - * @return - */ + @Override protected HealthCheckResult check(Repository repository, File directory) { @@ -130,16 +101,8 @@ public class DBFormatHealthCheck extends DirectoryHealthCheck : HealthCheckResult.unhealthy(failures); } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param repository - * - * @return - */ + @Override protected boolean isCheckResponsible(Repository repository) { @@ -147,16 +110,8 @@ public class DBFormatHealthCheck extends DirectoryHealthCheck repository.getType()); } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param failures - * @param repository - * @param directory - */ + private void checkForBadDBVersion(List failures, Repository repository, File directory) { @@ -188,14 +143,7 @@ public class DBFormatHealthCheck extends DirectoryHealthCheck } } - /** - * Method description - * - * - * @param failures - * @param repository - * @param directory - */ + private void checkIfRepositoryIsOpenable(List failures, Repository repository, File directory) { diff --git a/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/ScmSvnErrorCode.java b/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/ScmSvnErrorCode.java index 58879e9a5e..f10640499b 100644 --- a/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/ScmSvnErrorCode.java +++ b/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/ScmSvnErrorCode.java @@ -24,45 +24,22 @@ package sonia.scm.repository; -//~--- non-JDK imports -------------------------------------------------------- import org.tmatesoft.svn.core.SVNErrorCode; -/** - * - * @author Sebastian Sdorra - */ + public final class ScmSvnErrorCode extends SVNErrorCode { - /** Field description */ private static final long serialVersionUID = -6864996390796610410L; - //~--- constructors --------------------------------------------------------- - - /** - * Constructs ... - * - * - * @param category - * @param index - * @param description - */ protected ScmSvnErrorCode(int category, int index, String description) { super(category, index, description); } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param description - * - * @return - */ + public static ScmSvnErrorCode authzNotEnoughPrivileges(String description) { return new ScmSvnErrorCode(AUTHZ_CATEGORY, 4, description); diff --git a/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/SvnBlameHandler.java b/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/SvnBlameHandler.java index 76d4497996..a353015e68 100644 --- a/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/SvnBlameHandler.java +++ b/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/SvnBlameHandler.java @@ -24,7 +24,6 @@ package sonia.scm.repository; -//~--- non-JDK imports -------------------------------------------------------- import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -36,8 +35,6 @@ import org.tmatesoft.svn.core.wc.ISVNAnnotateHandler; import sonia.scm.util.Util; -//~--- JDK imports ------------------------------------------------------------ - import java.io.File; import java.util.Collection; @@ -46,29 +43,21 @@ import java.util.HashMap; import java.util.List; import java.util.Map; -/** - * - * @author Sebastian Sdorra - */ + @SuppressWarnings("deprecation") public class SvnBlameHandler implements ISVNAnnotateHandler { - - /** the logger for SvnBlameHandler */ private static final Logger logger = LoggerFactory.getLogger(SvnBlameHandler.class); - //~--- constructors --------------------------------------------------------- + private final List blameLines; + + private final Map descriptionCache = new HashMap<>(); + + private final String path; + + private final SVNRepository svnRepository; - /** - * Constructs ... - * - * - * - * @param svnRepository - * @param path - * @param blameLines - */ public SvnBlameHandler(SVNRepository svnRepository, String path, List blameLines) { @@ -77,30 +66,14 @@ public class SvnBlameHandler implements ISVNAnnotateHandler this.blameLines = blameLines; } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - */ - @Override + @Override public void handleEOF() { // do nothing } - /** - * Method description - * - * - * @param date - * @param revision - * @param author - * @param line - * - * @throws SVNException - */ @Override public void handleLine(Date date, long revision, String author, String line) throws SVNException @@ -108,22 +81,6 @@ public class SvnBlameHandler implements ISVNAnnotateHandler handleLine(date, revision, author, line, null, -1, null, null, 0); } - /** - * Method description - * - * - * @param date - * @param revision - * @param author - * @param line - * @param mergedDate - * @param mergedRevision - * @param mergedAuthor - * @param mergedPath - * @param lineNumber - * - * @throws SVNException - */ @Override public void handleLine(Date date, long revision, String author, String line, Date mergedDate, long mergedRevision, @@ -150,19 +107,6 @@ public class SvnBlameHandler implements ISVNAnnotateHandler when, authorPerson, description, line)); } - /** - * Method description - * - * - * @param date - * @param revision - * @param author - * @param contents - * - * @return - * - * @throws SVNException - */ @Override public boolean handleRevision(Date date, long revision, String author, File contents) @@ -171,16 +115,8 @@ public class SvnBlameHandler implements ISVNAnnotateHandler return false; } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param revision - * - * @return - */ + @SuppressWarnings("unchecked") private String getDescription(long revision) { @@ -216,17 +152,4 @@ public class SvnBlameHandler implements ISVNAnnotateHandler return description; } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private final List blameLines; - - /** Field description */ - private final Map descriptionCache = new HashMap<>(); - - /** Field description */ - private final String path; - - /** Field description */ - private final SVNRepository svnRepository; } diff --git a/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/SvnConfig.java b/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/SvnConfig.java index 097a30e3a8..9193a025d7 100644 --- a/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/SvnConfig.java +++ b/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/SvnConfig.java @@ -31,10 +31,7 @@ import jakarta.xml.bind.annotation.XmlRootElement; import jakarta.xml.bind.annotation.XmlTransient; import sonia.scm.auditlog.AuditEntry; -/** - * - * @author Sebastian Sdorra - */ + @XmlRootElement(name = "config") @XmlAccessorType(XmlAccessType.FIELD) @AuditEntry(labels = {"svn", "config"}) @@ -44,12 +41,11 @@ public class SvnConfig extends RepositoryConfig @SuppressWarnings("WeakerAccess") // This might be needed for permission checking public static final String PERMISSION = "svn"; - /** - * Method description - * - * - * @return - */ + @XmlElement(name = "enable-gzip") + private boolean enabledGZip = false; + + private Compatibility compatibility = Compatibility.NONE; + public Compatibility getCompatibility() { if (compatibility == null) @@ -60,50 +56,25 @@ public class SvnConfig extends RepositoryConfig return compatibility; } - /** - * Method description - * - * - * @return - */ + public boolean isEnabledGZip() { return enabledGZip; } - //~--- set methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param compatibility - */ + public void setCompatibility(Compatibility compatibility) { this.compatibility = compatibility; } - /** - * Method description - * - * - * @param enabledGZip - */ + public void setEnabledGZip(boolean enabledGZip) { this.enabledGZip = enabledGZip; } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - @XmlElement(name = "enable-gzip") - private boolean enabledGZip = false; - - /** Field description */ - private Compatibility compatibility = Compatibility.NONE; - @Override @XmlTransient // Only for permission checks, don't serialize to XML public String getId() { diff --git a/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/SvnImportHandler.java b/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/SvnImportHandler.java index f1d24da9a8..e672efe25e 100644 --- a/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/SvnImportHandler.java +++ b/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/SvnImportHandler.java @@ -26,57 +26,34 @@ package sonia.scm.repository; /** * - * @author Sebastian Sdorra * @deprecated */ @Deprecated public class SvnImportHandler extends AbstactImportHandler { - /** Field description */ public static final String SVN_DIR_LOCKS = "locks"; - //~--- constructors --------------------------------------------------------- - - /** - * Constructs ... - * - * - * @param handler - */ + private SvnRepositoryHandler handler; + public SvnImportHandler(SvnRepositoryHandler handler) { this.handler = handler; } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + @Override protected String[] getDirectoryNames() { return new String[] { SVN_DIR_LOCKS }; } - /** - * Method description - * - * - * @return - */ + @Override protected AbstractRepositoryHandler getRepositoryHandler() { return handler; } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private SvnRepositoryHandler handler; } diff --git a/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/SvnRepositoryHandler.java b/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/SvnRepositoryHandler.java index 4c176de302..4d2561b08f 100644 --- a/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/SvnRepositoryHandler.java +++ b/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/SvnRepositoryHandler.java @@ -48,9 +48,7 @@ import java.io.IOException; import static sonia.scm.ContextEntry.ContextBuilder.entity; -/** - * @author Sebastian Sdorra - */ + @Singleton @Extension public class SvnRepositoryHandler extends AbstractSimpleRepositoryHandler { diff --git a/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/SvnRepositoryHook.java b/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/SvnRepositoryHook.java index 28d5d5258f..f3a607ff07 100644 --- a/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/SvnRepositoryHook.java +++ b/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/SvnRepositoryHook.java @@ -24,7 +24,6 @@ package sonia.scm.repository; -//~--- non-JDK imports -------------------------------------------------------- import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -46,20 +45,16 @@ import sonia.scm.util.Util; import java.io.File; import java.io.IOException; -//~--- JDK imports ------------------------------------------------------------ -/** - * - * @author Sebastian Sdorra - */ public class SvnRepositoryHook implements FSHook { - /** the logger for SvnRepositoryHook */ private static final Logger logger = LoggerFactory.getLogger(SvnRepositoryHook.class); - //~--- constructors --------------------------------------------------------- + private HookEventFacade hookEventFacade; + + private final SvnRepositoryHandler handler; public SvnRepositoryHook(HookEventFacade hookEventFacade, SvnRepositoryHandler handler) { @@ -67,16 +62,8 @@ public class SvnRepositoryHook implements FSHook this.handler = handler; } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param event - * - * @throws SVNException - */ + @Override public void onHook(FSHookEvent event) throws SVNException { @@ -130,15 +117,7 @@ public class SvnRepositoryHook implements FSHook } } - /** - * Method description - * - * - * @param directory - * @param changesetProvider - * - * @throws SVNCancelException - */ + private void fireHook(File directory, AbstractSvnHookChangesetProvider changesetProvider) throws SVNCancelException @@ -167,28 +146,12 @@ public class SvnRepositoryHook implements FSHook } } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param directory - * - * @return - * - * @throws IOException - */ + private String getRepositoryId(File directory) { AssertUtil.assertIsNotNull(directory); return handler.getRepositoryId(directory); } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private HookEventFacade hookEventFacade; - - private final SvnRepositoryHandler handler; } diff --git a/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/SvnUtil.java b/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/SvnUtil.java index e602222908..58e4e19d00 100644 --- a/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/SvnUtil.java +++ b/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/SvnUtil.java @@ -24,7 +24,6 @@ package sonia.scm.repository; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Strings; import com.google.common.collect.Lists; @@ -59,19 +58,12 @@ import static sonia.scm.ContextEntry.ContextBuilder.entity; import static sonia.scm.NotFoundException.notFound; import static sonia.scm.repository.ConsolidatingModificationCollector.consolidate; -//~--- JDK imports ------------------------------------------------------------ -/** - * - * @author Sebastian Sdorra - */ public final class SvnUtil { - /** Field description */ public static final String XML_CONTENT_TYPE = "text/xml; charset=\"utf-8\""; - /** Field description */ private static final String ID_TRANSACTION_PREFIX = "-1:"; /** @@ -80,27 +72,17 @@ public final class SvnUtil */ private static final char TYPE_UPDATED = 'U'; - /** Field description */ private static final String USERAGENT_SVN = "svn/"; - /** - * the logger for SvnUtil - */ + private static final Logger logger = LoggerFactory.getLogger(SvnUtil.class); - /** Field description */ private static final String ID_TRANSACTION_PATTERN = ID_TRANSACTION_PREFIX.concat("%s"); - //~--- constructors --------------------------------------------------------- - /** - * Constructs ... - * - */ private SvnUtil() {} - //~--- methods -------------------------------------------------------------- public static long parseRevision(String v, Repository repository) { long result = -1l; @@ -169,12 +151,7 @@ public final class SvnUtil } } - /** - * Method description - * - * - * @param repository - */ + public static void closeSession(SVNRepository repository) { if (repository != null) @@ -190,14 +167,7 @@ public final class SvnUtil } } - /** - * Method description - * - * - * @param entry - * - * @return - */ + @SuppressWarnings("unchecked") public static Changeset createChangeset(SVNLogEntry entry) { @@ -214,14 +184,7 @@ public final class SvnUtil return changeset; } - /** - * Method description - * - * - * @param entries - * - * @return - */ + public static List createChangesets(List entries) { List changesets = Lists.newArrayList(); @@ -234,13 +197,6 @@ public final class SvnUtil return changesets; } - /** - * Method description - * - * @param errorCode - * - * @return - */ @SuppressWarnings("java:S1149") // we can not use StringBuild SVNXMLUtil requires StringBuffer public static String createErrorBody(SVNErrorCode errorCode) { @@ -268,25 +224,13 @@ public final class SvnUtil return xmlBuffer.toString(); } - /** - * Method description - * - * - * @param transaction - * - * @return - */ + public static String createTransactionEntryId(String transaction) { return String.format(ID_TRANSACTION_PATTERN, transaction); } - /** - * Method description - * - * - * @param clientManager - */ + public static void dispose(SVNClientManager clientManager) { if (clientManager != null) @@ -302,17 +246,6 @@ public final class SvnUtil } } - /** - * Method description - * - * - * @param request - * @param response - * @param statusCode - * @param errorCode - * - * @throws IOException - */ public static void sendError(HttpServletRequest request, HttpServletResponse response, int statusCode, SVNErrorCode errorCode) throws IOException @@ -354,40 +287,19 @@ public final class SvnUtil return revisionNumber; } - /** - * Method description - * - * - * @param id - * - * @return - */ + public static String getTransactionId(String id) { return id.substring(ID_TRANSACTION_PREFIX.length()); } - /** - * Method description - * - * - * @param request - * - * @return - */ + public static boolean isSvnClient(HttpServletRequest request) { return HttpUtil.userAgentStartsWith(request, USERAGENT_SVN); } - /** - * Method description - * - * - * @param id - * - * @return - */ + public static boolean isTransactionEntryId(String id) { return Strings.nullToEmpty(id).startsWith(ID_TRANSACTION_PREFIX); diff --git a/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/spi/AbstractSvnCommand.java b/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/spi/AbstractSvnCommand.java index 3bf5dbcba5..cb6c9b1a80 100644 --- a/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/spi/AbstractSvnCommand.java +++ b/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/spi/AbstractSvnCommand.java @@ -24,53 +24,30 @@ package sonia.scm.repository.spi; -//~--- non-JDK imports -------------------------------------------------------- import org.tmatesoft.svn.core.SVNException; import org.tmatesoft.svn.core.io.SVNRepository; import sonia.scm.repository.Repository; -/** - * - * @author Sebastian Sdorra - */ + public class AbstractSvnCommand { + protected SvnContext context; + + protected Repository repository; - /** - * Constructs ... - * - * - * - * @param context - */ protected AbstractSvnCommand(SvnContext context) { this.context = context; this.repository = context.getRepository(); } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @return - * - * @throws SVNException - */ + public SVNRepository open() throws SVNException { return context.open(); } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - protected SvnContext context; - - /** Field description */ - protected Repository repository; } diff --git a/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/spi/AbstractSvnHookChangesetProvider.java b/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/spi/AbstractSvnHookChangesetProvider.java index e82d9d33e4..1f84d1d1c1 100644 --- a/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/spi/AbstractSvnHookChangesetProvider.java +++ b/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/spi/AbstractSvnHookChangesetProvider.java @@ -31,40 +31,19 @@ import sonia.scm.repository.api.HookChangesetProvider; import java.util.Collections; -/** - * - * @author Sebastian Sdorra - */ + public abstract class AbstractSvnHookChangesetProvider implements HookChangesetProvider { + private HookChangesetResponse response; - /** - * Method description - * - * - * @return - */ public abstract RepositoryHookType getType(); - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + protected abstract Changeset fetchChangeset(); - /** - * Method description - * - * - * @param request - * - * @return - */ + @Override @SuppressWarnings("unchecked") public synchronized HookChangesetResponse handleRequest( @@ -90,8 +69,4 @@ public abstract class AbstractSvnHookChangesetProvider return response; } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private HookChangesetResponse response; } diff --git a/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/spi/SvnBlameCommand.java b/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/spi/SvnBlameCommand.java index b0361c7d04..948df3a70b 100644 --- a/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/spi/SvnBlameCommand.java +++ b/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/spi/SvnBlameCommand.java @@ -24,7 +24,6 @@ package sonia.scm.repository.spi; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.collect.Lists; import org.tmatesoft.svn.core.SVNException; @@ -43,12 +42,7 @@ import sonia.scm.util.Util; import java.io.File; import java.util.List; -//~--- JDK imports ------------------------------------------------------------ -/** - * - * @author Sebastian Sdorra - */ public class SvnBlameCommand extends AbstractSvnCommand implements BlameCommand { diff --git a/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/spi/SvnBrowseCommand.java b/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/spi/SvnBrowseCommand.java index c5abd790dd..527e9b66cb 100644 --- a/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/spi/SvnBrowseCommand.java +++ b/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/spi/SvnBrowseCommand.java @@ -24,7 +24,6 @@ package sonia.scm.repository.spi; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Strings; import org.slf4j.Logger; @@ -50,17 +49,11 @@ import static org.tmatesoft.svn.core.SVNErrorCode.FS_NO_SUCH_REVISION; import static sonia.scm.ContextEntry.ContextBuilder.entity; import static sonia.scm.NotFoundException.notFound; -//~--- JDK imports ------------------------------------------------------------ -/** - * @author Sebastian Sdorra - */ public class SvnBrowseCommand extends AbstractSvnCommand implements BrowseCommand { - /** - * the logger for SvnBrowseCommand - */ + private static final Logger logger = LoggerFactory.getLogger(SvnBrowseCommand.class); @@ -111,7 +104,6 @@ public class SvnBrowseCommand extends AbstractSvnCommand return result; } - //~--- methods -------------------------------------------------------------- @SuppressWarnings("unchecked") private void traverse(SVNRepository svnRepository, long revisionNumber, BrowseCommandRequest request, diff --git a/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/spi/SvnBundleCommand.java b/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/spi/SvnBundleCommand.java index ae5e596269..0627f3e582 100644 --- a/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/spi/SvnBundleCommand.java +++ b/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/spi/SvnBundleCommand.java @@ -24,7 +24,6 @@ package sonia.scm.repository.spi; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.io.ByteSink; import com.google.common.io.Closeables; diff --git a/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/spi/SvnCatCommand.java b/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/spi/SvnCatCommand.java index 280bf18551..176fe61cfe 100644 --- a/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/spi/SvnCatCommand.java +++ b/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/spi/SvnCatCommand.java @@ -24,7 +24,6 @@ package sonia.scm.repository.spi; -//~--- non-JDK imports -------------------------------------------------------- import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -45,26 +44,18 @@ import java.io.OutputStream; import static sonia.scm.ContextEntry.ContextBuilder.entity; import static sonia.scm.NotFoundException.notFound; -//~--- JDK imports ------------------------------------------------------------ -/** - * @author Sebastian Sdorra - */ public class SvnCatCommand extends AbstractSvnCommand implements CatCommand { - /** - * the logger for SvnCatCommand - */ + private static final Logger logger = LoggerFactory.getLogger(SvnCatCommand.class); - //~--- constructors --------------------------------------------------------- SvnCatCommand(SvnContext context) { super(context); } - //~--- get methods ---------------------------------------------------------- @Override public void getCatResult(CatCommandRequest request, OutputStream output) { diff --git a/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/spi/SvnContext.java b/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/spi/SvnContext.java index 639bf25e8a..74119605f8 100644 --- a/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/spi/SvnContext.java +++ b/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/spi/SvnContext.java @@ -37,10 +37,7 @@ import sonia.scm.repository.SvnUtil; import java.io.Closeable; import java.io.File; -/** - * - * @author Sebastian Sdorra - */ + public class SvnContext implements Closeable, RepositoryProvider { private static final Logger LOG = LoggerFactory.getLogger(SvnContext.class); diff --git a/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/spi/SvnDiffCommand.java b/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/spi/SvnDiffCommand.java index e1746f0e1e..a7375a6f8f 100644 --- a/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/spi/SvnDiffCommand.java +++ b/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/spi/SvnDiffCommand.java @@ -24,7 +24,6 @@ package sonia.scm.repository.spi; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Preconditions; import org.slf4j.Logger; @@ -42,17 +41,10 @@ import sonia.scm.repository.api.DiffCommandBuilder; import sonia.scm.repository.api.DiffFormat; import sonia.scm.util.Util; -//~--- JDK imports ------------------------------------------------------------ -/** - * - * @author Sebastian Sdorra - */ public class SvnDiffCommand extends AbstractSvnCommand implements DiffCommand { - /** - * the logger for SvnDiffCommand - */ + private static final Logger logger = LoggerFactory.getLogger(SvnDiffCommand.class); diff --git a/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/spi/SvnHookContextProvider.java b/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/spi/SvnHookContextProvider.java index 7b0a95ddb5..0948aa2624 100644 --- a/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/spi/SvnHookContextProvider.java +++ b/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/spi/SvnHookContextProvider.java @@ -24,68 +24,40 @@ package sonia.scm.repository.spi; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.repository.api.HookFeature; -//~--- JDK imports ------------------------------------------------------------ - import java.util.EnumSet; import java.util.Set; -/** - * - * @author Sebastian Sdorra - */ + public class SvnHookContextProvider extends HookContextProvider { - /** Field description */ private static final Set SUPPORTED_FEATURES = EnumSet.of(HookFeature.CHANGESET_PROVIDER); - //~--- constructors --------------------------------------------------------- - - /** - * Constructs ... - * - * - * @param changesetProvider - */ + private AbstractSvnHookChangesetProvider changesetProvider; + public SvnHookContextProvider( AbstractSvnHookChangesetProvider changesetProvider) { this.changesetProvider = changesetProvider; } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + @Override public AbstractSvnHookChangesetProvider getChangesetProvider() { return changesetProvider; } - /** - * Method description - * - * - * @return - */ + @Override public Set getSupportedFeatures() { return SUPPORTED_FEATURES; } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private AbstractSvnHookChangesetProvider changesetProvider; } diff --git a/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/spi/SvnPostReceiveHookChangesetProvier.java b/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/spi/SvnPostReceiveHookChangesetProvier.java index ba0ae4746c..a9d391ab23 100644 --- a/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/spi/SvnPostReceiveHookChangesetProvier.java +++ b/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/spi/SvnPostReceiveHookChangesetProvier.java @@ -24,7 +24,6 @@ package sonia.scm.repository.spi; -//~--- non-JDK imports -------------------------------------------------------- import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -40,61 +39,39 @@ import sonia.scm.repository.RepositoryHookType; import sonia.scm.repository.SvnUtil; import sonia.scm.util.Util; -//~--- JDK imports ------------------------------------------------------------ - import java.io.File; import java.util.Collection; -/** - * - * @author Sebastian Sdorra - */ + public class SvnPostReceiveHookChangesetProvier extends AbstractSvnHookChangesetProvider { - /** the logger for SvnPostReceiveHookChangesetProvier */ + private static final Logger logger = LoggerFactory.getLogger(SvnPostReceiveHookChangesetProvier.class); - //~--- constructors --------------------------------------------------------- + private File repositoryDirectory; - /** - * Constructs ... - * - * - * @param repositoryDirectory - * @param revision - */ + private long revision; + public SvnPostReceiveHookChangesetProvier(File repositoryDirectory, long revision) { this.repositoryDirectory = repositoryDirectory; this.revision = revision; } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + @Override public RepositoryHookType getType() { return RepositoryHookType.POST_RECEIVE; } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + @Override @SuppressWarnings("unchecked") protected Changeset fetchChangeset() @@ -132,11 +109,4 @@ public class SvnPostReceiveHookChangesetProvier return changeset; } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private File repositoryDirectory; - - /** Field description */ - private long revision; } diff --git a/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/spi/SvnPreReceiveHookChangesetProvier.java b/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/spi/SvnPreReceiveHookChangesetProvier.java index 01abc8d314..2eccae9ef5 100644 --- a/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/spi/SvnPreReceiveHookChangesetProvier.java +++ b/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/spi/SvnPreReceiveHookChangesetProvier.java @@ -24,7 +24,6 @@ package sonia.scm.repository.spi; -//~--- non-JDK imports -------------------------------------------------------- import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -39,29 +38,17 @@ import sonia.scm.repository.SvnUtil; import java.io.File; -//~--- JDK imports ------------------------------------------------------------ -/** - * - * @author Sebastian Sdorra - */ public class SvnPreReceiveHookChangesetProvier extends AbstractSvnHookChangesetProvider { - - /** the logger for SvnPreReceiveHookChangesetProvier */ private static final Logger logger = LoggerFactory.getLogger(SvnPreReceiveHookChangesetProvier.class); - //~--- constructors --------------------------------------------------------- + private File repositoryDirectory; - /** - * Constructs ... - * - * - * @param repositoryDirectory - * @param transaction - */ + private String transaction; + public SvnPreReceiveHookChangesetProvier(File repositoryDirectory, String transaction) { @@ -69,28 +56,16 @@ public class SvnPreReceiveHookChangesetProvier this.transaction = transaction; } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + @Override public RepositoryHookType getType() { return RepositoryHookType.PRE_RECEIVE; } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + @Override protected Changeset fetchChangeset() { @@ -130,11 +105,4 @@ public class SvnPreReceiveHookChangesetProvier return changeset; } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private File repositoryDirectory; - - /** Field description */ - private String transaction; } diff --git a/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/spi/SvnRepositoryServiceProvider.java b/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/spi/SvnRepositoryServiceProvider.java index abfadd0ce6..8b9979b192 100644 --- a/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/spi/SvnRepositoryServiceProvider.java +++ b/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/spi/SvnRepositoryServiceProvider.java @@ -39,9 +39,7 @@ import java.io.IOException; import java.util.EnumSet; import java.util.Set; -/** - * @author Sebastian Sdorra - */ + public class SvnRepositoryServiceProvider extends RepositoryServiceProvider { public static final Set COMMANDS = ImmutableSet.of( diff --git a/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/web/SvnCollectionRenderer.java b/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/web/SvnCollectionRenderer.java index 18e7c4e817..aa4199c1dd 100644 --- a/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/web/SvnCollectionRenderer.java +++ b/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/web/SvnCollectionRenderer.java @@ -49,9 +49,7 @@ import java.io.IOException; import java.io.StringWriter; import java.util.List; -/** - * @author Sebastian Sdorra - */ + public class SvnCollectionRenderer implements CollectionRenderer { private final TemplateEngineFactory templateEngineFactory; diff --git a/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/web/SvnDAVConfig.java b/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/web/SvnDAVConfig.java index b8f4d4acba..b543fafe1e 100644 --- a/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/web/SvnDAVConfig.java +++ b/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/web/SvnDAVConfig.java @@ -24,7 +24,6 @@ package sonia.scm.web; -//~--- non-JDK imports -------------------------------------------------------- import org.tmatesoft.svn.core.internal.server.dav.CollectionRenderer; import org.tmatesoft.svn.core.internal.server.dav.DAVConfig; @@ -34,14 +33,9 @@ import sonia.scm.repository.Repository; import sonia.scm.repository.RepositoryProvider; import sonia.scm.repository.SvnRepositoryHandler; -//~--- JDK imports ------------------------------------------------------------ - import java.io.File; -/** - * - * @author Sebastian Sdorra - */ + public class SvnDAVConfig extends DAVConfig { @@ -64,50 +58,29 @@ public class SvnDAVConfig extends DAVConfig this.repositoryProvider = repositoryProvider; } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + @Override public String getActivitiesDBPath() { return null; } - /** - * Method description - * - * - * @return - */ + @Override public CollectionRenderer getCollectionRenderer() { return collectionRenderer; } - /** - * Method description - * - * - * @return - */ + @Override public String getRepositoryName() { return davConfig.getRepositoryName(); } - /** - * Method description - * - * - * @return - */ + @Override public String getRepositoryParentPath() { @@ -126,12 +99,7 @@ public class SvnDAVConfig extends DAVConfig return path; } - /** - * Method description - * - * - * @return - */ + @Override public String getRepositoryPath() { @@ -150,132 +118,77 @@ public class SvnDAVConfig extends DAVConfig return path; } - /** - * Method description - * - * - * @return - */ + @Override public SVNPathBasedAccess getSVNAccess() { return davConfig.getSVNAccess(); } - /** - * Method description - * - * - * @return - */ + @Override public String getXSLTIndex() { return davConfig.getXSLTIndex(); } - /** - * Method description - * - * - * @return - */ + @Override public boolean isAllowBulkUpdates() { return davConfig.isAllowBulkUpdates(); } - /** - * Method description - * - * - * @return - */ + @Override public boolean isAllowDepthInfinity() { return davConfig.isAllowDepthInfinity(); } - /** - * Method description - * - * - * @return - */ + @Override public boolean isAnonymousAllowed() { return davConfig.isAnonymousAllowed(); } - /** - * Method description - * - * - * @return - */ + @Override public boolean isAutoVersioning() { return davConfig.isAutoVersioning(); } - /** - * Method description - * - * - * @return - */ + @Override public boolean isListParentPath() { return davConfig.isListParentPath(); } - /** - * Method description - * - * - * @return - */ + @Override public boolean isNoAuthIfAnonymousAllowed() { return davConfig.isNoAuthIfAnonymousAllowed(); } - /** - * Method description - * - * - * @return - */ + @Override public boolean isUsingPBA() { return davConfig.isUsingPBA(); } - /** - * Method description - * - * - * @return - */ + @Override public boolean isUsingRepositoryPathDirective() { return true; } - /** - * Method description - * - * - * @return - */ + private File getRepositoryDirectory() { File directory = null; @@ -291,15 +204,11 @@ public class SvnDAVConfig extends DAVConfig //~--- fields --------------------------------------------------------------- - /** Field description */ private final CollectionRenderer collectionRenderer; - /** Field description */ private final DAVConfig davConfig; - /** Field description */ private final SvnRepositoryHandler handler; - /** Field description */ private final RepositoryProvider repositoryProvider; } diff --git a/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/web/SvnDAVServlet.java b/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/web/SvnDAVServlet.java index f691164a12..858922bdc4 100644 --- a/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/web/SvnDAVServlet.java +++ b/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/web/SvnDAVServlet.java @@ -44,35 +44,27 @@ import sonia.scm.util.HttpUtil; import java.io.IOException; -/** - * - * @author Sebastian Sdorra - */ + @Singleton public class SvnDAVServlet extends DAVServlet implements ScmProviderHttpServlet { - /** Field description */ private static final String HEADER_CONTEXTPATH = "X-Forwarded-Ctx"; - /** Field description */ private static final long serialVersionUID = -1462257085465785945L; - /** the logger for SvnDAVServlet */ + private static final Logger logger = LoggerFactory.getLogger(SvnDAVServlet.class); - //~--- constructors --------------------------------------------------------- + private final SvnCollectionRenderer collectionRenderer; + + private final SvnRepositoryHandler handler; + + private final RepositoryProvider repositoryProvider; + + private final RepositoryRequestListenerUtil repositoryRequestListenerUtil; - /** - * Constructs ... - * - * - * @param handler - * @param collectionRenderer - * @param repositoryProvider - * @param repositoryRequestListenerUtil - */ @Inject public SvnDAVServlet(SvnRepositoryHandler handler, SvnCollectionRenderer collectionRenderer, @@ -85,18 +77,7 @@ public class SvnDAVServlet extends DAVServlet implements ScmProviderHttpServlet this.repositoryRequestListenerUtil = repositoryRequestListenerUtil; } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param request - * @param response - * - * @throws IOException - * @throws ServletException - */ @Override public void service(HttpServletRequest request, HttpServletResponse response, Repository repository) throws ServletException, IOException @@ -113,14 +94,8 @@ public class SvnDAVServlet extends DAVServlet implements ScmProviderHttpServlet } } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + @Override protected DAVConfig getDAVConfig() { @@ -128,18 +103,13 @@ public class SvnDAVServlet extends DAVServlet implements ScmProviderHttpServlet repositoryProvider); } - //~--- inner classes -------------------------------------------------------- - /** - * Class description - * - * - * @version Enter version here..., 11/10/23 - * @author Enter your name here... - */ + + private static class SvnHttpServletRequestWrapper extends HttpServletRequestWrapper { + private final Repository repository; public SvnHttpServletRequestWrapper(HttpServletRequest request, Repository repository) @@ -148,14 +118,7 @@ public class SvnDAVServlet extends DAVServlet implements ScmProviderHttpServlet this.repository = repository; } - //~--- get methods -------------------------------------------------------- - - /** - * Method description - * - * - * @return - */ + @Override public String getContextPath() { @@ -169,12 +132,7 @@ public class SvnDAVServlet extends DAVServlet implements ScmProviderHttpServlet return header; } - /** - * Method description - * - * - * @return - */ + @Override public String getPathInfo() { @@ -195,12 +153,7 @@ public class SvnDAVServlet extends DAVServlet implements ScmProviderHttpServlet return pathInfo; } - /** - * Method description - * - * - * @return - */ + @Override public String getServletPath() { @@ -219,14 +172,7 @@ public class SvnDAVServlet extends DAVServlet implements ScmProviderHttpServlet return servletPath; } - /** - * Method description - * - * - * @param ctx - * - * @return - */ + private boolean isValidContextPath(String ctx) { int length = ctx.length(); @@ -245,23 +191,6 @@ public class SvnDAVServlet extends DAVServlet implements ScmProviderHttpServlet return result; } - //~--- fields ------------------------------------------------------------- - - /** Field description */ - private final Repository repository; } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private final SvnCollectionRenderer collectionRenderer; - - /** Field description */ - private final SvnRepositoryHandler handler; - - /** Field description */ - private final RepositoryProvider repositoryProvider; - - /** Field description */ - private final RepositoryRequestListenerUtil repositoryRequestListenerUtil; } diff --git a/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/web/SvnPermissionFilter.java b/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/web/SvnPermissionFilter.java index aa972b9f29..e5822ec0b2 100644 --- a/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/web/SvnPermissionFilter.java +++ b/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/web/SvnPermissionFilter.java @@ -37,41 +37,23 @@ import sonia.scm.web.filter.PermissionFilter; import java.io.IOException; import java.util.Set; -/** - * - * @author Sebastian Sdorra - */ + public class SvnPermissionFilter extends PermissionFilter { - /** Field description */ private static final Set WRITEMETHOD_SET = ImmutableSet.of("MKACTIVITY", "PROPPATCH", "PUT", "CHECKOUT", "MKCOL", "MOVE", "COPY", "DELETE", "LOCK", "UNLOCK", "MERGE"); - //~--- constructors --------------------------------------------------------- - /** - * Constructs ... - * - * @param configuration - */ + public SvnPermissionFilter(ScmConfiguration configuration, ScmProviderHttpServlet delegate) { super(configuration, delegate); } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param request - * @param response - * - * @throws IOException - */ + @Override protected void sendNotEnoughPrivilegesError(HttpServletRequest request, HttpServletResponse response) @@ -96,16 +78,8 @@ public class SvnPermissionFilter extends PermissionFilter } } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param request - * - * @return - */ + @Override public boolean isWriteRequest(HttpServletRequest request) { diff --git a/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/web/SvnServletModule.java b/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/web/SvnServletModule.java index 078c613418..584a51ab8a 100644 --- a/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/web/SvnServletModule.java +++ b/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/web/SvnServletModule.java @@ -32,10 +32,7 @@ import sonia.scm.plugin.Extension; import sonia.scm.repository.SvnWorkingCopyFactory; import sonia.scm.repository.spi.SimpleSvnWorkingCopyFactory; -/** - * - * @author Sebastian Sdorra - */ + @Extension public class SvnServletModule extends ServletModule { diff --git a/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/web/SvnUserAgentProvider.java b/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/web/SvnUserAgentProvider.java index 060ff3f3f2..df28d71010 100644 --- a/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/web/SvnUserAgentProvider.java +++ b/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/web/SvnUserAgentProvider.java @@ -24,7 +24,6 @@ package sonia.scm.web; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.annotations.VisibleForTesting; import com.google.common.base.Charsets; @@ -57,16 +56,8 @@ public final class SvnUserAgentProvider implements UserAgentProvider UserAgent.scmClient("Subversion") .basicAuthenticationCharset(Charsets.UTF_8).build(); - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param userAgentString - * - * @return - */ + @Override public UserAgent parseUserAgent(String userAgentString) { diff --git a/scm-plugins/scm-svn-plugin/src/test/java/sonia/scm/repository/SvnRepositoryHandlerTest.java b/scm-plugins/scm-svn-plugin/src/test/java/sonia/scm/repository/SvnRepositoryHandlerTest.java index bd12979dc2..40c00b4e12 100644 --- a/scm-plugins/scm-svn-plugin/src/test/java/sonia/scm/repository/SvnRepositoryHandlerTest.java +++ b/scm-plugins/scm-svn-plugin/src/test/java/sonia/scm/repository/SvnRepositoryHandlerTest.java @@ -41,12 +41,7 @@ import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; import static org.mockito.MockitoAnnotations.initMocks; -//~--- JDK imports ------------------------------------------------------------ -/** - * - * @author Sebastian Sdorra - */ public class SvnRepositoryHandlerTest extends SimpleRepositoryHandlerTestBase { @Mock diff --git a/scm-plugins/scm-svn-plugin/src/test/java/sonia/scm/repository/client/spi/SvnRepositoryClientFactoryProvider.java b/scm-plugins/scm-svn-plugin/src/test/java/sonia/scm/repository/client/spi/SvnRepositoryClientFactoryProvider.java index 1b7a24f9fe..f1e2d94520 100644 --- a/scm-plugins/scm-svn-plugin/src/test/java/sonia/scm/repository/client/spi/SvnRepositoryClientFactoryProvider.java +++ b/scm-plugins/scm-svn-plugin/src/test/java/sonia/scm/repository/client/spi/SvnRepositoryClientFactoryProvider.java @@ -43,7 +43,6 @@ import sonia.scm.repository.client.api.RepositoryClientException; /** * Client provider factory for subversion. * - * @author Sebastian Sdorra * @since 1.51 */ public class SvnRepositoryClientFactoryProvider implements RepositoryClientFactoryProvider { diff --git a/scm-plugins/scm-svn-plugin/src/test/java/sonia/scm/repository/client/spi/SvnRepositoryClientProvider.java b/scm-plugins/scm-svn-plugin/src/test/java/sonia/scm/repository/client/spi/SvnRepositoryClientProvider.java index 449f7904d3..6ce5b73909 100644 --- a/scm-plugins/scm-svn-plugin/src/test/java/sonia/scm/repository/client/spi/SvnRepositoryClientProvider.java +++ b/scm-plugins/scm-svn-plugin/src/test/java/sonia/scm/repository/client/spi/SvnRepositoryClientProvider.java @@ -34,7 +34,6 @@ import java.util.Set; /** * Subversion repository client provider. * - * @author Sebastian Sdorra * @since 1.51 */ public class SvnRepositoryClientProvider extends RepositoryClientProvider { diff --git a/scm-plugins/scm-svn-plugin/src/test/java/sonia/scm/repository/spi/SvnBlameCommandTest.java b/scm-plugins/scm-svn-plugin/src/test/java/sonia/scm/repository/spi/SvnBlameCommandTest.java index e3b09899e1..b83c273a04 100644 --- a/scm-plugins/scm-svn-plugin/src/test/java/sonia/scm/repository/spi/SvnBlameCommandTest.java +++ b/scm-plugins/scm-svn-plugin/src/test/java/sonia/scm/repository/spi/SvnBlameCommandTest.java @@ -24,7 +24,6 @@ package sonia.scm.repository.spi; -//~--- non-JDK imports -------------------------------------------------------- import org.junit.Test; import sonia.scm.repository.BlameLine; @@ -34,12 +33,7 @@ import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertNotNull; import static org.junit.Assert.assertNull; -//~--- JDK imports ------------------------------------------------------------ -/** - * - * @author Sebastian Sdorra - */ public class SvnBlameCommandTest extends AbstractSvnCommandTestBase { @@ -85,12 +79,7 @@ public class SvnBlameCommandTest extends AbstractSvnCommandTestBase checkFirstLine(line); } - /** - * Method description - * - * - * @param line - */ + private void checkFirstLine(BlameLine line) { assertEquals(1, line.getLineNumber()); @@ -102,12 +91,7 @@ public class SvnBlameCommandTest extends AbstractSvnCommandTestBase assertNull(line.getAuthor().getMail()); } - /** - * Method description - * - * - * @return - */ + private SvnBlameCommand createCommand() { return new SvnBlameCommand(createContext()); diff --git a/scm-plugins/scm-svn-plugin/src/test/java/sonia/scm/repository/spi/SvnBrowseCommandTest.java b/scm-plugins/scm-svn-plugin/src/test/java/sonia/scm/repository/spi/SvnBrowseCommandTest.java index 698fec8f37..6f07b3c9d9 100644 --- a/scm-plugins/scm-svn-plugin/src/test/java/sonia/scm/repository/spi/SvnBrowseCommandTest.java +++ b/scm-plugins/scm-svn-plugin/src/test/java/sonia/scm/repository/spi/SvnBrowseCommandTest.java @@ -49,9 +49,7 @@ import static org.junit.Assert.assertNotNull; import static org.junit.Assert.assertNull; import static org.junit.Assert.assertTrue; -/** - * @author Sebastian Sdorra - */ + public class SvnBrowseCommandTest extends AbstractSvnCommandTestBase { @Rule @@ -310,24 +308,13 @@ public class SvnBrowseCommandTest extends AbstractSvnCommandTestBase { return context; } - /** - * Method description - * - * @return - */ + private SvnBrowseCommand createCommand() { return new SvnBrowseCommand(createContext()); } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * @param foList - * @param name - * @return - */ + private FileObject getFileObject(Collection foList, String name) { return foList.stream() .filter(f -> name.equals(f.getName())) diff --git a/scm-plugins/scm-svn-plugin/src/test/java/sonia/scm/repository/spi/SvnBundleCommandTest.java b/scm-plugins/scm-svn-plugin/src/test/java/sonia/scm/repository/spi/SvnBundleCommandTest.java index 3c8e125165..f9dfe8f462 100644 --- a/scm-plugins/scm-svn-plugin/src/test/java/sonia/scm/repository/spi/SvnBundleCommandTest.java +++ b/scm-plugins/scm-svn-plugin/src/test/java/sonia/scm/repository/spi/SvnBundleCommandTest.java @@ -24,7 +24,6 @@ package sonia.scm.repository.spi; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.io.ByteSink; import com.google.common.io.Files; @@ -42,12 +41,7 @@ import static org.hamcrest.Matchers.notNullValue; import static org.junit.Assert.assertThat; import static org.junit.Assert.assertTrue; -//~--- JDK imports ------------------------------------------------------------ -/** - * - * @author Sebastian Sdorra - */ public class SvnBundleCommandTest extends AbstractSvnCommandTestBase { @@ -67,7 +61,6 @@ public class SvnBundleCommandTest extends AbstractSvnCommandTestBase //~--- fields --------------------------------------------------------------- - /** Field description */ @Rule public TemporaryFolder temp = new TemporaryFolder(); } diff --git a/scm-plugins/scm-svn-plugin/src/test/java/sonia/scm/repository/spi/SvnCatCommandTest.java b/scm-plugins/scm-svn-plugin/src/test/java/sonia/scm/repository/spi/SvnCatCommandTest.java index b16b691db0..90ac738296 100644 --- a/scm-plugins/scm-svn-plugin/src/test/java/sonia/scm/repository/spi/SvnCatCommandTest.java +++ b/scm-plugins/scm-svn-plugin/src/test/java/sonia/scm/repository/spi/SvnCatCommandTest.java @@ -37,8 +37,6 @@ import java.io.InputStream; import static org.junit.Assert.assertEquals; -//~--- JDK imports ------------------------------------------------------------ - public class SvnCatCommandTest extends AbstractSvnCommandTestBase { @Rule diff --git a/scm-plugins/scm-svn-plugin/src/test/java/sonia/scm/repository/spi/SvnLogCommandTest.java b/scm-plugins/scm-svn-plugin/src/test/java/sonia/scm/repository/spi/SvnLogCommandTest.java index b758d7828c..5f0e884bd3 100644 --- a/scm-plugins/scm-svn-plugin/src/test/java/sonia/scm/repository/spi/SvnLogCommandTest.java +++ b/scm-plugins/scm-svn-plugin/src/test/java/sonia/scm/repository/spi/SvnLogCommandTest.java @@ -24,7 +24,6 @@ package sonia.scm.repository.spi; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.collect.Iterables; import org.junit.Test; @@ -36,12 +35,7 @@ import java.util.stream.StreamSupport; import static org.junit.Assert.*; -//~--- JDK imports ------------------------------------------------------------ -/** - * - * @author Sebastian Sdorra - */ public class SvnLogCommandTest extends AbstractSvnCommandTestBase { @@ -193,12 +187,7 @@ public class SvnLogCommandTest extends AbstractSvnCommandTestBase assertEquals("1", c2.getId()); } - /** - * Method description - * - * - * @return - */ + private SvnLogCommand createCommand() { return new SvnLogCommand(createContext()); diff --git a/scm-plugins/scm-svn-plugin/src/test/java/sonia/scm/web/SvnUserAgentProviderTest.java b/scm-plugins/scm-svn-plugin/src/test/java/sonia/scm/web/SvnUserAgentProviderTest.java index 3d9ddd1815..507bb9101e 100644 --- a/scm-plugins/scm-svn-plugin/src/test/java/sonia/scm/web/SvnUserAgentProviderTest.java +++ b/scm-plugins/scm-svn-plugin/src/test/java/sonia/scm/web/SvnUserAgentProviderTest.java @@ -24,15 +24,12 @@ package sonia.scm.web; -//~--- non-JDK imports -------------------------------------------------------- import org.junit.Test; import static org.junit.Assert.*; -//~--- JDK imports ------------------------------------------------------------ - import java.util.Locale; /** @@ -42,27 +39,18 @@ import java.util.Locale; public class SvnUserAgentProviderTest { - /** Field description */ private static final String UA_1 = "SVN/1.8.8 (x64-microsoft-windows) serf/1.3.4 TortoiseSVN-1.8.6.25419"; - /** Field description */ private static final String UA_2 = "SVN/1.5.4 (r33841) neon/0.28.3"; - /** Field description */ private static final String UA_3 = "SVN/1.6.3 (r38063) neon/0.28.4"; - /** Field description */ private static final String UA_4 = "Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.0;Google Wireless Transcoder;)"; - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - */ - @Test + @Test public void testParseUserAgent() { assertEquals(SvnUserAgentProvider.TORTOISE_SVN, parse(UA_1)); @@ -71,14 +59,7 @@ public class SvnUserAgentProviderTest assertNull(parse(UA_4)); } - /** - * Method description - * - * - * @param ua - * - * @return - */ + private UserAgent parse(String ua) { return suap.parseUserAgent(ua.toLowerCase(Locale.ENGLISH)); @@ -86,6 +67,5 @@ public class SvnUserAgentProviderTest //~--- fields --------------------------------------------------------------- - /** Field description */ private final SvnUserAgentProvider suap = new SvnUserAgentProvider(); } diff --git a/scm-server/src/main/java/sonia/scm/server/ScmServerDaemon.java b/scm-server/src/main/java/sonia/scm/server/ScmServerDaemon.java index e47cf5b20d..37cb4bb27d 100644 --- a/scm-server/src/main/java/sonia/scm/server/ScmServerDaemon.java +++ b/scm-server/src/main/java/sonia/scm/server/ScmServerDaemon.java @@ -24,82 +24,44 @@ package sonia.scm.server; -//~--- non-JDK imports -------------------------------------------------------- import org.apache.commons.daemon.Daemon; import org.apache.commons.daemon.DaemonContext; import org.apache.commons.daemon.DaemonInitException; -/** - * - * @author Sebastian Sdorra - */ + public class ScmServerDaemon implements Daemon { - /** Field description */ private static volatile ScmServer webserver = new ScmServer(); - //~--- methods -------------------------------------------------------------- + private String[] daemonArgs; - /** - * Method description - * - * - * @param args - */ public static void main(String[] args) { webserver.run(); } - /** - * Method description - * - * - * @param args - * - * @throws Exception - */ + public static void start(String[] args) throws Exception { webserver.start(); } - /** - * Method description - * - * - * @param args - * - * @throws Exception - */ + public static void stop(String[] args) throws Exception { webserver.stopServer(); webserver.join((long) ScmServer.GRACEFUL_TIMEOUT); } - /** - * Method description - * - */ - @Override + @Override public void destroy() { // do nothing } - /** - * Method description - * - * - * @param context - * - * @throws DaemonInitException - * @throws Exception - */ @Override public void init(DaemonContext context) throws DaemonInitException, Exception { @@ -110,32 +72,16 @@ public class ScmServerDaemon implements Daemon webserver.init(); } - /** - * Method description - * - * - * @throws Exception - */ @Override public void start() throws Exception { start(daemonArgs); } - /** - * Method description - * - * - * @throws Exception - */ @Override public void stop() throws Exception { stop(daemonArgs); } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private String[] daemonArgs; } diff --git a/scm-server/src/main/java/sonia/scm/server/ScmServerException.java b/scm-server/src/main/java/sonia/scm/server/ScmServerException.java index 2169e4a402..fd04b2a956 100644 --- a/scm-server/src/main/java/sonia/scm/server/ScmServerException.java +++ b/scm-server/src/main/java/sonia/scm/server/ScmServerException.java @@ -24,53 +24,28 @@ package sonia.scm.server; -/** - * - * @author Sebastian Sdorra - */ + public class ScmServerException extends RuntimeException { - /** Field description */ private static final long serialVersionUID = -6496747280225411051L; - //~--- constructors --------------------------------------------------------- - /** - * Constructs ... - * - */ public ScmServerException() {} - /** - * Constructs ... - * - * - * @param message - */ + public ScmServerException(String message) { super(message); } - /** - * Constructs ... - * - * - * @param throwable - */ + public ScmServerException(Throwable throwable) { super(throwable); } - /** - * Constructs ... - * - * - * @param message - * @param throwable - */ + public ScmServerException(String message, Throwable throwable) { super(message, throwable); diff --git a/scm-test/src/main/java/sonia/scm/AbstractTestBase.java b/scm-test/src/main/java/sonia/scm/AbstractTestBase.java index 160c2b7841..cb4465ce60 100644 --- a/scm-test/src/main/java/sonia/scm/AbstractTestBase.java +++ b/scm-test/src/main/java/sonia/scm/AbstractTestBase.java @@ -24,7 +24,6 @@ package sonia.scm; -//~--- non-JDK imports -------------------------------------------------------- import org.apache.shiro.SecurityUtils; import org.apache.shiro.UnavailableSecurityManagerException; @@ -51,10 +50,7 @@ import java.util.logging.Logger; import static java.util.Collections.emptySet; import static org.junit.Assert.assertTrue; -/** - * - * @author Sebastian Sdorra - */ + public class AbstractTestBase { @@ -79,11 +75,7 @@ public class AbstractTestBase postSetUp(); } - /** - * Method description - * - */ - @AfterAll + @AfterAll @AfterClass public static void tearDownShiro() { @@ -108,40 +100,23 @@ public class AbstractTestBase setSecurityManager(null); } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + protected static org.apache.shiro.mgt.SecurityManager getSecurityManager() { return SecurityUtils.getSecurityManager(); } - //~--- set methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param securityManager - */ + protected static void setSecurityManager( org.apache.shiro.mgt.SecurityManager securityManager) { SecurityUtils.setSecurityManager(securityManager); } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - */ - private static void doClearSubject() + private static void doClearSubject() { if (subjectThreadState != null) { @@ -150,12 +125,7 @@ public class AbstractTestBase } } - /** - * Method description - * - * - * @throws Exception - */ + @AfterEach @After public void tearDownTest() throws Exception @@ -185,49 +155,25 @@ public class AbstractTestBase doClearSubject(); } - /** - * Method description - * - * - * @param subject - * - * @return - */ + protected ThreadState createThreadState(Subject subject) { return new SubjectThreadState(subject); } - /** - * Method description - * - * - * @throws Exception - */ + protected void postSetUp() throws Exception {} - /** - * Method description - * - * - * @throws Exception - */ + protected void preTearDown() throws Exception {} - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + protected Subject getSubject() { return SecurityUtils.getSubject(); } - //~--- set methods ---------------------------------------------------------- /** * Allows subclasses to set the currently executing {@link Subject} instance. diff --git a/scm-test/src/main/java/sonia/scm/ManagerTestBase.java b/scm-test/src/main/java/sonia/scm/ManagerTestBase.java index b6b368250e..98c0e10048 100644 --- a/scm-test/src/main/java/sonia/scm/ManagerTestBase.java +++ b/scm-test/src/main/java/sonia/scm/ManagerTestBase.java @@ -39,12 +39,7 @@ import java.io.IOException; import static java.util.Collections.emptySet; import static org.mockito.Mockito.mock; -/** - * - * @author Sebastian Sdorra - * - * @param - */ + public abstract class ManagerTestBase { @@ -76,12 +71,7 @@ public abstract class ManagerTestBase manager.close(); } - /** - * Method description - * - * - * @return - */ + protected abstract Manager createManager(); } diff --git a/scm-test/src/main/java/sonia/scm/TempSCMContextProvider.java b/scm-test/src/main/java/sonia/scm/TempSCMContextProvider.java index 3c38bf6faf..bf933ccc8f 100644 --- a/scm-test/src/main/java/sonia/scm/TempSCMContextProvider.java +++ b/scm-test/src/main/java/sonia/scm/TempSCMContextProvider.java @@ -24,74 +24,44 @@ package sonia.scm; -//~--- non-JDK imports -------------------------------------------------------- import java.io.File; import java.nio.file.Path; -/** - * - * @author Sebastian Sdorra - */ + public class TempSCMContextProvider implements SCMContextProvider { - - /** - * Method description - * - * - * @return - */ + private File baseDirectory; + @Override public File getBaseDirectory() { return baseDirectory; } - /** - * Method description - * - * - * @return - */ + @Override public Stage getStage() { return Stage.DEVELOPMENT; } - /** - * Method description - * - * - * @return - */ + @Override public Throwable getStartupError() { return null; } - /** - * Method description - * - * - * @return - */ + @Override public String getVersion() { return "900.0.1-SNAPSHOT"; } - //~--- set methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param baseDirectory - */ + public void setBaseDirectory(File baseDirectory) { this.baseDirectory = baseDirectory; @@ -102,8 +72,4 @@ public class TempSCMContextProvider implements SCMContextProvider return baseDirectory.toPath().resolve(path); } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private File baseDirectory; } diff --git a/scm-test/src/main/java/sonia/scm/cache/MapCache.java b/scm-test/src/main/java/sonia/scm/cache/MapCache.java index b87aae2344..aad8b50c81 100644 --- a/scm-test/src/main/java/sonia/scm/cache/MapCache.java +++ b/scm-test/src/main/java/sonia/scm/cache/MapCache.java @@ -24,104 +24,59 @@ package sonia.scm.cache; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Predicate; import com.google.common.collect.Maps; import com.google.common.collect.Sets; -//~--- JDK imports ------------------------------------------------------------ - import java.util.Collection; import java.util.Collections; import java.util.Map; import java.util.Set; /** - * - * @author Sebastian Sdorra * @since 1.17 - * - * @param - * @param */ public class MapCache implements Cache, org.apache.shiro.cache.Cache { + private final Map map = Maps.newHashMap(); - /** - * Method description - * - */ - @Override + @Override public void clear() { map.clear(); } - /** - * Method description - * - * - * @param key - * - * @return - */ + @Override public boolean contains(K key) { return map.containsKey(key); } - /** - * Method description - * - * - * @return - */ + @Override public Set keys() { return Collections.unmodifiableSet(map.keySet()); } - /** - * Method description - * - * - * @param key - * @param value - * - * @return - */ + @Override public V put(K key, V value) { return map.put(key, value); } - /** - * Method description - * - * - * @param key - * - * @return - */ + @Override public V remove(K key) { return map.remove(key); } - /** - * Method description - * - * - * @param filter - * - * @return - */ + @Override public Iterable removeAll(Predicate filter) { @@ -138,60 +93,33 @@ public class MapCache return values; } - /** - * Method description - * - * - * @return - */ + @Override public int size() { return map.size(); } - /** - * Method description - * - * - * @return - */ + @Override public Collection values() { return Collections.unmodifiableCollection(map.values()); } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param key - * - * @return - */ + @Override public V get(K key) { return map.get(key); } - /** - * Method description - * - * - * @return - */ + @Override public CacheStatistics getStatistics() { return null; } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private final Map map = Maps.newHashMap(); } diff --git a/scm-test/src/main/java/sonia/scm/cache/MapCacheManager.java b/scm-test/src/main/java/sonia/scm/cache/MapCacheManager.java index b6cc38558e..d051bef11b 100644 --- a/scm-test/src/main/java/sonia/scm/cache/MapCacheManager.java +++ b/scm-test/src/main/java/sonia/scm/cache/MapCacheManager.java @@ -24,32 +24,22 @@ package sonia.scm.cache; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.collect.Maps; -//~--- JDK imports ------------------------------------------------------------ - import java.io.IOException; import java.util.Map; /** - * - * @author Sebastian Sdorra * @since 1.17 */ @SuppressWarnings("unchecked") public class MapCacheManager implements CacheManager, org.apache.shiro.cache.CacheManager { + private final Map cacheMap = Maps.newHashMap(); - /** - * Method description - * - * - * @throws IOException - */ @Override public void close() throws IOException { @@ -57,18 +47,7 @@ public class MapCacheManager // do nothing } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param name - * @param - * @param - * - * @return - */ @Override public synchronized MapCache getCache(String name) { @@ -82,8 +61,4 @@ public class MapCacheManager } } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private final Map cacheMap = Maps.newHashMap(); } diff --git a/scm-test/src/main/java/sonia/scm/event/ScmTestEventBus.java b/scm-test/src/main/java/sonia/scm/event/ScmTestEventBus.java index 7147a8ff23..dc4449054c 100644 --- a/scm-test/src/main/java/sonia/scm/event/ScmTestEventBus.java +++ b/scm-test/src/main/java/sonia/scm/event/ScmTestEventBus.java @@ -24,56 +24,35 @@ package sonia.scm.event; -//~--- non-JDK imports -------------------------------------------------------- import com.github.legman.EventBus; /** * - * @author Sebastian Sdorra * @since 2.0.0 */ public class ScmTestEventBus extends ScmEventBus { + private final EventBus eventBus = new EventBus("testing"); - /** - * Method description - * - * - * @param event - */ @Override public void post(Object event) { eventBus.post(event); } - /** - * Method description - * - * - * @param subscriber - */ + @Override public void register(Object subscriber) { eventBus.register(subscriber); } - /** - * Method description - * - * - * @param subscriber - */ + @Override public void unregister(Object subscriber) { eventBus.unregister(subscriber); } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private final EventBus eventBus = new EventBus("testing"); } diff --git a/scm-test/src/main/java/sonia/scm/repository/DummyRepositoryHandler.java b/scm-test/src/main/java/sonia/scm/repository/DummyRepositoryHandler.java index 09a0295751..0fdd49ce15 100644 --- a/scm-test/src/main/java/sonia/scm/repository/DummyRepositoryHandler.java +++ b/scm-test/src/main/java/sonia/scm/repository/DummyRepositoryHandler.java @@ -24,7 +24,6 @@ package sonia.scm.repository; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.collect.Sets; import jakarta.xml.bind.annotation.XmlRootElement; @@ -35,11 +34,7 @@ import java.io.File; import java.util.HashSet; import java.util.Set; -//~--- JDK imports ------------------------------------------------------------ -/** - * @author Sebastian Sdorra - */ public class DummyRepositoryHandler extends AbstractSimpleRepositoryHandler { diff --git a/scm-test/src/main/java/sonia/scm/repository/PersonTestData.java b/scm-test/src/main/java/sonia/scm/repository/PersonTestData.java index 7e1da65f42..9acdc4003a 100644 --- a/scm-test/src/main/java/sonia/scm/repository/PersonTestData.java +++ b/scm-test/src/main/java/sonia/scm/repository/PersonTestData.java @@ -26,45 +26,32 @@ package sonia.scm.repository; /** * - * @author Sebastian Sdorra * @since 1.18 */ public final class PersonTestData { - /** Field description */ public static final Person ADAMS = Person.toPerson("Douglas Adams "); - /** Field description */ public static final Person DENT = Person.toPerson("Arthur Dent "); - /** Field description */ public static final Person MARVIN = Person.toPerson("Marvin "); - /** Field description */ public static final Person PERFECT = Person.toPerson("Ford Prefect "); - /** Field description */ public static final Person SLARTI = Person.toPerson("Slartibartfaß "); - /** Field description */ public static final Person TILLIAN = Person.toPerson("Tricia McMillan "); - /** Field description */ public static final Person ZAPHOD = Person.toPerson("Zaphod Beeblebrox "); - //~--- constructors --------------------------------------------------------- - /** - * Constructs ... - * - */ private PersonTestData() {} } diff --git a/scm-test/src/main/java/sonia/scm/repository/SimpleRepositoryHandlerTestBase.java b/scm-test/src/main/java/sonia/scm/repository/SimpleRepositoryHandlerTestBase.java index 9ccb3544d9..40814d08d4 100644 --- a/scm-test/src/main/java/sonia/scm/repository/SimpleRepositoryHandlerTestBase.java +++ b/scm-test/src/main/java/sonia/scm/repository/SimpleRepositoryHandlerTestBase.java @@ -24,7 +24,6 @@ package sonia.scm.repository; -//~--- non-JDK imports -------------------------------------------------------- import org.junit.Test; import org.mockito.stubbing.Answer; @@ -43,11 +42,7 @@ import static org.mockito.ArgumentMatchers.anyString; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; -//~--- JDK imports ------------------------------------------------------------ -/** - * @author Sebastian Sdorra - */ public abstract class SimpleRepositoryHandlerTestBase extends AbstractTestBase { protected Path repoPath; diff --git a/scm-test/src/main/java/sonia/scm/repository/client/api/BranchCommandBuilder.java b/scm-test/src/main/java/sonia/scm/repository/client/api/BranchCommandBuilder.java index 0383fb4bc6..72456f44b3 100644 --- a/scm-test/src/main/java/sonia/scm/repository/client/api/BranchCommandBuilder.java +++ b/scm-test/src/main/java/sonia/scm/repository/client/api/BranchCommandBuilder.java @@ -24,56 +24,34 @@ package sonia.scm.repository.client.api; -//~--- non-JDK imports -------------------------------------------------------- import org.slf4j.Logger; import org.slf4j.LoggerFactory; import sonia.scm.repository.client.spi.BranchCommand; -//~--- JDK imports ------------------------------------------------------------ - import java.io.IOException; /** * - * @author Sebastian Sdorra * @since 1.18 */ public final class BranchCommandBuilder { - /** - * the logger for BranchCommandBuilder - */ + private static final Logger logger = LoggerFactory.getLogger(BranchCommandBuilder.class); - //~--- constructors --------------------------------------------------------- - - /** - * Constructs ... - * - * - * @param command - */ + private BranchCommand command; + public BranchCommandBuilder(BranchCommand command) { this.command = command; } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param name - * - * @return - * - * @throws IOException - */ + public BranchCommandBuilder branch(String name) throws IOException { if (logger.isDebugEnabled()) @@ -86,8 +64,4 @@ public final class BranchCommandBuilder return this; } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private BranchCommand command; } diff --git a/scm-test/src/main/java/sonia/scm/repository/client/api/ClientCommand.java b/scm-test/src/main/java/sonia/scm/repository/client/api/ClientCommand.java index 37e1cce24a..f18b69ee44 100644 --- a/scm-test/src/main/java/sonia/scm/repository/client/api/ClientCommand.java +++ b/scm-test/src/main/java/sonia/scm/repository/client/api/ClientCommand.java @@ -26,7 +26,6 @@ package sonia.scm.repository.client.api; /** * - * @author Sebastian Sdorra * @since 1.18 */ public enum ClientCommand diff --git a/scm-test/src/main/java/sonia/scm/repository/client/api/ClientCommandNotSupportedException.java b/scm-test/src/main/java/sonia/scm/repository/client/api/ClientCommandNotSupportedException.java index 9277128842..f59212f519 100644 --- a/scm-test/src/main/java/sonia/scm/repository/client/api/ClientCommandNotSupportedException.java +++ b/scm-test/src/main/java/sonia/scm/repository/client/api/ClientCommandNotSupportedException.java @@ -26,18 +26,12 @@ package sonia.scm.repository.client.api; /** * - * @author Sebastian Sdorra * @since 1.18 */ public class ClientCommandNotSupportedException extends RuntimeException { - - /** - * Constructs ... - * - * - * @param clientCommand - */ + private ClientCommand clientCommand; + public ClientCommandNotSupportedException(ClientCommand clientCommand) { super( @@ -46,13 +40,7 @@ public class ClientCommandNotSupportedException extends RuntimeException this.clientCommand = clientCommand; } - /** - * Constructs ... - * - * - * @param clientCommand - * @param message - */ + public ClientCommandNotSupportedException(ClientCommand clientCommand, String message) { @@ -60,21 +48,11 @@ public class ClientCommandNotSupportedException extends RuntimeException this.clientCommand = clientCommand; } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + public ClientCommand getClientCommand() { return clientCommand; } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private ClientCommand clientCommand; } diff --git a/scm-test/src/main/java/sonia/scm/repository/client/api/CommitCommandBuilder.java b/scm-test/src/main/java/sonia/scm/repository/client/api/CommitCommandBuilder.java index 76be8ac707..0ae352fc04 100644 --- a/scm-test/src/main/java/sonia/scm/repository/client/api/CommitCommandBuilder.java +++ b/scm-test/src/main/java/sonia/scm/repository/client/api/CommitCommandBuilder.java @@ -24,7 +24,6 @@ package sonia.scm.repository.client.api; -//~--- non-JDK imports -------------------------------------------------------- import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -34,51 +33,28 @@ import sonia.scm.repository.Person; import sonia.scm.repository.client.spi.CommitCommand; import sonia.scm.repository.client.spi.CommitRequest; -//~--- JDK imports ------------------------------------------------------------ - import java.io.IOException; /** * - * @author Sebastian Sdorra * @since 1.18 */ public final class CommitCommandBuilder { - /** - * the logger for CommitCommandBuilder - */ + private static final Logger logger = LoggerFactory.getLogger(CommitCommandBuilder.class); - //~--- constructors --------------------------------------------------------- + private CommitCommand command; - /** - * Constructs ... - * - * - * @param directory - * @param command - */ + private CommitRequest request = new CommitRequest(); + CommitCommandBuilder(CommitCommand command) { this.command = command; } - //~--- methods -------------------------------------------------------------- - - /** - * Method description - * - * - * @param author - * @param message - * - * @return - * - * @throws IOException - */ public Changeset commit(Person author, String message) throws IOException { request.setAuthor(author); @@ -96,11 +72,4 @@ public final class CommitCommandBuilder return changeset; } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private CommitCommand command; - - /** Field description */ - private CommitRequest request = new CommitRequest(); } diff --git a/scm-test/src/main/java/sonia/scm/repository/client/api/PushCommandBuilder.java b/scm-test/src/main/java/sonia/scm/repository/client/api/PushCommandBuilder.java index e43e43f627..b139bd2932 100644 --- a/scm-test/src/main/java/sonia/scm/repository/client/api/PushCommandBuilder.java +++ b/scm-test/src/main/java/sonia/scm/repository/client/api/PushCommandBuilder.java @@ -24,7 +24,6 @@ package sonia.scm.repository.client.api; -//~--- non-JDK imports -------------------------------------------------------- import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -32,43 +31,26 @@ import sonia.scm.repository.client.spi.PushCommand; import java.io.IOException; -//~--- JDK imports ------------------------------------------------------------ - /** * - * @author Sebastian Sdorra * @since 1.18 */ public final class PushCommandBuilder { - /** - * the logger for PushCommandBuilder - */ + private static final Logger logger = LoggerFactory.getLogger(PushCommandBuilder.class); - //~--- constructors --------------------------------------------------------- - - /** - * Constructs ... - * - * - * @param command - */ + private PushCommand command; + PushCommandBuilder(PushCommand command) { this.command = command; } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @throws IOException - */ + public void push() throws IOException { if (logger.isDebugEnabled()) @@ -87,8 +69,4 @@ public final class PushCommandBuilder command.pushTags(); } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private PushCommand command; } diff --git a/scm-test/src/main/java/sonia/scm/repository/client/api/RepositoryClient.java b/scm-test/src/main/java/sonia/scm/repository/client/api/RepositoryClient.java index 660cdb160b..9da6a3a107 100644 --- a/scm-test/src/main/java/sonia/scm/repository/client/api/RepositoryClient.java +++ b/scm-test/src/main/java/sonia/scm/repository/client/api/RepositoryClient.java @@ -36,6 +36,8 @@ public final class RepositoryClient implements Closeable { private static final Logger logger = LoggerFactory.getLogger(RepositoryClient.class); + private final RepositoryClientProvider clientProvider; + RepositoryClient(RepositoryClientProvider clientProvider) { this.clientProvider = clientProvider; @@ -110,5 +112,4 @@ public final class RepositoryClient implements Closeable { return clientProvider.getSupportedClientCommands().contains(command); } - private final RepositoryClientProvider clientProvider; } diff --git a/scm-test/src/main/java/sonia/scm/repository/client/api/RepositoryClientException.java b/scm-test/src/main/java/sonia/scm/repository/client/api/RepositoryClientException.java index 7e11bb3ca9..d733250840 100644 --- a/scm-test/src/main/java/sonia/scm/repository/client/api/RepositoryClientException.java +++ b/scm-test/src/main/java/sonia/scm/repository/client/api/RepositoryClientException.java @@ -24,53 +24,30 @@ package sonia.scm.repository.client.api; -//~--- JDK imports ------------------------------------------------------------ - import java.io.IOException; /** * - * @author Sebastian Sdorra * @since 1.18 */ public final class RepositoryClientException extends IOException { - /** - * Constructs ... - * - */ public RepositoryClientException() {} - /** - * Constructs ... - * - * - * @param message - */ + public RepositoryClientException(String message) { super(message); } - /** - * Constructs ... - * - * - * @param cause - */ + public RepositoryClientException(Throwable cause) { super(cause); } - /** - * Constructs ... - * - * - * @param message - * @param cause - */ + public RepositoryClientException(String message, Throwable cause) { super(message, cause); diff --git a/scm-test/src/main/java/sonia/scm/repository/client/api/RepositoryClientFactory.java b/scm-test/src/main/java/sonia/scm/repository/client/api/RepositoryClientFactory.java index 9062c5c8b4..409e97426f 100644 --- a/scm-test/src/main/java/sonia/scm/repository/client/api/RepositoryClientFactory.java +++ b/scm-test/src/main/java/sonia/scm/repository/client/api/RepositoryClientFactory.java @@ -24,22 +24,18 @@ package sonia.scm.repository.client.api; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.collect.Lists; import sonia.scm.repository.client.spi.RepositoryClientFactoryProvider; import sonia.scm.util.ServiceUtil; -//~--- JDK imports ------------------------------------------------------------ - import java.io.File; import java.io.IOException; import java.util.List; /** - * @author Sebastian Sdorra * @since 1.18 */ public final class RepositoryClientFactory { diff --git a/scm-test/src/main/java/sonia/scm/repository/client/api/TagCommandBuilder.java b/scm-test/src/main/java/sonia/scm/repository/client/api/TagCommandBuilder.java index 68711a7956..e038a854f3 100644 --- a/scm-test/src/main/java/sonia/scm/repository/client/api/TagCommandBuilder.java +++ b/scm-test/src/main/java/sonia/scm/repository/client/api/TagCommandBuilder.java @@ -24,7 +24,6 @@ package sonia.scm.repository.client.api; -//~--- non-JDK imports -------------------------------------------------------- import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -34,47 +33,28 @@ import sonia.scm.repository.client.spi.TagRequest; import java.io.IOException; -//~--- JDK imports ------------------------------------------------------------ - /** * - * @author Sebastian Sdorra * @since 1.18 */ public final class TagCommandBuilder { - /** - * the logger for TagCommandBuilder - */ + private static final Logger logger = LoggerFactory.getLogger(TagCommandBuilder.class); - //~--- constructors --------------------------------------------------------- + private TagCommand command; - /** - * Constructs ... - * - * - * @param command - */ + private TagRequest request = new TagRequest(); + TagCommandBuilder(TagCommand command) { this.command = command; } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param name - * - * @return - * - * @throws IOException - */ + public Tag tag(String name, String username) throws IOException { request.setName(name); @@ -92,16 +72,8 @@ public final class TagCommandBuilder return tag; } - //~--- set methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param revision - * - * @return - */ + public TagCommandBuilder setRevision(String revision) { request.setRevision(revision); @@ -109,11 +81,4 @@ public final class TagCommandBuilder return this; } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private TagCommand command; - - /** Field description */ - private TagRequest request = new TagRequest(); } diff --git a/scm-test/src/main/java/sonia/scm/repository/client/spi/AddCommand.java b/scm-test/src/main/java/sonia/scm/repository/client/spi/AddCommand.java index 63d4be354e..179727a033 100644 --- a/scm-test/src/main/java/sonia/scm/repository/client/spi/AddCommand.java +++ b/scm-test/src/main/java/sonia/scm/repository/client/spi/AddCommand.java @@ -24,12 +24,9 @@ package sonia.scm.repository.client.spi; -//~--- JDK imports ------------------------------------------------------------ - import java.io.IOException; /** - * @author Sebastian Sdorra * @since 1.18 */ public interface AddCommand { diff --git a/scm-test/src/main/java/sonia/scm/repository/client/spi/BranchCommand.java b/scm-test/src/main/java/sonia/scm/repository/client/spi/BranchCommand.java index e8bab1f791..53b252fbb4 100644 --- a/scm-test/src/main/java/sonia/scm/repository/client/spi/BranchCommand.java +++ b/scm-test/src/main/java/sonia/scm/repository/client/spi/BranchCommand.java @@ -24,31 +24,18 @@ package sonia.scm.repository.client.spi; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.repository.Branch; -//~--- JDK imports ------------------------------------------------------------ - import java.io.IOException; /** * - * @author Sebastian Sdorra * @since 1.18 */ public interface BranchCommand { - /** - * Method description - * - * - * @param name - * - * @return - * - * @throws IOException - */ + public Branch branch(String name) throws IOException; } diff --git a/scm-test/src/main/java/sonia/scm/repository/client/spi/CommitCommand.java b/scm-test/src/main/java/sonia/scm/repository/client/spi/CommitCommand.java index 117d97e55d..439f59e070 100644 --- a/scm-test/src/main/java/sonia/scm/repository/client/spi/CommitCommand.java +++ b/scm-test/src/main/java/sonia/scm/repository/client/spi/CommitCommand.java @@ -24,31 +24,18 @@ package sonia.scm.repository.client.spi; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.repository.Changeset; -//~--- JDK imports ------------------------------------------------------------ - import java.io.IOException; /** * - * @author Sebastian Sdorra * @since 1.18 */ public interface CommitCommand { - /** - * Method description - * - * - * @param request - * - * @return - * - * @throws IOException - */ + public Changeset commit(CommitRequest request) throws IOException; } diff --git a/scm-test/src/main/java/sonia/scm/repository/client/spi/CommitRequest.java b/scm-test/src/main/java/sonia/scm/repository/client/spi/CommitRequest.java index 5f31dabbde..745cdb3d48 100644 --- a/scm-test/src/main/java/sonia/scm/repository/client/spi/CommitRequest.java +++ b/scm-test/src/main/java/sonia/scm/repository/client/spi/CommitRequest.java @@ -24,7 +24,6 @@ package sonia.scm.repository.client.spi; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.MoreObjects; import com.google.common.base.Objects; @@ -32,20 +31,14 @@ import sonia.scm.repository.Person; /** * - * @author Sebastian Sdorra * @since 1.18 */ public final class CommitRequest { + private Person author; + + private String message; - /** - * Method description - * - * - * @param obj - * - * @return - */ @Override public boolean equals(Object obj) { @@ -65,34 +58,20 @@ public final class CommitRequest && Objects.equal(message, other.message); } - /** - * Method description - * - * - * @return - */ + @Override public int hashCode() { return Objects.hashCode(author, message); } - /** - * Method description - * - */ - public void reset() + public void reset() { this.author = null; this.message = null; } - /** - * Method description - * - * - * @return - */ + @Override public String toString() { @@ -104,59 +83,30 @@ public final class CommitRequest //J+ } - //~--- set methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param author - */ + public void setAuthor(Person author) { this.author = author; } - /** - * Method description - * - * - * @param message - */ + public void setMessage(String message) { this.message = message; } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + Person getAuthor() { return author; } - /** - * Method description - * - * - * @return - */ + String getMessage() { return message; } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private Person author; - - /** Field description */ - private String message; } diff --git a/scm-test/src/main/java/sonia/scm/repository/client/spi/PushCommand.java b/scm-test/src/main/java/sonia/scm/repository/client/spi/PushCommand.java index a7daa851ec..f0811abac9 100644 --- a/scm-test/src/main/java/sonia/scm/repository/client/spi/PushCommand.java +++ b/scm-test/src/main/java/sonia/scm/repository/client/spi/PushCommand.java @@ -24,13 +24,10 @@ package sonia.scm.repository.client.spi; -//~--- JDK imports ------------------------------------------------------------ - import java.io.IOException; /** * - * @author Sebastian Sdorra * @since 1.18 */ public interface PushCommand diff --git a/scm-test/src/main/java/sonia/scm/repository/client/spi/RemoveCommand.java b/scm-test/src/main/java/sonia/scm/repository/client/spi/RemoveCommand.java index 602b980cc5..74dff5733c 100644 --- a/scm-test/src/main/java/sonia/scm/repository/client/spi/RemoveCommand.java +++ b/scm-test/src/main/java/sonia/scm/repository/client/spi/RemoveCommand.java @@ -24,12 +24,9 @@ package sonia.scm.repository.client.spi; -//~--- JDK imports ------------------------------------------------------------ - import java.io.IOException; /** - * @author Sebastian Sdorra * @since 1.18 */ public interface RemoveCommand { diff --git a/scm-test/src/main/java/sonia/scm/repository/client/spi/RepositoryClientFactoryProvider.java b/scm-test/src/main/java/sonia/scm/repository/client/spi/RepositoryClientFactoryProvider.java index 0dc99d81ec..fa6c66f9d4 100644 --- a/scm-test/src/main/java/sonia/scm/repository/client/spi/RepositoryClientFactoryProvider.java +++ b/scm-test/src/main/java/sonia/scm/repository/client/spi/RepositoryClientFactoryProvider.java @@ -24,57 +24,24 @@ package sonia.scm.repository.client.spi; -//~--- JDK imports ------------------------------------------------------------ - import java.io.File; import java.io.IOException; /** * - * @author Sebastian Sdorra * @since 1.18 */ public interface RepositoryClientFactoryProvider { - /** - * Method description - * - * - * @param main - * @param workingCopy - * - * @return - * - * @throws IOException - */ public RepositoryClientProvider create(File main, File workingCopy) throws IOException; - /** - * Method description - * - * - * @param url - * @param username - * @param password - * @param workingCopy - * - * @return - * - * @throws IOException - */ public RepositoryClientProvider create(String url, String username, String password, File workingCopy) throws IOException; - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + public String getType(); } diff --git a/scm-test/src/main/java/sonia/scm/repository/client/spi/RepositoryClientProvider.java b/scm-test/src/main/java/sonia/scm/repository/client/spi/RepositoryClientProvider.java index bfe4c5afe8..37633e2bd2 100644 --- a/scm-test/src/main/java/sonia/scm/repository/client/spi/RepositoryClientProvider.java +++ b/scm-test/src/main/java/sonia/scm/repository/client/spi/RepositoryClientProvider.java @@ -24,7 +24,6 @@ package sonia.scm.repository.client.spi; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.repository.client.api.ClientCommand; import sonia.scm.repository.client.api.ClientCommandNotSupportedException; @@ -34,54 +33,29 @@ import java.io.File; import java.io.IOException; import java.util.Set; -//~--- JDK imports ------------------------------------------------------------ - /** * - * @author Sebastian Sdorra * @since 1.18 */ public abstract class RepositoryClientProvider implements Closeable { - /** - * Method description - * - * - * @return - */ + public abstract Set getSupportedClientCommands(); - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @throws IOException - */ + @Override public void close() throws IOException {} - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + public AddCommand getAddCommand() { throw new ClientCommandNotSupportedException(ClientCommand.ADD); } - /** - * Method description - * - * - * @return - */ + public BranchCommand getBranchCommand() { throw new ClientCommandNotSupportedException(ClientCommand.BRANCH); @@ -95,45 +69,25 @@ public abstract class RepositoryClientProvider implements Closeable throw new ClientCommandNotSupportedException(ClientCommand.CHECKOUT); } - /** - * Method description - * - * - * @return - */ + public CommitCommand getCommitCommand() { throw new ClientCommandNotSupportedException(ClientCommand.COMMIT); } - /** - * Method description - * - * - * @return - */ + public PushCommand getPushCommand() { throw new ClientCommandNotSupportedException(ClientCommand.PUSH); } - /** - * Method description - * - * - * @return - */ + public RemoveCommand getRemoveCommand() { throw new ClientCommandNotSupportedException(ClientCommand.REMOVE); } - /** - * Method description - * - * - * @return - */ + public TagCommand getTagCommand() { throw new ClientCommandNotSupportedException(ClientCommand.TAG); diff --git a/scm-test/src/main/java/sonia/scm/repository/client/spi/TagCommand.java b/scm-test/src/main/java/sonia/scm/repository/client/spi/TagCommand.java index d26e6ba804..777134d4c1 100644 --- a/scm-test/src/main/java/sonia/scm/repository/client/spi/TagCommand.java +++ b/scm-test/src/main/java/sonia/scm/repository/client/spi/TagCommand.java @@ -24,31 +24,18 @@ package sonia.scm.repository.client.spi; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.repository.Tag; -//~--- JDK imports ------------------------------------------------------------ - import java.io.IOException; /** * - * @author Sebastian Sdorra * @since 1.18 */ public interface TagCommand { - /** - * Method description - * - * - * @param request - * - * @return - * - * @throws IOException - */ + public Tag tag(TagRequest request) throws IOException; } diff --git a/scm-test/src/main/java/sonia/scm/repository/client/spi/TagRequest.java b/scm-test/src/main/java/sonia/scm/repository/client/spi/TagRequest.java index 57e3acfa4d..16a5486ee3 100644 --- a/scm-test/src/main/java/sonia/scm/repository/client/spi/TagRequest.java +++ b/scm-test/src/main/java/sonia/scm/repository/client/spi/TagRequest.java @@ -24,26 +24,21 @@ package sonia.scm.repository.client.spi; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.MoreObjects; import com.google.common.base.Objects; /** * - * @author Sebastian Sdorra * @since 1.18 */ public final class TagRequest { + private String name; + + private String revision; + + private String username; - /** - * Method description - * - * - * @param obj - * - * @return - */ @Override public boolean equals(Object obj) { @@ -63,35 +58,21 @@ public final class TagRequest && Objects.equal(name, other.name); } - /** - * Method description - * - * - * @return - */ + @Override public int hashCode() { return Objects.hashCode(revision, name); } - /** - * Method description - * - */ - public void reset() + public void reset() { this.name = null; this.revision = null; this.username = null; } - /** - * Method description - * - * - * @return - */ + @Override public String toString() { @@ -104,25 +85,14 @@ public final class TagRequest //J+ } - //~--- set methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param name - */ + public void setName(String name) { this.name = name; } - /** - * Method description - * - * - * @param revision - */ + public void setRevision(String revision) { this.revision = revision; @@ -132,25 +102,14 @@ public final class TagRequest this.username = username; } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + String getName() { return name; } - /** - * Method description - * - * - * @return - */ + String getRevision() { return revision; @@ -160,13 +119,4 @@ public final class TagRequest return username; } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private String name; - - /** Field description */ - private String revision; - - private String username; } diff --git a/scm-test/src/main/java/sonia/scm/repository/spi/ZippedRepositoryTestBase.java b/scm-test/src/main/java/sonia/scm/repository/spi/ZippedRepositoryTestBase.java index 565f6e7d17..a8b09590c6 100644 --- a/scm-test/src/main/java/sonia/scm/repository/spi/ZippedRepositoryTestBase.java +++ b/scm-test/src/main/java/sonia/scm/repository/spi/ZippedRepositoryTestBase.java @@ -24,7 +24,6 @@ package sonia.scm.repository.spi; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.io.Resources; @@ -39,8 +38,6 @@ import sonia.scm.util.IOUtil; import static org.junit.Assert.*; -//~--- JDK imports ------------------------------------------------------------ - import java.io.File; import java.io.FileOutputStream; import java.io.IOException; @@ -51,47 +48,29 @@ import java.net.URL; import java.util.zip.ZipEntry; import java.util.zip.ZipInputStream; -/** - * - * @author Sebastian Sdorra - */ + public abstract class ZippedRepositoryTestBase extends AbstractTestBase { + @Rule + public TemporaryFolder tempFolder = new TemporaryFolder(); - /** - * Method description - * - * - * @return - */ + protected Repository repository = createRepository(); + + protected File repositoryDirectory; + protected abstract String getType(); - /** - * Method description - * - * - * @return - */ + protected abstract String getZippedRepositoryResource(); - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - */ - @Before + @Before public void before() { repositoryDirectory = createRepositoryDirectory(); } - /** - * Method description - * - * - * @param date - */ + protected void checkDate(long date) { assertNotNull(date); @@ -99,23 +78,13 @@ public abstract class ZippedRepositoryTestBase extends AbstractTestBase date < System.currentTimeMillis()); } - /** - * Method description - * - * - * @return - */ + protected Repository createRepository() { return RepositoryTestData.createHeartOfGold(getType()); } - /** - * Method description - * - * - * @return - */ + protected File createRepositoryDirectory() { File folder = null; @@ -134,14 +103,7 @@ public abstract class ZippedRepositoryTestBase extends AbstractTestBase return folder; } - /** - * Method description - * - * - * @param folder - * - * @throws IOException - */ + private void extract(File folder) throws IOException { String zippedRepositoryResource = getZippedRepositoryResource(); @@ -186,15 +148,4 @@ public abstract class ZippedRepositoryTestBase extends AbstractTestBase } } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - @Rule - public TemporaryFolder tempFolder = new TemporaryFolder(); - - /** Field description */ - protected Repository repository = createRepository(); - - /** Field description */ - protected File repositoryDirectory; } diff --git a/scm-test/src/main/java/sonia/scm/security/InMemoryCipherHandler.java b/scm-test/src/main/java/sonia/scm/security/InMemoryCipherHandler.java index 3da3e31dad..a0c7bae210 100644 --- a/scm-test/src/main/java/sonia/scm/security/InMemoryCipherHandler.java +++ b/scm-test/src/main/java/sonia/scm/security/InMemoryCipherHandler.java @@ -24,26 +24,17 @@ package sonia.scm.security; -//~--- JDK imports ------------------------------------------------------------ - import java.util.UUID; /** - * @author Sebastian Sdorra * @since 1.38 */ public class InMemoryCipherHandler extends DefaultCipherHandler { - /** Field description */ private static final String KEY = UUID.randomUUID().toString(); - //~--- constructors --------------------------------------------------------- - /** - * Constructs ... - * - */ public InMemoryCipherHandler() { super(KEY); diff --git a/scm-test/src/main/java/sonia/scm/store/ConfigurationEntryStoreTestBase.java b/scm-test/src/main/java/sonia/scm/store/ConfigurationEntryStoreTestBase.java index ff44f6cbd2..0403e450c7 100644 --- a/scm-test/src/main/java/sonia/scm/store/ConfigurationEntryStoreTestBase.java +++ b/scm-test/src/main/java/sonia/scm/store/ConfigurationEntryStoreTestBase.java @@ -26,19 +26,12 @@ package sonia.scm.store; import sonia.scm.repository.Repository; -/** - * @author Sebastian Sdorra - */ + public abstract class ConfigurationEntryStoreTestBase extends KeyValueStoreTestBase { - /** - * Method description - * - * @return - */ + protected abstract ConfigurationEntryStoreFactory createConfigurationStoreFactory(); - //~--- get methods ---------------------------------------------------------- @Override protected ConfigurationEntryStore getDataStore(Class type) { return this.createConfigurationStoreFactory() diff --git a/scm-test/src/main/java/sonia/scm/store/DataStoreTestBase.java b/scm-test/src/main/java/sonia/scm/store/DataStoreTestBase.java index 7ab092f4fa..3bc3d8287e 100644 --- a/scm-test/src/main/java/sonia/scm/store/DataStoreTestBase.java +++ b/scm-test/src/main/java/sonia/scm/store/DataStoreTestBase.java @@ -31,23 +31,14 @@ import sonia.scm.repository.RepositoryTestData; import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertNotNull; -/** - * - * @author Sebastian Sdorra - */ + public abstract class DataStoreTestBase extends KeyValueStoreTestBase { - /** - * Method description - * - * - * @return - */ + protected abstract DataStoreFactory createDataStoreFactory(); - //~--- get methods ---------------------------------------------------------- diff --git a/scm-test/src/main/java/sonia/scm/store/InMemoryConfigurationStore.java b/scm-test/src/main/java/sonia/scm/store/InMemoryConfigurationStore.java index 0d1cf1f306..c1a400d540 100644 --- a/scm-test/src/main/java/sonia/scm/store/InMemoryConfigurationStore.java +++ b/scm-test/src/main/java/sonia/scm/store/InMemoryConfigurationStore.java @@ -27,7 +27,6 @@ package sonia.scm.store; /** * In memory store implementation of {@link ConfigurationStore}. * - * @author Sebastian Sdorra * * @param type of stored object * diff --git a/scm-test/src/main/java/sonia/scm/store/InMemoryConfigurationStoreFactory.java b/scm-test/src/main/java/sonia/scm/store/InMemoryConfigurationStoreFactory.java index 504213fb69..b7580ff099 100644 --- a/scm-test/src/main/java/sonia/scm/store/InMemoryConfigurationStoreFactory.java +++ b/scm-test/src/main/java/sonia/scm/store/InMemoryConfigurationStoreFactory.java @@ -30,7 +30,6 @@ import java.util.Map; /** * In memory configuration store factory for testing purposes. * - * @author Sebastian Sdorra * * @deprecated Use the {@link InMemoryByteConfigurationStoreFactory} to verify JaxB serialization, too. */ diff --git a/scm-test/src/main/java/sonia/scm/store/InMemoryDataStore.java b/scm-test/src/main/java/sonia/scm/store/InMemoryDataStore.java index beef74a863..f276726f8e 100644 --- a/scm-test/src/main/java/sonia/scm/store/InMemoryDataStore.java +++ b/scm-test/src/main/java/sonia/scm/store/InMemoryDataStore.java @@ -34,7 +34,6 @@ import java.util.Map; /** * In memory store implementation of {@link DataStore}. * - * @author Sebastian Sdorra * * @param type of stored object * @deprecated use {@link InMemoryByteDataStore} instead. diff --git a/scm-test/src/main/java/sonia/scm/store/InMemoryDataStoreFactory.java b/scm-test/src/main/java/sonia/scm/store/InMemoryDataStoreFactory.java index abd0aa489e..24682166d0 100644 --- a/scm-test/src/main/java/sonia/scm/store/InMemoryDataStoreFactory.java +++ b/scm-test/src/main/java/sonia/scm/store/InMemoryDataStoreFactory.java @@ -27,7 +27,6 @@ package sonia.scm.store; /** * In memory configuration store factory for testing purposes. * - * @author Sebastian Sdorra * @deprecated use {@link InMemoryByteDataStoreFactory} instead. */ @Deprecated diff --git a/scm-test/src/main/java/sonia/scm/store/KeyValueStoreTestBase.java b/scm-test/src/main/java/sonia/scm/store/KeyValueStoreTestBase.java index 70b3b3d59d..99114dad5a 100644 --- a/scm-test/src/main/java/sonia/scm/store/KeyValueStoreTestBase.java +++ b/scm-test/src/main/java/sonia/scm/store/KeyValueStoreTestBase.java @@ -24,7 +24,6 @@ package sonia.scm.store; -//~--- non-JDK imports -------------------------------------------------------- import org.junit.Before; import org.junit.Test; @@ -39,14 +38,9 @@ import static org.junit.Assert.assertNotNull; import static org.junit.Assert.assertNull; import static org.junit.Assert.assertTrue; -//~--- JDK imports ------------------------------------------------------------ - import java.util.Map; -/** - * - * @author Sebastian Sdorra - */ + public abstract class KeyValueStoreTestBase extends AbstractTestBase { @@ -56,23 +50,13 @@ public abstract class KeyValueStoreTestBase extends AbstractTestBase protected String repoStoreName = "testRepoStore"; protected String storeName = "testStore"; - /** - * Method description - * - * - * @return - */ + protected abstract DataStore getDataStore(Class type , Repository repository); protected abstract DataStore getDataStore(Class type ); - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - */ - @Before + @Before public void before() { store = getDataStore(StoreObject.class); @@ -81,11 +65,7 @@ public abstract class KeyValueStoreTestBase extends AbstractTestBase repoStore.clear(); } - /** - * Method description - * - */ - @Test + @Test public void testClear() { testPutWithId(); @@ -97,11 +77,7 @@ public abstract class KeyValueStoreTestBase extends AbstractTestBase assertTrue(store.getAll().isEmpty()); } - /** - * Method description - * - */ - @Test + @Test public void testGet() { StoreObject other = store.get("1"); @@ -116,11 +92,7 @@ public abstract class KeyValueStoreTestBase extends AbstractTestBase assertEquals(obj, other); } - /** - * Method description - * - */ - @Test + @Test public void testGetAll() { StoreObject obj1 = new StoreObject("test-1"); @@ -144,11 +116,7 @@ public abstract class KeyValueStoreTestBase extends AbstractTestBase assertNull(map.get("3")); } - /** - * Method description - * - */ - @Test + @Test public void testGetAllFromEmpty() { Map map = store.getAll(); @@ -157,11 +125,7 @@ public abstract class KeyValueStoreTestBase extends AbstractTestBase assertTrue(map.isEmpty()); } - /** - * Method description - * - */ - @Test + @Test public void testGetFromEmpty() { StoreObject obj = store.get("test"); @@ -169,11 +133,7 @@ public abstract class KeyValueStoreTestBase extends AbstractTestBase assertNull(obj); } - /** - * Method description - * - */ - @Test + @Test public void testPutWithId() { StoreObject obj1 = new StoreObject("test-1"); @@ -188,11 +148,7 @@ public abstract class KeyValueStoreTestBase extends AbstractTestBase assertEquals(obj2, store.get("2")); } - /** - * Method description - * - */ - @Test + @Test public void testPutWithoutId() { StoreObject obj = new StoreObject("test-1"); @@ -203,11 +159,7 @@ public abstract class KeyValueStoreTestBase extends AbstractTestBase assertEquals(obj, store.get(id)); } - /** - * Method description - * - */ - @Test + @Test public void testRemove() { testPutWithId(); diff --git a/scm-test/src/main/java/sonia/scm/store/StoreObject.java b/scm-test/src/main/java/sonia/scm/store/StoreObject.java index 45bb3a4351..6c9e6fe92c 100644 --- a/scm-test/src/main/java/sonia/scm/store/StoreObject.java +++ b/scm-test/src/main/java/sonia/scm/store/StoreObject.java @@ -24,48 +24,26 @@ package sonia.scm.store; -//~--- JDK imports ------------------------------------------------------------ - import jakarta.xml.bind.annotation.XmlAccessType; import jakarta.xml.bind.annotation.XmlAccessorType; import jakarta.xml.bind.annotation.XmlRootElement; -/** - * - * @author Sebastian Sdorra - */ + @XmlRootElement @XmlAccessorType(XmlAccessType.FIELD) public class StoreObject { - /** - * Constructs ... - * - */ public StoreObject() {} - /** - * Constructs ... - * - * - * @param value - */ + public StoreObject(String value) { this.value = value; } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param obj - * - * @return - */ + @Override public boolean equals(Object obj) { @@ -91,12 +69,7 @@ public class StoreObject return true; } - /** - * Method description - * - * - * @return - */ + @Override public int hashCode() { @@ -109,14 +82,8 @@ public class StoreObject return hash; } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + public String getValue() { return value; @@ -124,6 +91,5 @@ public class StoreObject //~--- fields --------------------------------------------------------------- - /** Field description */ private String value; } diff --git a/scm-test/src/main/java/sonia/scm/store/StoreTestBase.java b/scm-test/src/main/java/sonia/scm/store/StoreTestBase.java index 94574e9137..5d18c7c7c1 100644 --- a/scm-test/src/main/java/sonia/scm/store/StoreTestBase.java +++ b/scm-test/src/main/java/sonia/scm/store/StoreTestBase.java @@ -24,7 +24,6 @@ package sonia.scm.store; -//~--- non-JDK imports -------------------------------------------------------- import org.junit.Test; import sonia.scm.AbstractTestBase; @@ -33,29 +32,15 @@ import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertNotNull; import static org.junit.Assert.assertNull; -//~--- JDK imports ------------------------------------------------------------ -/** - * - * @author Sebastian Sdorra - */ public abstract class StoreTestBase extends AbstractTestBase { - /** - * Method description - * - * - * @return - */ + protected abstract ConfigurationStoreFactory createStoreFactory(); - /** - * Method description - * - */ - @Test + @Test public void testGet() { ConfigurationStore store = createStoreFactory().withType(StoreObject.class).withName("test").build(); @@ -67,11 +52,7 @@ public abstract class StoreTestBase extends AbstractTestBase assertNull(object); } - /** - * Method description - * - */ - @Test + @Test public void testSet() { ConfigurationStore store = createStoreFactory().withType(StoreObject.class).withName("test").build(); diff --git a/scm-test/src/main/java/sonia/scm/user/UserManagerTestBase.java b/scm-test/src/main/java/sonia/scm/user/UserManagerTestBase.java index 29bbb18afa..73bf104280 100644 --- a/scm-test/src/main/java/sonia/scm/user/UserManagerTestBase.java +++ b/scm-test/src/main/java/sonia/scm/user/UserManagerTestBase.java @@ -24,7 +24,6 @@ package sonia.scm.user; -//~--- non-JDK imports -------------------------------------------------------- import org.apache.shiro.SecurityUtils; import org.apache.shiro.subject.Subject; @@ -45,8 +44,6 @@ import static org.junit.Assert.assertNotNull; import static org.junit.Assert.assertNull; import static org.junit.Assert.assertTrue; -//~--- JDK imports ------------------------------------------------------------ - public abstract class UserManagerTestBase extends ManagerTestBase { public static final int THREAD_COUNT = 10; @@ -252,13 +249,16 @@ public abstract class UserManagerTestBase extends ManagerTestBase { private static class MultiThreadTester implements Runnable { + private boolean finished = false; + + private Manager manager; public MultiThreadTester(Manager userManager) { this.manager = userManager; } - //~--- methods ------------------------------------------------------------ + @Override public void run() @@ -305,12 +305,5 @@ public abstract class UserManagerTestBase extends ManagerTestBase { assertNull(otherUser); } - //~--- fields ------------------------------------------------------------- - - /** Field description */ - private boolean finished = false; - - /** Field description */ - private Manager manager; } } diff --git a/scm-test/src/main/java/sonia/scm/user/UserTestData.java b/scm-test/src/main/java/sonia/scm/user/UserTestData.java index 48d92a2b5d..7d4c4ace51 100644 --- a/scm-test/src/main/java/sonia/scm/user/UserTestData.java +++ b/scm-test/src/main/java/sonia/scm/user/UserTestData.java @@ -24,82 +24,44 @@ package sonia.scm.user; -/** - * - * @author Sebastian Sdorra - */ + public final class UserTestData { - /** - * Constructs ... - * - */ private UserTestData() {} - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + public static User createAdams() { return new User("adams", "Douglas Adams", "douglas.adams@hitchhiker.com"); } - /** - * Method description - * - * - * @return - */ + public static User createDent() { return new User("dent", "Arthur Dent", "arthur.dent@hitchhiker.com"); } - /** - * Method description - * - * - * @return - */ + public static User createMarvin() { return new User("marvin", "Marvin", "paranoid.android@hitchhiker.com"); } - /** - * Method description - * - * - * @return - */ + public static User createPerfect() { return new User("perfect", "Ford Prefect", "ford.perfect@hitchhiker.com"); } - /** - * Method description - * - * - * @return - */ + public static User createSlarti() { return new User("slarti", "Slartibartfaß", "slartibartfass@hitchhiker.com"); } - /** - * Method description - * - * - * @return - */ + public static User createTrillian() { User user = new User("trillian", "Tricia McMillan", "tricia.mcmillan@hitchhiker.com"); @@ -108,12 +70,7 @@ public final class UserTestData return user; } - /** - * Method description - * - * - * @return - */ + public static User createZaphod() { User user = new User("zaphod", "Zaphod Beeblebrox", "zaphod.beeblebrox@hitchhiker.com"); diff --git a/scm-test/src/main/java/sonia/scm/util/MockUtil.java b/scm-test/src/main/java/sonia/scm/util/MockUtil.java index 35271a4e48..8394c1b2ed 100644 --- a/scm-test/src/main/java/sonia/scm/util/MockUtil.java +++ b/scm-test/src/main/java/sonia/scm/util/MockUtil.java @@ -24,7 +24,6 @@ package sonia.scm.util; -//~--- non-JDK imports -------------------------------------------------------- import jakarta.servlet.http.HttpServletRequest; @@ -53,33 +52,18 @@ import static org.mockito.Mockito.lenient; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; -/** - * - * @author Sebastian Sdorra - */ + public final class MockUtil { - /** Field description */ private static final User ADMIN = new User("scmadmin", "SCM Admin", "scmadmin@scm.org"); - //~--- constructors --------------------------------------------------------- - /** - * Constructs ... - * - */ private MockUtil() {} - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + @SuppressWarnings("unchecked") public static Subject createAdminSubject() { @@ -120,25 +104,12 @@ public final class MockUtil return subject; } - /** - * Method description - * - * - * @return - */ + public static Subject createUserSubject() { return createUserSubject(null); } - /** - * Method description - * - * - * - * @param securityManager - * @return - */ public static Subject createUserSubject( org.apache.shiro.mgt.SecurityManager securityManager) { @@ -162,14 +133,8 @@ public final class MockUtil return builder.principals(collection).authenticated(true).buildSubject(); } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + public static HttpServletRequest getHttpServletRequest() { HttpServletRequest request = mock(HttpServletRequest.class); @@ -179,25 +144,13 @@ public final class MockUtil return request; } - /** - * Method description - * - * - * @return - */ + public static HttpServletResponse getHttpServletResponse() { return mock(HttpServletResponse.class); } - /** - * Method description - * - * - * @param directory - * - * @return - */ + public static SCMContextProvider getSCMContextProvider(File directory) { SCMContextProvider provider = mock(SCMContextProvider.class); diff --git a/scm-ui/ui-components/src/__resources__/SearchHit.ts b/scm-ui/ui-components/src/__resources__/SearchHit.ts index 5b466cc718..9f2d84ba08 100644 --- a/scm-ui/ui-components/src/__resources__/SearchHit.ts +++ b/scm-ui/ui-components/src/__resources__/SearchHit.ts @@ -30,7 +30,7 @@ export const javaHit: Hit = { content: { highlighted: true, fragments: [ - "import org.slf4j.LoggerFactory;\n\nimport java.util.Date;\nimport java.util.HashMap;\nimport java.util.Map;\nimport java.util.concurrent.TimeUnit;\n\n/**\n * Jwt implementation of {@link <|[[--AccessTokenBuilder--]]|>}.\n * \n * @author Sebastian Sdorra\n * @since 2.0.0\n */\npublic final class <|[[--JwtAccessTokenBuilder--]]|> implements <|[[--AccessTokenBuilder--]]|> {\n\n /**\n * the logger for <|[[--JwtAccessTokenBuilder--]]|>\n */\n private static final Logger LOG = LoggerFactory.getLogger(<|[[--JwtAccessTokenBuilder.class--]]|>);\n \n private final KeyGenerator keyGenerator; \n private final SecureKeyResolver keyResolver; \n \n private String subject;\n private String issuer;\n", + "import org.slf4j.LoggerFactory;\n\nimport java.util.Date;\nimport java.util.HashMap;\nimport java.util.Map;\nimport java.util.concurrent.TimeUnit;\n\n/**\n * Jwt implementation of {@link <|[[--AccessTokenBuilder--]]|>}.\n * \n * @since 2.0.0\n */\npublic final class <|[[--JwtAccessTokenBuilder--]]|> implements <|[[--AccessTokenBuilder--]]|> {\n\n /**\n * the logger for <|[[--JwtAccessTokenBuilder--]]|>\n */\n private static final Logger LOG = LoggerFactory.getLogger(<|[[--JwtAccessTokenBuilder.class--]]|>);\n \n private final KeyGenerator keyGenerator; \n private final SecureKeyResolver keyResolver; \n \n private String subject;\n private String issuer;\n", " private final Map custom = Maps.newHashMap();\n \n <|[[--JwtAccessTokenBuilder--]]|>(KeyGenerator keyGenerator, SecureKeyResolver keyResolver) {\n this.keyGenerator = keyGenerator;\n this.keyResolver = keyResolver;\n }\n\n @Override\n public <|[[--JwtAccessTokenBuilder--]]|> subject(String subject) {\n", ' public <|[[--JwtAccessTokenBuilder--]]|> custom(String key, Object value) {\n Preconditions.checkArgument(!Strings.isNullOrEmpty(key), "null or empty value not allowed");\n Preconditions.checkArgument(value != null, "null or empty value not allowed");\n', ], diff --git a/scm-ui/ui-components/src/__snapshots__/storyshots.test.ts.snap b/scm-ui/ui-components/src/__snapshots__/storyshots.test.ts.snap index fbaef7432c..931db3c105 100644 --- a/scm-ui/ui-components/src/__snapshots__/storyshots.test.ts.snap +++ b/scm-ui/ui-components/src/__snapshots__/storyshots.test.ts.snap @@ -79301,7 +79301,6 @@ import java.util.concurrent.TimeUnit; }. * - * @author Sebastian Sdorra * @since 2.0.0 */ public final class @@ -79384,7 +79383,6 @@ import java.util.concurrent.TimeUnit; }. * - * @author Sebastian Sdorra * @since 2.0.0 */ public final class diff --git a/scm-webapp/src/main/java/sonia/scm/Undecorated.java b/scm-webapp/src/main/java/sonia/scm/Undecorated.java index a93ba6bd68..b71460b234 100644 --- a/scm-webapp/src/main/java/sonia/scm/Undecorated.java +++ b/scm-webapp/src/main/java/sonia/scm/Undecorated.java @@ -24,21 +24,15 @@ package sonia.scm; -//~--- non-JDK imports -------------------------------------------------------- import com.google.inject.BindingAnnotation; -//~--- JDK imports ------------------------------------------------------------ - import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; -/** - * - * @author Sebastian Sdorra - */ + @BindingAnnotation @Target({ ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER }) @Retention(RetentionPolicy.RUNTIME) diff --git a/scm-webapp/src/main/java/sonia/scm/api/rest/AuthorizationExceptionMapper.java b/scm-webapp/src/main/java/sonia/scm/api/rest/AuthorizationExceptionMapper.java index 9f3e842d22..1cf9562b20 100644 --- a/scm-webapp/src/main/java/sonia/scm/api/rest/AuthorizationExceptionMapper.java +++ b/scm-webapp/src/main/java/sonia/scm/api/rest/AuthorizationExceptionMapper.java @@ -24,7 +24,6 @@ package sonia.scm.api.rest; -//~--- non-JDK imports -------------------------------------------------------- import jakarta.ws.rs.core.MediaType; import jakarta.ws.rs.core.Response; @@ -35,11 +34,8 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; import sonia.scm.security.Authentications; -//~--- JDK imports ------------------------------------------------------------ - /** * - * @author Sebastian Sdorra * @since 2.0.0 */ @Provider diff --git a/scm-webapp/src/main/java/sonia/scm/api/rest/DisabledAccountExceptionMapper.java b/scm-webapp/src/main/java/sonia/scm/api/rest/DisabledAccountExceptionMapper.java index 02a923d730..650af5ea28 100644 --- a/scm-webapp/src/main/java/sonia/scm/api/rest/DisabledAccountExceptionMapper.java +++ b/scm-webapp/src/main/java/sonia/scm/api/rest/DisabledAccountExceptionMapper.java @@ -24,25 +24,17 @@ package sonia.scm.api.rest; -//~--- non-JDK imports -------------------------------------------------------- import jakarta.ws.rs.core.Response; import jakarta.ws.rs.ext.Provider; import org.apache.shiro.authc.DisabledAccountException; -/** - * - * @author Sebastian Sdorra - */ + @Provider public class DisabledAccountExceptionMapper extends StatusExceptionMapper { - /** - * Constructs ... - * - */ public DisabledAccountExceptionMapper() { super(DisabledAccountException.class, Response.Status.FORBIDDEN); diff --git a/scm-webapp/src/main/java/sonia/scm/api/rest/ExcessiveAttemptsExceptionMapper.java b/scm-webapp/src/main/java/sonia/scm/api/rest/ExcessiveAttemptsExceptionMapper.java index 7cb8544509..16cf8581cc 100644 --- a/scm-webapp/src/main/java/sonia/scm/api/rest/ExcessiveAttemptsExceptionMapper.java +++ b/scm-webapp/src/main/java/sonia/scm/api/rest/ExcessiveAttemptsExceptionMapper.java @@ -24,25 +24,17 @@ package sonia.scm.api.rest; -//~--- non-JDK imports -------------------------------------------------------- import jakarta.ws.rs.core.Response; import jakarta.ws.rs.ext.Provider; import org.apache.shiro.authc.ExcessiveAttemptsException; -/** - * - * @author Sebastian Sdorra - */ + @Provider public class ExcessiveAttemptsExceptionMapper extends StatusExceptionMapper { - /** - * Constructs ... - * - */ public ExcessiveAttemptsExceptionMapper() { super(ExcessiveAttemptsException.class, Response.Status.FORBIDDEN); diff --git a/scm-webapp/src/main/java/sonia/scm/api/rest/JSONContextResolver.java b/scm-webapp/src/main/java/sonia/scm/api/rest/JSONContextResolver.java index 330dc11251..2db5eead09 100644 --- a/scm-webapp/src/main/java/sonia/scm/api/rest/JSONContextResolver.java +++ b/scm-webapp/src/main/java/sonia/scm/api/rest/JSONContextResolver.java @@ -33,7 +33,6 @@ import jakarta.ws.rs.ext.Provider; /** * Configures the way objects are marshaled to json. * - * @author Sebastian Sdorra * @since 2.0.0 */ @Provider diff --git a/scm-webapp/src/main/java/sonia/scm/api/rest/RestActionResult.java b/scm-webapp/src/main/java/sonia/scm/api/rest/RestActionResult.java index 824b9c7ddb..5cbf00ce78 100644 --- a/scm-webapp/src/main/java/sonia/scm/api/rest/RestActionResult.java +++ b/scm-webapp/src/main/java/sonia/scm/api/rest/RestActionResult.java @@ -24,63 +24,34 @@ package sonia.scm.api.rest; -//~--- JDK imports ------------------------------------------------------------ - import jakarta.xml.bind.annotation.XmlRootElement; -/** - * - * @author Sebastian Sdorra - */ + @XmlRootElement(name = "result") public class RestActionResult { + private boolean success = false; - /** - * Constructs ... - * - */ public RestActionResult() {} - /** - * Constructs ... - * - * - * @param success - */ + public RestActionResult(boolean success) { this.success = success; } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + public boolean isSuccess() { return success; } - //~--- set methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param success - */ + public void setSuccess(boolean success) { this.success = success; } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private boolean success = false; } diff --git a/scm-webapp/src/main/java/sonia/scm/api/rest/RestActionUploadResult.java b/scm-webapp/src/main/java/sonia/scm/api/rest/RestActionUploadResult.java index c3a8f23719..0d28226642 100644 --- a/scm-webapp/src/main/java/sonia/scm/api/rest/RestActionUploadResult.java +++ b/scm-webapp/src/main/java/sonia/scm/api/rest/RestActionUploadResult.java @@ -24,33 +24,19 @@ package sonia.scm.api.rest; -//~--- JDK imports ------------------------------------------------------------ - import jakarta.xml.bind.annotation.XmlRootElement; -/** - * - * @author Sebastian Sdorra - */ + @XmlRootElement(name = "result") public class RestActionUploadResult extends RestActionResult { - /** - * Constructs ... - * - */ public RestActionUploadResult() { this(true); } - /** - * Constructs ... - * - * - * @param success - */ + public RestActionUploadResult(boolean success) { super(success); diff --git a/scm-webapp/src/main/java/sonia/scm/api/rest/RestActionUploadResultMessageWriter.java b/scm-webapp/src/main/java/sonia/scm/api/rest/RestActionUploadResultMessageWriter.java index 7eaa5e5857..9eae596c01 100644 --- a/scm-webapp/src/main/java/sonia/scm/api/rest/RestActionUploadResultMessageWriter.java +++ b/scm-webapp/src/main/java/sonia/scm/api/rest/RestActionUploadResultMessageWriter.java @@ -24,7 +24,6 @@ package sonia.scm.api.rest; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Charsets; import jakarta.ws.rs.WebApplicationException; @@ -43,28 +42,11 @@ import java.lang.reflect.Type; * mimetype for uploads. * * TODO find a better way - * @author Sebastian Sdorra */ @Provider public class RestActionUploadResultMessageWriter implements MessageBodyWriter { - - /** - * Method description - * - * - * @param result - * @param type - * @param genericType - * @param annotations - * @param mediaType - * @param httpHeaders - * @param entityStream - * - * @throws IOException - * @throws WebApplicationException - */ @Override public void writeTo(RestActionResult result, Class type, Type genericType, Annotation[] annotations, MediaType mediaType, @@ -77,20 +59,6 @@ public class RestActionUploadResultMessageWriter entityStream.write(v.getBytes(Charsets.UTF_8)); } - //~--- get methods ---------------------------------------------------------- - - /** - * Method description - * - * - * @param result - * @param type - * @param genericType - * @param annotations - * @param mediaType - * - * @return - */ @Override public long getSize(RestActionResult result, Class type, Type genericType, Annotation[] annotations, MediaType mediaType) @@ -98,17 +66,6 @@ public class RestActionUploadResultMessageWriter return -1; } - /** - * Method description - * - * - * @param type - * @param genericType - * @param annotations - * @param mediaType - * - * @return - */ @Override public boolean isWriteable(Class type, Type genericType, Annotation[] annotations, MediaType mediaType) diff --git a/scm-webapp/src/main/java/sonia/scm/api/rest/RestExceptionResult.java b/scm-webapp/src/main/java/sonia/scm/api/rest/RestExceptionResult.java index 754afdadc4..ba4c9dd8c7 100644 --- a/scm-webapp/src/main/java/sonia/scm/api/rest/RestExceptionResult.java +++ b/scm-webapp/src/main/java/sonia/scm/api/rest/RestExceptionResult.java @@ -24,7 +24,6 @@ package sonia.scm.api.rest; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.MoreObjects; import com.google.common.base.Objects; @@ -33,69 +32,38 @@ import jakarta.xml.bind.annotation.XmlAccessType; import jakarta.xml.bind.annotation.XmlAccessorType; import jakarta.xml.bind.annotation.XmlRootElement; -//~--- JDK imports ------------------------------------------------------------ -/** - * - * @author Sebastian Sdorra - */ @XmlAccessorType(XmlAccessType.FIELD) @XmlRootElement(name = "exception") public class RestExceptionResult { + private String message; + + private String stacktrace; - /** - * Constructs ... - * - */ public RestExceptionResult() {} - /** - * Constructs ... - * - * - * @param throwable - */ + public RestExceptionResult(Throwable throwable) { this(throwable.getMessage(), throwable); } - /** - * Constructs ... - * - * - * @param message - * @param stacktrace - */ + public RestExceptionResult(String message, String stacktrace) { this.message = message; this.stacktrace = stacktrace; } - /** - * Constructs ... - * - * - * @param message - * @param throwable - */ + public RestExceptionResult(String message, Throwable throwable) { this(message, Throwables.getStackTraceAsString(throwable)); } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param obj - * - * @return - */ + @Override public boolean equals(Object obj) { @@ -115,24 +83,14 @@ public class RestExceptionResult && Objects.equal(stacktrace, other.stacktrace); } - /** - * Method description - * - * - * @return - */ + @Override public int hashCode() { return Objects.hashCode(message, stacktrace); } - /** - * Method description - * - * - * @return - */ + @Override public String toString() { @@ -144,59 +102,30 @@ public class RestExceptionResult //J+ } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + public String getMessage() { return message; } - /** - * Method description - * - * - * @return - */ + public String getStacktrace() { return stacktrace; } - //~--- set methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param message - */ + public void setMessage(String message) { this.message = message; } - /** - * Method description - * - * - * @param stacktrace - */ + public void setStacktrace(String stacktrace) { this.stacktrace = stacktrace; } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private String message; - - /** Field description */ - private String stacktrace; } diff --git a/scm-webapp/src/main/java/sonia/scm/api/rest/ScmSecurityExceptionMapper.java b/scm-webapp/src/main/java/sonia/scm/api/rest/ScmSecurityExceptionMapper.java index c0bf8b5e91..f8792310cb 100644 --- a/scm-webapp/src/main/java/sonia/scm/api/rest/ScmSecurityExceptionMapper.java +++ b/scm-webapp/src/main/java/sonia/scm/api/rest/ScmSecurityExceptionMapper.java @@ -24,25 +24,17 @@ package sonia.scm.api.rest; -//~--- non-JDK imports -------------------------------------------------------- import jakarta.ws.rs.core.Response; import jakarta.ws.rs.ext.Provider; import sonia.scm.security.ScmSecurityException; -/** - * - * @author Sebastian Sdorra - */ + @Provider public class ScmSecurityExceptionMapper extends StatusExceptionMapper { - /** - * Constructs ... - * - */ public ScmSecurityExceptionMapper() { super(ScmSecurityException.class, Response.Status.FORBIDDEN); diff --git a/scm-webapp/src/main/java/sonia/scm/api/rest/StatusExceptionMapper.java b/scm-webapp/src/main/java/sonia/scm/api/rest/StatusExceptionMapper.java index 1d789892e1..f5e68e275c 100644 --- a/scm-webapp/src/main/java/sonia/scm/api/rest/StatusExceptionMapper.java +++ b/scm-webapp/src/main/java/sonia/scm/api/rest/StatusExceptionMapper.java @@ -24,7 +24,6 @@ package sonia.scm.api.rest; -//~--- non-JDK imports -------------------------------------------------------- import jakarta.ws.rs.core.MediaType; import jakarta.ws.rs.core.Response; @@ -32,20 +31,11 @@ import jakarta.ws.rs.ext.ExceptionMapper; import org.slf4j.Logger; import org.slf4j.LoggerFactory; -//~--- JDK imports ------------------------------------------------------------ - -/** - * - * @author Sebastian Sdorra - * @param - */ public class StatusExceptionMapper implements ExceptionMapper { - /** - * the logger for StatusExceptionMapper - */ + private static final Logger logger = LoggerFactory.getLogger(StatusExceptionMapper.class); diff --git a/scm-webapp/src/main/java/sonia/scm/api/rest/TemplateEngineViewable.java b/scm-webapp/src/main/java/sonia/scm/api/rest/TemplateEngineViewable.java index 94fb58e10d..84d763c8eb 100644 --- a/scm-webapp/src/main/java/sonia/scm/api/rest/TemplateEngineViewable.java +++ b/scm-webapp/src/main/java/sonia/scm/api/rest/TemplateEngineViewable.java @@ -24,7 +24,6 @@ package sonia.scm.api.rest; -//~--- non-JDK imports -------------------------------------------------------- import com.google.inject.Inject; import jakarta.ws.rs.WebApplicationException; @@ -43,10 +42,7 @@ import java.io.PrintWriter; import java.lang.annotation.Annotation; import java.lang.reflect.Type; -/** - * - * @author Sebastian Sdorra - */ + @Provider public class TemplateEngineViewable implements MessageBodyWriter { diff --git a/scm-webapp/src/main/java/sonia/scm/api/v2/resources/AvailablePluginResource.java b/scm-webapp/src/main/java/sonia/scm/api/v2/resources/AvailablePluginResource.java index 068d2c07d7..5f42932ded 100644 --- a/scm-webapp/src/main/java/sonia/scm/api/v2/resources/AvailablePluginResource.java +++ b/scm-webapp/src/main/java/sonia/scm/api/v2/resources/AvailablePluginResource.java @@ -64,8 +64,6 @@ public class AvailablePluginResource { /** * Returns a collection of available plugins. - * - * @return collection of available plugins. */ @GET @Path("") @@ -107,8 +105,6 @@ public class AvailablePluginResource { /** * Returns available plugin. - * - * @return available plugin. */ @GET @Path("/{name}") diff --git a/scm-webapp/src/main/java/sonia/scm/api/v2/resources/InstalledPluginResource.java b/scm-webapp/src/main/java/sonia/scm/api/v2/resources/InstalledPluginResource.java index c798727409..804353e885 100644 --- a/scm-webapp/src/main/java/sonia/scm/api/v2/resources/InstalledPluginResource.java +++ b/scm-webapp/src/main/java/sonia/scm/api/v2/resources/InstalledPluginResource.java @@ -64,8 +64,6 @@ public class InstalledPluginResource { /** * Returns a collection of installed plugins. - * - * @return collection of installed plugins. */ @GET @Path("") @@ -129,7 +127,6 @@ public class InstalledPluginResource { * Returns the installed plugin with the given id. * * @param name name of plugin - * @return installed plugin with specified id */ @GET @Path("/{name}") diff --git a/scm-webapp/src/main/java/sonia/scm/api/v2/resources/NamespaceStrategyResource.java b/scm-webapp/src/main/java/sonia/scm/api/v2/resources/NamespaceStrategyResource.java index 77bf1594f3..3aeb1c3ba1 100644 --- a/scm-webapp/src/main/java/sonia/scm/api/v2/resources/NamespaceStrategyResource.java +++ b/scm-webapp/src/main/java/sonia/scm/api/v2/resources/NamespaceStrategyResource.java @@ -62,7 +62,6 @@ public class NamespaceStrategyResource { * * @param uriInfo uri info * - * @return available and current namespace strategies */ @GET @Path("") diff --git a/scm-webapp/src/main/java/sonia/scm/api/v2/resources/RepositoryPermissionRootResource.java b/scm-webapp/src/main/java/sonia/scm/api/v2/resources/RepositoryPermissionRootResource.java index 017f6cc3f5..4684043bd1 100644 --- a/scm-webapp/src/main/java/sonia/scm/api/v2/resources/RepositoryPermissionRootResource.java +++ b/scm-webapp/src/main/java/sonia/scm/api/v2/resources/RepositoryPermissionRootResource.java @@ -368,13 +368,6 @@ public class RepositoryPermissionRootResource { .orElseThrow(() -> notFound(entity(namespaceAndName))); } - /** - * check if the permission already exists in the repository - * - * @param permission the searched permission - * @param repository the repository to be inspected - * @throws AlreadyExistsException if the permission already exists in the repository - */ private void checkPermissionAlreadyExists(RepositoryPermissionDto permission, Repository repository) { if (isPermissionExist(permission, repository)) { throw alreadyExists(entity("Permission", permission.getName()).in(repository)); diff --git a/scm-webapp/src/main/java/sonia/scm/api/v2/resources/UIPluginResource.java b/scm-webapp/src/main/java/sonia/scm/api/v2/resources/UIPluginResource.java index a73347d743..08551d9f2f 100644 --- a/scm-webapp/src/main/java/sonia/scm/api/v2/resources/UIPluginResource.java +++ b/scm-webapp/src/main/java/sonia/scm/api/v2/resources/UIPluginResource.java @@ -59,8 +59,6 @@ public class UIPluginResource { /** * Returns a collection of installed plugins and their ui bundles. - * - * @return collection of installed plugins. */ @GET @Path("") @@ -95,7 +93,6 @@ public class UIPluginResource { * * @param id id of plugin * - * @return installed plugin with specified id */ @GET @Path("{id}") diff --git a/scm-webapp/src/main/java/sonia/scm/cache/CacheConfigurationLoader.java b/scm-webapp/src/main/java/sonia/scm/cache/CacheConfigurationLoader.java index e6e59af8ec..3a7f04b756 100644 --- a/scm-webapp/src/main/java/sonia/scm/cache/CacheConfigurationLoader.java +++ b/scm-webapp/src/main/java/sonia/scm/cache/CacheConfigurationLoader.java @@ -24,8 +24,6 @@ package sonia.scm.cache; -//~--- JDK imports ------------------------------------------------------------ - import com.google.inject.ImplementedBy; import java.io.File; @@ -34,9 +32,7 @@ import java.net.URL; import java.util.Iterator; -/** - * @author Sebastian Sdorra - */ + @ImplementedBy(DefaultCacheConfigurationLoader.class) public interface CacheConfigurationLoader { diff --git a/scm-webapp/src/main/java/sonia/scm/cache/CacheException.java b/scm-webapp/src/main/java/sonia/scm/cache/CacheException.java index 45b292d659..26cdc1aa1b 100644 --- a/scm-webapp/src/main/java/sonia/scm/cache/CacheException.java +++ b/scm-webapp/src/main/java/sonia/scm/cache/CacheException.java @@ -24,53 +24,28 @@ package sonia.scm.cache; -/** - * - * @author Sebastian Sdorra - */ + public class CacheException extends RuntimeException { - /** Field description */ private static final long serialVersionUID = -1108209749696572319L; - //~--- constructors --------------------------------------------------------- - /** - * Constructs ... - * - */ public CacheException() {} - /** - * Constructs ... - * - * - * @param message - */ + public CacheException(String message) { super(message); } - /** - * Constructs ... - * - * - * @param cause - */ + public CacheException(Throwable cause) { super(cause); } - /** - * Constructs ... - * - * - * @param message - * @param cause - */ + public CacheException(String message, Throwable cause) { super(message, cause); diff --git a/scm-webapp/src/main/java/sonia/scm/cache/CopyStrategy.java b/scm-webapp/src/main/java/sonia/scm/cache/CopyStrategy.java index 51b2a822a2..420feed038 100644 --- a/scm-webapp/src/main/java/sonia/scm/cache/CopyStrategy.java +++ b/scm-webapp/src/main/java/sonia/scm/cache/CopyStrategy.java @@ -24,20 +24,14 @@ package sonia.scm.cache; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.io.DeepCopy; -//~--- JDK imports ------------------------------------------------------------ - import java.io.IOException; import java.util.Locale; -/** - * - * @author Sebastian Sdorra - */ + public enum CopyStrategy { @@ -61,30 +55,14 @@ public enum CopyStrategy this.copyOnWrite = copyOnWrite; } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param value - * - * @return - */ + public static CopyStrategy fromString(String value) { return valueOf(value.toUpperCase(Locale.ENGLISH).replace("-", "")); } - /** - * Method description - * - * - * @param object - * @param - * - * @return - */ + public T copyOnRead(T object) { return copyOnRead @@ -92,15 +70,7 @@ public enum CopyStrategy : object; } - /** - * Method description - * - * - * @param object - * @param - * - * @return - */ + public T copyOnWrite(T object) { return copyOnWrite @@ -108,30 +78,15 @@ public enum CopyStrategy : object; } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + public String getConfigName() { return configName; } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param object - * @param - * - * @return - */ + private T deepCopy(T object) { T copy = null; @@ -151,12 +106,9 @@ public enum CopyStrategy //~--- fields --------------------------------------------------------------- - /** Field description */ private String configName; - /** Field description */ private boolean copyOnRead; - /** Field description */ private boolean copyOnWrite; } diff --git a/scm-webapp/src/main/java/sonia/scm/cache/DefaultCacheConfigurationLoader.java b/scm-webapp/src/main/java/sonia/scm/cache/DefaultCacheConfigurationLoader.java index 41133af3d1..d98e7d29f6 100644 --- a/scm-webapp/src/main/java/sonia/scm/cache/DefaultCacheConfigurationLoader.java +++ b/scm-webapp/src/main/java/sonia/scm/cache/DefaultCacheConfigurationLoader.java @@ -24,7 +24,6 @@ package sonia.scm.cache; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.collect.Iterators; import jakarta.inject.Inject; diff --git a/scm-webapp/src/main/java/sonia/scm/cache/GuavaCacheConfigurationReader.java b/scm-webapp/src/main/java/sonia/scm/cache/GuavaCacheConfigurationReader.java index edf148c6d5..6a18f9194f 100644 --- a/scm-webapp/src/main/java/sonia/scm/cache/GuavaCacheConfigurationReader.java +++ b/scm-webapp/src/main/java/sonia/scm/cache/GuavaCacheConfigurationReader.java @@ -24,7 +24,6 @@ package sonia.scm.cache; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.collect.ImmutableList; import com.google.common.collect.Maps; @@ -42,24 +41,17 @@ import java.util.Iterator; import java.util.List; import java.util.Map; -/** - * @author Sebastian Sdorra - */ + public class GuavaCacheConfigurationReader { - /** - * the logger for CacheConfigurationReader - */ + private static final Logger logger = LoggerFactory.getLogger(GuavaCacheConfigurationReader.class); - //~--- constructors --------------------------------------------------------- + private JAXBContext context; + + private CacheConfigurationLoader loader; - /** - * Constructs ... - * - * @param loader - */ @Inject public GuavaCacheConfigurationReader(CacheConfigurationLoader loader) { this.loader = loader; @@ -71,7 +63,6 @@ public class GuavaCacheConfigurationReader { } } - //~--- methods -------------------------------------------------------------- public GuavaCacheManagerConfiguration read() { URL defaultConfigUrl = loader.getDefaultResource(); @@ -127,13 +118,7 @@ public class GuavaCacheConfigurationReader { return map; } - /** - * Method description - * - * @param config - * @param other - * @return - */ + private GuavaCacheManagerConfiguration merge( GuavaCacheManagerConfiguration config, GuavaCacheManagerConfiguration other) { GuavaCacheConfiguration defaultCache = config.getDefaultCache(); @@ -154,13 +139,7 @@ public class GuavaCacheConfigurationReader { ImmutableList.copyOf(namedCaches.values())); } - /** - * Method description - * - * @param url - * @param fail - * @return - */ + private GuavaCacheManagerConfiguration readConfiguration(URL url, boolean fail) { logger.debug("read cache configuration from {}", url); @@ -180,15 +159,4 @@ public class GuavaCacheConfigurationReader { return config; } - //~--- fields --------------------------------------------------------------- - - /** - * Field description - */ - private JAXBContext context; - - /** - * Field description - */ - private CacheConfigurationLoader loader; } diff --git a/scm-webapp/src/main/java/sonia/scm/cache/GuavaCacheManager.java b/scm-webapp/src/main/java/sonia/scm/cache/GuavaCacheManager.java index 06a3c03f45..4904e2ba42 100644 --- a/scm-webapp/src/main/java/sonia/scm/cache/GuavaCacheManager.java +++ b/scm-webapp/src/main/java/sonia/scm/cache/GuavaCacheManager.java @@ -36,7 +36,6 @@ import java.util.concurrent.ConcurrentHashMap; /** * Guava based implementation of {@link CacheManager} and {@link org.apache.shiro.cache.CacheManager}. * - * @author Sebastian Sdorra */ @Singleton public class GuavaCacheManager implements CacheManager, org.apache.shiro.cache.CacheManager { diff --git a/scm-webapp/src/main/java/sonia/scm/cache/GuavaCacheManagerConfiguration.java b/scm-webapp/src/main/java/sonia/scm/cache/GuavaCacheManagerConfiguration.java index 12e7397f4d..4f53ae07dd 100644 --- a/scm-webapp/src/main/java/sonia/scm/cache/GuavaCacheManagerConfiguration.java +++ b/scm-webapp/src/main/java/sonia/scm/cache/GuavaCacheManagerConfiguration.java @@ -24,8 +24,6 @@ package sonia.scm.cache; -//~--- JDK imports ------------------------------------------------------------ - import jakarta.xml.bind.annotation.XmlAccessType; import jakarta.xml.bind.annotation.XmlAccessorType; import jakarta.xml.bind.annotation.XmlElement; @@ -34,28 +32,20 @@ import jakarta.xml.bind.annotation.XmlRootElement; import java.util.Collections; import java.util.List; -/** - * - * @author Sebastian Sdorra - */ + @XmlRootElement(name = "caches") @XmlAccessorType(XmlAccessType.FIELD) public class GuavaCacheManagerConfiguration { + @XmlElement(name = "cache") + private List caches; + + @XmlElement(name = "defaultCache") + private GuavaCacheConfiguration defaultCache; - /** - * Constructs ... - * - */ public GuavaCacheManagerConfiguration() {} - /** - * Constructs ... - * - * - * @param defaultCache - * @param caches - */ + public GuavaCacheManagerConfiguration(GuavaCacheConfiguration defaultCache, List caches) { @@ -63,14 +53,8 @@ public class GuavaCacheManagerConfiguration this.caches = caches; } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + @SuppressWarnings("unchecked") public List getCaches() { @@ -82,24 +66,10 @@ public class GuavaCacheManagerConfiguration return caches; } - /** - * Method description - * - * - * @return - */ + public GuavaCacheConfiguration getDefaultCache() { return defaultCache; } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - @XmlElement(name = "cache") - private List caches; - - /** Field description */ - @XmlElement(name = "defaultCache") - private GuavaCacheConfiguration defaultCache; } diff --git a/scm-webapp/src/main/java/sonia/scm/cache/GuavaNamedCacheConfiguration.java b/scm-webapp/src/main/java/sonia/scm/cache/GuavaNamedCacheConfiguration.java index 5d3a174e0e..17c1cb09f4 100644 --- a/scm-webapp/src/main/java/sonia/scm/cache/GuavaNamedCacheConfiguration.java +++ b/scm-webapp/src/main/java/sonia/scm/cache/GuavaNamedCacheConfiguration.java @@ -24,8 +24,6 @@ package sonia.scm.cache; -//~--- JDK imports ------------------------------------------------------------ - import jakarta.xml.bind.annotation.XmlAccessType; import jakarta.xml.bind.annotation.XmlAccessorType; import jakarta.xml.bind.annotation.XmlAttribute; diff --git a/scm-webapp/src/main/java/sonia/scm/cache/XmlCopyStrategyAdapter.java b/scm-webapp/src/main/java/sonia/scm/cache/XmlCopyStrategyAdapter.java index 1b11e4a272..83ebd96b82 100644 --- a/scm-webapp/src/main/java/sonia/scm/cache/XmlCopyStrategyAdapter.java +++ b/scm-webapp/src/main/java/sonia/scm/cache/XmlCopyStrategyAdapter.java @@ -24,43 +24,20 @@ package sonia.scm.cache; -//~--- JDK imports ------------------------------------------------------------ - import jakarta.xml.bind.annotation.adapters.XmlAdapter; -/** - * - * @author Sebastian Sdorra - */ + public class XmlCopyStrategyAdapter extends XmlAdapter { - /** - * Method description - * - * - * @param v - * - * @return - * - * @throws Exception - */ + @Override public String marshal(CopyStrategy v) throws Exception { return v.getConfigName(); } - /** - * Method description - * - * - * @param v - * - * @return - * - * @throws Exception - */ + @Override public CopyStrategy unmarshal(String v) throws Exception { diff --git a/scm-webapp/src/main/java/sonia/scm/config/ScmLogFilePropertyDefiner.java b/scm-webapp/src/main/java/sonia/scm/config/ScmLogFilePropertyDefiner.java index 14775d1322..43746e435b 100644 --- a/scm-webapp/src/main/java/sonia/scm/config/ScmLogFilePropertyDefiner.java +++ b/scm-webapp/src/main/java/sonia/scm/config/ScmLogFilePropertyDefiner.java @@ -24,7 +24,6 @@ package sonia.scm.config; -//~--- non-JDK imports -------------------------------------------------------- import ch.qos.logback.core.PropertyDefinerBase; import com.google.common.annotations.VisibleForTesting; @@ -34,15 +33,12 @@ import sonia.scm.SCMContext; import sonia.scm.SCMContextProvider; import sonia.scm.util.SystemUtil; -//~--- JDK imports ------------------------------------------------------------ - import java.io.File; import java.util.Properties; /** * Resolve directory path for SCM-Manager logs. * - * @author Sebastian Sdorra */ public class ScmLogFilePropertyDefiner extends PropertyDefinerBase { diff --git a/scm-webapp/src/main/java/sonia/scm/debug/DebugHook.java b/scm-webapp/src/main/java/sonia/scm/debug/DebugHook.java index 8d279c5bde..e1916167e6 100644 --- a/scm-webapp/src/main/java/sonia/scm/debug/DebugHook.java +++ b/scm-webapp/src/main/java/sonia/scm/debug/DebugHook.java @@ -38,23 +38,15 @@ import sonia.scm.repository.PostReceiveRepositoryHookEvent; /** * {@link PostReceiveRepositoryHookEvent} which stores receives data and passes it to the {@link DebugService}. * - * @author Sebastian Sdorra */ @EagerSingleton public final class DebugHook { - /** - * the logger for DebugHook - */ + private static final Logger LOG = LoggerFactory.getLogger(DebugHook.class); private final DebugService debugService; - /** - * Constructs a new instance. - * - * @param debugService debug service - */ @Inject public DebugHook(DebugService debugService) { diff --git a/scm-webapp/src/main/java/sonia/scm/debug/DebugHookData.java b/scm-webapp/src/main/java/sonia/scm/debug/DebugHookData.java index f34255c5a6..5b829af868 100644 --- a/scm-webapp/src/main/java/sonia/scm/debug/DebugHookData.java +++ b/scm-webapp/src/main/java/sonia/scm/debug/DebugHookData.java @@ -34,7 +34,6 @@ import java.util.Date; /** * Received data from repository hook event. * - * @author Sebastian Sdorra */ @XmlRootElement(name = "hook") @XmlAccessorType(XmlAccessType.FIELD) @@ -44,7 +43,7 @@ public class DebugHookData private Collection changesets; /** - * Constructs a new instance. This constructor should only be used by JAXB. + * This constructor should only be used by JAXB. */ public DebugHookData() { @@ -63,8 +62,6 @@ public class DebugHookData /** * Returns the receiving date. - * - * @return receiving date */ public Date getDate() { @@ -73,8 +70,6 @@ public class DebugHookData /** * Return collection of changeset ids. - * - * @return collection of changeset ids */ public Collection getChangesets() { diff --git a/scm-webapp/src/main/java/sonia/scm/debug/DebugModule.java b/scm-webapp/src/main/java/sonia/scm/debug/DebugModule.java index a8d0b38204..f792685a97 100644 --- a/scm-webapp/src/main/java/sonia/scm/debug/DebugModule.java +++ b/scm-webapp/src/main/java/sonia/scm/debug/DebugModule.java @@ -30,7 +30,6 @@ import com.google.inject.AbstractModule; * DebugModule binds all required classes around the {@link DebugService}. The module will only be activated, if the * application was started in development stage. * - * @author Sebastian Sdorra */ public final class DebugModule extends AbstractModule { diff --git a/scm-webapp/src/main/java/sonia/scm/debug/DebugResource.java b/scm-webapp/src/main/java/sonia/scm/debug/DebugResource.java index 43307ebda8..e82677018b 100644 --- a/scm-webapp/src/main/java/sonia/scm/debug/DebugResource.java +++ b/scm-webapp/src/main/java/sonia/scm/debug/DebugResource.java @@ -37,18 +37,12 @@ import java.util.Collection; /** * Rest api resource for the {@link DebugService}. * - * @author Sebastian Sdorra */ @Path("debug/{namespace}/{name}/post-receive") public final class DebugResource { private final DebugService debugService; - /** - * Constructs a new instance. - * - * @param debugService debug service - */ @Inject public DebugResource(DebugService debugService) { diff --git a/scm-webapp/src/main/java/sonia/scm/debug/DebugService.java b/scm-webapp/src/main/java/sonia/scm/debug/DebugService.java index 37b372865f..95ae45e337 100644 --- a/scm-webapp/src/main/java/sonia/scm/debug/DebugService.java +++ b/scm-webapp/src/main/java/sonia/scm/debug/DebugService.java @@ -38,7 +38,6 @@ import java.util.Collection; /** * The DebugService stores and returns received data from repository hook events. * - * @author Sebastian Sdorra */ @Singleton public final class DebugService diff --git a/scm-webapp/src/main/java/sonia/scm/event/LegmanScmEventBus.java b/scm-webapp/src/main/java/sonia/scm/event/LegmanScmEventBus.java index efc5b7b4a2..b84dd4db37 100644 --- a/scm-webapp/src/main/java/sonia/scm/event/LegmanScmEventBus.java +++ b/scm-webapp/src/main/java/sonia/scm/event/LegmanScmEventBus.java @@ -24,7 +24,6 @@ package sonia.scm.event; -//~--- non-JDK imports -------------------------------------------------------- import com.github.legman.EventBus; import com.github.legman.Subscribe; @@ -39,18 +38,13 @@ import sonia.scm.metrics.MeterRegistryProvider; import java.util.concurrent.Executor; import java.util.concurrent.atomic.AtomicLong; -/** - * - * @author Sebastian Sdorra - */ + public class LegmanScmEventBus extends ScmEventBus { private static final AtomicLong INSTANCE_COUNTER = new AtomicLong(); private static final String FORMAT_NAME = "ScmEventBus-%s"; - /** - * the logger for LegmanScmEventBus - */ + private static final Logger logger = LoggerFactory.getLogger(LegmanScmEventBus.class); private String name; diff --git a/scm-webapp/src/main/java/sonia/scm/filter/BaseUrlFilter.java b/scm-webapp/src/main/java/sonia/scm/filter/BaseUrlFilter.java index ff0495d135..df3f25dc15 100644 --- a/scm-webapp/src/main/java/sonia/scm/filter/BaseUrlFilter.java +++ b/scm-webapp/src/main/java/sonia/scm/filter/BaseUrlFilter.java @@ -38,15 +38,11 @@ import sonia.scm.web.filter.HttpFilter; import java.io.IOException; -/** - * - * @author Sebastian Sdorra - */ + @Priority(Filters.PRIORITY_BASEURL) @WebElement(Filters.PATTERN_ALL) public class BaseUrlFilter extends HttpFilter { - /** scm configuration */ private final ScmConfiguration configuration; @Inject diff --git a/scm-webapp/src/main/java/sonia/scm/filter/MDCFilter.java b/scm-webapp/src/main/java/sonia/scm/filter/MDCFilter.java index c818376f61..d4900bae01 100644 --- a/scm-webapp/src/main/java/sonia/scm/filter/MDCFilter.java +++ b/scm-webapp/src/main/java/sonia/scm/filter/MDCFilter.java @@ -24,7 +24,6 @@ package sonia.scm.filter; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.annotations.VisibleForTesting; import jakarta.servlet.FilterChain; @@ -42,10 +41,7 @@ import sonia.scm.web.filter.HttpFilter; import java.io.IOException; -/** - * - * @author Sebastian Sdorra - */ + @Priority(Filters.PRIORITY_POST_AUTHENTICATION) @WebElement(Filters.PATTERN_ALL) public class MDCFilter extends HttpFilter @@ -67,19 +63,8 @@ public class MDCFilter extends HttpFilter @VisibleForTesting static final String MDC_USERNAME = "username"; - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param request - * @param response - * @param chain - * - * @throws IOException - * @throws ServletException - */ + @Override protected void doFilter(HttpServletRequest request, HttpServletResponse response, FilterChain chain) @@ -107,14 +92,8 @@ public class MDCFilter extends HttpFilter } } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + private String getUsername() { Subject subject = SecurityUtils.getSubject(); diff --git a/scm-webapp/src/main/java/sonia/scm/filter/PropagatePrincipleFilter.java b/scm-webapp/src/main/java/sonia/scm/filter/PropagatePrincipleFilter.java index b55e521e78..a4a0743f12 100644 --- a/scm-webapp/src/main/java/sonia/scm/filter/PropagatePrincipleFilter.java +++ b/scm-webapp/src/main/java/sonia/scm/filter/PropagatePrincipleFilter.java @@ -24,7 +24,6 @@ package sonia.scm.filter; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.annotations.VisibleForTesting; import com.google.inject.Inject; @@ -43,12 +42,7 @@ import sonia.scm.web.filter.PropagatePrincipleServletRequestWrapper; import java.io.IOException; -//~--- JDK imports ------------------------------------------------------------ -/** - * - * @author Sebastian Sdorra - */ @Priority(Filters.PRIORITY_AUTHORIZATION) public class PropagatePrincipleFilter extends HttpFilter { diff --git a/scm-webapp/src/main/java/sonia/scm/filter/StaticResourceFilter.java b/scm-webapp/src/main/java/sonia/scm/filter/StaticResourceFilter.java index 609076d492..847c77bfbc 100644 --- a/scm-webapp/src/main/java/sonia/scm/filter/StaticResourceFilter.java +++ b/scm-webapp/src/main/java/sonia/scm/filter/StaticResourceFilter.java @@ -24,7 +24,6 @@ package sonia.scm.filter; -//~--- non-JDK imports -------------------------------------------------------- import com.google.inject.Singleton; import jakarta.servlet.FilterChain; @@ -41,47 +40,23 @@ import sonia.scm.web.filter.HttpFilter; import java.io.File; import java.io.IOException; -//~--- JDK imports ------------------------------------------------------------ -/** - * - * @author Sebastian Sdorra - */ @Singleton public class StaticResourceFilter extends HttpFilter { - /** Field description */ private static final Logger logger = LoggerFactory.getLogger(StaticResourceFilter.class); - //~--- methods -------------------------------------------------------------- - - /** - * Method description - * - * - * @param filterConfig - * - * @throws ServletException - */ + private ServletContext context; + @Override public void init(FilterConfig filterConfig) throws ServletException { this.context = filterConfig.getServletContext(); } - /** - * Method description - * - * - * @param request - * @param response - * @param chain - * - * @throws IOException - * @throws ServletException - */ + @Override protected void doFilter(HttpServletRequest request, HttpServletResponse response, FilterChain chain) @@ -115,17 +90,8 @@ public class StaticResourceFilter extends HttpFilter } } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param request - * @param uri - * - * @return - */ + private File getResourceFile(HttpServletRequest request, String uri) { String path = uri.substring(request.getContextPath().length()); @@ -133,8 +99,4 @@ public class StaticResourceFilter extends HttpFilter return new File(context.getRealPath(path)); } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private ServletContext context; } diff --git a/scm-webapp/src/main/java/sonia/scm/filter/TypedWebElementDescriptor.java b/scm-webapp/src/main/java/sonia/scm/filter/TypedWebElementDescriptor.java index c3ef626f5c..b417b69bda 100644 --- a/scm-webapp/src/main/java/sonia/scm/filter/TypedWebElementDescriptor.java +++ b/scm-webapp/src/main/java/sonia/scm/filter/TypedWebElementDescriptor.java @@ -28,9 +28,6 @@ import lombok.Value; import sonia.scm.plugin.WebElementDescriptor; /** - * - * @author Sebastian Sdorra - * @param * @since 2.0.0 */ @Value diff --git a/scm-webapp/src/main/java/sonia/scm/filter/WebElementCollector.java b/scm-webapp/src/main/java/sonia/scm/filter/WebElementCollector.java index 9504a192bd..5436fbc299 100644 --- a/scm-webapp/src/main/java/sonia/scm/filter/WebElementCollector.java +++ b/scm-webapp/src/main/java/sonia/scm/filter/WebElementCollector.java @@ -24,7 +24,6 @@ package sonia.scm.filter; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.collect.Lists; import com.google.common.collect.Ordering; @@ -40,27 +39,18 @@ import sonia.scm.plugin.WebElementExtension; import java.util.List; -/** - * - * @author Sebastian Sdorra - */ + public final class WebElementCollector { - /** - * the logger for WebElementCollector - */ + private static final Logger logger = LoggerFactory.getLogger(WebElementCollector.class); - //~--- constructors --------------------------------------------------------- + private final Iterable> filters; - /** - * Constructs ... - * - * - * @param elements - */ + private final Iterable> servlets; + @SuppressWarnings("unchecked") private WebElementCollector(Iterable elements) { @@ -95,68 +85,34 @@ public final class WebElementCollector servlets = ordering.immutableSortedCopy(sl); } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param loader - * - * @return - */ + public static WebElementCollector collect(PluginLoader loader) { return new WebElementCollector( loader.getExtensionProcessor().getWebElements()); } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + public Iterable> getFilters() { return filters; } - /** - * Method description - * - * - * @return - */ + public Iterable> getServlets() { return servlets; } - //~--- inner classes -------------------------------------------------------- - /** - * Class description - * - * - * @version Enter version here..., 15/02/01 - * @author Enter your name here... - */ + + private static class TypedWebElementDescriptorOrdering extends Ordering> { - /** - * Method description - * - * - * @param left - * @param right - * - * @return - */ @Override public int compare(TypedWebElementDescriptor left, TypedWebElementDescriptor right) @@ -166,12 +122,4 @@ public final class WebElementCollector } } - - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private final Iterable> filters; - - /** Field description */ - private final Iterable> servlets; } diff --git a/scm-webapp/src/main/java/sonia/scm/filter/WebElementModule.java b/scm-webapp/src/main/java/sonia/scm/filter/WebElementModule.java index c7a5289d33..61f2548494 100644 --- a/scm-webapp/src/main/java/sonia/scm/filter/WebElementModule.java +++ b/scm-webapp/src/main/java/sonia/scm/filter/WebElementModule.java @@ -24,7 +24,6 @@ package sonia.scm.filter; -//~--- non-JDK imports -------------------------------------------------------- import com.google.inject.Scopes; import com.google.inject.servlet.ServletModule; @@ -35,17 +34,13 @@ import org.slf4j.LoggerFactory; import sonia.scm.plugin.PluginLoader; import sonia.scm.plugin.WebElementDescriptor; -/** - * - * @author Sebastian Sdorra - */ + public class WebElementModule extends ServletModule { - /** - * the logger for WebElementModule - */ private static final Logger LOG = LoggerFactory.getLogger(WebElementModule.class); + private final WebElementCollector collector; + public WebElementModule(PluginLoader pluginLoader) { collector = WebElementCollector.collect(pluginLoader); @@ -113,8 +108,4 @@ public class WebElementModule extends ServletModule { builder.with(clazz); } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private final WebElementCollector collector; } diff --git a/scm-webapp/src/main/java/sonia/scm/group/DefaultGroupManager.java b/scm-webapp/src/main/java/sonia/scm/group/DefaultGroupManager.java index 40f53ef24d..c468297ae0 100644 --- a/scm-webapp/src/main/java/sonia/scm/group/DefaultGroupManager.java +++ b/scm-webapp/src/main/java/sonia/scm/group/DefaultGroupManager.java @@ -52,9 +52,7 @@ import java.util.function.Predicate; import static java.util.stream.Collectors.toSet; -/** - * @author Sebastian Sdorra - */ + @Singleton public class DefaultGroupManager extends AbstractGroupManager { diff --git a/scm-webapp/src/main/java/sonia/scm/group/GroupManagerProvider.java b/scm-webapp/src/main/java/sonia/scm/group/GroupManagerProvider.java index 82a7ffc3bc..6fe2cfabfd 100644 --- a/scm-webapp/src/main/java/sonia/scm/group/GroupManagerProvider.java +++ b/scm-webapp/src/main/java/sonia/scm/group/GroupManagerProvider.java @@ -24,7 +24,6 @@ package sonia.scm.group; -//~--- non-JDK imports -------------------------------------------------------- import com.google.inject.Inject; import com.google.inject.Provider; @@ -32,63 +31,37 @@ import com.google.inject.Provider; import sonia.scm.Undecorated; import sonia.scm.util.Decorators; -//~--- JDK imports ------------------------------------------------------------ - import java.util.Set; -/** - * - * @author Sebastian Sdorra - */ + public class GroupManagerProvider implements Provider { + @Inject(optional = true) + private Set decoratorFactories; - /** - * Method description - * - * - * @return - */ + @Inject + @Undecorated + private Provider groupManagerProvider; + @Override public GroupManager get() { return Decorators.decorate(groupManagerProvider.get(), decoratorFactories); } - //~--- set methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param decoratorFactories - */ + public void setDecoratorFactories( Set decoratorFactories) { this.decoratorFactories = decoratorFactories; } - /** - * Method description - * - * - * @param groupManagerProvider - */ + public void setGroupManagerProvider( Provider groupManagerProvider) { this.groupManagerProvider = groupManagerProvider; } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - @Inject(optional = true) - private Set decoratorFactories; - - /** Field description */ - @Inject - @Undecorated - private Provider groupManagerProvider; } diff --git a/scm-webapp/src/main/java/sonia/scm/initialization/InitializationCookieIssuer.java b/scm-webapp/src/main/java/sonia/scm/initialization/InitializationCookieIssuer.java index 4a638226ba..38eefcad4d 100644 --- a/scm-webapp/src/main/java/sonia/scm/initialization/InitializationCookieIssuer.java +++ b/scm-webapp/src/main/java/sonia/scm/initialization/InitializationCookieIssuer.java @@ -31,7 +31,6 @@ import sonia.scm.security.AccessToken; /** * Generates cookies and invalidates initialization token cookies. * - * @author Sebastian Sdorra * @since 2.35.0 */ public interface InitializationCookieIssuer { diff --git a/scm-webapp/src/main/java/sonia/scm/lifecycle/BootstrapContextFilter.java b/scm-webapp/src/main/java/sonia/scm/lifecycle/BootstrapContextFilter.java index c9b2b1aec4..554a6785e6 100644 --- a/scm-webapp/src/main/java/sonia/scm/lifecycle/BootstrapContextFilter.java +++ b/scm-webapp/src/main/java/sonia/scm/lifecycle/BootstrapContextFilter.java @@ -24,7 +24,6 @@ package sonia.scm.lifecycle; -//~--- non-JDK imports -------------------------------------------------------- import com.github.legman.Subscribe; import com.google.inject.servlet.GuiceFilter; @@ -37,24 +36,16 @@ import sonia.scm.event.ScmEventBus; import java.util.Optional; -//~--- JDK imports ------------------------------------------------------------ -/** - * - * @author Sebastian Sdorra - */ public class BootstrapContextFilter extends GuiceFilter { - /** - * the logger for BootstrapContextFilter - */ + private static final Logger LOG = LoggerFactory.getLogger(BootstrapContextFilter.class); private final BootstrapContextListener listener = new BootstrapContextListener(); private ClassLoader webAppClassLoader; - /** Field description */ private FilterConfig filterConfig; @Override diff --git a/scm-webapp/src/main/java/sonia/scm/lifecycle/BootstrapContextListener.java b/scm-webapp/src/main/java/sonia/scm/lifecycle/BootstrapContextListener.java index b1408e9c75..a23f0b42b2 100644 --- a/scm-webapp/src/main/java/sonia/scm/lifecycle/BootstrapContextListener.java +++ b/scm-webapp/src/main/java/sonia/scm/lifecycle/BootstrapContextListener.java @@ -56,9 +56,7 @@ import sonia.scm.update.UpdateEngine; import java.util.ArrayList; import java.util.List; -/** - * @author Sebastian Sdorra - */ + public class BootstrapContextListener extends GuiceServletContextListener { private static final Logger LOG = LoggerFactory.getLogger(BootstrapContextListener.class); diff --git a/scm-webapp/src/main/java/sonia/scm/lifecycle/modules/ClassOverride.java b/scm-webapp/src/main/java/sonia/scm/lifecycle/modules/ClassOverride.java index 6ba57812e7..29fde9b6ae 100644 --- a/scm-webapp/src/main/java/sonia/scm/lifecycle/modules/ClassOverride.java +++ b/scm-webapp/src/main/java/sonia/scm/lifecycle/modules/ClassOverride.java @@ -24,7 +24,6 @@ package sonia.scm.lifecycle.modules; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.MoreObjects; import com.google.common.base.Objects; @@ -32,24 +31,14 @@ import jakarta.xml.bind.annotation.XmlAccessType; import jakarta.xml.bind.annotation.XmlAccessorType; import sonia.scm.Validateable; -//~--- JDK imports ------------------------------------------------------------ -/** - * - * @author Sebastian Sdorra - */ @XmlAccessorType(XmlAccessType.FIELD) public class ClassOverride implements Validateable { + private Class bind; + + private Class to; - /** - * Method description - * - * - * @param obj - * - * @return - */ @Override public boolean equals(Object obj) { @@ -68,24 +57,14 @@ public class ClassOverride implements Validateable return Objects.equal(bind, other.bind) && Objects.equal(to, other.to); } - /** - * Method description - * - * - * @return - */ + @Override public int hashCode() { return Objects.hashCode(bind, to); } - /** - * Method description - * - * - * @return - */ + @Override public String toString() { @@ -97,71 +76,37 @@ public class ClassOverride implements Validateable //J+ } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + public Class getBind() { return bind; } - /** - * Method description - * - * - * @return - */ + public Class getTo() { return to; } - /** - * Method description - * - * - * @return - */ + @Override public boolean isValid() { return (bind != null) && (to != null); } - //~--- set methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param bind - */ + public void setBind(Class bind) { this.bind = bind; } - /** - * Method description - * - * - * @param to - */ + public void setTo(Class to) { this.to = to; } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private Class bind; - - /** Field description */ - private Class to; } diff --git a/scm-webapp/src/main/java/sonia/scm/lifecycle/modules/ClassOverrides.java b/scm-webapp/src/main/java/sonia/scm/lifecycle/modules/ClassOverrides.java index 4b273b35ea..f903312722 100644 --- a/scm-webapp/src/main/java/sonia/scm/lifecycle/modules/ClassOverrides.java +++ b/scm-webapp/src/main/java/sonia/scm/lifecycle/modules/ClassOverrides.java @@ -24,7 +24,6 @@ package sonia.scm.lifecycle.modules; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Function; import com.google.common.collect.Lists; @@ -48,35 +47,24 @@ import java.util.Enumeration; import java.util.Iterator; import java.util.List; -/** - * - * @author Sebastian Sdorra - */ + @XmlRootElement(name = "overrides") @XmlAccessorType(XmlAccessType.FIELD) public class ClassOverrides implements Iterable { - /** Field description */ public static final String OVERRIDE_PATH = "META-INF/scm/override.xml"; - /** - * the logger for ClassOverrides - */ + private static final Logger logger = LoggerFactory.getLogger(ClassOverrides.class); - //~--- methods -------------------------------------------------------------- + @XmlElement(name = "module") + private List> moduleClasses; + + @XmlElement(name = "override") + private List overrides; - /** - * Method description - * - * - * - * @param classLoader - * @return - * - */ public static ClassOverrides findOverrides(ClassLoader classLoader) { final ClassOverrides overrides = new ClassOverrides(); @@ -133,12 +121,7 @@ public class ClassOverrides implements Iterable return overrides; } - /** - * Method description - * - * - * @param overrides - */ + public void append(ClassOverrides overrides) { AssertUtil.assertIsNotNull(overrides); @@ -158,26 +141,15 @@ public class ClassOverrides implements Iterable getModuleClasses().addAll(overrides.getModuleClasses()); } - /** - * Method description - * - * - * @return - */ + @Override public Iterator iterator() { return getOverrides().iterator(); } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + public List> getModuleClasses() { if (moduleClasses == null) @@ -188,12 +160,7 @@ public class ClassOverrides implements Iterable return moduleClasses; } - /** - * Method description - * - * - * @return - */ + @SuppressWarnings("unchecked") public List getModules() { @@ -232,15 +199,7 @@ public class ClassOverrides implements Iterable return modules; } - /** - * Method description - * - * - * @param clazz - * @param - * - * @return - */ + @SuppressWarnings("unchecked") public Class getOverride(Class clazz) { @@ -257,12 +216,7 @@ public class ClassOverrides implements Iterable return implementation; } - /** - * Method description - * - * - * @return - */ + public List getOverrides() { if (overrides == null) @@ -273,38 +227,17 @@ public class ClassOverrides implements Iterable return overrides; } - //~--- set methods ---------------------------------------------------------- - /** - * Method description - * - * - * - * @param moduleClasses - */ + public void setModuleClasses(List> moduleClasses) { this.moduleClasses = moduleClasses; } - /** - * Method description - * - * - * @param overrides - */ + public void setOverrides(List overrides) { this.overrides = overrides; } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - @XmlElement(name = "module") - private List> moduleClasses; - - /** Field description */ - @XmlElement(name = "override") - private List overrides; } diff --git a/scm-webapp/src/main/java/sonia/scm/lifecycle/modules/CloseableModule.java b/scm-webapp/src/main/java/sonia/scm/lifecycle/modules/CloseableModule.java index 53e097f735..40a18968d6 100644 --- a/scm-webapp/src/main/java/sonia/scm/lifecycle/modules/CloseableModule.java +++ b/scm-webapp/src/main/java/sonia/scm/lifecycle/modules/CloseableModule.java @@ -42,7 +42,6 @@ import java.util.concurrent.ConcurrentLinkedDeque; * Guice module which captures all classes which are implementing the {@link Closeable}. These classes can be later * closed, by injecting the {@link CloseableModule} and calling {@link #closeAll()}. * - * @author Sebastian Sdorra */ public final class CloseableModule extends AbstractModule { diff --git a/scm-webapp/src/main/java/sonia/scm/lifecycle/modules/EagerSingletonModule.java b/scm-webapp/src/main/java/sonia/scm/lifecycle/modules/EagerSingletonModule.java index 729ba1ec7d..f81aa809de 100644 --- a/scm-webapp/src/main/java/sonia/scm/lifecycle/modules/EagerSingletonModule.java +++ b/scm-webapp/src/main/java/sonia/scm/lifecycle/modules/EagerSingletonModule.java @@ -24,7 +24,6 @@ package sonia.scm.lifecycle.modules; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.collect.Sets; import com.google.inject.AbstractModule; @@ -38,13 +37,10 @@ import sonia.scm.EagerSingleton; import java.util.Set; -//~--- JDK imports ------------------------------------------------------------ - /** * Guice module which captures all classes which are annotated with {@link EagerSingleton}. These classes can be later * initialized. * - * @author Sebastian Sdorra */ public class EagerSingletonModule extends AbstractModule { diff --git a/scm-webapp/src/main/java/sonia/scm/lifecycle/modules/ScmEventBusModule.java b/scm-webapp/src/main/java/sonia/scm/lifecycle/modules/ScmEventBusModule.java index 0b32d3745c..a0bbe9d86a 100644 --- a/scm-webapp/src/main/java/sonia/scm/lifecycle/modules/ScmEventBusModule.java +++ b/scm-webapp/src/main/java/sonia/scm/lifecycle/modules/ScmEventBusModule.java @@ -24,7 +24,6 @@ package sonia.scm.lifecycle.modules; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.annotations.VisibleForTesting; import com.google.inject.AbstractModule; @@ -38,7 +37,6 @@ import sonia.scm.event.ScmEventBus; /** * Registers every instance to the scm-manager event bus. * - * @author Sebastian Sdorra */ public class ScmEventBusModule extends AbstractModule { diff --git a/scm-webapp/src/main/java/sonia/scm/lifecycle/modules/ScmInitializerModule.java b/scm-webapp/src/main/java/sonia/scm/lifecycle/modules/ScmInitializerModule.java index 52e36c6f3b..d9dd8fac4b 100644 --- a/scm-webapp/src/main/java/sonia/scm/lifecycle/modules/ScmInitializerModule.java +++ b/scm-webapp/src/main/java/sonia/scm/lifecycle/modules/ScmInitializerModule.java @@ -24,7 +24,6 @@ package sonia.scm.lifecycle.modules; -//~--- non-JDK imports -------------------------------------------------------- import com.google.inject.AbstractModule; import com.google.inject.TypeLiteral; @@ -39,7 +38,6 @@ import sonia.scm.SCMContext; /** * Initializes all instances which are implementing the {@link Initable} interface. * - * @author Sebastian Sdorra */ public class ScmInitializerModule extends AbstractModule { diff --git a/scm-webapp/src/main/java/sonia/scm/lifecycle/modules/ScmSecurityModule.java b/scm-webapp/src/main/java/sonia/scm/lifecycle/modules/ScmSecurityModule.java index ac33189432..33872812c6 100644 --- a/scm-webapp/src/main/java/sonia/scm/lifecycle/modules/ScmSecurityModule.java +++ b/scm-webapp/src/main/java/sonia/scm/lifecycle/modules/ScmSecurityModule.java @@ -24,7 +24,6 @@ package sonia.scm.lifecycle.modules; -//~--- non-JDK imports -------------------------------------------------------- import com.google.inject.name.Names; import jakarta.servlet.ServletContext; @@ -48,44 +47,25 @@ import sonia.scm.security.DisabledRememberMeManager; import sonia.scm.security.ScmAtLeastOneSuccessfulStrategy; import sonia.scm.security.ScmPermissionResolver; -/** - * - * @author Sebastian Sdorra - */ + public class ScmSecurityModule extends ShiroWebModule { - /** Field description */ private static final int ITERATIONS = 8192; - /** - * the logger for ScmSecurityModule - */ private static final Logger logger = LoggerFactory.getLogger(ScmSecurityModule.class); - //~--- constructors --------------------------------------------------------- - - /** - * Constructs ... - * - * - * @param servletContext - * @param extensionProcessor - */ + private final ExtensionProcessor extensionProcessor; + public ScmSecurityModule(ServletContext servletContext, ExtensionProcessor extensionProcessor) { super(servletContext); this.extensionProcessor = extensionProcessor; } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - */ - @Override + @Override @SuppressWarnings("unchecked") protected void configureShiroWeb() { @@ -153,11 +133,6 @@ public class ScmSecurityModule extends ShiroWebModule return passwordService; } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private final ExtensionProcessor extensionProcessor; - static class IdempotentPasswordService extends DefaultPasswordService { private boolean isEncrypted(Object password) { diff --git a/scm-webapp/src/main/java/sonia/scm/lifecycle/modules/ScmServletModule.java b/scm-webapp/src/main/java/sonia/scm/lifecycle/modules/ScmServletModule.java index 604b04c775..f1cf78838a 100644 --- a/scm-webapp/src/main/java/sonia/scm/lifecycle/modules/ScmServletModule.java +++ b/scm-webapp/src/main/java/sonia/scm/lifecycle/modules/ScmServletModule.java @@ -143,9 +143,7 @@ import sonia.scm.work.DefaultCentralWorkQueue; import javax.net.ssl.SSLContext; import javax.net.ssl.TrustManager; -/** - * @author Sebastian Sdorra - */ + class ScmServletModule extends ServletModule { private static final String PATTERN_ALL = "/*"; diff --git a/scm-webapp/src/main/java/sonia/scm/lifecycle/modules/ServletContextListenerHolder.java b/scm-webapp/src/main/java/sonia/scm/lifecycle/modules/ServletContextListenerHolder.java index 55fe415d32..50945887a2 100644 --- a/scm-webapp/src/main/java/sonia/scm/lifecycle/modules/ServletContextListenerHolder.java +++ b/scm-webapp/src/main/java/sonia/scm/lifecycle/modules/ServletContextListenerHolder.java @@ -24,7 +24,6 @@ package sonia.scm.lifecycle.modules; -//~--- non-JDK imports -------------------------------------------------------- import com.google.inject.Inject; import com.google.inject.Singleton; @@ -34,10 +33,7 @@ import jakarta.servlet.ServletContextListener; import java.util.Collections; import java.util.Set; -/** - * - * @author Sebastian Sdorra - */ + @Singleton public class ServletContextListenerHolder implements ServletContextListener { diff --git a/scm-webapp/src/main/java/sonia/scm/net/SSLContextProvider.java b/scm-webapp/src/main/java/sonia/scm/net/SSLContextProvider.java index 1982ec0fd1..33cb5d7459 100644 --- a/scm-webapp/src/main/java/sonia/scm/net/SSLContextProvider.java +++ b/scm-webapp/src/main/java/sonia/scm/net/SSLContextProvider.java @@ -38,14 +38,11 @@ import java.security.NoSuchAlgorithmException; * Provider for {@link SSLContext}. The provider will first try to retrieve the {@link SSLContext} from an "default" * named optional provider, if this fails the provider will return the jvm default context. * - * @author Sebastian Sdorra * @version 1.47 */ public final class SSLContextProvider implements Provider { - /** - * the logger for SSLContextProvider - */ + private static final Logger logger = LoggerFactory.getLogger(SSLContextProvider.class); @Named("default") diff --git a/scm-webapp/src/main/java/sonia/scm/net/TrustAllHostnameVerifier.java b/scm-webapp/src/main/java/sonia/scm/net/TrustAllHostnameVerifier.java index c25f2076c4..bf1f656564 100644 --- a/scm-webapp/src/main/java/sonia/scm/net/TrustAllHostnameVerifier.java +++ b/scm-webapp/src/main/java/sonia/scm/net/TrustAllHostnameVerifier.java @@ -24,27 +24,14 @@ package sonia.scm.net; -//~--- JDK imports ------------------------------------------------------------ - import javax.net.ssl.HostnameVerifier; import javax.net.ssl.SSLSession; -/** - * - * @author Sebastian Sdorra - */ + public class TrustAllHostnameVerifier implements HostnameVerifier { - /** - * Method description - * - * - * @param hostname - * @param session - * - * @return - */ + @Override public boolean verify(String hostname, SSLSession session) { diff --git a/scm-webapp/src/main/java/sonia/scm/net/TrustAllTrustManager.java b/scm-webapp/src/main/java/sonia/scm/net/TrustAllTrustManager.java index f36081695b..26377dc5af 100644 --- a/scm-webapp/src/main/java/sonia/scm/net/TrustAllTrustManager.java +++ b/scm-webapp/src/main/java/sonia/scm/net/TrustAllTrustManager.java @@ -24,53 +24,26 @@ package sonia.scm.net; -//~--- JDK imports ------------------------------------------------------------ - import javax.net.ssl.X509TrustManager; import java.security.cert.CertificateException; import java.security.cert.X509Certificate; -/** - * - * @author Sebastian Sdorra - */ + public class TrustAllTrustManager implements X509TrustManager { - /** - * Method description - * - * - * @param chain - * @param authType - * - * @throws CertificateException - */ + @Override public void checkClientTrusted(X509Certificate[] chain, String authType) throws CertificateException {} - /** - * Method description - * - * - * @param chain - * @param authType - * - * @throws CertificateException - */ + @Override public void checkServerTrusted(X509Certificate[] chain, String authType) throws CertificateException {} - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + @Override public X509Certificate[] getAcceptedIssuers() { diff --git a/scm-webapp/src/main/java/sonia/scm/net/ahc/DefaultAdvancedHttpClient.java b/scm-webapp/src/main/java/sonia/scm/net/ahc/DefaultAdvancedHttpClient.java index fdca3092ef..5e0440d4a2 100644 --- a/scm-webapp/src/main/java/sonia/scm/net/ahc/DefaultAdvancedHttpClient.java +++ b/scm-webapp/src/main/java/sonia/scm/net/ahc/DefaultAdvancedHttpClient.java @@ -49,14 +49,11 @@ import java.util.Set; * Default implementation of the {@link AdvancedHttpClient}. The default * implementation uses {@link HttpURLConnection}. * - * @author Sebastian Sdorra * @since 1.46 */ public class DefaultAdvancedHttpClient extends AdvancedHttpClient { - /** - * the logger for DefaultAdvancedHttpClient - */ + private static final Logger LOG = LoggerFactory.getLogger(DefaultAdvancedHttpClient.class); private final HttpURLConnectionFactory connectionFactory; diff --git a/scm-webapp/src/main/java/sonia/scm/net/ahc/DefaultAdvancedHttpResponse.java b/scm-webapp/src/main/java/sonia/scm/net/ahc/DefaultAdvancedHttpResponse.java index 084dbd0e9e..335c5f2445 100644 --- a/scm-webapp/src/main/java/sonia/scm/net/ahc/DefaultAdvancedHttpResponse.java +++ b/scm-webapp/src/main/java/sonia/scm/net/ahc/DefaultAdvancedHttpResponse.java @@ -24,7 +24,6 @@ package sonia.scm.net.ahc; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.collect.LinkedHashMultimap; import com.google.common.collect.Multimap; @@ -33,8 +32,6 @@ import com.google.common.io.ByteSource; import org.slf4j.Logger; import org.slf4j.LoggerFactory; -//~--- JDK imports ------------------------------------------------------------ - import java.io.IOException; import java.io.InputStream; @@ -46,11 +43,22 @@ import java.util.Map.Entry; /** * Http server response object of {@link DefaultAdvancedHttpClient}. * - * @author Sebastian Sdorra * @since 1.46 */ public class DefaultAdvancedHttpResponse extends AdvancedHttpResponse { + private final DefaultAdvancedHttpClient client; + + private final HttpURLConnection connection; + + /** server response status */ + private final int status; + + /** server response text */ + private final String statusText; + + /** http headers */ + private Multimap headers; /** * Constructs a new {@link DefaultAdvancedHttpResponse}. @@ -69,22 +77,16 @@ HttpURLConnection connection, int status, String statusText) this.statusText = statusText; } - //~--- methods -------------------------------------------------------------- - /** - * {@inheritDoc} - */ + @Override public ByteSource contentAsByteSource() throws IOException { return new URLConnectionByteSource(connection); } - //~--- get methods ---------------------------------------------------------- - /** - * {@inheritDoc} - */ + @Override public Multimap getHeaders() { @@ -102,29 +104,22 @@ HttpURLConnection connection, int status, String statusText) return headers; } - /** - * {@inheritDoc} - */ + @Override public int getStatus() { return status; } - /** - * {@inheritDoc} - */ + @Override public String getStatusText() { return statusText; } - //~--- methods -------------------------------------------------------------- - /** - * {@inheritDoc} - */ + @Override protected ContentTransformer createTransformer(Class type, String contentType) @@ -132,7 +127,7 @@ HttpURLConnection connection, int status, String statusText) return client.createTransformer(type, contentType); } - //~--- inner classes -------------------------------------------------------- + /** * {@link ByteSource} implementation of a http connection. @@ -140,26 +135,17 @@ HttpURLConnection connection, int status, String statusText) private static class URLConnectionByteSource extends ByteSource { - /** - * the logger for URLConnectionByteSource - */ private static final Logger logger = LoggerFactory.getLogger(URLConnectionByteSource.class); - //~--- constructors ------------------------------------------------------- + private final HttpURLConnection connection; - /** - * Constructs a new {@link URLConnectionByteSource}. - * - * - * @param connection http connection - */ private URLConnectionByteSource(HttpURLConnection connection) { this.connection = connection; } - //~--- methods ------------------------------------------------------------ + /** * Opens the input stream of http connection, if an error occurs during @@ -193,27 +179,6 @@ HttpURLConnection connection, int status, String statusText) return stream; } - //~--- fields ------------------------------------------------------------- - - /** http connection */ - private final HttpURLConnection connection; } - - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private final DefaultAdvancedHttpClient client; - - /** http connection */ - private final HttpURLConnection connection; - - /** server response status */ - private final int status; - - /** server response text */ - private final String statusText; - - /** http headers */ - private Multimap headers; } diff --git a/scm-webapp/src/main/java/sonia/scm/net/ahc/JsonContentTransformer.java b/scm-webapp/src/main/java/sonia/scm/net/ahc/JsonContentTransformer.java index 78f6174e0f..47500ada13 100644 --- a/scm-webapp/src/main/java/sonia/scm/net/ahc/JsonContentTransformer.java +++ b/scm-webapp/src/main/java/sonia/scm/net/ahc/JsonContentTransformer.java @@ -24,7 +24,6 @@ package sonia.scm.net.ahc; -//~--- non-JDK imports -------------------------------------------------------- import com.fasterxml.jackson.databind.AnnotationIntrospector; import com.fasterxml.jackson.databind.DeserializationFeature; @@ -46,17 +45,13 @@ import java.io.InputStream; * {@link ContentTransformer} for json. The {@link JsonContentTransformer} uses * jacksons {@link ObjectMapper} to marshalling/unmarshalling. * - * @author Sebastian Sdorra * @since 1.46 */ @Extension public class JsonContentTransformer implements ContentTransformer { + private final ObjectMapper mapper; - /** - * Constructs a new {@link JsonContentTransformer}. - * - */ public JsonContentTransformer() { this.mapper = new ObjectMapper(); @@ -71,11 +66,8 @@ public class JsonContentTransformer implements ContentTransformer this.mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false); } - //~--- methods -------------------------------------------------------------- - /** - * {@inheritDoc} - */ + @Override public ByteSource marshall(Object object) { @@ -95,9 +87,7 @@ public class JsonContentTransformer implements ContentTransformer return source; } - /** - * {@inheritDoc} - */ + @Override public T unmarshall(Class type, ByteSource content) { @@ -121,7 +111,6 @@ public class JsonContentTransformer implements ContentTransformer return object; } - //~--- get methods ---------------------------------------------------------- /** * Returns {@code true}, if the content type is compatible with @@ -140,8 +129,4 @@ public class JsonContentTransformer implements ContentTransformer return MediaType.valueOf(contentType).isCompatible(MediaType.APPLICATION_JSON_TYPE); } - //~--- fields --------------------------------------------------------------- - - /** object mapper */ - private final ObjectMapper mapper; } diff --git a/scm-webapp/src/main/java/sonia/scm/net/ahc/XmlContentTransformer.java b/scm-webapp/src/main/java/sonia/scm/net/ahc/XmlContentTransformer.java index fdcf15b6ae..ed2852952d 100644 --- a/scm-webapp/src/main/java/sonia/scm/net/ahc/XmlContentTransformer.java +++ b/scm-webapp/src/main/java/sonia/scm/net/ahc/XmlContentTransformer.java @@ -24,7 +24,6 @@ package sonia.scm.net.ahc; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.io.ByteSource; import jakarta.ws.rs.core.MediaType; @@ -37,22 +36,17 @@ import java.io.ByteArrayOutputStream; import java.io.IOException; import java.io.InputStream; -//~--- JDK imports ------------------------------------------------------------ - /** * {@link ContentTransformer} for xml. The {@link XmlContentTransformer} uses * jaxb to marshalling/unmarshalling. * - * @author Sebastian Sdorra * @since 1.46 */ @Extension public class XmlContentTransformer implements ContentTransformer { - /** - * {@inheritDoc} - */ + @Override public ByteSource marshall(Object object) { @@ -72,9 +66,7 @@ public class XmlContentTransformer implements ContentTransformer return source; } - /** - * {@inheritDoc} - */ + @Override public T unmarshall(Class type, ByteSource content) { @@ -97,7 +89,6 @@ public class XmlContentTransformer implements ContentTransformer return object; } - //~--- get methods ---------------------------------------------------------- /** * Returns {@code true}, if the content type is compatible with diff --git a/scm-webapp/src/main/java/sonia/scm/plugin/ChildFirstPluginClassLoader.java b/scm-webapp/src/main/java/sonia/scm/plugin/ChildFirstPluginClassLoader.java index b358943c87..2608f4e2b8 100644 --- a/scm-webapp/src/main/java/sonia/scm/plugin/ChildFirstPluginClassLoader.java +++ b/scm-webapp/src/main/java/sonia/scm/plugin/ChildFirstPluginClassLoader.java @@ -24,18 +24,14 @@ package sonia.scm.plugin; -//~--- non-JDK imports -------------------------------------------------------- import sonia.scm.net.ChildFirstURLClassLoader; -//~--- JDK imports ------------------------------------------------------------ - import java.net.URL; /** * Child first {@link ClassLoader} for SCM-Manager plugins. * - * @author Sebastian Sdorra */ public class ChildFirstPluginClassLoader extends ChildFirstURLClassLoader implements PluginClassLoader @@ -43,13 +39,7 @@ public class ChildFirstPluginClassLoader extends ChildFirstURLClassLoader private final String plugin; - /** - * Constructs ... - * - * - * @param urls - * @param parent - */ + public ChildFirstPluginClassLoader(URL[] urls, ClassLoader parent, String plugin) { super(urls, parent); diff --git a/scm-webapp/src/main/java/sonia/scm/plugin/DefaultExtensionProcessor.java b/scm-webapp/src/main/java/sonia/scm/plugin/DefaultExtensionProcessor.java index 59f5a9c671..e01eeaf801 100644 --- a/scm-webapp/src/main/java/sonia/scm/plugin/DefaultExtensionProcessor.java +++ b/scm-webapp/src/main/java/sonia/scm/plugin/DefaultExtensionProcessor.java @@ -24,7 +24,6 @@ package sonia.scm.plugin; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Stopwatch; import com.google.inject.Binder; @@ -35,25 +34,17 @@ import sonia.scm.config.ConfigBinding; import java.util.Set; import java.util.stream.Collectors; -/** - * @author Sebastian Sdorra - */ + @SuppressWarnings("unchecked") public class DefaultExtensionProcessor implements ExtensionProcessor { - /** - * the logger for DefaultExtensionProcessor - */ + private static final Logger logger = LoggerFactory.getLogger(DefaultExtensionProcessor.class); - //~--- constructors --------------------------------------------------------- + private final ExtensionCollector collector; + private final Set configBindings; - /** - * Constructs ... - * - * @param collector - */ public DefaultExtensionProcessor(ExtensionCollector collector, ConfigurationResolver configurationResolver) { this.collector = collector; this.configBindings = collector.getConfigElements().stream().map(configElement -> { @@ -63,35 +54,20 @@ public class DefaultExtensionProcessor implements ExtensionProcessor { }).collect(Collectors.toSet()); } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * @param extensionPoint - * @return - */ + @Override public Iterable byExtensionPoint(Class extensionPoint) { return collector.byExtensionPoint(extensionPoint); } - /** - * Method description - * - * @param extensionPoint - * @return - */ + @Override public Class oneByExtensionPoint(Class extensionPoint) { return collector.oneByExtensionPoint(extensionPoint); } - /** - * Method description - * - * @param binder - */ + @Override public void processAutoBindExtensions(Binder binder) { logger.info("start processing extensions"); @@ -102,13 +78,8 @@ public class DefaultExtensionProcessor implements ExtensionProcessor { logger.info("bound extensions in {}", sw.stop()); } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * @return - */ + @Override public Iterable getWebElements() { return collector.getWebElements(); @@ -124,11 +95,4 @@ public class DefaultExtensionProcessor implements ExtensionProcessor { return configBindings; } - //~--- fields --------------------------------------------------------------- - - /** - * Field description - */ - private final ExtensionCollector collector; - private final Set configBindings; } diff --git a/scm-webapp/src/main/java/sonia/scm/plugin/DefaultPluginClassLoader.java b/scm-webapp/src/main/java/sonia/scm/plugin/DefaultPluginClassLoader.java index e8044d9ee8..b2267c4fc1 100644 --- a/scm-webapp/src/main/java/sonia/scm/plugin/DefaultPluginClassLoader.java +++ b/scm-webapp/src/main/java/sonia/scm/plugin/DefaultPluginClassLoader.java @@ -24,8 +24,6 @@ package sonia.scm.plugin; -//~--- JDK imports ------------------------------------------------------------ - import java.net.URL; import java.net.URLClassLoader; @@ -33,7 +31,6 @@ import java.net.URLClassLoader; * Default {@link ClassLoader} for SCM-Manager plugins. This {@link ClassLoader} * uses the default parent first strategy. * - * @author Sebastian Sdorra */ public class DefaultPluginClassLoader extends URLClassLoader implements PluginClassLoader @@ -41,13 +38,7 @@ public class DefaultPluginClassLoader extends URLClassLoader private final String plugin; - /** - * Constructs ... - * - * - * @param urls - * @param parent - */ + public DefaultPluginClassLoader(URL[] urls, ClassLoader parent, String plugin) { super(urls, parent); diff --git a/scm-webapp/src/main/java/sonia/scm/plugin/DefaultPluginLoader.java b/scm-webapp/src/main/java/sonia/scm/plugin/DefaultPluginLoader.java index d0f1684dab..8eb30d1907 100644 --- a/scm-webapp/src/main/java/sonia/scm/plugin/DefaultPluginLoader.java +++ b/scm-webapp/src/main/java/sonia/scm/plugin/DefaultPluginLoader.java @@ -24,7 +24,6 @@ package sonia.scm.plugin; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Throwables; import com.google.common.collect.ImmutableSet; @@ -39,30 +38,24 @@ import java.util.Collection; import java.util.Enumeration; import java.util.Set; -//~--- JDK imports ------------------------------------------------------------ -/** - * - * @author Sebastian Sdorra - */ public class DefaultPluginLoader implements PluginLoader { - /** Field description */ public static final String PATH_MODULECONFIG = "META-INF/scm/module.xml"; - /** Field description */ public static final String PATH_PLUGINCONFIG = "META-INF/scm/plugin.xml"; - //~--- constructors --------------------------------------------------------- + private final ExtensionProcessor extensionProcessor; + + private final Set installedPlugins; + + private final Set modules; + + private final ClassLoader uberClassLoader; + + private final UberWebResourceLoader uberWebResourceLoader; - /** - * Constructs ... - * - * @param servletContext - * @param parent - * @param installedPlugins - */ public DefaultPluginLoader(ServletContext servletContext, ClassLoader parent, Set installedPlugins, ConfigurationResolver configurationResolver) { @@ -87,84 +80,43 @@ public class DefaultPluginLoader implements PluginLoader } } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + @Override public ExtensionProcessor getExtensionProcessor() { return extensionProcessor; } - /** - * Method description - * - * - * @return - */ + @Override public Collection getInstalledModules() { return modules; } - /** - * Method description - * - * - * @return - */ + @Override public Collection getInstalledPlugins() { return installedPlugins; } - /** - * Method description - * - * - * @return - */ + @Override public ClassLoader getUberClassLoader() { return uberClassLoader; } - /** - * Method description - * - * - * @return - */ + @Override public UberWebResourceLoader getUberWebResourceLoader() { return uberWebResourceLoader; } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param classLoader - * @param context - * @param path - * @param - * - * @return - * - * @throws IOException - * @throws JAXBException - */ @SuppressWarnings("unchecked") private Set getInstalled(ClassLoader classLoader, JAXBContext context, String path) @@ -184,20 +136,4 @@ public class DefaultPluginLoader implements PluginLoader return builder.build(); } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private final ExtensionProcessor extensionProcessor; - - /** Field description */ - private final Set installedPlugins; - - /** Field description */ - private final Set modules; - - /** Field description */ - private final ClassLoader uberClassLoader; - - /** Field description */ - private final UberWebResourceLoader uberWebResourceLoader; } diff --git a/scm-webapp/src/main/java/sonia/scm/plugin/DefaultPluginManager.java b/scm-webapp/src/main/java/sonia/scm/plugin/DefaultPluginManager.java index 7e508370cf..00bab2569b 100644 --- a/scm-webapp/src/main/java/sonia/scm/plugin/DefaultPluginManager.java +++ b/scm-webapp/src/main/java/sonia/scm/plugin/DefaultPluginManager.java @@ -51,11 +51,7 @@ import java.util.stream.Collectors; import static sonia.scm.ContextEntry.ContextBuilder.entity; import static sonia.scm.ScmConstraintViolationException.Builder.doThrow; -//~--- JDK imports ------------------------------------------------------------ -/** - * @author Sebastian Sdorra - */ @Singleton public class DefaultPluginManager implements PluginManager { diff --git a/scm-webapp/src/main/java/sonia/scm/plugin/DefaultUberWebResourceLoader.java b/scm-webapp/src/main/java/sonia/scm/plugin/DefaultUberWebResourceLoader.java index bf5d72fe5f..9476874d74 100644 --- a/scm-webapp/src/main/java/sonia/scm/plugin/DefaultUberWebResourceLoader.java +++ b/scm-webapp/src/main/java/sonia/scm/plugin/DefaultUberWebResourceLoader.java @@ -24,7 +24,6 @@ package sonia.scm.plugin; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.annotations.VisibleForTesting; import com.google.common.base.Throwables; @@ -45,24 +44,23 @@ import java.nio.file.Files; import java.nio.file.Paths; import java.util.List; -//~--- JDK imports ------------------------------------------------------------ - /** * Default implementation of the {@link UberWebResourceLoader}. * - * @author Sebastian Sdorra * @since 2.0.0 */ public class DefaultUberWebResourceLoader implements UberWebResourceLoader { - /** - * the logger for DefaultUberWebResourceLoader - */ + private static final Logger logger = LoggerFactory.getLogger(DefaultUberWebResourceLoader.class); - //~--- constructors --------------------------------------------------------- + private final Cache cache; + + private final Iterable plugins; + + private final ServletContext servletContext; public DefaultUberWebResourceLoader(ServletContext servletContext, Iterable plugins) { this(servletContext, plugins, SCMContext.getContext().getStage()); @@ -81,16 +79,8 @@ public class DefaultUberWebResourceLoader implements UberWebResourceLoader return CacheBuilder.newBuilder().build(); } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param path - * - * @return - */ + @Override public URL getResource(String path) { @@ -121,14 +111,7 @@ public class DefaultUberWebResourceLoader implements UberWebResourceLoader cache.put(path, url); } - /** - * Method description - * - * - * @param path - * - * @return - */ + @Override public List getResources(String path) { @@ -166,28 +149,15 @@ public class DefaultUberWebResourceLoader implements UberWebResourceLoader return resources.build(); } - /** - * Method description - * - * - * @return - */ + @VisibleForTesting Cache getCache() { return cache; } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param path - * - * @return - */ + private URL find(String path) { URL resource; @@ -246,14 +216,4 @@ public class DefaultUberWebResourceLoader implements UberWebResourceLoader return false; } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private final Cache cache; - - /** Field description */ - private final Iterable plugins; - - /** Field description */ - private final ServletContext servletContext; } diff --git a/scm-webapp/src/main/java/sonia/scm/plugin/EmptyWebResourceLoader.java b/scm-webapp/src/main/java/sonia/scm/plugin/EmptyWebResourceLoader.java index f6b99fdda2..50d9bcd108 100644 --- a/scm-webapp/src/main/java/sonia/scm/plugin/EmptyWebResourceLoader.java +++ b/scm-webapp/src/main/java/sonia/scm/plugin/EmptyWebResourceLoader.java @@ -24,15 +24,12 @@ package sonia.scm.plugin; -//~--- JDK imports ------------------------------------------------------------ - import java.net.URL; /** * This {@link WebResourceLoader} is used, if the plugin does not contain a * webapp directory. * - * @author Sebastian Sdorra * @since 2.0.0 */ public class EmptyWebResourceLoader implements WebResourceLoader @@ -44,7 +41,6 @@ public class EmptyWebResourceLoader implements WebResourceLoader * * @param path resource path * - * @return {@code null} */ @Override public URL getResource(String path) diff --git a/scm-webapp/src/main/java/sonia/scm/plugin/ExplodedSmp.java b/scm-webapp/src/main/java/sonia/scm/plugin/ExplodedSmp.java index 7140f7e516..d07d6d6f60 100644 --- a/scm-webapp/src/main/java/sonia/scm/plugin/ExplodedSmp.java +++ b/scm-webapp/src/main/java/sonia/scm/plugin/ExplodedSmp.java @@ -24,7 +24,6 @@ package sonia.scm.plugin; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Function; import org.slf4j.Logger; @@ -34,33 +33,33 @@ import java.nio.file.Files; import java.nio.file.Path; import java.util.Objects; -//~--- JDK imports ------------------------------------------------------------ - /** * The ExplodedSmp object represents an extracted SCM-Manager plugin. The object * contains the path to the plugin directory and loads the plugin descriptor. * The ExplodedSmp can be created with the {@link #create(java.nio.file.Path)} * method. * - * @author Sebastian Sdorra */ public final class ExplodedSmp { private static final Logger logger = LoggerFactory.getLogger(ExplodedSmp.class); /** - * Constructs ... - * - * @param path - * @param plugin + * directory */ + private final Path path; + + /** + * plugin object + */ + private final InstalledPluginDescriptor plugin; + ExplodedSmp(Path path, InstalledPluginDescriptor plugin) { logger.trace("create exploded scm for plugin {} and dependencies {}", plugin.getInformation().getName(), plugin.getDependencies()); this.path = path; this.plugin = plugin; } - //~--- methods -------------------------------------------------------------- /** * Creates a new ExplodedSmp object. @@ -76,12 +75,10 @@ public final class ExplodedSmp { return new ExplodedSmp(directory, Plugins.parsePluginDescriptor(desc)); } - //~--- get methods ---------------------------------------------------------- /** * Returns {@code true} if the exploded smp contains a core plugin * - * @return {@code true} for a core plugin * @since 2.30.0 */ public boolean isCore() { @@ -92,7 +89,6 @@ public final class ExplodedSmp { /** * Returns the path to the plugin directory. * - * @return to plugin directory */ public Path getPath() { return path; @@ -101,7 +97,6 @@ public final class ExplodedSmp { /** * Returns parsed plugin descriptor. * - * @return plugin descriptor */ public InstalledPluginDescriptor getPlugin() { return plugin; @@ -126,7 +121,7 @@ public final class ExplodedSmp { return information.getName() + "@" + information.getVersion() + " (" + path + ")"; } - //~--- inner classes -------------------------------------------------------- + /** * Transforms {@link Path} to {@link ExplodedSmp}. @@ -148,16 +143,4 @@ public final class ExplodedSmp { } } - - //~--- fields --------------------------------------------------------------- - - /** - * directory - */ - private final Path path; - - /** - * plugin object - */ - private final InstalledPluginDescriptor plugin; } diff --git a/scm-webapp/src/main/java/sonia/scm/plugin/ExtensionBinder.java b/scm-webapp/src/main/java/sonia/scm/plugin/ExtensionBinder.java index 302e91cdc4..93f9878311 100644 --- a/scm-webapp/src/main/java/sonia/scm/plugin/ExtensionBinder.java +++ b/scm-webapp/src/main/java/sonia/scm/plugin/ExtensionBinder.java @@ -35,9 +35,7 @@ import org.slf4j.LoggerFactory; import sonia.scm.EagerSingleton; import sonia.scm.util.Util; -/** - * @author Sebastian Sdorra - */ + @SuppressWarnings({"unchecked", "rawtypes"}) public final class ExtensionBinder { diff --git a/scm-webapp/src/main/java/sonia/scm/plugin/MultiParentClassLoader.java b/scm-webapp/src/main/java/sonia/scm/plugin/MultiParentClassLoader.java index 9b2a338355..69eaf9e1a5 100644 --- a/scm-webapp/src/main/java/sonia/scm/plugin/MultiParentClassLoader.java +++ b/scm-webapp/src/main/java/sonia/scm/plugin/MultiParentClassLoader.java @@ -24,8 +24,6 @@ package sonia.scm.plugin; -//~--- JDK imports ------------------------------------------------------------ - import java.io.IOException; import java.net.URL; @@ -42,44 +40,25 @@ import java.util.concurrent.CopyOnWriteArrayList; /** * TODO add caching * - * @author Sebastian Sdorra */ public class MultiParentClassLoader extends ClassLoader { - - /** - * Constructs ... - * - * - * @param parents - */ + private final List parents; + public MultiParentClassLoader(ClassLoader... parents) { this(Arrays.asList(parents)); } - /** - * Constructs ... - * - * - * @param parents - */ + public MultiParentClassLoader(Collection parents) { super(null); this.parents = new CopyOnWriteArrayList<>(parents); } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param name - * - * @return - */ + @Override public URL getResource(String name) { @@ -96,16 +75,7 @@ public class MultiParentClassLoader extends ClassLoader return null; } - /** - * Method description - * - * - * @param name - * - * @return - * - * @throws IOException - */ + @Override public Enumeration getResources(String name) throws IOException { @@ -124,19 +94,6 @@ public class MultiParentClassLoader extends ClassLoader return Collections.enumeration(resources); } - //~--- methods -------------------------------------------------------------- - - /** - * Method description - * - * - * @param name - * @param resolve - * - * @return - * - * @throws ClassNotFoundException - */ @Override protected Class loadClass(String name, boolean resolve) throws ClassNotFoundException @@ -157,8 +114,4 @@ public class MultiParentClassLoader extends ClassLoader throw new ClassNotFoundException(String.format("%s not found.", name)); } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private final List parents; } diff --git a/scm-webapp/src/main/java/sonia/scm/plugin/PathWebResourceLoader.java b/scm-webapp/src/main/java/sonia/scm/plugin/PathWebResourceLoader.java index fd8889f5b7..a78ef4875f 100644 --- a/scm-webapp/src/main/java/sonia/scm/plugin/PathWebResourceLoader.java +++ b/scm-webapp/src/main/java/sonia/scm/plugin/PathWebResourceLoader.java @@ -35,7 +35,6 @@ import java.nio.file.Path; /** * Load web resources from a plugin webapp directory. * - * @author Sebastian Sdorra * @since 2.0.0 */ public class PathWebResourceLoader implements WebResourceLoader { @@ -44,9 +43,7 @@ public class PathWebResourceLoader implements WebResourceLoader { private final Path directory; - /** - * the logger for PathWebResourceLoader - */ + private static final Logger LOG = LoggerFactory.getLogger(PathWebResourceLoader.class); public PathWebResourceLoader(Path directory) { diff --git a/scm-webapp/src/main/java/sonia/scm/plugin/PluginClassLoader.java b/scm-webapp/src/main/java/sonia/scm/plugin/PluginClassLoader.java index b23d9b6566..ef16dbcac9 100644 --- a/scm-webapp/src/main/java/sonia/scm/plugin/PluginClassLoader.java +++ b/scm-webapp/src/main/java/sonia/scm/plugin/PluginClassLoader.java @@ -28,6 +28,5 @@ package sonia.scm.plugin; * The PluginClassLoader interface is mainly a marker to find the class loader * in a memory dump. This should make it easier to find class loader leaks. * - * @author Sebastian Sdorra */ public interface PluginClassLoader {} diff --git a/scm-webapp/src/main/java/sonia/scm/plugin/PluginNode.java b/scm-webapp/src/main/java/sonia/scm/plugin/PluginNode.java index 2af78a31fc..6254fdb6b6 100644 --- a/scm-webapp/src/main/java/sonia/scm/plugin/PluginNode.java +++ b/scm-webapp/src/main/java/sonia/scm/plugin/PluginNode.java @@ -24,69 +24,39 @@ package sonia.scm.plugin; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Predicate; import com.google.common.collect.Iterables; import com.google.common.collect.Lists; -//~--- JDK imports ------------------------------------------------------------ - import java.util.List; -/** - * - * @author Sebastian Sdorra - */ + public final class PluginNode { - /** - * Constructs ... - * - * - * @param plugin - */ + public PluginNode(ExplodedSmp plugin) { this.plugin = plugin; } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param node - */ + public void addChild(PluginNode node) { this.children.add(node); node.addParent(this); } - /** - * Method description - * - * - * @param node - */ + private void addParent(PluginNode node) { this.parents.add(node); } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param id - * - * @return - */ + public PluginNode getChild(final String id) { return Iterables.find(children, new Predicate() @@ -100,69 +70,38 @@ public final class PluginNode }); } - /** - * Method description - * - * - * @return - */ + public List getChildren() { return children; } - /** - * Method description - * - * - * @return - */ + public String getId() { return plugin.getPlugin().getInformation().getName(false); } - /** - * Method description - * - * - * @return - */ + public List getParents() { return parents; } - /** - * Method description - * - * - * @return - */ + public ExplodedSmp getPlugin() { return plugin; } - /** - * Method description - * - * - * @return - */ + public InstalledPlugin getWrapper() { return wrapper; } - //~--- set methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param wrapper - */ + public void setWrapper(InstalledPlugin wrapper) { this.wrapper = wrapper; @@ -186,15 +125,11 @@ public final class PluginNode //~--- fields --------------------------------------------------------------- - /** Field description */ private final List parents = Lists.newArrayList(); - /** Field description */ private final List children = Lists.newArrayList(); - /** Field description */ private final ExplodedSmp plugin; - /** Field description */ private InstalledPlugin wrapper; } diff --git a/scm-webapp/src/main/java/sonia/scm/plugin/PluginProcessor.java b/scm-webapp/src/main/java/sonia/scm/plugin/PluginProcessor.java index 2f8589908a..5cdc98b57b 100644 --- a/scm-webapp/src/main/java/sonia/scm/plugin/PluginProcessor.java +++ b/scm-webapp/src/main/java/sonia/scm/plugin/PluginProcessor.java @@ -24,7 +24,6 @@ package sonia.scm.plugin; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.annotations.VisibleForTesting; import com.google.common.collect.ImmutableList; @@ -60,11 +59,8 @@ import java.util.stream.Collectors; import static java.util.stream.Collectors.toSet; -//~--- JDK imports ------------------------------------------------------------ - /** * - * @author Sebastian Sdorra * * TODO don't mix nio and io */ @@ -72,54 +68,44 @@ import static java.util.stream.Collectors.toSet; public final class PluginProcessor { - /** Field description */ private static final String INSTALLEDNAME_FORMAT = "%s.%03d"; - /** Field description */ private static final String DIRECTORY_CLASSES = "classes"; - /** Field description */ private static final String DIRECTORY_DEPENDENCIES = "lib"; - /** Field description */ private static final String DIRECTORY_INSTALLED = ".installed"; public static final String JAKARTA_COMPATIBLE = ".jakarta-compatible"; - /** Field description */ private static final String DIRECTORY_METAINF = "META-INF"; - /** Field description */ private static final String DIRECTORY_WEBAPP = "webapp"; - /** Field description */ private static final String EXTENSION_PLUGIN = ".smp"; - /** Field description */ private static final String FORMAT_DATE = "yyyy-MM-dd"; - /** Field description */ private static final String GLOB_JAR = "*.jar"; - /** - * the logger for PluginProcessor - */ + private static final Logger logger = LoggerFactory.getLogger(PluginProcessor.class); - //~--- constructors --------------------------------------------------------- private final SmpDescriptorExtractor extractor = new SmpDescriptorExtractor(); private ClassLoaderLifeCycle classLoaderLifeCycle; - /** - * Constructs ... - * - * - * @param classLoaderLifeCycle - * @param pluginDirectory - */ + private final JAXBContext context; + + private final Path installedRootDirectory; + + private final Path installedDirectory; + + private final Path pluginDirectory; + private final PluginArchiveCleaner pluginArchiveCleaner; + public PluginProcessor(ClassLoaderLifeCycle classLoaderLifeCycle, Path pluginDirectory){ this(classLoaderLifeCycle, pluginDirectory, new PluginArchiveCleaner()); } @@ -139,19 +125,7 @@ public final class PluginProcessor } } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param directory - * @param filter - * - * @return - * - * @throws IOException - */ private static DirectoryStream stream(Path directory, Filter filter) throws IOException @@ -159,15 +133,6 @@ public final class PluginProcessor return Files.newDirectoryStream(directory, filter); } - /** - * Method description - * - * - * @param classLoader - * @return - * - * @throws IOException - */ public Set collectPlugins(ClassLoader classLoader) throws IOException { @@ -268,16 +233,6 @@ public final class PluginProcessor return dir -> Files.exists(dir.resolve(DIRECTORY_METAINF).resolve("scm").resolve("plugin.xml")); } - /** - * Method description - * - * - * @param plugins - * @param classLoader - * @param node - * - * @throws IOException - */ private void appendPluginWrapper(Set plugins, ClassLoader classLoader, PluginNode node) throws IOException @@ -321,17 +276,6 @@ public final class PluginProcessor } } - /** - * Method description - * - * - * @param directory - * @param filter - * - * @return - * - * @throws IOException - */ private Set collect(Path directory, Filter filter) throws IOException { @@ -345,16 +289,7 @@ public final class PluginProcessor return paths; } - /** - * Method description - * - * - * @param directory - * - * @return - * - * @throws IOException - */ + private List collectPluginDirectories(Path directory) throws IOException { Builder paths = ImmutableList.builder(); @@ -372,17 +307,6 @@ public final class PluginProcessor return paths.build(); } - /** - * Method description - * - * - * @param parentClassLoader - * @param smp - * - * @return - * - * @throws IOException - */ private ClassLoader createClassLoader(ClassLoader parentClassLoader, ExplodedSmp smp) throws IOException @@ -436,26 +360,13 @@ public final class PluginProcessor return classLoader; } - /** - * Method description - * - * - * @return - */ + private String createDate() { return new SimpleDateFormat(FORMAT_DATE).format(new Date()); } - /** - * Method description - * - * - * @param root - * @param parents - * - * @return - */ + private ClassLoader createParentPluginClassLoader(ClassLoader root, List parents) { @@ -510,18 +421,6 @@ public final class PluginProcessor return plugin; } - /** - * Method description - * - * - * - * @param classLoader - * @param nodes - * - * @return - * - * @throws IOException - */ private Set createPluginWrappers(ClassLoader classLoader, List nodes) throws IOException @@ -536,14 +435,7 @@ public final class PluginProcessor return plugins; } - /** - * Method description - * - * - * @param directory - * - * @return - */ + private WebResourceLoader createWebResourceLoader(Path directory) { WebResourceLoader resourceLoader; @@ -563,14 +455,7 @@ public final class PluginProcessor return resourceLoader; } - /** - * Method description - * - * - * @param archives - * - * @throws IOException - */ + private Set extract(Iterable archives) throws IOException { logger.debug("extract archives"); @@ -603,12 +488,7 @@ public final class PluginProcessor return extracted.build(); } - /** - * Method description - * - * - * @return - */ + private Path findInstalledDirectory() { Path directory = null; @@ -635,14 +515,7 @@ public final class PluginProcessor return directory; } - /** - * Method description - * - * - * @param archive - * - * @throws IOException - */ + private void moveArchive(Path archive) throws IOException { if (!Files.exists(installedDirectory)) @@ -670,28 +543,12 @@ public final class PluginProcessor Files.move(archive, installed); } - //~--- inner classes -------------------------------------------------------- - /** - * Class description - * - * - * @version Enter version here..., 14/06/04 - * @author Enter your name here... - */ + + private static class DirectoryFilter implements DirectoryStream.Filter { - /** - * Method description - * - * - * @param entry - * - * @return - * - * @throws IOException - */ @Override public boolean accept(Path entry) throws IOException { @@ -701,27 +558,11 @@ public final class PluginProcessor } - /** - * Class description - * - * - * @version Enter version here..., 14/06/04 - * @author Enter your name here... - */ + private static class PluginArchiveFilter implements DirectoryStream.Filter { - /** - * Method description - * - * - * @param entry - * - * @return - * - * @throws IOException - */ @Override public boolean accept(Path entry) throws IOException { @@ -730,18 +571,4 @@ public final class PluginProcessor } } - - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private final JAXBContext context; - - private final Path installedRootDirectory; - - /** Field description */ - private final Path installedDirectory; - - /** Field description */ - private final Path pluginDirectory; - private final PluginArchiveCleaner pluginArchiveCleaner; } diff --git a/scm-webapp/src/main/java/sonia/scm/plugin/PluginTree.java b/scm-webapp/src/main/java/sonia/scm/plugin/PluginTree.java index f9f0d89553..660077bdd3 100644 --- a/scm-webapp/src/main/java/sonia/scm/plugin/PluginTree.java +++ b/scm-webapp/src/main/java/sonia/scm/plugin/PluginTree.java @@ -35,16 +35,12 @@ import java.util.LinkedHashSet; import java.util.LinkedList; import java.util.List; -/** - * @author Sebastian Sdorra - */ + public final class PluginTree { private static final int SCM_VERSION = 3; - /** - * the logger for PluginTree - */ + private static final Logger LOG = LoggerFactory.getLogger(PluginTree.class); private final Stage stage; diff --git a/scm-webapp/src/main/java/sonia/scm/plugin/PluginsInternal.java b/scm-webapp/src/main/java/sonia/scm/plugin/PluginsInternal.java index a277b61ae6..831bb0460f 100644 --- a/scm-webapp/src/main/java/sonia/scm/plugin/PluginsInternal.java +++ b/scm-webapp/src/main/java/sonia/scm/plugin/PluginsInternal.java @@ -38,14 +38,10 @@ import java.io.IOException; import java.nio.file.Path; import java.util.Set; -/** - * @author Sebastian Sdorra - */ + public final class PluginsInternal { - /** - * the logger for PluginsInternal - */ + private static final Logger logger = LoggerFactory.getLogger(PluginsInternal.class); diff --git a/scm-webapp/src/main/java/sonia/scm/plugin/UberClassLoader.java b/scm-webapp/src/main/java/sonia/scm/plugin/UberClassLoader.java index c3366ca497..c05133841f 100644 --- a/scm-webapp/src/main/java/sonia/scm/plugin/UberClassLoader.java +++ b/scm-webapp/src/main/java/sonia/scm/plugin/UberClassLoader.java @@ -24,7 +24,6 @@ package sonia.scm.plugin; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.annotations.VisibleForTesting; import com.google.common.collect.ImmutableSet; @@ -39,13 +38,10 @@ import java.util.LinkedHashSet; import java.util.Set; import java.util.concurrent.ConcurrentMap; -//~--- JDK imports ------------------------------------------------------------ - /** * {@link ClassLoader} which is able to load classes and resources from all * plugins. * - * @author Sebastian Sdorra */ public final class UberClassLoader extends ClassLoader { diff --git a/scm-webapp/src/main/java/sonia/scm/repository/DefaultRepositoryManager.java b/scm-webapp/src/main/java/sonia/scm/repository/DefaultRepositoryManager.java index 9432be20f0..341a740851 100644 --- a/scm-webapp/src/main/java/sonia/scm/repository/DefaultRepositoryManager.java +++ b/scm-webapp/src/main/java/sonia/scm/repository/DefaultRepositoryManager.java @@ -71,7 +71,6 @@ import static sonia.scm.NotFoundException.notFound; /** * Default implementation of {@link RepositoryManager}. * - * @author Sebastian Sdorra */ @Singleton public class DefaultRepositoryManager extends AbstractRepositoryManager { diff --git a/scm-webapp/src/main/java/sonia/scm/repository/DefaultRepositoryRoleManager.java b/scm-webapp/src/main/java/sonia/scm/repository/DefaultRepositoryRoleManager.java index 4e86063acf..2b2242da4c 100644 --- a/scm-webapp/src/main/java/sonia/scm/repository/DefaultRepositoryRoleManager.java +++ b/scm-webapp/src/main/java/sonia/scm/repository/DefaultRepositoryRoleManager.java @@ -51,12 +51,14 @@ import java.util.stream.Collectors; @EagerSingleton public class DefaultRepositoryRoleManager extends AbstractRepositoryRoleManager { - /** - * the logger for XmlRepositoryRoleManager - */ + private static final Logger logger = LoggerFactory.getLogger(DefaultRepositoryRoleManager.class); + private final RepositoryRoleDAO repositoryRoleDAO; + private final ManagerDaoAdapter managerDaoAdapter; + private final RepositoryPermissionProvider repositoryPermissionProvider; + @Inject public DefaultRepositoryRoleManager(RepositoryRoleDAO repositoryRoleDAO, RepositoryPermissionProvider repositoryPermissionProvider, @@ -197,7 +199,4 @@ public class DefaultRepositoryRoleManager extends AbstractRepositoryRoleManager return repositoryRoleDAO.getLastModified(); } - private final RepositoryRoleDAO repositoryRoleDAO; - private final ManagerDaoAdapter managerDaoAdapter; - private final RepositoryPermissionProvider repositoryPermissionProvider; } diff --git a/scm-webapp/src/main/java/sonia/scm/repository/HealthCheckContextListener.java b/scm-webapp/src/main/java/sonia/scm/repository/HealthCheckContextListener.java index 87dc1371a8..6341663249 100644 --- a/scm-webapp/src/main/java/sonia/scm/repository/HealthCheckContextListener.java +++ b/scm-webapp/src/main/java/sonia/scm/repository/HealthCheckContextListener.java @@ -24,7 +24,6 @@ package sonia.scm.repository; -//~--- non-JDK imports -------------------------------------------------------- import com.google.inject.Inject; import jakarta.servlet.ServletContextEvent; @@ -34,34 +33,20 @@ import sonia.scm.plugin.Extension; import sonia.scm.web.security.AdministrationContext; import sonia.scm.web.security.PrivilegedAction; -/** - * - * @author Sebastian Sdorra - */ + @Extension public class HealthCheckContextListener implements ServletContextListener { - - /** - * Constructs ... - * - * - * @param context - */ + private final AdministrationContext context; + @Inject public HealthCheckContextListener(AdministrationContext context) { this.context = context; } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param sce - */ + @Override public void contextDestroyed(ServletContextEvent sce) { @@ -69,48 +54,29 @@ public class HealthCheckContextListener implements ServletContextListener // do nothing } - /** - * Method description - * - * - * @param sce - */ + @Override public void contextInitialized(ServletContextEvent sce) { context.runAsAdmin(HealthCheckStartupAction.class); } - //~--- inner classes -------------------------------------------------------- - /** - * Class description - * - * - * @version Enter version here..., 14/01/23 - * @author Enter your name here... - */ + + static class HealthCheckStartupAction implements PrivilegedAction { - - /** - * Constructs ... - * - * - * @param healthChecker - */ + private final HealthChecker healthChecker; + @Inject public HealthCheckStartupAction(HealthChecker healthChecker) { this.healthChecker = healthChecker; } - //~--- methods ------------------------------------------------------------ + + - /** - * Method description - * - */ @Override public void run() { @@ -119,15 +85,6 @@ public class HealthCheckContextListener implements ServletContextListener SecurityUtils.getSubject().execute(healthChecker::lightCheckAll); } - //~--- fields ------------------------------------------------------------- - - /** Field description */ - private final HealthChecker healthChecker; } - - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private final AdministrationContext context; } diff --git a/scm-webapp/src/main/java/sonia/scm/repository/LastModifiedUpdateListener.java b/scm-webapp/src/main/java/sonia/scm/repository/LastModifiedUpdateListener.java index c72581ea18..4e50bc8529 100644 --- a/scm-webapp/src/main/java/sonia/scm/repository/LastModifiedUpdateListener.java +++ b/scm-webapp/src/main/java/sonia/scm/repository/LastModifiedUpdateListener.java @@ -35,7 +35,6 @@ import sonia.scm.web.security.AdministrationContext; import sonia.scm.web.security.PrivilegedAction; /** - * @author Sebastian Sdorra * @since 1.37 */ @Extension diff --git a/scm-webapp/src/main/java/sonia/scm/repository/RepositoryManagerProvider.java b/scm-webapp/src/main/java/sonia/scm/repository/RepositoryManagerProvider.java index 004b321e5f..694691212f 100644 --- a/scm-webapp/src/main/java/sonia/scm/repository/RepositoryManagerProvider.java +++ b/scm-webapp/src/main/java/sonia/scm/repository/RepositoryManagerProvider.java @@ -24,7 +24,6 @@ package sonia.scm.repository; -//~--- non-JDK imports -------------------------------------------------------- import com.google.inject.Inject; import com.google.inject.Provider; @@ -32,23 +31,18 @@ import com.google.inject.Provider; import sonia.scm.Undecorated; import sonia.scm.util.Decorators; -//~--- JDK imports ------------------------------------------------------------ - import java.util.Set; -/** - * - * @author Sebastian Sdorra - */ + public class RepositoryManagerProvider implements Provider { + @Inject(optional = true) + private Set decoratorFactories; - /** - * Method description - * - * - * @return - */ + @Inject + @Undecorated + private Provider repositoryManagerProvider; + @Override public RepositoryManager get() { @@ -56,40 +50,19 @@ public class RepositoryManagerProvider implements Provider decoratorFactories); } - //~--- set methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param decoratorFactories - */ + public void setDecoratorFactories( Set decoratorFactories) { this.decoratorFactories = decoratorFactories; } - /** - * Method description - * - * - * @param repositoryManagerProvider - */ + public void setRepositoryManagerProvider( Provider repositoryManagerProvider) { this.repositoryManagerProvider = repositoryManagerProvider; } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - @Inject(optional = true) - private Set decoratorFactories; - - /** Field description */ - @Inject - @Undecorated - private Provider repositoryManagerProvider; } diff --git a/scm-webapp/src/main/java/sonia/scm/repository/RepositoryMatcher.java b/scm-webapp/src/main/java/sonia/scm/repository/RepositoryMatcher.java index bee71c57a9..941c039e9e 100644 --- a/scm-webapp/src/main/java/sonia/scm/repository/RepositoryMatcher.java +++ b/scm-webapp/src/main/java/sonia/scm/repository/RepositoryMatcher.java @@ -37,7 +37,6 @@ import java.util.Set; /** * RepositoryMatcher is able to check if a repository matches the requested path. * - * @author Sebastian Sdorra * @since 1.54 */ public final class RepositoryMatcher { diff --git a/scm-webapp/src/main/java/sonia/scm/security/AuthorizationChangedEventProducer.java b/scm-webapp/src/main/java/sonia/scm/security/AuthorizationChangedEventProducer.java index 694599ba13..0053c88eae 100644 --- a/scm-webapp/src/main/java/sonia/scm/security/AuthorizationChangedEventProducer.java +++ b/scm-webapp/src/main/java/sonia/scm/security/AuthorizationChangedEventProducer.java @@ -53,21 +53,15 @@ import java.util.Collection; * Receives all kinds of events, which affects authorization relevant data and fires an * {@link AuthorizationChangedEvent} if authorization data has changed. * - * @author Sebastian Sdorra * @since 1.52 */ @Singleton @EagerSingleton public class AuthorizationChangedEventProducer { - /** - * the logger for AuthorizationChangedEventProducer - */ + private static final Logger logger = LoggerFactory.getLogger(AuthorizationChangedEventProducer.class); - /** - * Constructs a new instance. - */ public AuthorizationChangedEventProducer() { } diff --git a/scm-webapp/src/main/java/sonia/scm/security/BearerRealm.java b/scm-webapp/src/main/java/sonia/scm/security/BearerRealm.java index 83e11e36fb..e7a0d45e6d 100644 --- a/scm-webapp/src/main/java/sonia/scm/security/BearerRealm.java +++ b/scm-webapp/src/main/java/sonia/scm/security/BearerRealm.java @@ -43,7 +43,6 @@ import static com.google.common.base.Preconditions.checkArgument; /** * Realm for authentication with {@link BearerToken}. * - * @author Sebastian Sdorra * @since 2.0.0 */ @Singleton @@ -58,12 +57,7 @@ public class BearerRealm extends AuthenticatingRealm { private final DAORealmHelper helper; private final AccessTokenResolver tokenResolver; - /** - * Constructs ... - * - * @param helperFactory dao realm helper factory - * @param tokenResolver resolve access token from bearer - */ + @Inject public BearerRealm(DAORealmHelperFactory helperFactory, AccessTokenResolver tokenResolver) { this.helper = helperFactory.create(REALM); diff --git a/scm-webapp/src/main/java/sonia/scm/security/ConfigurableLoginAttemptHandler.java b/scm-webapp/src/main/java/sonia/scm/security/ConfigurableLoginAttemptHandler.java index 1b24cd101e..3f14e02e9c 100644 --- a/scm-webapp/src/main/java/sonia/scm/security/ConfigurableLoginAttemptHandler.java +++ b/scm-webapp/src/main/java/sonia/scm/security/ConfigurableLoginAttemptHandler.java @@ -42,25 +42,20 @@ import java.util.concurrent.TimeUnit; /** * Configurable implementation of {@link LoginAttemptHandler}. * - * @author Sebastian Sdorra * @since 1.34 */ @Singleton public class ConfigurableLoginAttemptHandler implements LoginAttemptHandler { - /** - * the logger for ConfigurableLoginAttemptHandler - */ + private static final Logger LOG = LoggerFactory.getLogger(ConfigurableLoginAttemptHandler.class); - //~--- fields --------------------------------------------------------------- - + private final ConcurrentMap attempts = new ConcurrentHashMap<>(); private final ScmConfiguration configuration; - //~--- constructors --------------------------------------------------------- /** * Constructs a new instance. @@ -72,7 +67,6 @@ public class ConfigurableLoginAttemptHandler implements LoginAttemptHandler { this.configuration = configuration; } - //~--- methods -------------------------------------------------------------- @Override public void beforeAuthentication(AuthenticationToken token) throws AuthenticationException { @@ -130,7 +124,6 @@ public class ConfigurableLoginAttemptHandler implements LoginAttemptHandler { attempt.increase(); } - //~--- get methods ---------------------------------------------------------- private LoginAttempt getAttempt(AuthenticationToken token){ LoginAttempt freshAttempt = new LoginAttempt(); @@ -151,7 +144,7 @@ public class ConfigurableLoginAttemptHandler implements LoginAttemptHandler { return (configuration.getLoginAttemptLimit() > 0) && (configuration.getLoginAttemptLimitTimeout() > 0l); } - //~--- inner classes -------------------------------------------------------- + private static class LoginAttempt { diff --git a/scm-webapp/src/main/java/sonia/scm/security/DefaultAccessTokenCookieIssuer.java b/scm-webapp/src/main/java/sonia/scm/security/DefaultAccessTokenCookieIssuer.java index 5114756f9f..f04b04fc37 100644 --- a/scm-webapp/src/main/java/sonia/scm/security/DefaultAccessTokenCookieIssuer.java +++ b/scm-webapp/src/main/java/sonia/scm/security/DefaultAccessTokenCookieIssuer.java @@ -45,14 +45,11 @@ import static sonia.scm.initialization.InitializationWebTokenGenerator.INIT_TOKE /** * Generates cookies and invalidates access token cookies. * - * @author Sebastian Sdorra * @since 2.0.0 */ public final class DefaultAccessTokenCookieIssuer implements AccessTokenCookieIssuer, InitializationCookieIssuer { - /** - * the logger for DefaultAccessTokenCookieIssuer - */ + private static final Logger LOG = LoggerFactory.getLogger(DefaultAccessTokenCookieIssuer.class); private static final int DEFAULT_COOKIE_EXPIRATION_AMOUNT = 365; diff --git a/scm-webapp/src/main/java/sonia/scm/security/DefaultAuthorizationCollector.java b/scm-webapp/src/main/java/sonia/scm/security/DefaultAuthorizationCollector.java index 93fdd4b9fc..c342a2cca1 100644 --- a/scm-webapp/src/main/java/sonia/scm/security/DefaultAuthorizationCollector.java +++ b/scm-webapp/src/main/java/sonia/scm/security/DefaultAuthorizationCollector.java @@ -291,7 +291,6 @@ public class DefaultAuthorizationCollector implements AuthorizationCollector { return UserPermissions.read(user.getName()).asShiroString(); } - //~--- get methods ---------------------------------------------------------- private boolean isUserPermitted(User user, Set groups, PermissionObject perm) diff --git a/scm-webapp/src/main/java/sonia/scm/security/DefaultKeyGenerator.java b/scm-webapp/src/main/java/sonia/scm/security/DefaultKeyGenerator.java index 8ea513f782..25e012c82a 100644 --- a/scm-webapp/src/main/java/sonia/scm/security/DefaultKeyGenerator.java +++ b/scm-webapp/src/main/java/sonia/scm/security/DefaultKeyGenerator.java @@ -24,7 +24,6 @@ package sonia.scm.security; -//~--- non-JDK imports -------------------------------------------------------- import com.google.inject.Singleton; @@ -33,50 +32,32 @@ import org.slf4j.LoggerFactory; import sonia.scm.util.Base62; -//~--- JDK imports ------------------------------------------------------------ - import java.util.Random; import java.util.concurrent.atomic.AtomicLong; -/** - * - * @author Sebastian Sdorra - */ + @Singleton public class DefaultKeyGenerator implements KeyGenerator { - /** Field description */ private static final int RANDOM_MAX = 999; - /** Field description */ private static final int RANDOM_MIN = 100; - /** - * the logger for DefaultKeyGenerator - */ + private static final Logger logger = LoggerFactory.getLogger(DefaultKeyGenerator.class); - //~--- methods -------------------------------------------------------------- + private final AtomicLong sessionKey = new AtomicLong(); + + private final Random random = new Random(); - /** - * Method description - * - * - * @param args - */ public static void main(String[] args) { System.out.println(new DefaultKeyGenerator().createKey()); } - /** - * Method description - * - * - * @return - */ + @Override public String createKey() { @@ -107,11 +88,4 @@ public class DefaultKeyGenerator implements KeyGenerator return random.nextInt(RANDOM_MAX - RANDOM_MIN + 1) + RANDOM_MIN; } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private final AtomicLong sessionKey = new AtomicLong(); - - /** Field description */ - private final Random random = new Random(); } diff --git a/scm-webapp/src/main/java/sonia/scm/security/DefaultRealm.java b/scm-webapp/src/main/java/sonia/scm/security/DefaultRealm.java index dd99870a8f..69def1336f 100644 --- a/scm-webapp/src/main/java/sonia/scm/security/DefaultRealm.java +++ b/scm-webapp/src/main/java/sonia/scm/security/DefaultRealm.java @@ -24,7 +24,6 @@ package sonia.scm.security; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.annotations.VisibleForTesting; import jakarta.inject.Inject; @@ -49,7 +48,6 @@ import java.util.Set; /** * Default authorizing realm. * - * @author Sebastian Sdorra * @since 2.0.0 */ @Extension diff --git a/scm-webapp/src/main/java/sonia/scm/security/DefaultSecuritySystem.java b/scm-webapp/src/main/java/sonia/scm/security/DefaultSecuritySystem.java index da827f828f..6eb3af4fb6 100644 --- a/scm-webapp/src/main/java/sonia/scm/security/DefaultSecuritySystem.java +++ b/scm-webapp/src/main/java/sonia/scm/security/DefaultSecuritySystem.java @@ -67,7 +67,6 @@ import static java.util.Objects.isNull; /** - * @author Sebastian Sdorra * @since 1.31 */ @Singleton diff --git a/scm-webapp/src/main/java/sonia/scm/security/DisabledRememberMeManager.java b/scm-webapp/src/main/java/sonia/scm/security/DisabledRememberMeManager.java index 4ac3aca980..c15227e71e 100644 --- a/scm-webapp/src/main/java/sonia/scm/security/DisabledRememberMeManager.java +++ b/scm-webapp/src/main/java/sonia/scm/security/DisabledRememberMeManager.java @@ -21,10 +21,9 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ - + package sonia.scm.security; -//~--- non-JDK imports -------------------------------------------------------- import org.apache.shiro.authc.AuthenticationException; import org.apache.shiro.authc.AuthenticationInfo; @@ -39,7 +38,6 @@ import org.apache.shiro.subject.SubjectContext; * DisabledRememberMeManager is used to disable the cookie creation of the * default {@link RememberMeManager}. * - * @author Sebastian Sdorra * @since 2.0.0 */ public class DisabledRememberMeManager implements RememberMeManager @@ -47,9 +45,6 @@ public class DisabledRememberMeManager implements RememberMeManager /** * The implementation does nothing. - * - * - * @param subjectContext subject context */ @Override public void forgetIdentity(SubjectContext subjectContext) @@ -60,11 +55,6 @@ public class DisabledRememberMeManager implements RememberMeManager /** * The implementation does nothing. - * - * - * @param subject subject - * @param token authentication token - * @param ae authentication exception */ @Override public void onFailedLogin(Subject subject, AuthenticationToken token, @@ -76,9 +66,6 @@ public class DisabledRememberMeManager implements RememberMeManager /** * The implementation does nothing. - * - * - * @param subject subject */ @Override public void onLogout(Subject subject) @@ -89,11 +76,6 @@ public class DisabledRememberMeManager implements RememberMeManager /** * The implementation does nothing. - * - * - * @param subject subject - * @param token authentication token - * @param info authentication info */ @Override public void onSuccessfulLogin(Subject subject, AuthenticationToken token, @@ -103,15 +85,9 @@ public class DisabledRememberMeManager implements RememberMeManager // do nothing } - //~--- get methods ---------------------------------------------------------- /** * The implementation returns always {@code null}. - * - * - * @param subjectContext subject context - * - * @return always {@code null} */ @Override public PrincipalCollection getRememberedPrincipals( diff --git a/scm-webapp/src/main/java/sonia/scm/security/JwtAccessToken.java b/scm-webapp/src/main/java/sonia/scm/security/JwtAccessToken.java index ebd6e2bd84..8d3e4a480e 100644 --- a/scm-webapp/src/main/java/sonia/scm/security/JwtAccessToken.java +++ b/scm-webapp/src/main/java/sonia/scm/security/JwtAccessToken.java @@ -38,7 +38,6 @@ import static java.util.Optional.ofNullable; /** * Jwt implementation of {@link AccessToken}. * - * @author Sebastian Sdorra * @since 2.0.0 */ public final class JwtAccessToken implements AccessToken { diff --git a/scm-webapp/src/main/java/sonia/scm/security/JwtAccessTokenBuilder.java b/scm-webapp/src/main/java/sonia/scm/security/JwtAccessTokenBuilder.java index 2f7fba69b9..6da6083890 100644 --- a/scm-webapp/src/main/java/sonia/scm/security/JwtAccessTokenBuilder.java +++ b/scm-webapp/src/main/java/sonia/scm/security/JwtAccessTokenBuilder.java @@ -48,14 +48,11 @@ import java.util.concurrent.TimeUnit; /** * Jwt implementation of {@link AccessTokenBuilder}. * - * @author Sebastian Sdorra * @since 2.0.0 */ public final class JwtAccessTokenBuilder implements AccessTokenBuilder { - /** - * the logger for JwtAccessTokenBuilder - */ + private static final Logger LOG = LoggerFactory.getLogger(JwtAccessTokenBuilder.class); @VisibleForTesting diff --git a/scm-webapp/src/main/java/sonia/scm/security/JwtAccessTokenBuilderFactory.java b/scm-webapp/src/main/java/sonia/scm/security/JwtAccessTokenBuilderFactory.java index d4e6faa7c9..5a53ed4cab 100644 --- a/scm-webapp/src/main/java/sonia/scm/security/JwtAccessTokenBuilderFactory.java +++ b/scm-webapp/src/main/java/sonia/scm/security/JwtAccessTokenBuilderFactory.java @@ -33,7 +33,6 @@ import java.util.Set; /** * Jwt implementation of {@link AccessTokenBuilderFactory}. * - * @author Sebastian Sdorra * @since 2.0.0 */ @Extension diff --git a/scm-webapp/src/main/java/sonia/scm/security/JwtAccessTokenResolver.java b/scm-webapp/src/main/java/sonia/scm/security/JwtAccessTokenResolver.java index 68a749626c..7fc8de5fb9 100644 --- a/scm-webapp/src/main/java/sonia/scm/security/JwtAccessTokenResolver.java +++ b/scm-webapp/src/main/java/sonia/scm/security/JwtAccessTokenResolver.java @@ -39,15 +39,12 @@ import java.util.Set; /** * Jwt implementation of {@link AccessTokenResolver}. * - * @author Sebastian Sdorra * @since 2.0.0 */ @Extension public final class JwtAccessTokenResolver implements AccessTokenResolver { - /** - * the logger for JwtAccessTokenResolver - */ + private static final Logger LOG = LoggerFactory.getLogger(JwtAccessTokenResolver.class); private final SecureKeyResolver keyResolver; diff --git a/scm-webapp/src/main/java/sonia/scm/security/Scopes.java b/scm-webapp/src/main/java/sonia/scm/security/Scopes.java index 8e4abbbd7d..bb6b382ab4 100644 --- a/scm-webapp/src/main/java/sonia/scm/security/Scopes.java +++ b/scm-webapp/src/main/java/sonia/scm/security/Scopes.java @@ -41,7 +41,6 @@ import java.util.stream.Collectors; /** * Util methods for {@link Scope}. * - * @author Sebastian Sdorra * @since 2.0.0 */ public final class Scopes { diff --git a/scm-webapp/src/main/java/sonia/scm/security/SecureKey.java b/scm-webapp/src/main/java/sonia/scm/security/SecureKey.java index e0e1e56615..75ba0f5d9f 100644 --- a/scm-webapp/src/main/java/sonia/scm/security/SecureKey.java +++ b/scm-webapp/src/main/java/sonia/scm/security/SecureKey.java @@ -24,51 +24,39 @@ package sonia.scm.security; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Objects; import jakarta.xml.bind.annotation.XmlAccessType; import jakarta.xml.bind.annotation.XmlAccessorType; import jakarta.xml.bind.annotation.XmlRootElement; -//~--- JDK imports ------------------------------------------------------------ - /** * Secure key can be used for singing messages and tokens. * - * @author Sebastian Sdorra * @since 2.0.0 */ @XmlRootElement(name = "secure-key") @XmlAccessorType(XmlAccessType.FIELD) public final class SecureKey { + /** bytes of key */ + private byte[] bytes; + + private long creationDate; /** - * Constructs a new secure key. * This constructor should only be used by jaxb. - * */ SecureKey() {} - /** - * Constructs a new secure key. - * - * - * @param bytes bytes of key - * @param creationDate creation date - */ public SecureKey(byte[] bytes, long creationDate) { this.bytes = bytes; this.creationDate = creationDate; } - //~--- methods -------------------------------------------------------------- - /** - * {@inheritDoc} - */ + @Override public boolean equals(Object obj) { @@ -88,44 +76,22 @@ public final class SecureKey && Objects.equal(creationDate, other.creationDate); } - /** - * {@inheritDoc} - */ + @Override public int hashCode() { return Objects.hashCode(bytes, creationDate); } - //~--- get methods ---------------------------------------------------------- - /** - * Returns the bytes of the key. - * - * - * @return bytes of key - */ public byte[] getBytes() { return bytes; } - /** - * Returns the creation date of the key. - * - * - * @return key creation date - */ public long getCreationDate() { return creationDate; } - //~--- fields --------------------------------------------------------------- - - /** bytes of key */ - private byte[] bytes; - - /** creation date */ - private long creationDate; } diff --git a/scm-webapp/src/main/java/sonia/scm/security/SecureKeyResolver.java b/scm-webapp/src/main/java/sonia/scm/security/SecureKeyResolver.java index 506debccde..58e3d26619 100644 --- a/scm-webapp/src/main/java/sonia/scm/security/SecureKeyResolver.java +++ b/scm-webapp/src/main/java/sonia/scm/security/SecureKeyResolver.java @@ -24,7 +24,6 @@ package sonia.scm.security; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.annotations.VisibleForTesting; import com.google.common.base.Strings; @@ -49,34 +48,30 @@ import static com.google.common.base.Preconditions.checkNotNull; /** * Resolve secure keys which can be used for signing token and messages. * - * @author Sebastian Sdorra * @since 2.0.0 */ @Singleton public class SecureKeyResolver extends SigningKeyResolverAdapter { - /** key length */ private static final int KEY_LENGTH = 64; /** name of the configuration store */ @VisibleForTesting static final String STORE_NAME = "keys"; - /** - * the logger for SecureKeyResolver - */ + private static final Logger logger = LoggerFactory.getLogger(SecureKeyResolver.class); - //~--- constructors --------------------------------------------------------- + /** secure randon */ + private final Random random; + + /** configuration entry store */ + private final ConfigurationEntryStore store; + + private final JwtSettingsStore jwtSettingsStore; - /** - * Constructs a new SecureKeyResolver - * - * - * @param storeFactory store factory - */ @Inject @SuppressWarnings("unchecked") public SecureKeyResolver(ConfigurationEntryStoreFactory storeFactory, JwtSettingsStore jwtSettingsStore) { @@ -93,11 +88,8 @@ public class SecureKeyResolver extends SigningKeyResolverAdapter this.random = random; } - //~--- methods -------------------------------------------------------------- - /** - * {@inheritDoc} - */ + @Override public byte[] resolveSigningKeyBytes(JwsHeader header, Claims claims) { @@ -110,7 +102,6 @@ public class SecureKeyResolver extends SigningKeyResolverAdapter return getSecureKey(subject).getBytes(); } - //~--- get methods ---------------------------------------------------------- /** * Returns the secure key for the given subject, if there is no key for the @@ -118,7 +109,6 @@ public class SecureKeyResolver extends SigningKeyResolverAdapter * * @param subject subject * - * @return secure key */ public SecureKey getSecureKey(String subject) { @@ -140,14 +130,6 @@ public class SecureKeyResolver extends SigningKeyResolverAdapter return key.getCreationDate() < settings.getKeysValidAfterTimestampInMs(); } - //~--- methods -------------------------------------------------------------- - - /** - * Creates a new secure key. - * - * - * @return new secure key - */ private SecureKey createNewKey() { byte[] bytes = new byte[KEY_LENGTH]; @@ -157,13 +139,4 @@ public class SecureKeyResolver extends SigningKeyResolverAdapter return new SecureKey(bytes, System.currentTimeMillis()); } - //~--- fields --------------------------------------------------------------- - - /** secure randon */ - private final Random random; - - /** configuration entry store */ - private final ConfigurationEntryStore store; - - private final JwtSettingsStore jwtSettingsStore; } diff --git a/scm-webapp/src/main/java/sonia/scm/security/SecurityRequests.java b/scm-webapp/src/main/java/sonia/scm/security/SecurityRequests.java index fcd455c5cb..76e4de7886 100644 --- a/scm-webapp/src/main/java/sonia/scm/security/SecurityRequests.java +++ b/scm-webapp/src/main/java/sonia/scm/security/SecurityRequests.java @@ -30,9 +30,6 @@ import java.util.regex.Pattern; import static sonia.scm.api.v2.resources.ScmPathInfo.REST_API_PATH; -/** - * Created by masuewer on 04.07.18. - */ public final class SecurityRequests { private static final Pattern URI_LOGIN_PATTERN = Pattern.compile(REST_API_PATH + "(?:/v2)?/auth/access_token"); diff --git a/scm-webapp/src/main/java/sonia/scm/security/XsrfAccessTokenEnricher.java b/scm-webapp/src/main/java/sonia/scm/security/XsrfAccessTokenEnricher.java index d664bbe5c4..81b89c2242 100644 --- a/scm-webapp/src/main/java/sonia/scm/security/XsrfAccessTokenEnricher.java +++ b/scm-webapp/src/main/java/sonia/scm/security/XsrfAccessTokenEnricher.java @@ -44,16 +44,13 @@ import java.util.UUID; * enabled. The xsrf field will be validated on every request by the {@link XsrfAccessTokenValidator}. Xsrf protection * can be disabled with {@link ScmConfiguration#setEnabledXsrfProtection(boolean)}. * - * @author Sebastian Sdorra * @see Issue 793 * @since 2.0.0 */ @Extension public class XsrfAccessTokenEnricher implements AccessTokenEnricher { - /** - * the logger for XsrfAccessTokenEnricher - */ + private static final Logger LOG = LoggerFactory.getLogger(XsrfAccessTokenEnricher.class); private final ScmConfiguration configuration; diff --git a/scm-webapp/src/main/java/sonia/scm/security/XsrfAccessTokenValidator.java b/scm-webapp/src/main/java/sonia/scm/security/XsrfAccessTokenValidator.java index 23f979c480..e1e0e749f9 100644 --- a/scm-webapp/src/main/java/sonia/scm/security/XsrfAccessTokenValidator.java +++ b/scm-webapp/src/main/java/sonia/scm/security/XsrfAccessTokenValidator.java @@ -39,7 +39,6 @@ import java.util.Set; * equal to the one in the access token. If the token does not contain a xsrf key, the check is passed by. The xsrf keys * are added by the {@link XsrfAccessTokenEnricher}. * - * @author Sebastian Sdorra * @since 2.0.0 */ @Extension @@ -52,12 +51,6 @@ public class XsrfAccessTokenValidator implements AccessTokenValidator { private final Provider requestProvider; private final XsrfExcludes excludes; - /** - * Constructs a new instance. - * - * @param requestProvider http request provider - * @param excludes - */ @Inject public XsrfAccessTokenValidator(Provider requestProvider, XsrfExcludes excludes) { this.requestProvider = requestProvider; diff --git a/scm-webapp/src/main/java/sonia/scm/template/MustacheTemplate.java b/scm-webapp/src/main/java/sonia/scm/template/MustacheTemplate.java index b933a62a36..63f6c219fc 100644 --- a/scm-webapp/src/main/java/sonia/scm/template/MustacheTemplate.java +++ b/scm-webapp/src/main/java/sonia/scm/template/MustacheTemplate.java @@ -32,14 +32,10 @@ import org.slf4j.LoggerFactory; import java.io.IOException; import java.io.Writer; -/** - * @author Sebastian Sdorra - */ + public class MustacheTemplate implements Template { - /** - * the logger for MustacheTemplae - */ + private static final Logger logger = LoggerFactory.getLogger(MustacheTemplate.class); diff --git a/scm-webapp/src/main/java/sonia/scm/template/MustacheTemplateEngine.java b/scm-webapp/src/main/java/sonia/scm/template/MustacheTemplateEngine.java index c6b45372fd..758e9eea4f 100644 --- a/scm-webapp/src/main/java/sonia/scm/template/MustacheTemplateEngine.java +++ b/scm-webapp/src/main/java/sonia/scm/template/MustacheTemplateEngine.java @@ -24,7 +24,6 @@ package sonia.scm.template; -//~--- non-JDK imports -------------------------------------------------------- import com.github.mustachejava.Mustache; import com.github.mustachejava.MustacheException; @@ -46,12 +45,7 @@ import java.io.Reader; import java.util.concurrent.ExecutorService; import java.util.concurrent.Executors; -//~--- JDK imports ------------------------------------------------------------ -/** - * - * @author Sebastian Sdorra - */ @Default public class MustacheTemplateEngine implements TemplateEngine { @@ -72,16 +66,15 @@ public class MustacheTemplateEngine implements TemplateEngine @Inject(optional = true) MeterRegistry registry; } - /** Field description */ public static final TemplateType TYPE = new TemplateType("mustache", "Mustache", "mustache"); - /** - * the logger for MustacheTemplateEngine - */ + private static final Logger logger = LoggerFactory.getLogger(MustacheTemplateEngine.class); + private final ServletMustacheFactory factory; + @Inject public MustacheTemplateEngine(@Default ServletContext context, PluginLoaderHolder pluginLoaderHolder, MeterRegistryHolder registryHolder) { @@ -110,18 +103,7 @@ public class MustacheTemplateEngine implements TemplateEngine return pluginLoader.getUberClassLoader(); } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param templateIdentifier - * @param reader - * - * @return - * - */ @Override public Template getTemplate(String templateIdentifier, Reader reader) { if (logger.isTraceEnabled()) @@ -135,16 +117,7 @@ public class MustacheTemplateEngine implements TemplateEngine return new MustacheTemplate(templateIdentifier, mustache); } - /** - * Method description - * - * - * @param templatePath - * - * @return - * - * @throws IOException - */ + @Override public Template getTemplate(String templatePath) throws IOException { @@ -194,29 +167,15 @@ public class MustacheTemplateEngine implements TemplateEngine return template; } - /** - * Method description - * - * - * @return - */ + @Override public TemplateType getType() { return TYPE; } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param ex - * @param templatePath - * - * @throws IOException - */ + private void handleWrappedException(Exception ex, String templatePath) throws IOException { @@ -235,8 +194,4 @@ public class MustacheTemplateEngine implements TemplateEngine } } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private final ServletMustacheFactory factory; } diff --git a/scm-webapp/src/main/java/sonia/scm/template/MustacheTemplateNotFoundException.java b/scm-webapp/src/main/java/sonia/scm/template/MustacheTemplateNotFoundException.java index 8f9df55e6b..8fce85c38e 100644 --- a/scm-webapp/src/main/java/sonia/scm/template/MustacheTemplateNotFoundException.java +++ b/scm-webapp/src/main/java/sonia/scm/template/MustacheTemplateNotFoundException.java @@ -24,53 +24,28 @@ package sonia.scm.template; -/** - * - * @author Sebastian Sdorra - */ + public final class MustacheTemplateNotFoundException extends RuntimeException { - /** Field description */ private static final long serialVersionUID = -1998700779900576217L; - //~--- constructors --------------------------------------------------------- - /** - * Constructs ... - * - */ public MustacheTemplateNotFoundException() {} - /** - * Constructs ... - * - * - * @param message - */ + public MustacheTemplateNotFoundException(String message) { super(message); } - /** - * Constructs ... - * - * - * @param cause - */ + public MustacheTemplateNotFoundException(Throwable cause) { super(cause); } - /** - * Constructs ... - * - * - * @param message - * @param cause - */ + public MustacheTemplateNotFoundException(String message, Throwable cause) { super(message, cause); diff --git a/scm-webapp/src/main/java/sonia/scm/template/ServletMustacheFactory.java b/scm-webapp/src/main/java/sonia/scm/template/ServletMustacheFactory.java index 3fd0ad5e7f..7e46b37f29 100644 --- a/scm-webapp/src/main/java/sonia/scm/template/ServletMustacheFactory.java +++ b/scm-webapp/src/main/java/sonia/scm/template/ServletMustacheFactory.java @@ -24,7 +24,6 @@ package sonia.scm.template; -//~--- non-JDK imports -------------------------------------------------------- import com.github.mustachejava.DefaultMustacheFactory; import com.google.common.base.Charsets; @@ -37,46 +36,26 @@ import java.io.InputStream; import java.io.InputStreamReader; import java.io.Reader; -//~--- JDK imports ------------------------------------------------------------ -/** - * - * @author Sebastian Sdorra - */ public class ServletMustacheFactory extends DefaultMustacheFactory { - /** - * the logger for ServletMustacheFactory - */ + private static final Logger logger = LoggerFactory.getLogger(ServletMustacheFactory.class); - //~--- constructors --------------------------------------------------------- + private ServletContext servletContext; - /** - * Constructs ... - * - * - * @param servletContext - * @param classLoader - */ + private ClassLoader classLoader; + public ServletMustacheFactory(ServletContext servletContext, ClassLoader classLoader) { this.servletContext = servletContext; this.classLoader = classLoader; } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param resourceName - * - * @return - */ + @Override public Reader getReader(String resourceName) { @@ -127,10 +106,4 @@ public class ServletMustacheFactory extends DefaultMustacheFactory return reader; } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private ServletContext servletContext; - - private ClassLoader classLoader; } diff --git a/scm-webapp/src/main/java/sonia/scm/template/TemplateServlet.java b/scm-webapp/src/main/java/sonia/scm/template/TemplateServlet.java index 10077325ae..acb0f9082c 100644 --- a/scm-webapp/src/main/java/sonia/scm/template/TemplateServlet.java +++ b/scm-webapp/src/main/java/sonia/scm/template/TemplateServlet.java @@ -24,7 +24,6 @@ package sonia.scm.template; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.collect.ImmutableSet; import com.google.inject.Inject; @@ -45,46 +44,30 @@ import java.util.Locale; import java.util.Map; import java.util.Set; -//~--- JDK imports ------------------------------------------------------------ -/** - * - * @author Sebastian Sdorra - */ @Singleton public class TemplateServlet extends HttpServlet { - /** Field description */ public static final String CONTENT_TYPE = "text/html"; - /** Field description */ public static final String ENCODING = "UTF-8"; - /** Field description */ private static final long serialVersionUID = 3578555653924091546L; - /** - * the logger for TemplateServlet - */ + private static final Logger logger = LoggerFactory.getLogger(TemplateServlet.class); - /** Field description */ private static final Set DEFAULT_LOCALE = ImmutableSet.of(Locale.ENGLISH, Locale.UK, Locale.US); - //~--- constructors --------------------------------------------------------- + private final ScmConfiguration configuration; + + private final TemplateEngineFactory templateEngineFactory; + + private final String version; - /** - * Constructs ... - * - * - * - * @param context - * @param templateEngineFactory - * @param configuration - */ @Inject public TemplateServlet(SCMContextProvider context, TemplateEngineFactory templateEngineFactory, ScmConfiguration configuration) @@ -94,17 +77,8 @@ public class TemplateServlet extends HttpServlet this.version = context.getVersion(); } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param request - * @param response - * - * @throws IOException - */ + @Override protected void doGet(HttpServletRequest request, HttpServletResponse response) throws IOException { @@ -182,17 +156,8 @@ public class TemplateServlet extends HttpServlet } } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param contextPath - * @param requestURI - * - * @return - */ + private String getTemplateName(String contextPath, String requestURI) { String path = requestURI.substring(contextPath.length()); @@ -214,14 +179,4 @@ public class TemplateServlet extends HttpServlet return path; } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private final ScmConfiguration configuration; - - /** Field description */ - private final TemplateEngineFactory templateEngineFactory; - - /** Field description */ - private final String version; } diff --git a/scm-webapp/src/main/java/sonia/scm/user/DefaultUserManager.java b/scm-webapp/src/main/java/sonia/scm/user/DefaultUserManager.java index d4967eaead..573cf802f1 100644 --- a/scm-webapp/src/main/java/sonia/scm/user/DefaultUserManager.java +++ b/scm-webapp/src/main/java/sonia/scm/user/DefaultUserManager.java @@ -52,9 +52,7 @@ import java.util.List; import java.util.Set; import java.util.function.Predicate; -/** - * @author Sebastian Sdorra - */ + @Singleton @EagerSingleton public class DefaultUserManager extends AbstractUserManager { @@ -223,7 +221,6 @@ public class DefaultUserManager extends AbstractUserManager { return userDAO.getLastModified(); } - //~--- methods -------------------------------------------------------------- @Override public void changePasswordForLoggedInUser(String oldPassword, String newPassword) { diff --git a/scm-webapp/src/main/java/sonia/scm/user/UserEventHack.java b/scm-webapp/src/main/java/sonia/scm/user/UserEventHack.java index 6e13f4936b..ef5075759c 100644 --- a/scm-webapp/src/main/java/sonia/scm/user/UserEventHack.java +++ b/scm-webapp/src/main/java/sonia/scm/user/UserEventHack.java @@ -24,44 +24,25 @@ package sonia.scm.user; -//~--- non-JDK imports -------------------------------------------------------- import org.slf4j.Logger; import org.slf4j.LoggerFactory; import sonia.scm.HandlerEventType; -/** - * - * @author Sebastian Sdorra - */ + public final class UserEventHack { - /** - * the logger for UserEventHack - */ + private static final Logger logger = LoggerFactory.getLogger(UserEventHack.class); - //~--- constructors --------------------------------------------------------- - /** - * Constructs ... - * - */ private UserEventHack() {} - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param userManager - * @param user - * @param event - */ + public static void fireEvent(UserManager userManager, HandlerEventType event, User user) { @@ -78,16 +59,8 @@ public final class UserEventHack } } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param userManager - * - * @return - */ + private static AbstractUserManager getAbstractUserManager( UserManager userManager) { diff --git a/scm-webapp/src/main/java/sonia/scm/user/UserManagerProvider.java b/scm-webapp/src/main/java/sonia/scm/user/UserManagerProvider.java index 8df359a3d5..d38042610d 100644 --- a/scm-webapp/src/main/java/sonia/scm/user/UserManagerProvider.java +++ b/scm-webapp/src/main/java/sonia/scm/user/UserManagerProvider.java @@ -24,7 +24,6 @@ package sonia.scm.user; -//~--- non-JDK imports -------------------------------------------------------- import com.google.inject.Inject; import com.google.inject.Provider; @@ -32,62 +31,36 @@ import com.google.inject.Provider; import sonia.scm.Undecorated; import sonia.scm.util.Decorators; -//~--- JDK imports ------------------------------------------------------------ - import java.util.Set; -/** - * - * @author Sebastian Sdorra - */ + public class UserManagerProvider implements Provider { + @Inject(optional = true) + private Set decoratorFactories; - /** - * Method description - * - * - * @return - */ + @Inject + @Undecorated + private Provider userManagerProvider; + @Override public UserManager get() { return Decorators.decorate(userManagerProvider.get(), decoratorFactories); } - //~--- set methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param decoratorFactories - */ + public void setDecoratorFactories( Set decoratorFactories) { this.decoratorFactories = decoratorFactories; } - /** - * Method description - * - * - * @param userManagerProvider - */ + public void setUserManagerProvider(Provider userManagerProvider) { this.userManagerProvider = userManagerProvider; } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - @Inject(optional = true) - private Set decoratorFactories; - - /** Field description */ - @Inject - @Undecorated - private Provider userManagerProvider; } diff --git a/scm-webapp/src/main/java/sonia/scm/util/DebugServlet.java b/scm-webapp/src/main/java/sonia/scm/util/DebugServlet.java index 1435a84870..7cf99fcb01 100644 --- a/scm-webapp/src/main/java/sonia/scm/util/DebugServlet.java +++ b/scm-webapp/src/main/java/sonia/scm/util/DebugServlet.java @@ -24,7 +24,6 @@ package sonia.scm.util; -//~--- non-JDK imports -------------------------------------------------------- import com.google.inject.Singleton; import jakarta.servlet.ServletContext; @@ -38,29 +37,13 @@ import java.io.IOException; import java.io.PrintWriter; import java.util.Enumeration; -/** - * - * @author Sebastian Sdorra - */ + @Singleton public class DebugServlet extends HttpServlet { - /** Field description */ private static final long serialVersionUID = -1918351712617918728L; - //~--- methods -------------------------------------------------------------- - - /** - * Method description - * - * - * @param request - * @param response - * - * @throws IOException - * @throws ServletException - */ @Override protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException @@ -68,16 +51,6 @@ public class DebugServlet extends HttpServlet processRequest(request, response); } - /** - * Method description - * - * - * @param request - * @param response - * - * @throws IOException - * @throws ServletException - */ @Override protected void doPost(HttpServletRequest request, HttpServletResponse response) @@ -86,13 +59,7 @@ public class DebugServlet extends HttpServlet processRequest(request, response); } - /** - * Method description - * - * - * @param writer - * @param context - */ + private void appendAttributes(PrintWriter writer, AttributeContext context) { writer.append("
    "); @@ -114,12 +81,7 @@ public class DebugServlet extends HttpServlet writer.append("
"); } - /** - * Method description - * - * - * @param writer - */ + @SuppressWarnings("unchecked") private void appendContextAttributes(PrintWriter writer) { @@ -142,13 +104,7 @@ public class DebugServlet extends HttpServlet }); } - /** - * Method description - * - * - * @param writer - * @param session - */ + @SuppressWarnings("unchecked") private void appendSessionAttributes(PrintWriter writer, final HttpSession session) @@ -169,23 +125,13 @@ public class DebugServlet extends HttpServlet }); } - /** - * Method description - * - * - * @param writer - */ + private void printFooter(PrintWriter writer) { writer.append(""); } - /** - * Method description - * - * - * @param writer - */ + private void printHeader(PrintWriter writer) { writer.append(""); @@ -193,16 +139,6 @@ public class DebugServlet extends HttpServlet writer.append("

SCM Manager :: Debugging

"); } - /** - * Method description - * - * - * @param request - * @param response - * - * @throws IOException - * @throws ServletException - */ private void processRequest(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException @@ -231,34 +167,14 @@ public class DebugServlet extends HttpServlet } } - //~--- inner interfaces ----------------------------------------------------- - /** - * Interface description - * - * - * @version Enter version here..., 10/10/15 - * @author Enter your name here... - */ private interface AttributeContext { - /** - * Method description - * - * - * @return - */ + public Enumeration getNames(); - /** - * Method description - * - * - * @param name - * - * @return - */ + public Object getValue(String name); } } diff --git a/scm-webapp/src/main/java/sonia/scm/web/BasicWebTokenGenerator.java b/scm-webapp/src/main/java/sonia/scm/web/BasicWebTokenGenerator.java index 15c461ec8b..9171d4401e 100644 --- a/scm-webapp/src/main/java/sonia/scm/web/BasicWebTokenGenerator.java +++ b/scm-webapp/src/main/java/sonia/scm/web/BasicWebTokenGenerator.java @@ -24,7 +24,6 @@ package sonia.scm.web; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.annotations.VisibleForTesting; import com.google.inject.Inject; @@ -45,13 +44,10 @@ import java.io.UnsupportedEncodingException; import java.nio.charset.Charset; import java.nio.charset.StandardCharsets; -//~--- JDK imports ------------------------------------------------------------ - /** * Creates a {@link UsernamePasswordToken} from an authorization header with * basic authentication. * - * @author Sebastian Sdorra * @since 2.0.0 */ @Priority(100) @@ -67,9 +63,7 @@ public class BasicWebTokenGenerator extends SchemeBasedWebTokenGenerator { /** default encoding to decode basic authentication header */ private static final Charset DEFAULT_ENCODING = StandardCharsets.ISO_8859_1; - /** - * the logger for BasicWebTokenGenerator - */ + private static final Logger logger = LoggerFactory.getLogger(BasicWebTokenGenerator.class); diff --git a/scm-webapp/src/main/java/sonia/scm/web/BearerWebTokenGenerator.java b/scm-webapp/src/main/java/sonia/scm/web/BearerWebTokenGenerator.java index 38d7321d61..0d9aaf06fc 100644 --- a/scm-webapp/src/main/java/sonia/scm/web/BearerWebTokenGenerator.java +++ b/scm-webapp/src/main/java/sonia/scm/web/BearerWebTokenGenerator.java @@ -24,7 +24,6 @@ package sonia.scm.web; -//~--- non-JDK imports -------------------------------------------------------- import jakarta.servlet.http.HttpServletRequest; import sonia.scm.plugin.Extension; @@ -36,7 +35,6 @@ import sonia.scm.util.HttpUtil; * Creates a {@link BearerToken} from an authorization header with * bearer authorization. * - * @author Sebastian Sdorra * @since 2.0.0 */ @Extension diff --git a/scm-webapp/src/main/java/sonia/scm/web/BrowserUserAgentProvider.java b/scm-webapp/src/main/java/sonia/scm/web/BrowserUserAgentProvider.java index e9725b41d7..3a2291f59e 100644 --- a/scm-webapp/src/main/java/sonia/scm/web/BrowserUserAgentProvider.java +++ b/scm-webapp/src/main/java/sonia/scm/web/BrowserUserAgentProvider.java @@ -24,70 +24,47 @@ package sonia.scm.web; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.annotations.VisibleForTesting; import com.google.common.base.Charsets; import sonia.scm.plugin.Extension; -/** - * - * @author Sebastian Sdorra - */ @Extension public class BrowserUserAgentProvider implements UserAgentProvider { - /** Field description */ @VisibleForTesting static final UserAgent CHROME = UserAgent.browser( "Chrome").basicAuthenticationCharset( Charsets.UTF_8).build(); - /** Field description */ private static final String CHROME_PATTERN = "chrome"; - /** Field description */ @VisibleForTesting static final UserAgent FIREFOX = UserAgent.browser("Firefox").build(); - /** Field description */ private static final String FIREFOX_PATTERN = "firefox"; - /** Field description */ @VisibleForTesting static final UserAgent MSIE = UserAgent.browser("Internet Explorer").build(); - /** Field description */ private static final String MSIE_PATTERN = "msie"; - /** Field description */ @VisibleForTesting // todo check charset static final UserAgent SAFARI = UserAgent.browser("Safari").build(); - /** Field description */ private static final String OPERA_PATTERN = "opera"; - /** Field description */ private static final String SAFARI_PATTERN = "safari"; - /** Field description */ @VisibleForTesting // todo check charset static final UserAgent OPERA = UserAgent.browser( "Opera").basicAuthenticationCharset( Charsets.UTF_8).build(); - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param userAgentString - * - * @return - */ + @Override public UserAgent parseUserAgent(String userAgentString) { diff --git a/scm-webapp/src/main/java/sonia/scm/web/CookieBearerWebTokenGenerator.java b/scm-webapp/src/main/java/sonia/scm/web/CookieBearerWebTokenGenerator.java index 0568b92900..118f33c0ca 100644 --- a/scm-webapp/src/main/java/sonia/scm/web/CookieBearerWebTokenGenerator.java +++ b/scm-webapp/src/main/java/sonia/scm/web/CookieBearerWebTokenGenerator.java @@ -21,10 +21,9 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ - + package sonia.scm.web; -//~--- non-JDK imports -------------------------------------------------------- import jakarta.servlet.http.Cookie; import jakarta.servlet.http.HttpServletRequest; @@ -37,7 +36,6 @@ import sonia.scm.util.HttpUtil; * Creates an {@link BearerToken} from the {@link HttpUtil#COOKIE_BEARER_AUTHENTICATION} * cookie. * - * @author Sebastian Sdorra * @since 2.0.0 */ @Extension diff --git a/scm-webapp/src/main/java/sonia/scm/web/cgi/DefaultCGIExceptionHandler.java b/scm-webapp/src/main/java/sonia/scm/web/cgi/DefaultCGIExceptionHandler.java index 1bf1eb47d1..0be5bce6b1 100644 --- a/scm-webapp/src/main/java/sonia/scm/web/cgi/DefaultCGIExceptionHandler.java +++ b/scm-webapp/src/main/java/sonia/scm/web/cgi/DefaultCGIExceptionHandler.java @@ -24,7 +24,6 @@ package sonia.scm.web.cgi; -//~--- non-JDK imports -------------------------------------------------------- import jakarta.servlet.http.HttpServletRequest; import jakarta.servlet.http.HttpServletResponse; @@ -32,27 +31,16 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; import sonia.scm.security.ScmSecurityException; -/** - * - * @author Sebastian Sdorra - */ + public class DefaultCGIExceptionHandler implements CGIExceptionHandler { - /** the logger for DefaultCGIExceptionHandler */ + private static final Logger logger = LoggerFactory.getLogger(DefaultCGIExceptionHandler.class); - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param request - * @param response - * @param exception - */ + @Override public void handleException(HttpServletRequest request, HttpServletResponse response, Throwable exception) diff --git a/scm-webapp/src/main/java/sonia/scm/web/cgi/DefaultCGIExecutor.java b/scm-webapp/src/main/java/sonia/scm/web/cgi/DefaultCGIExecutor.java index 8c5c3eefb4..ed8708fb72 100644 --- a/scm-webapp/src/main/java/sonia/scm/web/cgi/DefaultCGIExecutor.java +++ b/scm-webapp/src/main/java/sonia/scm/web/cgi/DefaultCGIExecutor.java @@ -24,7 +24,6 @@ package sonia.scm.web.cgi; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.annotations.VisibleForTesting; import com.google.common.base.Joiner; @@ -56,41 +55,35 @@ import java.util.List; import java.util.Map; import java.util.concurrent.ExecutorService; -/** - * - * @author Sebastian Sdorra - */ + public class DefaultCGIExecutor extends AbstractCGIExecutor { - /** Field description */ public static final String CGI_VERSION = "CGI/1.1"; - /** Field description */ public static final int DEFAULT_BUFFER_SIZE = 16264; - /** Field description */ public static final String SYSTEM_ROOT_WINDOWS = "C:\\WINDOWS"; - /** Field description */ private static final String SERVER_SOFTWARE_PREFIX = "scm-manager/"; - /** the logger for DefaultCGIExecutor */ + private static final Logger logger = LoggerFactory.getLogger(DefaultCGIExecutor.class); - //~--- constructors --------------------------------------------------------- + /** executor to handle error stream processing */ + private final ExecutorService executor; + + private ScmConfiguration configuration; + + private boolean contentLengthWorkaround = false; + + private ServletContext context; + + private HttpServletRequest request; + + private HttpServletResponse response; - /** - * Constructs ... - * - * - * @param executor to handle error stream processing - * @param configuration - * @param context - * @param request - * @param response - */ public DefaultCGIExecutor(ExecutorService executor, ScmConfiguration configuration, ServletContext context, HttpServletRequest request, HttpServletResponse response) @@ -106,7 +99,6 @@ public class DefaultCGIExecutor extends AbstractCGIExecutor this.environment = createEnvironment(); } - //~--- methods -------------------------------------------------------------- @Override public void execute(String cmd) @@ -176,14 +168,8 @@ public class DefaultCGIExecutor extends AbstractCGIExecutor } } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + @Override public CGIExceptionHandler getExceptionHandler() { @@ -195,12 +181,7 @@ public class DefaultCGIExecutor extends AbstractCGIExecutor return exceptionHandler; } - /** - * Method description - * - * - * @return - */ + @Override public CGIStatusCodeHandler getStatusCodeHandler() { @@ -212,41 +193,23 @@ public class DefaultCGIExecutor extends AbstractCGIExecutor return statusCodeHandler; } - /** - * Method description - * - * - * @return - */ + @Override public boolean isContentLengthWorkaround() { return contentLengthWorkaround; } - //~--- set methods ---------------------------------------------------------- - /** - * Method description - * - * - * - * @param contentLengthWorkaround - */ + @Override public void setContentLengthWorkaround(boolean contentLengthWorkaround) { this.contentLengthWorkaround = contentLengthWorkaround; } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param env - */ + private void apendOsEnvironment(EnvList env) { Map osEnv = System.getenv(); @@ -260,12 +223,7 @@ public class DefaultCGIExecutor extends AbstractCGIExecutor } } - /** - * Method description - * - * - * @return - */ + private EnvList createEnvironment() { @@ -369,14 +327,7 @@ public class DefaultCGIExecutor extends AbstractCGIExecutor return cgiContentLength; } - /** - * Method description - * - * - * @param process - * - * @throws IOException - */ + @SuppressWarnings("UnstableApiUsage") private void execute(Process process) throws IOException { @@ -447,14 +398,7 @@ public class DefaultCGIExecutor extends AbstractCGIExecutor } } - /** - * Method description - * - * - * @param in - * - * @throws IOException - */ + private void processErrorStream(InputStream in) throws IOException { if (logger.isWarnEnabled()) @@ -470,13 +414,7 @@ public class DefaultCGIExecutor extends AbstractCGIExecutor } } - /** - * Method description - * - * - * - * @param process - */ + private void processErrorStreamAsync(final Process process) { executor.execute(() -> { @@ -498,12 +436,7 @@ public class DefaultCGIExecutor extends AbstractCGIExecutor }); } - /** - * Method description - * - * - * @param process - */ + private void processServletInput(Process process) { logger.trace("process servlet input"); @@ -530,17 +463,6 @@ public class DefaultCGIExecutor extends AbstractCGIExecutor } } - /** - * Method description - * - * - * @param process - * @param output - * @param content - * - * - * @throws IOException - */ private void waitForFinish(Process process, ServletOutputStream output, long content) throws IOException @@ -580,18 +502,8 @@ public class DefaultCGIExecutor extends AbstractCGIExecutor } } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param is - * - * @return - * - * @throws IOException - */ + private String getTextLineFromStream(InputStream is) throws IOException { StringBuilder buffer = new StringBuilder(); @@ -605,23 +517,4 @@ public class DefaultCGIExecutor extends AbstractCGIExecutor return buffer.toString().trim(); } - //~--- fields --------------------------------------------------------------- - - /** executor to handle error stream processing */ - private final ExecutorService executor; - - /** Field description */ - private ScmConfiguration configuration; - - /** Field description */ - private boolean contentLengthWorkaround = false; - - /** Field description */ - private ServletContext context; - - /** Field description */ - private HttpServletRequest request; - - /** Field description */ - private HttpServletResponse response; } diff --git a/scm-webapp/src/main/java/sonia/scm/web/cgi/DefaultCGIExecutorFactory.java b/scm-webapp/src/main/java/sonia/scm/web/cgi/DefaultCGIExecutorFactory.java index 4748868571..216a415036 100644 --- a/scm-webapp/src/main/java/sonia/scm/web/cgi/DefaultCGIExecutorFactory.java +++ b/scm-webapp/src/main/java/sonia/scm/web/cgi/DefaultCGIExecutorFactory.java @@ -24,7 +24,6 @@ package sonia.scm.web.cgi; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.util.concurrent.ThreadFactoryBuilder; import io.micrometer.core.instrument.MeterRegistry; @@ -38,19 +37,16 @@ import sonia.scm.metrics.Metrics; import java.util.concurrent.ExecutorService; import java.util.concurrent.Executors; -//~--- JDK imports ------------------------------------------------------------ -/** - * - * @author Sebastian Sdorra - */ public class DefaultCGIExecutorFactory implements CGIExecutorFactory, AutoCloseable { + @Override + public void close() { + executor.shutdown(); + } + + private final ExecutorService executor; - /** - * Constructs ... - * - */ @Inject public DefaultCGIExecutorFactory(MeterRegistry registry) { this.executor = createExecutor(registry); @@ -66,19 +62,6 @@ public class DefaultCGIExecutorFactory implements CGIExecutorFactory, AutoClosea return executorService; } - //~--- methods -------------------------------------------------------------- - - /** - * Method description - * - * - * @param configuration - * @param context - * @param request - * @param response - * - * @return - */ @Override public CGIExecutor createExecutor(ScmConfiguration configuration, ServletContext context, HttpServletRequest request, @@ -88,13 +71,4 @@ public class DefaultCGIExecutorFactory implements CGIExecutorFactory, AutoClosea response); } - //~--- fields --------------------------------------------------------------- - - @Override - public void close() { - executor.shutdown(); - } - - /** Field description */ - private final ExecutorService executor; } diff --git a/scm-webapp/src/main/java/sonia/scm/web/cgi/DefaultCGIStatusCodeHandler.java b/scm-webapp/src/main/java/sonia/scm/web/cgi/DefaultCGIStatusCodeHandler.java index aa19f72384..18cd1dd2ed 100644 --- a/scm-webapp/src/main/java/sonia/scm/web/cgi/DefaultCGIStatusCodeHandler.java +++ b/scm-webapp/src/main/java/sonia/scm/web/cgi/DefaultCGIStatusCodeHandler.java @@ -24,7 +24,6 @@ package sonia.scm.web.cgi; -//~--- non-JDK imports -------------------------------------------------------- import jakarta.servlet.http.HttpServletRequest; import jakarta.servlet.http.HttpServletResponse; @@ -34,28 +33,16 @@ import org.slf4j.LoggerFactory; import java.io.IOException; import java.io.OutputStream; -/** - * - * @author Sebastian Sdorra - */ + public class DefaultCGIStatusCodeHandler implements CGIStatusCodeHandler { - /** - * the logger for DefaultCGIStatusCodeHandler - */ + private static final Logger logger = LoggerFactory.getLogger(DefaultCGIStatusCodeHandler.class); - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param request - * @param statusCode - */ + @Override public void handleStatusCode(HttpServletRequest request, int statusCode) { @@ -65,17 +52,7 @@ public class DefaultCGIStatusCodeHandler implements CGIStatusCodeHandler } } - /** - * Method description - * - * - * @param request - * @param response - * @param ouputStream - * @param statusCode - * - * @throws IOException - */ + @Override public void handleStatusCode(HttpServletRequest request, HttpServletResponse response, diff --git a/scm-webapp/src/main/java/sonia/scm/web/security/ApiAuthenticationFilter.java b/scm-webapp/src/main/java/sonia/scm/web/security/ApiAuthenticationFilter.java index 5feb9eaadd..11dc2e7ba1 100644 --- a/scm-webapp/src/main/java/sonia/scm/web/security/ApiAuthenticationFilter.java +++ b/scm-webapp/src/main/java/sonia/scm/web/security/ApiAuthenticationFilter.java @@ -24,7 +24,6 @@ package sonia.scm.web.security; -//~--- non-JDK imports -------------------------------------------------------- import com.google.inject.Inject; import jakarta.servlet.FilterChain; @@ -42,12 +41,9 @@ import sonia.scm.web.filter.AuthenticationFilter; import java.io.IOException; import java.util.Set; -//~--- JDK imports ------------------------------------------------------------ - /** * Filter to handle authentication for the rest api of SCM-Manager. * - * @author Sebastian Sdorra */ @Priority(Filters.PRIORITY_AUTHENTICATION) @WebElement(value = Filters.PATTERN_RESTAPI, @@ -55,7 +51,6 @@ import java.util.Set; public class ApiAuthenticationFilter extends AuthenticationFilter { - //~--- constructors --------------------------------------------------------- /** * Constructs a new ApiAuthenticationFilter @@ -70,7 +65,6 @@ public class ApiAuthenticationFilter extends AuthenticationFilter super(configuration, tokenGenerators); } - //~--- methods -------------------------------------------------------------- /** * The filter skips the authentication chain on the login resource, for all diff --git a/scm-webapp/src/main/java/sonia/scm/web/security/DefaultAdministrationContext.java b/scm-webapp/src/main/java/sonia/scm/web/security/DefaultAdministrationContext.java index e0de27a917..9211fbfcda 100644 --- a/scm-webapp/src/main/java/sonia/scm/web/security/DefaultAdministrationContext.java +++ b/scm-webapp/src/main/java/sonia/scm/web/security/DefaultAdministrationContext.java @@ -36,11 +36,7 @@ import sonia.scm.security.Impersonator; import sonia.scm.user.User; import sonia.scm.util.AssertUtil; -//~--- JDK imports ------------------------------------------------------------ -/** - * @author Sebastian Sdorra - */ @Singleton public class DefaultAdministrationContext implements AdministrationContext { diff --git a/scm-webapp/src/test/java/sonia/scm/api/rest/JSONContextResolverTest.java b/scm-webapp/src/test/java/sonia/scm/api/rest/JSONContextResolverTest.java index 7697a8e1cf..37a68446b0 100644 --- a/scm-webapp/src/test/java/sonia/scm/api/rest/JSONContextResolverTest.java +++ b/scm-webapp/src/test/java/sonia/scm/api/rest/JSONContextResolverTest.java @@ -51,7 +51,6 @@ import static org.junit.Assert.assertNotNull; /** * Unit tests for {@link JSONContextResolver}. * - * @author Sebastian Sdorra */ public class JSONContextResolverTest { diff --git a/scm-webapp/src/test/java/sonia/scm/cache/CacheConfigurationTestLoader.java b/scm-webapp/src/test/java/sonia/scm/cache/CacheConfigurationTestLoader.java index 8308e8a510..c0ad9276a9 100644 --- a/scm-webapp/src/test/java/sonia/scm/cache/CacheConfigurationTestLoader.java +++ b/scm-webapp/src/test/java/sonia/scm/cache/CacheConfigurationTestLoader.java @@ -24,7 +24,6 @@ package sonia.scm.cache; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Function; import com.google.common.collect.Iterators; @@ -42,21 +41,11 @@ import static java.util.Collections.emptyIterator; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; -//~--- JDK imports ------------------------------------------------------------ -/** - * - * @author Sebastian Sdorra - */ public class CacheConfigurationTestLoader implements CacheConfigurationLoader { - /** - * Constructs ... - * - * - * @param tempFolder - */ + public CacheConfigurationTestLoader(TemporaryFolder tempFolder) { this.tempFolder = tempFolder; @@ -114,14 +103,8 @@ public class CacheConfigurationTestLoader implements CacheConfigurationLoader this.manualConfiguration = manualConfiguration; } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + @Override public URL getDefaultResource() { @@ -135,12 +118,7 @@ public class CacheConfigurationTestLoader implements CacheConfigurationLoader return url; } - /** - * Method description - * - * - * @return - */ + @Override public File getManualFileResource() { @@ -171,12 +149,7 @@ public class CacheConfigurationTestLoader implements CacheConfigurationLoader return file; } - /** - * Method description - * - * - * @return - */ + @Override public Iterator getModuleResources() { @@ -203,14 +176,7 @@ public class CacheConfigurationTestLoader implements CacheConfigurationLoader return urlIterator; } - /** - * Method description - * - * - * @param name - * - * @return - */ + private URL getResource(String name) { return Resources.getResource("sonia/scm/cache/".concat(name)); @@ -218,15 +184,11 @@ public class CacheConfigurationTestLoader implements CacheConfigurationLoader //~--- fields --------------------------------------------------------------- - /** Field description */ private String defaultConfiguration; - /** Field description */ private String manualConfiguration; - /** Field description */ private Iterator moduleConfigurations; - /** Field description */ private TemporaryFolder tempFolder; } diff --git a/scm-webapp/src/test/java/sonia/scm/cache/CacheCopyTestBase.java b/scm-webapp/src/test/java/sonia/scm/cache/CacheCopyTestBase.java index e146846d73..d484a0501b 100644 --- a/scm-webapp/src/test/java/sonia/scm/cache/CacheCopyTestBase.java +++ b/scm-webapp/src/test/java/sonia/scm/cache/CacheCopyTestBase.java @@ -24,20 +24,14 @@ package sonia.scm.cache; -//~--- non-JDK imports -------------------------------------------------------- import org.junit.Test; import static org.junit.Assert.*; -//~--- JDK imports ------------------------------------------------------------ - import java.io.Serializable; -/** - * - * @author Sebastian Sdorra - */ + public abstract class CacheCopyTestBase { @@ -52,11 +46,7 @@ public abstract class CacheCopyTestBase protected abstract Cache createCache(CopyStrategy strategy); - /** - * Method description - * - */ - @Test + @Test public void testNoneCopy() { Cache cache = createCache(CopyStrategy.NONE); @@ -73,11 +63,7 @@ public abstract class CacheCopyTestBase assertEquals(3, mo.getVersion()); } - /** - * Method description - * - */ - @Test + @Test public void testReadCopy() { Cache cache = createCache(CopyStrategy.READ); @@ -93,11 +79,7 @@ public abstract class CacheCopyTestBase assertEquals(1, mo.getVersion()); } - /** - * Method description - * - */ - @Test + @Test public void testReadWriteCopy() { Cache cache = createCache(CopyStrategy.READWRITE); @@ -114,11 +96,7 @@ public abstract class CacheCopyTestBase assertEquals(1, mo.getVersion()); } - /** - * Method description - * - */ - @Test + @Test public void testWriteCopy() { Cache cache = createCache(CopyStrategy.WRITE); @@ -130,42 +108,25 @@ public abstract class CacheCopyTestBase assertEquals(1, mo.getVersion()); } - //~--- inner classes -------------------------------------------------------- - /** - * Class description - * - * - * @version Enter version here..., 13/04/12 - * @author Enter your name here... - */ + + public static class MutableObject implements Serializable { - /** Field description */ - private static final long serialVersionUID = -6934061151741193924L; + private static final long serialVersionUID = -6934061151741193924L; - //~--- constructors ------------------------------------------------------- + - /** - * Constructs ... - * - * - * @param version - */ + public MutableObject(int version) { this.version = version; } - //~--- get methods -------------------------------------------------------- + - /** - * Method description - * - * - * @return - */ + public int getVersion() { return version; @@ -186,7 +147,6 @@ public abstract class CacheCopyTestBase //~--- fields ------------------------------------------------------------- - /** Field description */ - private int version; + private int version; } } diff --git a/scm-webapp/src/test/java/sonia/scm/cache/CacheManagerTestBase.java b/scm-webapp/src/test/java/sonia/scm/cache/CacheManagerTestBase.java index c06de3877f..e60256ae38 100644 --- a/scm-webapp/src/test/java/sonia/scm/cache/CacheManagerTestBase.java +++ b/scm-webapp/src/test/java/sonia/scm/cache/CacheManagerTestBase.java @@ -24,7 +24,6 @@ package sonia.scm.cache; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.collect.Sets; @@ -34,8 +33,6 @@ import org.junit.Test; import static org.junit.Assert.*; -//~--- JDK imports ------------------------------------------------------------ - import java.io.IOException; import java.util.Set; @@ -47,38 +44,23 @@ import java.util.concurrent.Future; /** * - * @author Sebastian Sdorra * * @param */ public abstract class CacheManagerTestBase { - /** - * Method description - * - * - * @return - */ + protected abstract CacheManager createCacheManager(); - /** - * Method description - * - * - * @throws IOException - */ + @After public void tearDown() throws IOException { cacheManager.close(); } - /** - * Method description - * - */ - @Test + @Test public void testSameReference() { Cache c1 = cacheManager.getCache("test-1"); @@ -143,58 +125,34 @@ public abstract class CacheManagerTestBase } } - //~--- set methods ---------------------------------------------------------- - /** - * Method description - * - */ - @Before + @Before public void setUp() { cacheManager = createCacheManager(); } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param c1 - * @param c2 - */ + protected void assertIsSame(Cache c1, Cache c2) { assertSame(c1, c2); } - //~--- inner classes -------------------------------------------------------- - /** - * Class description - * - * - * @version Enter version here..., 13/03/25 - * @author Enter your name here... - */ + + private static class AcquireCacheCallable implements Callable { - /** - * Constructs ... - * - * - * @param cacheManager - * @param name - */ + public AcquireCacheCallable(CacheManager cacheManager, String name) { this.cacheManager = cacheManager; this.name = name; } - //~--- methods ------------------------------------------------------------ + /** * Method description @@ -212,16 +170,13 @@ public abstract class CacheManagerTestBase //~--- fields ------------------------------------------------------------- - /** Field description */ - private final CacheManager cacheManager; + private final CacheManager cacheManager; - /** Field description */ - private final String name; + private final String name; } //~--- fields --------------------------------------------------------------- - /** Field description */ private CacheManager cacheManager; } diff --git a/scm-webapp/src/test/java/sonia/scm/cache/GuavaCacheCopyTest.java b/scm-webapp/src/test/java/sonia/scm/cache/GuavaCacheCopyTest.java index 0efbe5ff1e..444ba8a7f5 100644 --- a/scm-webapp/src/test/java/sonia/scm/cache/GuavaCacheCopyTest.java +++ b/scm-webapp/src/test/java/sonia/scm/cache/GuavaCacheCopyTest.java @@ -24,25 +24,14 @@ package sonia.scm.cache; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.cache.CacheBuilder; -/** - * - * @author Sebastian Sdorra - */ + public class GuavaCacheCopyTest extends CacheCopyTestBase { - /** - * Method description - * - * - * @param strategy - * - * @return - */ + @Override @SuppressWarnings("unchecked") protected Cache createCache(CopyStrategy strategy) diff --git a/scm-webapp/src/test/java/sonia/scm/cache/GuavaCacheManagerTest.java b/scm-webapp/src/test/java/sonia/scm/cache/GuavaCacheManagerTest.java index a27956d64b..0df84fcfbb 100644 --- a/scm-webapp/src/test/java/sonia/scm/cache/GuavaCacheManagerTest.java +++ b/scm-webapp/src/test/java/sonia/scm/cache/GuavaCacheManagerTest.java @@ -24,19 +24,11 @@ package sonia.scm.cache; -/** - * - * @author Sebastian Sdorra - */ + public class GuavaCacheManagerTest extends CacheManagerTestBase { - /** - * Method description - * - * - * @return - */ + @Override protected CacheManager createCacheManager() { diff --git a/scm-webapp/src/test/java/sonia/scm/cache/GuavaConfigurationReaderTest.java b/scm-webapp/src/test/java/sonia/scm/cache/GuavaConfigurationReaderTest.java index aa7a9a2e63..de901dc3c3 100644 --- a/scm-webapp/src/test/java/sonia/scm/cache/GuavaConfigurationReaderTest.java +++ b/scm-webapp/src/test/java/sonia/scm/cache/GuavaConfigurationReaderTest.java @@ -24,7 +24,6 @@ package sonia.scm.cache; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.collect.Iterators; @@ -34,22 +33,13 @@ import org.junit.rules.TemporaryFolder; import static org.junit.Assert.*; -//~--- JDK imports ------------------------------------------------------------ - import java.util.Iterator; -/** - * - * @author Sebastian Sdorra - */ + public class GuavaConfigurationReaderTest { - /** - * Method description - * - */ - @Test + @Test public void testDefaultConfiguration() { GuavaCacheConfiguration cfg = @@ -58,11 +48,7 @@ public class GuavaConfigurationReaderTest assertCacheValues(cfg, 200L, 1200L, 2400L); } - /** - * Method description - * - */ - @Test + @Test public void testMergeAndOverride() { //J- @@ -80,11 +66,7 @@ public class GuavaConfigurationReaderTest 2400L); } - /** - * Method description - * - */ - @Test + @Test public void testMergeWithManualConfiguration() { GuavaCacheManagerConfiguration gcm = readConfiguration("gcache.001.xml", @@ -96,11 +78,7 @@ public class GuavaConfigurationReaderTest assertCacheValues(getCache(gcm, "sonia.test.cache.002"), 1000L, 120L, 60L); } - /** - * Method description - * - */ - @Test + @Test public void testMergeWithModuleConfigurations() { GuavaCacheManagerConfiguration gcm = readConfiguration("gcache.001.xml", @@ -113,11 +91,7 @@ public class GuavaConfigurationReaderTest 2400L); } - /** - * Method description - * - */ - @Test + @Test public void testSimpleConfiguration() { GuavaCacheConfiguration cfg = @@ -126,11 +100,7 @@ public class GuavaConfigurationReaderTest assertCacheValues(cfg, 1000L, 60L, 30L); } - /** - * Method description - * - */ - @Test + @Test public void testWithoutDefaultConfiguration() { GuavaCacheConfiguration cfg = @@ -156,29 +126,14 @@ public class GuavaConfigurationReaderTest assertEquals(Long.valueOf(expireAfterWrite), cfg.getExpireAfterWrite()); } - /** - * Method description - * - * - * @param defaultConfiguration - * - * @return - */ + private GuavaCacheManagerConfiguration readConfiguration( String defaultConfiguration) { return readConfiguration(defaultConfiguration, null, null); } - /** - * Method description - * - * - * @param defaultConfiguration - * @param moduleConfiguration - * - * @return - */ + private GuavaCacheManagerConfiguration readConfiguration( String defaultConfiguration, Iterator moduleConfiguration) { @@ -205,17 +160,8 @@ public class GuavaConfigurationReaderTest manualConfiguration)).read(); } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param gcmc - * @param name - * - * @return - */ + private GuavaNamedCacheConfiguration getCache( GuavaCacheManagerConfiguration gcmc, String name) { @@ -234,7 +180,6 @@ public class GuavaConfigurationReaderTest //~--- fields --------------------------------------------------------------- - /** Field description */ @Rule public TemporaryFolder tempFolder = new TemporaryFolder(); } diff --git a/scm-webapp/src/test/java/sonia/scm/event/GuavaScmEventBusTest.java b/scm-webapp/src/test/java/sonia/scm/event/GuavaScmEventBusTest.java index 32371bfbbc..8f7614aa96 100644 --- a/scm-webapp/src/test/java/sonia/scm/event/GuavaScmEventBusTest.java +++ b/scm-webapp/src/test/java/sonia/scm/event/GuavaScmEventBusTest.java @@ -24,7 +24,6 @@ package sonia.scm.event; -//~--- non-JDK imports -------------------------------------------------------- import com.github.legman.Subscribe; @@ -41,22 +40,13 @@ import sonia.scm.user.UserEvent; import static org.junit.Assert.*; -//~--- JDK imports ------------------------------------------------------------ - import java.io.IOException; -/** - * - * @author Sebastian Sdorra - */ + public class GuavaScmEventBusTest extends AbstractTestBase { - /** - * Method description - * - */ - @Before + @Before public void createSubject() { Subject.Builder builder = new Subject.Builder(new DefaultSecurityManager()); @@ -68,12 +58,7 @@ public class GuavaScmEventBusTest extends AbstractTestBase setSubject(subject); } - /** - * Method description - * - * - * @throws InterruptedException - */ + @Test public void testAsyncPost() throws InterruptedException { @@ -97,11 +82,7 @@ public class GuavaScmEventBusTest extends AbstractTestBase assertNotEquals(thread, currentThread); } - /** - * Method description - * - */ - @Test + @Test public void testSyncPost() { thread = null; @@ -147,11 +128,7 @@ public class GuavaScmEventBusTest extends AbstractTestBase eventBus.post(new Object()); } - /** - * Method description - * - */ - @Test(expected = RuntimeException.class) + @Test(expected = RuntimeException.class) public void testSyncPostWithRuntimeException() { LegmanScmEventBus eventBus = new LegmanScmEventBus(); @@ -172,6 +149,5 @@ public class GuavaScmEventBusTest extends AbstractTestBase //~--- fields --------------------------------------------------------------- - /** Field description */ private String thread; } diff --git a/scm-webapp/src/test/java/sonia/scm/filter/BaseUrlFilterTest.java b/scm-webapp/src/test/java/sonia/scm/filter/BaseUrlFilterTest.java index 73e2316f1c..2d16db17ce 100644 --- a/scm-webapp/src/test/java/sonia/scm/filter/BaseUrlFilterTest.java +++ b/scm-webapp/src/test/java/sonia/scm/filter/BaseUrlFilterTest.java @@ -46,9 +46,7 @@ import static org.mockito.Mockito.verifyNoInteractions; import static org.mockito.Mockito.when; -/** - * @author Sebastian Sdorra - */ + @ExtendWith(MockitoExtension.class) class BaseUrlFilterTest { diff --git a/scm-webapp/src/test/java/sonia/scm/filter/PropagatePrincipleFilterTest.java b/scm-webapp/src/test/java/sonia/scm/filter/PropagatePrincipleFilterTest.java index 652b745a79..6582e0054d 100644 --- a/scm-webapp/src/test/java/sonia/scm/filter/PropagatePrincipleFilterTest.java +++ b/scm-webapp/src/test/java/sonia/scm/filter/PropagatePrincipleFilterTest.java @@ -54,7 +54,6 @@ import static org.mockito.Mockito.verify; /** * Unit tests for {@link PropagatePrincipleFilter}. * - * @author Sebastian Sdorra */ @RunWith(MockitoJUnitRunner.class) @SubjectAware(configuration = "classpath:sonia/scm/shiro-001.ini") diff --git a/scm-webapp/src/test/java/sonia/scm/net/ahc/DefaultAdvancedHttpClientTest.java b/scm-webapp/src/test/java/sonia/scm/net/ahc/DefaultAdvancedHttpClientTest.java index b2cbfc2f7e..83f1332ddb 100644 --- a/scm-webapp/src/test/java/sonia/scm/net/ahc/DefaultAdvancedHttpClientTest.java +++ b/scm-webapp/src/test/java/sonia/scm/net/ahc/DefaultAdvancedHttpClientTest.java @@ -58,10 +58,7 @@ import static org.mockito.Mockito.never; import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; -/** - * - * @author Sebastian Sdorra - */ + @ExtendWith(MockitoExtension.class) class DefaultAdvancedHttpClientTest { diff --git a/scm-webapp/src/test/java/sonia/scm/net/ahc/DefaultAdvancedHttpResponseTest.java b/scm-webapp/src/test/java/sonia/scm/net/ahc/DefaultAdvancedHttpResponseTest.java index 2dc982544d..d167e63d4d 100644 --- a/scm-webapp/src/test/java/sonia/scm/net/ahc/DefaultAdvancedHttpResponseTest.java +++ b/scm-webapp/src/test/java/sonia/scm/net/ahc/DefaultAdvancedHttpResponseTest.java @@ -24,7 +24,6 @@ package sonia.scm.net.ahc; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Charsets; import com.google.common.collect.Lists; @@ -54,12 +53,7 @@ import static org.mockito.Mockito.lenient; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; -//~--- JDK imports ------------------------------------------------------------ -/** - * - * @author Sebastian Sdorra - */ @ExtendWith(MockitoExtension.class) class DefaultAdvancedHttpResponseTest { diff --git a/scm-webapp/src/test/java/sonia/scm/net/ahc/JsonContentTransformerTest.java b/scm-webapp/src/test/java/sonia/scm/net/ahc/JsonContentTransformerTest.java index 119c8b35ad..10bdc75be2 100644 --- a/scm-webapp/src/test/java/sonia/scm/net/ahc/JsonContentTransformerTest.java +++ b/scm-webapp/src/test/java/sonia/scm/net/ahc/JsonContentTransformerTest.java @@ -24,7 +24,6 @@ package sonia.scm.net.ahc; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Charsets; import com.google.common.io.ByteSource; @@ -41,29 +40,18 @@ import static org.junit.Assert.assertTrue; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; -/** - * - * @author Sebastian Sdorra - */ + public class JsonContentTransformerTest { - /** - * Method description - * - */ - @Test + @Test public void testDoNotFailOnUnknownProperties() { ByteSource bs = ByteSource.wrap("{\"value\": \"test\", \"other\": \"test2\"}".getBytes(Charsets.UTF_8)); TestObject obj = transformer.unmarshall(TestObject.class, bs); assertEquals("test", obj.value); } - /** - * Method description - * - */ - @Test + @Test public void testIsResponsible() { assertTrue(transformer.isResponsible(String.class, "application/json")); @@ -71,12 +59,7 @@ public class JsonContentTransformerTest assertFalse(transformer.isResponsible(String.class, "text/plain")); } - /** - * Method description - * - * - * @throws IOException - */ + @Test public void testMarshallAndUnmarshall() throws IOException { @@ -86,12 +69,7 @@ public class JsonContentTransformerTest assertEquals("test", to.value); } - /** - * Method description - * - * - * @throws IOException - */ + @SuppressWarnings("unchecked") @Test(expected = ContentTransformerException.class) public void testUnmarshallIOException() throws IOException @@ -102,15 +80,9 @@ public class JsonContentTransformerTest transformer.unmarshall(String.class, bs); } - //~--- inner classes -------------------------------------------------------- - /** - * Class description - * - * - * @version Enter version here..., 15/10/21 - * @author Enter your name here... - */ + + @XmlRootElement(name = "test") @XmlAccessorType(XmlAccessType.FIELD) private static class TestObject @@ -122,12 +94,7 @@ public class JsonContentTransformerTest */ public TestObject() {} - /** - * Constructs ... - * - * - * @param value - */ + public TestObject(String value) { this.value = value; @@ -135,23 +102,15 @@ public class JsonContentTransformerTest //~--- fields ------------------------------------------------------------- - /** Field description */ - private String value; + private String value; } - /** - * Class description - * - * - * @version Enter version here..., 15/10/21 - * @author Enter your name here... - */ + private static class TestObject2 {} //~--- fields --------------------------------------------------------------- - /** Field description */ private final JsonContentTransformer transformer = new JsonContentTransformer(); } diff --git a/scm-webapp/src/test/java/sonia/scm/net/ahc/XmlContentTransformerTest.java b/scm-webapp/src/test/java/sonia/scm/net/ahc/XmlContentTransformerTest.java index a051857997..1a3bd71d74 100644 --- a/scm-webapp/src/test/java/sonia/scm/net/ahc/XmlContentTransformerTest.java +++ b/scm-webapp/src/test/java/sonia/scm/net/ahc/XmlContentTransformerTest.java @@ -38,10 +38,7 @@ import static org.junit.Assert.assertTrue; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; -/** - * - * @author Sebastian Sdorra - */ + public class XmlContentTransformerTest { private final XmlContentTransformer transformer = new XmlContentTransformer(); diff --git a/scm-webapp/src/test/java/sonia/scm/plugin/DefaultUberWebResourceLoaderTest.java b/scm-webapp/src/test/java/sonia/scm/plugin/DefaultUberWebResourceLoaderTest.java index c26859487e..c39c4a3c28 100644 --- a/scm-webapp/src/test/java/sonia/scm/plugin/DefaultUberWebResourceLoaderTest.java +++ b/scm-webapp/src/test/java/sonia/scm/plugin/DefaultUberWebResourceLoaderTest.java @@ -24,7 +24,6 @@ package sonia.scm.plugin; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.collect.Lists; import jakarta.servlet.ServletContext; @@ -53,33 +52,19 @@ import static org.junit.Assert.assertThat; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; -//~--- JDK imports ------------------------------------------------------------ -/** - * - * @author Sebastian Sdorra - */ @RunWith(MockitoJUnitRunner.class) public class DefaultUberWebResourceLoaderTest extends WebResourceLoaderTestBase { - /** Field description */ private static URL BITBUCKET; - /** Field description */ private static URL GITHUB; - /** Field description */ private static URL SCM_MANAGER; - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @throws MalformedURLException - */ + @BeforeClass public static void prepare() throws MalformedURLException { @@ -88,12 +73,7 @@ public class DefaultUberWebResourceLoaderTest extends WebResourceLoaderTestBase GITHUB = new URL("https://github.com"); } - /** - * Method description - * - * - */ - @Test + @Test public void testGetResourceFromCache() { DefaultUberWebResourceLoader resourceLoader = new DefaultUberWebResourceLoader(servletContext, @@ -115,12 +95,7 @@ public class DefaultUberWebResourceLoaderTest extends WebResourceLoaderTestBase assertNotSame(url, secondUrl); } - /** - * Method description - * - * - * @throws IOException - */ + @Test public void testGetResourceFromDirectory() throws IOException { @@ -152,12 +127,7 @@ public class DefaultUberWebResourceLoaderTest extends WebResourceLoaderTestBase assertSame(SCM_MANAGER, resource); } - /** - * Method description - * - * - * @throws IOException - */ + @Test public void testGetResources() throws IOException { @@ -219,27 +189,13 @@ public class DefaultUberWebResourceLoaderTest extends WebResourceLoaderTestBase Assertions.assertThat(resources).isEmpty(); } - /** - * Method description - * - * - * @param directory - * - * @return - */ + private InstalledPlugin createPluginWrapper(File directory) { return createPluginWrapper(directory.toPath()); } - /** - * Method description - * - * - * @param directory - * - * @return - */ + private InstalledPlugin createPluginWrapper(Path directory) { return new InstalledPlugin(null, null, new PathWebResourceLoader(directory), @@ -248,7 +204,6 @@ public class DefaultUberWebResourceLoaderTest extends WebResourceLoaderTestBase //~--- fields --------------------------------------------------------------- - /** Field description */ @Mock private ServletContext servletContext; } diff --git a/scm-webapp/src/test/java/sonia/scm/plugin/MultiParentClassLoaderTest.java b/scm-webapp/src/test/java/sonia/scm/plugin/MultiParentClassLoaderTest.java index 55e7e4b1b2..52ee26b443 100644 --- a/scm-webapp/src/test/java/sonia/scm/plugin/MultiParentClassLoaderTest.java +++ b/scm-webapp/src/test/java/sonia/scm/plugin/MultiParentClassLoaderTest.java @@ -45,10 +45,7 @@ import static net.bytebuddy.matcher.ElementMatchers.named; import static org.assertj.core.api.Assertions.assertThat; import static org.junit.jupiter.api.Assertions.assertThrows; -/** - * - * @author Sebastian Sdorra - */ + class MultiParentClassLoaderTest { @Test diff --git a/scm-webapp/src/test/java/sonia/scm/plugin/PathWebResourceLoaderTest.java b/scm-webapp/src/test/java/sonia/scm/plugin/PathWebResourceLoaderTest.java index b8075bd2f5..52c834b8bc 100644 --- a/scm-webapp/src/test/java/sonia/scm/plugin/PathWebResourceLoaderTest.java +++ b/scm-webapp/src/test/java/sonia/scm/plugin/PathWebResourceLoaderTest.java @@ -24,24 +24,18 @@ package sonia.scm.plugin; -//~--- non-JDK imports -------------------------------------------------------- import org.junit.Test; import static org.junit.Assert.*; -//~--- JDK imports ------------------------------------------------------------ - import java.io.File; import java.io.IOException; import java.net.URL; -/** - * - * @author Sebastian Sdorra - */ + public class PathWebResourceLoaderTest extends WebResourceLoaderTestBase { @Test diff --git a/scm-webapp/src/test/java/sonia/scm/plugin/PluginProcessorTest.java b/scm-webapp/src/test/java/sonia/scm/plugin/PluginProcessorTest.java index 873c57dc10..b3820cdda1 100644 --- a/scm-webapp/src/test/java/sonia/scm/plugin/PluginProcessorTest.java +++ b/scm-webapp/src/test/java/sonia/scm/plugin/PluginProcessorTest.java @@ -24,7 +24,6 @@ package sonia.scm.plugin; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Charsets; import com.google.common.collect.Iterables; @@ -57,10 +56,7 @@ import static org.mockito.ArgumentMatchers.any; import static org.mockito.Mockito.times; import static org.mockito.Mockito.verify; -/** - * - * @author Sebastian Sdorra - */ + @ExtendWith(MockitoExtension.class) class PluginProcessorTest { diff --git a/scm-webapp/src/test/java/sonia/scm/plugin/PluginTreeTest.java b/scm-webapp/src/test/java/sonia/scm/plugin/PluginTreeTest.java index b646dd3b98..64bde7e721 100644 --- a/scm-webapp/src/test/java/sonia/scm/plugin/PluginTreeTest.java +++ b/scm-webapp/src/test/java/sonia/scm/plugin/PluginTreeTest.java @@ -46,9 +46,7 @@ import static org.hamcrest.Matchers.containsInAnyOrder; import static org.junit.Assert.assertFalse; import static org.junit.Assert.assertThat; -/** - * @author Sebastian Sdorra - */ + public class PluginTreeTest { @Rule diff --git a/scm-webapp/src/test/java/sonia/scm/plugin/WebResourceLoaderTestBase.java b/scm-webapp/src/test/java/sonia/scm/plugin/WebResourceLoaderTestBase.java index f963d6ae36..68e1decc03 100644 --- a/scm-webapp/src/test/java/sonia/scm/plugin/WebResourceLoaderTestBase.java +++ b/scm-webapp/src/test/java/sonia/scm/plugin/WebResourceLoaderTestBase.java @@ -24,7 +24,6 @@ package sonia.scm.plugin; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Charsets; import com.google.common.io.Files; @@ -34,15 +33,10 @@ import org.junit.rules.TemporaryFolder; import sonia.scm.util.IOUtil; -//~--- JDK imports ------------------------------------------------------------ - import java.io.File; import java.io.IOException; -/** - * - * @author Sebastian Sdorra - */ + public abstract class WebResourceLoaderTestBase { @@ -70,7 +64,6 @@ public abstract class WebResourceLoaderTestBase //~--- fields --------------------------------------------------------------- - /** Field description */ @Rule public TemporaryFolder temp = new TemporaryFolder(); } diff --git a/scm-webapp/src/test/java/sonia/scm/repository/DefaultRepositoryManagerPerfTest.java b/scm-webapp/src/test/java/sonia/scm/repository/DefaultRepositoryManagerPerfTest.java index 27ae71bd2a..83e33edc4a 100644 --- a/scm-webapp/src/test/java/sonia/scm/repository/DefaultRepositoryManagerPerfTest.java +++ b/scm-webapp/src/test/java/sonia/scm/repository/DefaultRepositoryManagerPerfTest.java @@ -75,7 +75,6 @@ import static org.mockito.Mockito.when; * Performance test for {@link RepositoryManager#getAll()}. * * @see Issue 781 - * @author Sebastian Sdorra * @since 1.52 */ @RunWith(MockitoJUnitRunner.class) diff --git a/scm-webapp/src/test/java/sonia/scm/repository/DefaultRepositoryManagerTest.java b/scm-webapp/src/test/java/sonia/scm/repository/DefaultRepositoryManagerTest.java index dff97c98cd..3d0ed1041a 100644 --- a/scm-webapp/src/test/java/sonia/scm/repository/DefaultRepositoryManagerTest.java +++ b/scm-webapp/src/test/java/sonia/scm/repository/DefaultRepositoryManagerTest.java @@ -24,7 +24,6 @@ package sonia.scm.repository; -//~--- non-JDK imports -------------------------------------------------------- import com.github.legman.Subscribe; import com.github.sdorra.shiro.ShiroRule; @@ -89,12 +88,9 @@ import static org.mockito.Mockito.spy; import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; -//~--- JDK imports ------------------------------------------------------------ - /** * Unit tests for {@link DefaultRepositoryManager}. * - * @author Sebastian Sdorra */ @SubjectAware( username = "trillian", @@ -540,7 +536,6 @@ public class DefaultRepositoryManagerTest extends ManagerTestBase { verify(repositoryDAO, never()).modify(any()); } - //~--- methods -------------------------------------------------------------- @Override protected DefaultRepositoryManager createManager() { diff --git a/scm-webapp/src/test/java/sonia/scm/repository/RepositoryMatcherTest.java b/scm-webapp/src/test/java/sonia/scm/repository/RepositoryMatcherTest.java index c1776fa5b0..e3b2d67905 100644 --- a/scm-webapp/src/test/java/sonia/scm/repository/RepositoryMatcherTest.java +++ b/scm-webapp/src/test/java/sonia/scm/repository/RepositoryMatcherTest.java @@ -36,7 +36,6 @@ import static org.junit.Assert.assertTrue; /** * Unit tests for {@link RepositoryMatcher}. * - * @author Sebastian Sdorra * @since 1.54 */ public class RepositoryMatcherTest { diff --git a/scm-webapp/src/test/java/sonia/scm/security/AuthorizationChangedEventProducerTest.java b/scm-webapp/src/test/java/sonia/scm/security/AuthorizationChangedEventProducerTest.java index c9abf21d92..71a0d521de 100644 --- a/scm-webapp/src/test/java/sonia/scm/security/AuthorizationChangedEventProducerTest.java +++ b/scm-webapp/src/test/java/sonia/scm/security/AuthorizationChangedEventProducerTest.java @@ -54,7 +54,6 @@ import static org.junit.Assert.assertTrue; /** * Unit tests for {@link AuthorizationChangedEventProducer}. * - * @author Sebastian Sdorra */ public class AuthorizationChangedEventProducerTest { diff --git a/scm-webapp/src/test/java/sonia/scm/security/BearerRealmTest.java b/scm-webapp/src/test/java/sonia/scm/security/BearerRealmTest.java index 1f55dfdb27..c95d86aeaf 100644 --- a/scm-webapp/src/test/java/sonia/scm/security/BearerRealmTest.java +++ b/scm-webapp/src/test/java/sonia/scm/security/BearerRealmTest.java @@ -44,7 +44,6 @@ import static sonia.scm.security.BearerToken.valueOf; /** * Unit tests for {@link BearerRealm}. * - * @author Sebastian Sdorra */ @ExtendWith(MockitoExtension.class) class BearerRealmTest { diff --git a/scm-webapp/src/test/java/sonia/scm/security/ConfigurableLoginAttemptHandlerTest.java b/scm-webapp/src/test/java/sonia/scm/security/ConfigurableLoginAttemptHandlerTest.java index caf83847b7..99fb443cb1 100644 --- a/scm-webapp/src/test/java/sonia/scm/security/ConfigurableLoginAttemptHandlerTest.java +++ b/scm-webapp/src/test/java/sonia/scm/security/ConfigurableLoginAttemptHandlerTest.java @@ -34,7 +34,6 @@ import sonia.scm.config.ScmConfiguration; /** * Unit tests for {@link ConfigurableLoginAttemptHandler}. * - * @author Sebastian Sdorra */ public class ConfigurableLoginAttemptHandlerTest { diff --git a/scm-webapp/src/test/java/sonia/scm/security/DefaultAuthorizationCollectorTest.java b/scm-webapp/src/test/java/sonia/scm/security/DefaultAuthorizationCollectorTest.java index 1969917b97..8f542098b7 100644 --- a/scm-webapp/src/test/java/sonia/scm/security/DefaultAuthorizationCollectorTest.java +++ b/scm-webapp/src/test/java/sonia/scm/security/DefaultAuthorizationCollectorTest.java @@ -70,7 +70,6 @@ import static org.mockito.Mockito.when; /** * Unit tests for {@link AuthorizationCollector}. * - * @author Sebastian Sdorra */ @SuppressWarnings("unchecked") @RunWith(MockitoJUnitRunner.class) diff --git a/scm-webapp/src/test/java/sonia/scm/security/DefaultKeyGeneratorTest.java b/scm-webapp/src/test/java/sonia/scm/security/DefaultKeyGeneratorTest.java index d54caf5e90..b00be280ce 100644 --- a/scm-webapp/src/test/java/sonia/scm/security/DefaultKeyGeneratorTest.java +++ b/scm-webapp/src/test/java/sonia/scm/security/DefaultKeyGeneratorTest.java @@ -24,7 +24,6 @@ package sonia.scm.security; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.collect.Sets; import org.junit.Test; @@ -34,20 +33,11 @@ import java.util.concurrent.*; import static org.junit.Assert.*; -//~--- JDK imports ------------------------------------------------------------ -/** - * - * @author Sebastian Sdorra - */ public class DefaultKeyGeneratorTest { - /** - * Method description - * - */ - @Test + @Test public void testCreateRandom() { DefaultKeyGenerator gen = new DefaultKeyGenerator(); @@ -128,11 +118,7 @@ public class DefaultKeyGeneratorTest } - /** - * Method description - * - */ - @Test + @Test public void testSimple() { DefaultKeyGenerator generator = new DefaultKeyGenerator(); @@ -143,11 +129,7 @@ public class DefaultKeyGeneratorTest assertTrue(key.length() > 0); } - /** - * Method description - * - */ - @Test + @Test public void testUniqueness() { DefaultKeyGenerator generator = new DefaultKeyGenerator(); diff --git a/scm-webapp/src/test/java/sonia/scm/security/DefaultSecuritySystemTest.java b/scm-webapp/src/test/java/sonia/scm/security/DefaultSecuritySystemTest.java index a083827712..32e8406d4e 100644 --- a/scm-webapp/src/test/java/sonia/scm/security/DefaultSecuritySystemTest.java +++ b/scm-webapp/src/test/java/sonia/scm/security/DefaultSecuritySystemTest.java @@ -53,10 +53,7 @@ import static org.mockito.Mockito.spy; import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; -/** - * - * @author Sebastian Sdorra - */ + public class DefaultSecuritySystemTest extends AbstractTestBase { diff --git a/scm-webapp/src/test/java/sonia/scm/security/JwtAccessTokenBuilderTest.java b/scm-webapp/src/test/java/sonia/scm/security/JwtAccessTokenBuilderTest.java index 5a109988ba..4b930d5603 100644 --- a/scm-webapp/src/test/java/sonia/scm/security/JwtAccessTokenBuilderTest.java +++ b/scm-webapp/src/test/java/sonia/scm/security/JwtAccessTokenBuilderTest.java @@ -57,7 +57,6 @@ import static sonia.scm.security.SecureKeyTestUtil.createSecureKey; /** * Unit test for {@link JwtAccessTokenBuilder}. * - * @author Sebastian Sdorra */ @ExtendWith(MockitoExtension.class) class JwtAccessTokenBuilderTest { diff --git a/scm-webapp/src/test/java/sonia/scm/security/JwtAccessTokenResolverTest.java b/scm-webapp/src/test/java/sonia/scm/security/JwtAccessTokenResolverTest.java index cfeab5e35e..852688604f 100644 --- a/scm-webapp/src/test/java/sonia/scm/security/JwtAccessTokenResolverTest.java +++ b/scm-webapp/src/test/java/sonia/scm/security/JwtAccessTokenResolverTest.java @@ -57,7 +57,6 @@ import static sonia.scm.security.SecureKeyTestUtil.createSecureKey; /** * Unit tests for {@link JwtAccessTokenResolver}. * - * @author Sebastian Sdorra */ @RunWith(MockitoJUnitRunner.class) public class JwtAccessTokenResolverTest { diff --git a/scm-webapp/src/test/java/sonia/scm/security/ScopesTest.java b/scm-webapp/src/test/java/sonia/scm/security/ScopesTest.java index 22d09e4fc5..d978063a7b 100644 --- a/scm-webapp/src/test/java/sonia/scm/security/ScopesTest.java +++ b/scm-webapp/src/test/java/sonia/scm/security/ScopesTest.java @@ -42,7 +42,6 @@ import static org.junit.Assert.assertThat; /** * Unit tests for {@link Scopes}. * - * @author Sebastian Sdorra */ public class ScopesTest { diff --git a/scm-webapp/src/test/java/sonia/scm/security/SecureKeyResolverTest.java b/scm-webapp/src/test/java/sonia/scm/security/SecureKeyResolverTest.java index 670539b577..a975c460cb 100644 --- a/scm-webapp/src/test/java/sonia/scm/security/SecureKeyResolverTest.java +++ b/scm-webapp/src/test/java/sonia/scm/security/SecureKeyResolverTest.java @@ -24,7 +24,6 @@ package sonia.scm.security; -//~--- non-JDK imports -------------------------------------------------------- import io.jsonwebtoken.Jwts; import org.junit.Before; @@ -51,19 +50,12 @@ import static org.mockito.Mockito.doAnswer; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; -/** - * - * @author Sebastian Sdorra - */ + @RunWith(MockitoJUnitRunner.class) public class SecureKeyResolverTest { - /** - * Method description - * - */ - @Test + @Test public void testGetSecureKey() { SecureKey key = resolver.getSecureKey("test"); @@ -94,11 +86,7 @@ public class SecureKeyResolverTest assertThat(sameRegeneratedKey.getCreationDate()).isEqualTo(regeneratedKey.getCreationDate()); } - /** - * Method description - * - */ - @Test + @Test public void testResolveSigningKeyBytes() { SecureKey key = resolver.getSecureKey("test"); @@ -112,34 +100,21 @@ public class SecureKeyResolverTest assertArrayEquals(key.getBytes(), bytes); } - /** - * Method description - * - */ - @Test + @Test public void testResolveSigningKeyBytesWithoutKey() { byte[] bytes = resolver.resolveSigningKeyBytes(null, Jwts.claims().setSubject("test")); assertThat(bytes[0]).isEqualTo((byte) 42); } - /** - * Method description - * - */ - @Test(expected = IllegalArgumentException.class) + @Test(expected = IllegalArgumentException.class) public void testResolveSigningKeyBytesWithoutSubject() { resolver.resolveSigningKeyBytes(null, Jwts.claims()); } - //~--- set methods ---------------------------------------------------------- - /** - * Method description - * - */ - @Before + @Before public void setUp() { ConfigurationEntryStoreFactory factory = mock(ConfigurationEntryStoreFactory.class); @@ -157,10 +132,8 @@ public class SecureKeyResolverTest //~--- fields --------------------------------------------------------------- - /** Field description */ private SecureKeyResolver resolver; - /** Field description */ @Mock private ConfigurationEntryStore store; diff --git a/scm-webapp/src/test/java/sonia/scm/security/XsrfAccessTokenEnricherTest.java b/scm-webapp/src/test/java/sonia/scm/security/XsrfAccessTokenEnricherTest.java index f6291faef1..920ef9113e 100644 --- a/scm-webapp/src/test/java/sonia/scm/security/XsrfAccessTokenEnricherTest.java +++ b/scm-webapp/src/test/java/sonia/scm/security/XsrfAccessTokenEnricherTest.java @@ -46,7 +46,6 @@ import static org.mockito.Mockito.when; /** * Unit tests for {@link XsrfAccessTokenEnricher}. * - * @author Sebastian Sdorra */ @ExtendWith(MockitoExtension.class) class XsrfAccessTokenEnricherTest { diff --git a/scm-webapp/src/test/java/sonia/scm/security/XsrfAccessTokenValidatorTest.java b/scm-webapp/src/test/java/sonia/scm/security/XsrfAccessTokenValidatorTest.java index cd5eeb59ec..576546ca3a 100644 --- a/scm-webapp/src/test/java/sonia/scm/security/XsrfAccessTokenValidatorTest.java +++ b/scm-webapp/src/test/java/sonia/scm/security/XsrfAccessTokenValidatorTest.java @@ -44,7 +44,6 @@ import static org.mockito.Mockito.when; /** * Tests {@link XsrfAccessTokenValidator}. * - * @author Sebastian Sdorra */ @ExtendWith(MockitoExtension.class) class XsrfAccessTokenValidatorTest { diff --git a/scm-webapp/src/test/java/sonia/scm/template/MustacheTemplateEngineTest.java b/scm-webapp/src/test/java/sonia/scm/template/MustacheTemplateEngineTest.java index 5c5f0efe83..f6c0d66ec3 100644 --- a/scm-webapp/src/test/java/sonia/scm/template/MustacheTemplateEngineTest.java +++ b/scm-webapp/src/test/java/sonia/scm/template/MustacheTemplateEngineTest.java @@ -24,7 +24,6 @@ package sonia.scm.template; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.collect.ImmutableMap; import io.micrometer.core.instrument.simple.SimpleMeterRegistry; @@ -40,23 +39,11 @@ import java.io.StringWriter; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; -//~--- JDK imports ------------------------------------------------------------ -/** - * - * @author Sebastian Sdorra - */ public class MustacheTemplateEngineTest extends TemplateEngineTestBase { - /** - * Method description - * - * - * @param context - * - * @return - */ + @Override public TemplateEngine createEngine(ServletContext context) { @@ -74,26 +61,15 @@ public class MustacheTemplateEngineTest extends TemplateEngineTestBase return new MustacheTemplateEngine(context, pluginLoaderHolder, meterRegistryHolder); } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + @Override public String getDefectTemplateResource() { return "sonia/scm/template/005.mustache"; } - /** - * Method description - * - * - * @return - */ + @Override public String getTemplateResource() { @@ -105,14 +81,7 @@ public class MustacheTemplateEngineTest extends TemplateEngineTestBase return "sonia/scm/template/loc.mustache"; } - /** - * Method description - * - * - * @param resource - * - * @return - */ + @Override protected InputStream getResource(String resource) { diff --git a/scm-webapp/src/test/java/sonia/scm/template/MustacheTemplateTest.java b/scm-webapp/src/test/java/sonia/scm/template/MustacheTemplateTest.java index 4a0a3f7d4d..2d0cfdf829 100644 --- a/scm-webapp/src/test/java/sonia/scm/template/MustacheTemplateTest.java +++ b/scm-webapp/src/test/java/sonia/scm/template/MustacheTemplateTest.java @@ -24,60 +24,36 @@ package sonia.scm.template; -//~--- non-JDK imports -------------------------------------------------------- import com.github.mustachejava.DefaultMustacheFactory; import com.github.mustachejava.Mustache; import com.google.common.base.Function; -//~--- JDK imports ------------------------------------------------------------ - import java.io.IOException; import java.util.Map; -/** - * - * @author Sebastian Sdorra - */ + public class MustacheTemplateTest extends TemplateTestBase { - /** - * Method description - * - * - * @return - * - * @throws IOException - */ + @Override public Template getFailureTemplate() throws IOException { return getTemplate("sonia/scm/template/003.mustache"); } - /** - * Method description - * - * - * @return - */ + @Override public Template getHelloTemplate() { return getTemplate("sonia/scm/template/001.mustache"); } - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @param env - */ + @Override protected void prepareEnv(Map env) { @@ -86,16 +62,8 @@ public class MustacheTemplateTest extends TemplateTestBase }); } - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param path - * - * @return - */ + private Template getTemplate(String path) { DefaultMustacheFactory factory = new DefaultMustacheFactory(); diff --git a/scm-webapp/src/test/java/sonia/scm/template/TemplateEngineTestBase.java b/scm-webapp/src/test/java/sonia/scm/template/TemplateEngineTestBase.java index 163962aa1e..5a894c07fa 100644 --- a/scm-webapp/src/test/java/sonia/scm/template/TemplateEngineTestBase.java +++ b/scm-webapp/src/test/java/sonia/scm/template/TemplateEngineTestBase.java @@ -24,7 +24,6 @@ package sonia.scm.template; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.collect.Maps; import jakarta.servlet.ServletContext; @@ -46,61 +45,27 @@ import static org.junit.Assert.assertNull; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; -/** - * - * @author Sebastian Sdorra - */ + public abstract class TemplateEngineTestBase { - /** - * Method description - * - * - * @param context - * - * @return - */ + public abstract TemplateEngine createEngine(ServletContext context); - //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @return - */ + public abstract String getDefectTemplateResource(); - /** - * Method description - * - * - * @return - */ + public abstract String getTemplateResource(); public abstract String getTemplateResourceWithGermanTranslation(); - /** - * Method description - * - * - * @param resource - * - * @return - */ + protected abstract InputStream getResource(String resource); - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @throws IOException - */ + @Test(expected = IOException.class) public void testGetDefectTemplate() throws IOException { @@ -110,12 +75,7 @@ public abstract class TemplateEngineTestBase engine.getTemplate(getDefectTemplateResource()); } - /** - * Method description - * - * - * @throws IOException - */ + @Test public void testGetTemplateNotFound() throws IOException { @@ -126,12 +86,7 @@ public abstract class TemplateEngineTestBase assertNull(template); } - /** - * Method description - * - * - * @throws IOException - */ + @Test public void testGetTemplateFromClasspath() throws IOException { @@ -168,12 +123,7 @@ public abstract class TemplateEngineTestBase Assertions.assertThat(writer.toString()).contains("English"); } - /** - * Method description - * - * - * @throws IOException - */ + @Test public void testGetTemplateFromReader() throws IOException { @@ -207,12 +157,7 @@ public abstract class TemplateEngineTestBase } } - /** - * Method description - * - * - * @throws IOException - */ + @Test public void testGetTemplateFromServletContext() throws IOException { diff --git a/scm-webapp/src/test/java/sonia/scm/template/TemplateTestBase.java b/scm-webapp/src/test/java/sonia/scm/template/TemplateTestBase.java index fc04296210..8ee12e4d71 100644 --- a/scm-webapp/src/test/java/sonia/scm/template/TemplateTestBase.java +++ b/scm-webapp/src/test/java/sonia/scm/template/TemplateTestBase.java @@ -24,7 +24,6 @@ package sonia.scm.template; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.collect.Maps; @@ -32,48 +31,23 @@ import org.junit.Test; import static org.junit.Assert.*; -//~--- JDK imports ------------------------------------------------------------ - import java.io.IOException; import java.io.StringWriter; import java.util.Map; -/** - * - * @author Sebastian Sdorra - */ + public abstract class TemplateTestBase { - /** - * Method description - * - * - * @return - * - * @throws IOException - */ + public abstract Template getFailureTemplate() throws IOException; - /** - * Method description - * - * - * @return - * - * @throws IOException - */ + public abstract Template getHelloTemplate() throws IOException; - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - * - * @throws IOException - */ + @Test public void testRender() throws IOException { @@ -82,12 +56,7 @@ public abstract class TemplateTestBase assertEquals("Hello marvin!", execute(template)); } - /** - * Method description - * - * - * @throws IOException - */ + @Test(expected = IOException.class) public void testRenderFailure() throws IOException { @@ -96,24 +65,10 @@ public abstract class TemplateTestBase execute(template); } - /** - * Method description - * - * - * @param env - */ + protected void prepareEnv(Map env) {} - /** - * Method description - * - * - * @param template - * - * @return - * - * @throws IOException - */ + private String execute(Template template) throws IOException { Map env = Maps.newHashMap(); diff --git a/scm-webapp/src/test/java/sonia/scm/user/DefaultUserManagerTest.java b/scm-webapp/src/test/java/sonia/scm/user/DefaultUserManagerTest.java index 10581b8bbf..ff36af20c2 100644 --- a/scm-webapp/src/test/java/sonia/scm/user/DefaultUserManagerTest.java +++ b/scm-webapp/src/test/java/sonia/scm/user/DefaultUserManagerTest.java @@ -45,9 +45,7 @@ import static org.mockito.Mockito.doNothing; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; -/** - * @author Sebastian Sdorra - */ + @SubjectAware( username = "trillian", password = "secret", diff --git a/scm-webapp/src/test/java/sonia/scm/user/UserEventHackTest.java b/scm-webapp/src/test/java/sonia/scm/user/UserEventHackTest.java index 6fc85a0979..003ce9bbef 100644 --- a/scm-webapp/src/test/java/sonia/scm/user/UserEventHackTest.java +++ b/scm-webapp/src/test/java/sonia/scm/user/UserEventHackTest.java @@ -24,7 +24,6 @@ package sonia.scm.user; -//~--- non-JDK imports -------------------------------------------------------- import org.junit.Before; import org.junit.Test; @@ -38,29 +37,18 @@ import sonia.scm.HandlerEventType; import static org.mockito.Mockito.*; -/** - * - * @author Sebastian Sdorra - */ + @RunWith(MockitoJUnitRunner.class) public class UserEventHackTest { - /** - * Method description - * - */ - @Before + @Before public void before() { verifier = inOrder(userManager); } - /** - * Method description - * - */ - @Test + @Test public void testFireEvent() { fireEvent(userManager); @@ -68,11 +56,7 @@ public class UserEventHackTest verify(1); } - /** - * Method description - * - */ - @Test + @Test public void testFireEventDecorated() { @@ -83,11 +67,7 @@ public class UserEventHackTest verify(1); } - /** - * Method description - * - */ - @Test + @Test public void testFireEventMultiDecorated() { @@ -103,23 +83,13 @@ public class UserEventHackTest verify(1); } - /** - * Method description - * - * - * @param u - */ + private void fireEvent(UserManager u) { UserEventHack.fireEvent(u, HandlerEventType.CREATE, new User()); } - /** - * Method description - * - * - * @param count - */ + private void verify(int count) { verifier.verify(userManager, @@ -128,10 +98,8 @@ public class UserEventHackTest //~--- fields --------------------------------------------------------------- - /** Field description */ @Mock private AbstractUserManager userManager; - /** Field description */ private InOrder verifier; } diff --git a/scm-webapp/src/test/java/sonia/scm/web/BasicWebTokenGeneratorTest.java b/scm-webapp/src/test/java/sonia/scm/web/BasicWebTokenGeneratorTest.java index 7d393d848d..b37ecd0637 100644 --- a/scm-webapp/src/test/java/sonia/scm/web/BasicWebTokenGeneratorTest.java +++ b/scm-webapp/src/test/java/sonia/scm/web/BasicWebTokenGeneratorTest.java @@ -24,7 +24,6 @@ package sonia.scm.web; -//~--- non-JDK imports -------------------------------------------------------- import jakarta.servlet.http.HttpServletRequest; import org.apache.shiro.authc.AuthenticationToken; @@ -40,12 +39,9 @@ import sonia.scm.security.BearerToken; import static org.assertj.core.api.Assertions.assertThat; import static org.mockito.Mockito.when; -//~--- JDK imports ------------------------------------------------------------ - /** * TODO add test with {@link UserAgentParser}. * - * @author Sebastian Sdorra */ @ExtendWith(MockitoExtension.class) class BasicWebTokenGeneratorTest { diff --git a/scm-webapp/src/test/java/sonia/scm/web/BearerWebTokenGeneratorTest.java b/scm-webapp/src/test/java/sonia/scm/web/BearerWebTokenGeneratorTest.java index 822316a129..8f022bfedf 100644 --- a/scm-webapp/src/test/java/sonia/scm/web/BearerWebTokenGeneratorTest.java +++ b/scm-webapp/src/test/java/sonia/scm/web/BearerWebTokenGeneratorTest.java @@ -37,10 +37,7 @@ import static org.assertj.core.api.Assertions.assertThat; import static org.mockito.Mockito.doReturn; import static org.mockito.Mockito.when; -/** - * - * @author Sebastian Sdorra - */ + @ExtendWith(MockitoExtension.class) class BearerWebTokenGeneratorTest { diff --git a/scm-webapp/src/test/java/sonia/scm/web/BrowserUserAgentProviderTest.java b/scm-webapp/src/test/java/sonia/scm/web/BrowserUserAgentProviderTest.java index 79117073a0..c0542fb664 100644 --- a/scm-webapp/src/test/java/sonia/scm/web/BrowserUserAgentProviderTest.java +++ b/scm-webapp/src/test/java/sonia/scm/web/BrowserUserAgentProviderTest.java @@ -24,7 +24,6 @@ package sonia.scm.web; -//~--- non-JDK imports -------------------------------------------------------- import com.google.common.base.Strings; @@ -34,8 +33,6 @@ import org.junit.Test; import static org.junit.Assert.*; -//~--- JDK imports ------------------------------------------------------------ - import java.util.Locale; /** @@ -45,36 +42,25 @@ import java.util.Locale; public class BrowserUserAgentProviderTest { - /** Field description */ private static final String CHROME = "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/37.0.2062.124 Safari/537.36"; - /** Field description */ private static final String FIREFOX = "Mozilla/5.0 (Windows; U; Windows NT 5.2; en-GB; rv:1.8.1.18) Gecko/20081029 Firefox/2.0.0.18"; - /** Field description */ private static final String MSIE = "Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 5.1; )"; - /** Field description */ private static final String OPERA = "Opera/9.80 (Windows NT 5.1; U; cs) Presto/2.2.15 Version/10.00"; - /** Field description */ private static final String SAFARI = "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_8_5) AppleWebKit/537.75.14 (KHTML, like Gecko) Version/6.1.3 Safari/537.75.14"; - /** Field description */ private static final String WGET = "Wget/1.5.3"; - //~--- methods -------------------------------------------------------------- - /** - * Method description - * - */ - @Test + @Test public void testParseUserAgent() { assertEquals(BrowserUserAgentProvider.MSIE, parse(MSIE)); @@ -85,14 +71,7 @@ public class BrowserUserAgentProviderTest assertNull(parse(WGET)); } - /** - * Method description - * - * - * @param v - * - * @return - */ + private UserAgent parse(String v) { return provider.parseUserAgent( @@ -101,7 +80,6 @@ public class BrowserUserAgentProviderTest //~--- fields --------------------------------------------------------------- - /** Field description */ private final BrowserUserAgentProvider provider = new BrowserUserAgentProvider(); } diff --git a/scm-webapp/src/test/java/sonia/scm/web/CookieBearerWebTokenGeneratorTest.java b/scm-webapp/src/test/java/sonia/scm/web/CookieBearerWebTokenGeneratorTest.java index 8204fded99..343a7c8f82 100644 --- a/scm-webapp/src/test/java/sonia/scm/web/CookieBearerWebTokenGeneratorTest.java +++ b/scm-webapp/src/test/java/sonia/scm/web/CookieBearerWebTokenGeneratorTest.java @@ -24,7 +24,6 @@ package sonia.scm.web; -//~--- non-JDK imports -------------------------------------------------------- import jakarta.servlet.http.Cookie; import jakarta.servlet.http.HttpServletRequest; @@ -41,12 +40,7 @@ import static org.mockito.Mockito.lenient; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; -//~--- JDK imports ------------------------------------------------------------ -/** - * - * @author Sebastian Sdorra - */ @ExtendWith(MockitoExtension.class) class CookieBearerWebTokenGeneratorTest {