Commits

Anonymous committed ec87412

adding class-level javadocs to servlets

  • Participants
  • Parent commits 5a9423f

Comments (0)

Files changed (2)

src/main/java/com/example/plugins/tutorial/servlet/HelloWorldServlet.java

 import com.atlassian.upm.license.storage.lib.PluginLicenseStoragePluginUnresolvedException;
 import com.atlassian.upm.license.storage.lib.ThirdPartyPluginLicenseStorageManager;
 
+/**
+ * A simple "Hello World" servlet that demonstrates how to use
+ * {@link ThirdPartyPluginLicenseStorageManager} to ensure plugin license
+ * existence/validity at a plugin entry point.
+ *
+ * This servlet can be reached at http://localhost:2990/jira/plugins/servlet/helloworldservlet
+ */
 public class HelloWorldServlet extends HttpServlet
 {
     private final ThirdPartyPluginLicenseStorageManager licenseManager;

src/main/java/com/example/plugins/tutorial/servlet/LicenseServlet.java

 
 import org.apache.commons.lang.StringUtils;
 
+/**
+ * A simple license administration servlet that demonstrates how to use
+ * {@link ThirdPartyPluginLicenseStorageManager} to:
+ *  - get the current plugin license,
+ *  - update the plugin license,
+ *  - remove the plugin license,
+ *  - check for a licensing-aware UPM,
+ *  - and properly handle if a licensing-aware UPM is detected.
+ *
+ * This servlet can be reached at http://localhost:2990/jira/plugins/servlet/licenseservlet
+ */
 public class LicenseServlet extends HttpServlet
 {
     private final ThirdPartyPluginLicenseStorageManager licenseManager;