bug5260: minor adjustments to documentation; some "final" and "@Deprecated" improvements

home.md

@@ -99,7 +99,7 @@ SAP is at the center of today’s technology revolution, developing innovations
 * [[Checking our DBs for a user record by e-mail|wiki/howto/privacy]]
 * [[Managing ORC Performance Curve Regattas|wiki/howto/setup-orc-regatta]]
 * [[Qualtrics Surveys|wiki/howto/qualtrics/qualtrics]]
-* [[Chargebee|wiki/howto/chargebee]]
+* [[Chargebee Payment Integration|wiki/howto/chargebee]]
 
 ### Development
 

java/com.sap.sailing.gwt.ui/src/main/java/com/sap/sailing/gwt/ui/server/subscription/chargebee/ChargebeeSubscriptionServiceImpl.java

@@ -35,7 +35,7 @@ public class ChargebeeSubscriptionServiceImpl extends SubscriptionServiceImpl im
 
     @Override
     public ChargebeeConfigurationDTO getConfiguration() {
-        ChargebeeConfiguration configuration = ChargebeeConfiguration.getInstance();
+        final ChargebeeConfiguration configuration = ChargebeeConfiguration.getInstance();
         final ChargebeeConfigurationDTO result;
         if (configuration != null) {
             result = new ChargebeeConfigurationDTO(configuration.getSite());

java/com.sap.sailing.gwt.ui/src/main/java/com/sap/sailing/gwt/ui/shared/subscription/chargebee/ChargebeeConfigurationDTO.java

@@ -5,8 +5,8 @@ import com.google.gwt.user.client.rpc.IsSerializable;
 public class ChargebeeConfigurationDTO implements IsSerializable {
     private String siteName;
 
-    public ChargebeeConfigurationDTO() {
-    }
+    @Deprecated
+    ChargebeeConfigurationDTO() {} // for GWT serialization only
 
     public ChargebeeConfigurationDTO(String siteName) {
         this.siteName = siteName;
@@ -15,8 +15,4 @@ public class ChargebeeConfigurationDTO implements IsSerializable {
     public String getSiteName() {
         return siteName;
     }
-
-    public void setSiteName(String siteName) {
-        this.siteName = siteName;
-    }
 }

java/com.sap.sse.security.ui/GWT Security SDM.launch

@@ -104,7 +104,6 @@
 <stringAttribute key="org.eclipse.jdt.launching.CLASSPATH_PROVIDER" value="com.gwtplugins.gwt.eclipse.core.moduleClasspathProvider"/>
 <booleanAttribute key="org.eclipse.jdt.launching.DEFAULT_CLASSPATH" value="false"/>
 <stringAttribute key="org.eclipse.jdt.launching.MAIN_TYPE" value="com.google.gwt.dev.DevMode"/>
-<stringAttribute key="org.eclipse.jdt.launching.MODULE_NAME" value="com.sap.sse.security.ui"/>
 <stringAttribute key="org.eclipse.jdt.launching.PROGRAM_ARGUMENTS" value="-incremental -workDir &quot;${project_loc:com.sap.sse.security.ui}/.tmp/gwt-work&quot; -war &quot;${project_loc:com.sap.sse.security.ui}&quot; -noserver -remoteUI &quot;${gwt_remote_ui_server_port}:${unique_id}&quot; -logLevel INFO -codeServerPort 9877 -startupUrl /security/ui/Login.html -startupUrl /security/ui/EditProfile.html -startupUrl /security/ui/EmailValidation.html -startupUrl /security/ui/UserManagement.html -startupUrl /security/ui/Register.html -startupUrl /security/ui/Login.html com.sap.sse.security.ui.EditProfile com.sap.sse.security.ui.EmailValidation com.sap.sse.security.ui.OAuthLogin com.sap.sse.security.ui.UserManagementEntryPoint com.sap.sse.security.ui.Register com.sap.sse.security.ui.Login"/>
 <stringAttribute key="org.eclipse.jdt.launching.PROJECT_ATTR" value="com.sap.sse.security.ui"/>
 <stringAttribute key="org.eclipse.jdt.launching.VM_ARGUMENTS" value="-XX:+UseG1GC -XX:+UseStringDeduplication -Dgwt.watchFileChanges=false -Xmx2048m -Dgwt-usearchives=false -Dgwt.persistentunitcache=false"/>

wiki/howto/chargebee.md

@@ -1,25 +1,24 @@
 # Chargebee Configuration
 
 ## Site and API Key
-We need to provide these system properties(VM arguments):
+We need to provide these system properties as VM arguments:
 
 - chargebee.site: Site name
 
-For test, it should be "syrf-test". And value should be "syrf" for live site.
+For test, it should be "syrf-test". And value should be "syrf" for a live / production site.
 
 
 - chargebee.apikey: API Key
 
-Go into API Key setting page, from Dashboard -> Settings -> Configure Chargebee -> API Keys (API keys tab)
-If there's no keys yet then Press on Add new key to create a new one.
-Copy value of a key
+Go into API Key setting page at [https://app.chargebee.com/](https://app.chargebee.com/), from Dashboard -> Settings -> Configure Chargebee -> API Keys (API keys tab).
+If there's no keys yet then press on "Add new key" to create a new one.
+Copy the value of the key.
 
 ## Webhook
-Configure webhook to enable Chargebee webhook events listening in application
+Configure a webhook to enable Chargebee webhook events listening in application.
 
-Go to Dashboard -> Settings -> Configure Chargebee -> API Keys (Webhooks tab)
-Press on Add webhook button and fill popup form. Webhook URL is {host}/sailingserver/subscription/hooks/chargebee.
-Turn on "Protect webhook URL with basic authentication" option, fill username, password. We also need to create a user in application with same username and password so basic authentication would work correctly.
+Go to Dashboard -> Settings -> Configure Chargebee -> API Keys (Webhooks tab).
+Press on the "Add webhook" button and fill the popup form. Webhook URL is `{host}/sailingserver/subscription/hooks/chargebee`.
+Turn on the "Protect webhook URL with basic authentication" option, fill username and password. We also need to create a user in the application with the same username and password so basic authentication would work correctly. The user for this account requires the permission `USER:ADD_SUBSCRIPTION` on any user the web hook shall be able to manage subscriptions for.
 
-
-If all configurations are provided then Chargebee service will be active in application, otherwise it will be inactive.
+If all configurations are provided then Chargebee service will be active in the application, otherwise it will be inactive.