cleanup: remove trivial comments

This commit is contained in:
Kirill Likhodedov
2014-07-16 17:53:57 +04:00
parent d8f6d4c63e
commit 4d3abb7cfd
4 changed files with 1 additions and 119 deletions
@@ -27,37 +27,13 @@ import com.intellij.openapi.project.Project;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
/**
* The implementation of password safe service
*/
public class PasswordSafeImpl extends PasswordSafe {
/**
* The logger instance
*/
private static final Logger LOG = Logger.getInstance(PasswordSafeImpl.class.getName());
/**
* The current settings
*/
private final PasswordSafeSettings mySettings;
/**
* The master key provider
*/
private final MasterKeyPasswordSafe myMasterKeyProvider;
/**
* The nil provider
*/
private final NilProvider myNilProvider;
/**
* The memory provider
*/
private final MemoryPasswordSafe myMemoryProvider;
/**
* The constructor
*
* @param settings the settings for the password safe
* @param database the password database
*/
public PasswordSafeImpl(PasswordSafeSettings settings, PasswordDatabase database) {
mySettings = settings;
myMasterKeyProvider = new MasterKeyPasswordSafe(database);
@@ -89,15 +65,10 @@ public class PasswordSafeImpl extends PasswordSafe {
return p;
}
/**
* @return settings for the passwords safe
*/
public PasswordSafeSettings getSettings() {
return mySettings;
}
@Nullable
public String getPassword(@Nullable Project project, @NotNull Class requester, String key) throws PasswordSafeException {
if (mySettings.getProviderType().equals(PasswordSafeSettings.ProviderType.MASTER_PASSWORD)) {
@@ -114,9 +85,6 @@ public class PasswordSafeImpl extends PasswordSafe {
return provider().getPassword(project, requester, key);
}
/**
* {@inheritDoc}
*/
public void removePassword(@Nullable Project project, @NotNull Class requester, String key) throws PasswordSafeException {
if (mySettings.getProviderType().equals(PasswordSafeSettings.ProviderType.MASTER_PASSWORD)) {
getMemoryProvider().removePassword(project, requester, key);
@@ -124,9 +92,6 @@ public class PasswordSafeImpl extends PasswordSafe {
provider().removePassword(project, requester, key);
}
/**
* {@inheritDoc}
*/
public void storePassword(@Nullable Project project, @NotNull Class requester, String key, String value) throws PasswordSafeException {
if (mySettings.getProviderType().equals(PasswordSafeSettings.ProviderType.MASTER_PASSWORD)) {
getMemoryProvider().storePassword(project, requester, key, value);
@@ -45,9 +45,6 @@ public abstract class BasePasswordSafeProvider extends PasswordSafeProvider {
*/
protected abstract byte[] key(@Nullable Project project, @NotNull Class requestor) throws PasswordSafeException;
/**
* {@inheritDoc}
*/
@Nullable
public String getPassword(@Nullable Project project, @NotNull Class requestor, String key) throws PasswordSafeException {
byte[] k = dbKey(project, requestor, key);
@@ -75,9 +72,6 @@ public abstract class BasePasswordSafeProvider extends PasswordSafeProvider {
return EncryptionUtil.dbKey(key(project, requestor), requestor, key);
}
/**
* {@inheritDoc}
*/
public void removePassword(@Nullable Project project, @NotNull Class requester, String key) throws PasswordSafeException {
byte[] k = dbKey(project, requester, key);
removeEncryptedPassword(k);
@@ -90,9 +84,6 @@ public abstract class BasePasswordSafeProvider extends PasswordSafeProvider {
*/
protected abstract void removeEncryptedPassword(byte[] key);
/**
* {@inheritDoc}
*/
public void storePassword(@Nullable Project project, @NotNull Class requestor, String key, String value) throws PasswordSafeException {
byte[] k = dbKey(project, requestor, key);
byte[] ct = EncryptionUtil.encryptText(key(project, requestor), value);
@@ -42,17 +42,8 @@ import java.util.concurrent.atomic.AtomicReference;
* The password safe that stores information in configuration file encrypted by master password
*/
public class MasterKeyPasswordSafe extends BasePasswordSafeProvider {
/**
* The test password key
*/
private static final String TEST_PASSWORD_KEY = "TEST_PASSWORD:";
/**
* The test password value
*/
private static final String TEST_PASSWORD_VALUE = "test password";
/**
* The password database instance
*/
final PasswordDatabase database;
/**
* The key to use to encrypt data
@@ -68,18 +59,10 @@ public class MasterKeyPasswordSafe extends BasePasswordSafeProvider {
}
};
/**
* The constructor
*
* @param database the password database
*/
public MasterKeyPasswordSafe(PasswordDatabase database) {
this.database = database;
}
/**
* @return true if the component is running in the test mode
*/
protected boolean isTestMode() {
return false;
}
@@ -130,7 +113,6 @@ public class MasterKeyPasswordSafe extends BasePasswordSafeProvider {
else {
return true;
}
}
/**
@@ -167,12 +149,6 @@ public class MasterKeyPasswordSafe extends BasePasswordSafeProvider {
}
/**
* The test key
*
* @param password the password for the test key
* @return the test key
*/
private static String testKey(String password) {
return TEST_PASSWORD_KEY + password;
}
@@ -233,9 +209,6 @@ public class MasterKeyPasswordSafe extends BasePasswordSafeProvider {
return result.get();
}
/**
* {@inheritDoc}
*/
@Override
public String getPassword(@Nullable Project project, @NotNull Class requestor, String key) throws PasswordSafeException {
if (database.isEmpty()) {
@@ -244,9 +217,6 @@ public class MasterKeyPasswordSafe extends BasePasswordSafeProvider {
return super.getPassword(project, requestor, key);
}
/**
* {@inheritDoc}
*/
@Override
public void removePassword(@Nullable Project project, @NotNull Class requester, String key) throws PasswordSafeException {
if (database.isEmpty()) {
@@ -255,50 +225,32 @@ public class MasterKeyPasswordSafe extends BasePasswordSafeProvider {
super.removePassword(project, requester, key);
}
/**
* {@inheritDoc}
*/
@Override
protected byte[] getEncryptedPassword(byte[] key) {
return database.get(key);
}
/**
* {@inheritDoc}
*/
@Override
protected void removeEncryptedPassword(byte[] key) {
database.remove(key);
}
/**
* {@inheritDoc}
*/
@Override
protected void storeEncryptedPassword(byte[] key, byte[] encryptedPassword) {
database.put(key, encryptedPassword);
}
/**
* {@inheritDoc}
*/
@Override
public boolean isSupported() {
return !ApplicationManager.getApplication().isHeadlessEnvironment();
}
/**
* {@inheritDoc}
*/
@Override
public String getDescription() {
return "This provider stores passwords in IDEA config and uses master password to encrypt other passwords. " +
"The passwords for the same resources are shared between different projects.";
}
/**
* {@inheritDoc}
*/
@Override
public String getName() {
return "Master Key PasswordSafe";
@@ -309,9 +261,6 @@ public class MasterKeyPasswordSafe extends BasePasswordSafeProvider {
return setMasterPassword("");
}
/**
* @return true, if OS protected passwords are supported for the current platform
*/
@SuppressWarnings({"MethodMayBeStatic"})
public boolean isOsProtectedPasswordSupported() {
// TODO extension point needed?
@@ -351,9 +300,6 @@ public class MasterKeyPasswordSafe extends BasePasswordSafeProvider {
}
}
/**
* @return true, if the password is currently encrypted in the database
*/
public boolean isPasswordEncrypted() {
if (!isOsProtectedPasswordSupported()) return false;
@@ -361,9 +307,6 @@ public class MasterKeyPasswordSafe extends BasePasswordSafeProvider {
return i != null && i.length > 0;
}
/**
* @return check if provider database is empty
*/
public boolean isEmpty() {
return database.isEmpty();
}
@@ -25,48 +25,31 @@ import org.jetbrains.annotations.Nullable;
* The most secure provider that does not store anything, so it cannot be cracked
*/
public final class NilProvider extends PasswordSafeProvider {
/**
* {@inheritDoc}
*/
@Override
public boolean isSupported() {
return true;
}
/**
* {@inheritDoc}
*/
@Override
public String getDescription() {
return "The provider that does not remembers password.";
}
/**
* {@inheritDoc}
*/
@Override
public String getName() {
return "Do not Store";
}
/**
* {@inheritDoc}
*/
public String getPassword(@Nullable Project project, @NotNull Class requester, String key) throws PasswordSafeException {
// nothing is stored
return null;
}
/**
* {@inheritDoc}
*/
public void removePassword(@Nullable Project project, @NotNull Class requester, String key) throws PasswordSafeException {
// do nothing
}
/**
* {@inheritDoc}
*/
public void storePassword(@Nullable Project project, @NotNull Class requester, String key, String value) throws PasswordSafeException {
// just forget about password
}