Make some JavaThemis exceptions unchecked

CHANGELOG.md

@@ -11,6 +11,7 @@ _Code:_
   - JDK location is now detected automatically in most cases, you should not need to set JAVA_HOME or JDK_INCLUDE_PATH manually ([#551](https://github.com/cossacklabs/themis/pull/551)).
   - JNI libraries are now available as `libthemis-jni` packages for supported Linux systems ([#552](https://github.com/cossacklabs/themis/pull/552), [#553](https://github.com/cossacklabs/themis/pull/553)).
   - Fixed a NullPointerException bug in `SecureSocket` initialisation ([#557](https://github.com/cossacklabs/themis/pull/557)).
+  - Some Themis exceptions have been converted from checked `Exception` to _unchecked_ `RuntimeException`, relaxing requirements for `throws` specifiers ([#563](https://github.com/cossacklabs/themis/pull/563)).
 
 - **Python**
 

src/wrappers/themis/java/com/cossacklabs/themis/InvalidArgumentException.java

@@ -16,8 +16,8 @@
 
 package com.cossacklabs.themis;
 
-public class InvalidArgumentException extends Exception {
-	
+public class InvalidArgumentException extends IllegalArgumentException {
+
 	public InvalidArgumentException(String message) {
 		super("Invalid argument: " + message);
 	}

src/wrappers/themis/java/com/cossacklabs/themis/KeyGenerationException.java

@@ -16,6 +16,6 @@
 
 package com.cossacklabs.themis;
 
-public class KeyGenerationException extends Exception {
+public class KeyGenerationException extends RuntimeException {
 
 }

src/wrappers/themis/java/com/cossacklabs/themis/KeypairGenerator.java

@@ -36,7 +36,7 @@ private KeypairGenerator() {
 	 * @return new EC Keypair
 	 * @throws KeyGenerationException when cannot generate a keypair
 	 */
-	public static Keypair generateKeypair() throws KeyGenerationException {
+	public static Keypair generateKeypair() {
 		try {
 			return generateKeypair(AsymmetricKey.KEYTYPE_EC);
 		} catch (InvalidArgumentException e) {
@@ -51,8 +51,8 @@ public static Keypair generateKeypair() throws KeyGenerationException {
 	 * @throws KeyGenerationException when cannot generate a keypair
 	 * @throws InvalidArgumentException when keyType is invalid
 	 */
-	public static Keypair generateKeypair(int keyType) throws KeyGenerationException, InvalidArgumentException {
-		
+	public static Keypair generateKeypair(int keyType) {
+
 		if ((keyType != AsymmetricKey.KEYTYPE_EC) && (keyType != AsymmetricKey.KEYTYPE_RSA)) {
 			throw new InvalidArgumentException("keyType is invalid");
 		}

src/wrappers/themis/java/com/cossacklabs/themis/NullArgumentException.java

@@ -16,8 +16,8 @@
 
 package com.cossacklabs.themis;
 
-public class NullArgumentException extends Exception {
-	
+public class NullArgumentException extends NullPointerException {
+
 	public NullArgumentException() {
 		super();
 	}

src/wrappers/themis/java/com/cossacklabs/themis/SecureCell.java

@@ -16,7 +16,8 @@
 
 package com.cossacklabs.themis;
 
-import java.io.UnsupportedEncodingException;
+import java.nio.charset.Charset;
+import java.nio.charset.StandardCharsets;
 
 /**
  * Themis secure cell
@@ -32,8 +33,8 @@ public class SecureCell {
 	 * @param SecureCell mode
 	 * @throws InvalidArgumentException when unsupported mode is specified
 	 */
-	public SecureCell(int mode) throws InvalidArgumentException {
-		
+	public SecureCell(int mode) {
+
 		if (mode < MODE_SEAL || mode > MODE_CONTEXT_IMPRINT) {
 			throw new InvalidArgumentException("invalid mode");
 		}
@@ -55,46 +56,44 @@ public SecureCell(byte[] key) {
 	 * @param SecureCell mode
 	 * @throws InvalidArgumentException when unsupported mode is specified
 	 */
-	public SecureCell(byte[] key, int mode) throws InvalidArgumentException {
+	public SecureCell(byte[] key, int mode) {
 		this(mode);
 		this.key = key;
 	}
 
 	/**
 	 * Creates new SecureCell with default master password in SEAL mode
 	 * @param default master password
-	 * @throws UnsupportedEncodingException when UTF-16 decoding is not supported
 	 */
-	public SecureCell(String password) throws UnsupportedEncodingException {
+	public SecureCell(String password) {
 		this(password.getBytes(CHARSET));
 	}
 
 	/**
 	 * Creates new SecureCell with default master password in specified mode
 	 * @param default master password
 	 * @param SecureCell mode
-	 * @throws UnsupportedEncodingException when UTF-16 decoding is not supported
 	 * @throws InvalidArgumentException when unsupported mode is specified
 	 */
-	public SecureCell(String password, int mode) throws UnsupportedEncodingException, InvalidArgumentException {
+	public SecureCell(String password, int mode) {
 		this(mode);
 		this.key = password.getBytes(CHARSET);
 	}
 
 	int mode = MODE_SEAL;
 	byte[] key;
 
-	static final String CHARSET = "UTF-16";
+	static final Charset CHARSET = StandardCharsets.UTF_16;
 
 	public static final int MODE_SEAL = 0;
 	public static final int MODE_TOKEN_PROTECT = 1;
 	public static final int MODE_CONTEXT_IMPRINT = 2;
 
 	static native byte[][] encrypt(byte[] key, byte[] context, byte[] data, int mode);
 	static native byte[] decrypt(byte[] key, byte[] context, byte[][] protectedData, int mode);
-	
-	static SecureCellData protect(byte[] key, byte[] context, byte[] data, int mode) throws NullArgumentException, SecureCellException {
-		
+
+	static SecureCellData protect(byte[] key, byte[] context, byte[] data, int mode) throws SecureCellException {
+
 		if (null == key) {
 			throw new NullArgumentException("Master key was not provided");
 		}
@@ -118,9 +117,9 @@ static SecureCellData protect(byte[] key, byte[] context, byte[] data, int mode)
 
 		return new SecureCellData(protectedData[0], protectedData[1]);
 	}
-	
-	static byte[] unprotect(byte[] key, byte[] context, SecureCellData protectedData, int mode) throws NullArgumentException, SecureCellException, InvalidArgumentException {
-		
+
+	static byte[] unprotect(byte[] key, byte[] context, SecureCellData protectedData, int mode) throws SecureCellException {
+
 		if (null == key) {
 			throw new NullArgumentException("Master key was not provided");
 		}
@@ -163,7 +162,7 @@ static byte[] unprotect(byte[] key, byte[] context, SecureCellData protectedData
 	 * @throws NullArgumentException when key or data is null
 	 * @throws SecureCellException when cannot protect the data
 	 */
-	public SecureCellData protect(byte[] key, byte[] context, byte[] data) throws NullArgumentException, SecureCellException {
+	public SecureCellData protect(byte[] key, byte[] context, byte[] data) throws SecureCellException {
 		return protect(key, context, data, this.mode);
 	}
 
@@ -175,7 +174,7 @@ public SecureCellData protect(byte[] key, byte[] context, byte[] data) throws Nu
 	 * @throws NullArgumentException when default master key or data is null
 	 * @throws SecureCellException when cannot protect the data
 	 */
-	public SecureCellData protect(byte[] context, byte[] data) throws NullArgumentException, SecureCellException {
+	public SecureCellData protect(byte[] context, byte[] data) throws SecureCellException {
 		return this.protect(this.key, context, data);
 	}
 
@@ -187,9 +186,8 @@ public SecureCellData protect(byte[] context, byte[] data) throws NullArgumentEx
 	 * @return SecureCellData with protected data
 	 * @throws NullArgumentException when key or data is null
 	 * @throws SecureCellException when cannot protect the data
-	 * @throws UnsupportedEncodingException when UTF-16 decoding is not supported
 	 */
-	public SecureCellData protect(String password, String context, byte[] data) throws UnsupportedEncodingException, NullArgumentException, SecureCellException {
+	public SecureCellData protect(String password, String context, byte[] data) throws SecureCellException {
 		return this.protect(password.getBytes(CHARSET), context.getBytes(CHARSET), data);
 	}
 
@@ -200,9 +198,8 @@ public SecureCellData protect(String password, String context, byte[] data) thro
 	 * @return SecureCellData with protected data
 	 * @throws NullArgumentException when key or data is null
 	 * @throws SecureCellException when cannot protect the data
-	 * @throws UnsupportedEncodingException when UTF-16 decoding is not supported
 	 */
-	public SecureCellData protect(String context, byte[] data) throws UnsupportedEncodingException, NullArgumentException, SecureCellException {
+	public SecureCellData protect(String context, byte[] data) throws SecureCellException {
 		return this.protect(this.key, context.getBytes(CHARSET), data);
 	}
 
@@ -216,7 +213,7 @@ public SecureCellData protect(String context, byte[] data) throws UnsupportedEnc
 	 * @throws SecureCellException when cannot decrypt protectedData
 	 * @throws InvalidArgumentException when protectedData is incorrect
 	 */
-	public byte[] unprotect(byte[] key, byte[] context, SecureCellData protectedData) throws NullArgumentException, SecureCellException, InvalidArgumentException {
+	public byte[] unprotect(byte[] key, byte[] context, SecureCellData protectedData) throws SecureCellException {
 		return unprotect(key, context, protectedData, this.mode);
 	}
 
@@ -229,7 +226,7 @@ public byte[] unprotect(byte[] key, byte[] context, SecureCellData protectedData
 	 * @throws SecureCellException when cannot decrypt protectedData
 	 * @throws InvalidArgumentException when protectedData is incorrect
 	 */
-	public byte[] unprotect(byte[] context, SecureCellData protectedData) throws NullArgumentException, SecureCellException, InvalidArgumentException {
+	public byte[] unprotect(byte[] context, SecureCellData protectedData) throws SecureCellException {
 		return this.unprotect(this.key, context, protectedData);
 	}
 
@@ -242,9 +239,8 @@ public byte[] unprotect(byte[] context, SecureCellData protectedData) throws Nul
 	 * @throws NullArgumentException when key or protectedData is null
 	 * @throws SecureCellException when cannot decrypt protectedData
 	 * @throws InvalidArgumentException when protectedData is incorrect
-	 * @throws UnsupportedEncodingException when UTF-16 decoding is not supported
 	 */
-	public byte[] unprotect(String password, String context, SecureCellData protectedData) throws UnsupportedEncodingException, NullArgumentException, SecureCellException, InvalidArgumentException {
+	public byte[] unprotect(String password, String context, SecureCellData protectedData) throws SecureCellException {
 		return this.unprotect(password.getBytes(CHARSET), context.getBytes(CHARSET), protectedData);
 	}
 
@@ -256,9 +252,8 @@ public byte[] unprotect(String password, String context, SecureCellData protecte
 	 * @throws NullArgumentException when key or protectedData is null
 	 * @throws SecureCellException when cannot decrypt protectedData
 	 * @throws InvalidArgumentException when protectedData is incorrect
-	 * @throws UnsupportedEncodingException when UTF-16 decoding is not supported
 	 */
-	public byte[] unprotect(String context, SecureCellData protectedData) throws UnsupportedEncodingException, NullArgumentException, SecureCellException, InvalidArgumentException {
+	public byte[] unprotect(String context, SecureCellData protectedData) throws SecureCellException {
 		return this.unprotect(this.key, context.getBytes(CHARSET), protectedData);
 	}
 }

src/wrappers/themis/java/com/cossacklabs/themis/SecureCompare.java

@@ -1,6 +1,8 @@
 package com.cossacklabs.themis;
 
 import java.io.UnsupportedEncodingException;
+import java.nio.charset.Charset;
+import java.nio.charset.StandardCharsets;
 
 public class SecureCompare {
 
@@ -19,30 +21,30 @@ public enum ProtocolResult {
 		SEND_TO_PEER
 	}
 
-	static final String CHARSET = "UTF-16";
+	static final Charset CHARSET = StandardCharsets.UTF_16;
 
 	private long nativeCtx = 0;
 
 	native long create();
 	native void destroy();
-	
-	public SecureCompare() throws SecureCompareException {
-		
+
+	public SecureCompare() {
+
 		nativeCtx = create();
 
 		if (0 == nativeCtx) {
-			throw new SecureCompareException();
+			throw new RuntimeException("failed to create Secure Comparator", new SecureCompareException());
 		}
 	}
-	
-	public SecureCompare(byte[] secret) throws SecureCompareException {
-		
+
+	public SecureCompare(byte[] secret) {
+
 		this();
 		appendSecret(secret);
 
 	}
-	
-	public SecureCompare(String password) throws UnsupportedEncodingException, SecureCompareException {
+
+	public SecureCompare(String password) {
 		this(password.getBytes(CHARSET));
 	}
 
@@ -58,49 +60,55 @@ protected void finalize() {
 	}
 
 	native int jniAppend(byte[] secret);
-
-	public void appendSecret(byte[] secretData) throws SecureCompareException {
+
+	public void appendSecret(byte[] secretData) {
+		if (secretData == null) {
+			throw new NullArgumentException("secret cannot be null");
+		}
+		if (secretData.length == 0) {
+			throw new InvalidArgumentException("secret cannot be empty");
+		}
 		if (0 != jniAppend(secretData)) {
-			throw new SecureCompareException();
+			throw new RuntimeException("failed to append secret data", new SecureCompareException());
 		}
 	}
 
 	native byte[] jniBegin();
-	
-	CompareResult parseResult(int result) throws SecureCompareException {
+
+	CompareResult parseResult(int result) {
 		if (result == scompareNotReady()) {
 		    return CompareResult.NOT_READY;
 		}else if (result == scompareNoMatch()){
 		    return CompareResult.NO_MATCH;
 		}else if (result == scompareMatch()){
 		    return CompareResult.MATCH;
 		}
-		throw new SecureCompareException();
+		throw new RuntimeException("unexpected comparison result: " + result, new SecureCompareException());
 	}
-	
-	public byte[] begin() throws SecureCompareException {
+
+	public byte[] begin() {
 		byte[] compareData = jniBegin();
 
 		if (null == compareData) {
-			throw new SecureCompareException();
+			throw new RuntimeException("failed to begin comparison", new SecureCompareException());
 		}
 
 		return compareData;
 	}
 
 	native byte[] jniProceed(byte[] compareData);
-	
+
 	public byte[] proceed(byte[] compareData) throws SecureCompareException {
 		return jniProceed(compareData);
 	}
 
 	native int jniGetResult();
-	
-	public CompareResult getResult() throws SecureCompareException {
+
+	public CompareResult getResult() {
 		return parseResult(jniGetResult());
 	}
 
 	native int scompareMatch();
 	native int scompareNoMatch();
 	native int scompareNotReady();
-}
+}