Small docs cleanup
- NewAPI class will be removed in 5.5, not 5.4 - Add entry for "Deprecated" recommendation in hash algorithms page - Mention possibility of wildcards for restricted user rules
This commit is contained in:
@@ -22,8 +22,6 @@ import fr.xephi.authme.listener.PlayerListener16;
|
||||
import fr.xephi.authme.listener.PlayerListener18;
|
||||
import fr.xephi.authme.listener.PlayerListener19;
|
||||
import fr.xephi.authme.listener.ServerListener;
|
||||
import fr.xephi.authme.permission.PermissionsManager;
|
||||
import fr.xephi.authme.permission.PermissionsSystemType;
|
||||
import fr.xephi.authme.security.HashAlgorithm;
|
||||
import fr.xephi.authme.security.crypts.Sha256;
|
||||
import fr.xephi.authme.service.BackupService;
|
||||
@@ -67,7 +65,6 @@ public class AuthMe extends JavaPlugin {
|
||||
|
||||
// Private instances
|
||||
private CommandHandler commandHandler;
|
||||
private PermissionsManager permsMan;
|
||||
private Settings settings;
|
||||
private DataSource database;
|
||||
private BukkitService bukkitService;
|
||||
@@ -118,7 +115,7 @@ public class AuthMe extends JavaPlugin {
|
||||
|
||||
/**
|
||||
* Method used to obtain the v2 plugin's api instance
|
||||
* @deprecated Will be removed in 5.4, use {@link fr.xephi.authme.api.v3.AuthMeApi} instead
|
||||
* @deprecated Will be removed in 5.5, use {@link fr.xephi.authme.api.v3.AuthMeApi} instead
|
||||
*
|
||||
* @return The plugin's api instance
|
||||
*/
|
||||
@@ -248,7 +245,6 @@ public class AuthMe extends JavaPlugin {
|
||||
*/
|
||||
void instantiateServices(Injector injector) {
|
||||
database = injector.getSingleton(DataSource.class);
|
||||
permsMan = injector.getSingleton(PermissionsManager.class);
|
||||
bukkitService = injector.getSingleton(BukkitService.class);
|
||||
commandHandler = injector.getSingleton(CommandHandler.class);
|
||||
backupService = injector.getSingleton(BackupService.class);
|
||||
|
||||
@@ -27,7 +27,7 @@ import java.util.List;
|
||||
* NewAPI authmeApi = NewAPI.getInstance();
|
||||
* </code>
|
||||
*
|
||||
* @deprecated Will be removed in 5.4! Use {@link fr.xephi.authme.api.v3.AuthMeApi} instead.
|
||||
* @deprecated Will be removed in 5.5! Use {@link fr.xephi.authme.api.v3.AuthMeApi} instead.
|
||||
*/
|
||||
@SuppressWarnings({"checkstyle:AbbreviationAsWordInName"}) // Justification: Class name cannot be changed anymore
|
||||
@Deprecated
|
||||
|
||||
@@ -53,8 +53,10 @@ public class OnStartupTasks {
|
||||
public static void sendMetrics(AuthMe plugin, Settings settings) {
|
||||
final Metrics metrics = new Metrics(plugin);
|
||||
|
||||
metrics.addCustomChart(new Metrics.SimplePie("messages_language", () -> settings.getProperty(PluginSettings.MESSAGES_LANGUAGE)));
|
||||
metrics.addCustomChart(new Metrics.SimplePie("database_backend", () -> settings.getProperty(DatabaseSettings.BACKEND).toString()));
|
||||
metrics.addCustomChart(new Metrics.SimplePie("messages_language",
|
||||
() -> settings.getProperty(PluginSettings.MESSAGES_LANGUAGE)));
|
||||
metrics.addCustomChart(new Metrics.SimplePie("database_backend",
|
||||
() -> settings.getProperty(DatabaseSettings.BACKEND).toString()));
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
@@ -78,7 +78,7 @@ public final class RestrictionSettings implements SettingsHolder {
|
||||
@Comment({
|
||||
"The restricted user feature will kick players listed below",
|
||||
"if they don't match the defined IP address. Names are case-insensitive.",
|
||||
"Ip addresses support regex expressions (regex:127\\.0\\.0\\..*)",
|
||||
"You can use * as wildcard (127.0.0.*), or regex with a \"regex:\" prefix regex:127\\.0\\.0\\..*",
|
||||
"Example:",
|
||||
" AllowedRestrictedUser:",
|
||||
" - playername;127.0.0.1",
|
||||
|
||||
@@ -133,7 +133,7 @@ public final class SecuritySettings implements SettingsHolder {
|
||||
newProperty("Security.emailRecovery.cooldown", 60);
|
||||
|
||||
@Comment({
|
||||
"The maill shown using /email show will be partially hidden",
|
||||
"The mail shown using /email show will be partially hidden",
|
||||
"E.g. (if enabled)",
|
||||
" original email: my.email@example.com",
|
||||
" hidden email: my.***@***mple.com"
|
||||
|
||||
@@ -22,6 +22,7 @@ You can change the hashing algorithm in the config.yml: under `security`, locate
|
||||
The recommendation lists our usage recommendation in terms of how secure it is (not how _well_ the algorithm works!).
|
||||
- Recommended: The hash algorithm appears to be cryptographically secure and is one we recommend.
|
||||
- Acceptable: There are safer algorithms that can be chosen but using the algorithm is generally OK.
|
||||
- Deprecated: Cannot be used anymore actively or in the near future.
|
||||
- Do not use: Hash algorithm isn't sufficiently secure. Use only if required to hook into another system.
|
||||
- Does not work: The algorithm does not work properly; do not use.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user